From 1cb914be9a7d3577acf2f69ff9405be1757e62e6 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:32:18 -0700 Subject: [PATCH 001/157] feat:Add scheduleOptionsV2 and Error fields for TransferConfig (#7718) PiperOrigin-RevId: 680586383 Source-Link: https://github.com/googleapis/googleapis/commit/463b5a6b06e20504fb44bfedff59ba05b42bf0b2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/68d602fca86cfbf7653612f50c5cf9e3105065c9 Copy-Tag: eyJwIjoiQmlnUXVlcnlEYXRhVHJhbnNmZXIvLk93bEJvdC55YW1sIiwiaCI6IjY4ZDYwMmZjYTg2Y2ZiZjc2NTM2MTJmNTBjNWNmOWUzMTA1MDY1YzkifQ== --- BigQueryDataTransfer/metadata/V1/Transfer.php | Bin 4175 -> 4804 bytes .../src/V1/EventDrivenSchedule.php | 75 ++++++ .../src/V1/ManualSchedule.php | 33 +++ .../src/V1/ScheduleOptionsV2.php | 159 +++++++++++++ .../src/V1/TimeBasedSchedule.php | 220 ++++++++++++++++++ .../src/V1/TransferConfig.php | 100 ++++++++ 6 files changed, 587 insertions(+) create mode 100644 BigQueryDataTransfer/src/V1/EventDrivenSchedule.php create mode 100644 BigQueryDataTransfer/src/V1/ManualSchedule.php create mode 100644 BigQueryDataTransfer/src/V1/ScheduleOptionsV2.php create mode 100644 BigQueryDataTransfer/src/V1/TimeBasedSchedule.php diff --git a/BigQueryDataTransfer/metadata/V1/Transfer.php b/BigQueryDataTransfer/metadata/V1/Transfer.php index 81eda220fed4f3e1557734897f49fe3f57ffe639..385f1d373ad22e6a7f7da82a5d7a30fd29d42e10 100644 GIT binary patch delta 438 zcmX@Fa71;37c4XgL**qH6&N+RjVvZ}@u=&C0Og%P(lFf~3_<~1{JDvFrHMHRElgl7rXVebzF;{d z_0e3Ssb#5oCGjamnLrw$iy5rT3aCpX5Tw8bERWFX#Kpw{bCpsvBbOkCYlH+4D!}gM z6w>43DlSPZDw%wXMSb!IP8P1zyp(v5Hzk-SKV(sK72x7Sb)k|Gm#{0Q^+M8I!Ud&C z#idE{KwO+$lnD+uh%J*DS+$vFb8gmSWnz>In+a delta 37 tcmX@2dR}3J7cgoogle.cloud.bigquery.datatransfer.v1.EventDrivenSchedule + */ +class EventDrivenSchedule extends \Google\Protobuf\Internal\Message +{ + /** + * Pub/Sub subscription name used to receive events. + * Only Google Cloud Storage data source support this option. + * Format: projects/{project}/subscriptions/{subscription} + * + * Generated from protobuf field string pubsub_subscription = 1; + */ + protected $pubsub_subscription = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $pubsub_subscription + * Pub/Sub subscription name used to receive events. + * Only Google Cloud Storage data source support this option. + * Format: projects/{project}/subscriptions/{subscription} + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Bigquery\Datatransfer\V1\Transfer::initOnce(); + parent::__construct($data); + } + + /** + * Pub/Sub subscription name used to receive events. + * Only Google Cloud Storage data source support this option. + * Format: projects/{project}/subscriptions/{subscription} + * + * Generated from protobuf field string pubsub_subscription = 1; + * @return string + */ + public function getPubsubSubscription() + { + return $this->pubsub_subscription; + } + + /** + * Pub/Sub subscription name used to receive events. + * Only Google Cloud Storage data source support this option. + * Format: projects/{project}/subscriptions/{subscription} + * + * Generated from protobuf field string pubsub_subscription = 1; + * @param string $var + * @return $this + */ + public function setPubsubSubscription($var) + { + GPBUtil::checkString($var, True); + $this->pubsub_subscription = $var; + + return $this; + } + +} + diff --git a/BigQueryDataTransfer/src/V1/ManualSchedule.php b/BigQueryDataTransfer/src/V1/ManualSchedule.php new file mode 100644 index 000000000000..d63152a9d504 --- /dev/null +++ b/BigQueryDataTransfer/src/V1/ManualSchedule.php @@ -0,0 +1,33 @@ +google.cloud.bigquery.datatransfer.v1.ManualSchedule + */ +class ManualSchedule extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Bigquery\Datatransfer\V1\Transfer::initOnce(); + parent::__construct($data); + } + +} + diff --git a/BigQueryDataTransfer/src/V1/ScheduleOptionsV2.php b/BigQueryDataTransfer/src/V1/ScheduleOptionsV2.php new file mode 100644 index 000000000000..9f60741106c1 --- /dev/null +++ b/BigQueryDataTransfer/src/V1/ScheduleOptionsV2.php @@ -0,0 +1,159 @@ +google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 + */ +class ScheduleOptionsV2 extends \Google\Protobuf\Internal\Message +{ + protected $schedule; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\BigQuery\DataTransfer\V1\TimeBasedSchedule $time_based_schedule + * Time based transfer schedule options. This is the default schedule + * option. + * @type \Google\Cloud\BigQuery\DataTransfer\V1\ManualSchedule $manual_schedule + * Manual transfer schedule. If set, the transfer run will not be + * auto-scheduled by the system, unless the client invokes + * StartManualTransferRuns. This is equivalent to + * disable_auto_scheduling = true. + * @type \Google\Cloud\BigQuery\DataTransfer\V1\EventDrivenSchedule $event_driven_schedule + * Event driven transfer schedule options. If set, the transfer will be + * scheduled upon events arrial. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Bigquery\Datatransfer\V1\Transfer::initOnce(); + parent::__construct($data); + } + + /** + * Time based transfer schedule options. This is the default schedule + * option. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule time_based_schedule = 1; + * @return \Google\Cloud\BigQuery\DataTransfer\V1\TimeBasedSchedule|null + */ + public function getTimeBasedSchedule() + { + return $this->readOneof(1); + } + + public function hasTimeBasedSchedule() + { + return $this->hasOneof(1); + } + + /** + * Time based transfer schedule options. This is the default schedule + * option. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule time_based_schedule = 1; + * @param \Google\Cloud\BigQuery\DataTransfer\V1\TimeBasedSchedule $var + * @return $this + */ + public function setTimeBasedSchedule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\DataTransfer\V1\TimeBasedSchedule::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * Manual transfer schedule. If set, the transfer run will not be + * auto-scheduled by the system, unless the client invokes + * StartManualTransferRuns. This is equivalent to + * disable_auto_scheduling = true. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ManualSchedule manual_schedule = 2; + * @return \Google\Cloud\BigQuery\DataTransfer\V1\ManualSchedule|null + */ + public function getManualSchedule() + { + return $this->readOneof(2); + } + + public function hasManualSchedule() + { + return $this->hasOneof(2); + } + + /** + * Manual transfer schedule. If set, the transfer run will not be + * auto-scheduled by the system, unless the client invokes + * StartManualTransferRuns. This is equivalent to + * disable_auto_scheduling = true. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ManualSchedule manual_schedule = 2; + * @param \Google\Cloud\BigQuery\DataTransfer\V1\ManualSchedule $var + * @return $this + */ + public function setManualSchedule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\DataTransfer\V1\ManualSchedule::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Event driven transfer schedule options. If set, the transfer will be + * scheduled upon events arrial. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.EventDrivenSchedule event_driven_schedule = 3; + * @return \Google\Cloud\BigQuery\DataTransfer\V1\EventDrivenSchedule|null + */ + public function getEventDrivenSchedule() + { + return $this->readOneof(3); + } + + public function hasEventDrivenSchedule() + { + return $this->hasOneof(3); + } + + /** + * Event driven transfer schedule options. If set, the transfer will be + * scheduled upon events arrial. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.EventDrivenSchedule event_driven_schedule = 3; + * @param \Google\Cloud\BigQuery\DataTransfer\V1\EventDrivenSchedule $var + * @return $this + */ + public function setEventDrivenSchedule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\DataTransfer\V1\EventDrivenSchedule::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * @return string + */ + public function getSchedule() + { + return $this->whichOneof("schedule"); + } + +} + diff --git a/BigQueryDataTransfer/src/V1/TimeBasedSchedule.php b/BigQueryDataTransfer/src/V1/TimeBasedSchedule.php new file mode 100644 index 000000000000..11981b94a608 --- /dev/null +++ b/BigQueryDataTransfer/src/V1/TimeBasedSchedule.php @@ -0,0 +1,220 @@ +google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule + */ +class TimeBasedSchedule extends \Google\Protobuf\Internal\Message +{ + /** + * Data transfer schedule. + * If the data source does not support a custom schedule, this should be + * empty. If it is empty, the default value for the data source will be used. + * The specified times are in UTC. + * Examples of valid format: + * `1st,3rd monday of month 15:30`, + * `every wed,fri of jan,jun 13:15`, and + * `first sunday of quarter 00:00`. + * See more explanation about the format here: + * https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format + * NOTE: The minimum interval time between recurring transfers depends on the + * data source; refer to the documentation for your data source. + * + * Generated from protobuf field string schedule = 1; + */ + protected $schedule = ''; + /** + * Specifies time to start scheduling transfer runs. The first run will be + * scheduled at or after the start time according to a recurrence pattern + * defined in the schedule string. The start time can be changed at any + * moment. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 2; + */ + protected $start_time = null; + /** + * Defines time to stop scheduling transfer runs. A transfer run cannot be + * scheduled at or after the end time. The end time can be changed at any + * moment. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3; + */ + protected $end_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $schedule + * Data transfer schedule. + * If the data source does not support a custom schedule, this should be + * empty. If it is empty, the default value for the data source will be used. + * The specified times are in UTC. + * Examples of valid format: + * `1st,3rd monday of month 15:30`, + * `every wed,fri of jan,jun 13:15`, and + * `first sunday of quarter 00:00`. + * See more explanation about the format here: + * https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format + * NOTE: The minimum interval time between recurring transfers depends on the + * data source; refer to the documentation for your data source. + * @type \Google\Protobuf\Timestamp $start_time + * Specifies time to start scheduling transfer runs. The first run will be + * scheduled at or after the start time according to a recurrence pattern + * defined in the schedule string. The start time can be changed at any + * moment. + * @type \Google\Protobuf\Timestamp $end_time + * Defines time to stop scheduling transfer runs. A transfer run cannot be + * scheduled at or after the end time. The end time can be changed at any + * moment. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Bigquery\Datatransfer\V1\Transfer::initOnce(); + parent::__construct($data); + } + + /** + * Data transfer schedule. + * If the data source does not support a custom schedule, this should be + * empty. If it is empty, the default value for the data source will be used. + * The specified times are in UTC. + * Examples of valid format: + * `1st,3rd monday of month 15:30`, + * `every wed,fri of jan,jun 13:15`, and + * `first sunday of quarter 00:00`. + * See more explanation about the format here: + * https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format + * NOTE: The minimum interval time between recurring transfers depends on the + * data source; refer to the documentation for your data source. + * + * Generated from protobuf field string schedule = 1; + * @return string + */ + public function getSchedule() + { + return $this->schedule; + } + + /** + * Data transfer schedule. + * If the data source does not support a custom schedule, this should be + * empty. If it is empty, the default value for the data source will be used. + * The specified times are in UTC. + * Examples of valid format: + * `1st,3rd monday of month 15:30`, + * `every wed,fri of jan,jun 13:15`, and + * `first sunday of quarter 00:00`. + * See more explanation about the format here: + * https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format + * NOTE: The minimum interval time between recurring transfers depends on the + * data source; refer to the documentation for your data source. + * + * Generated from protobuf field string schedule = 1; + * @param string $var + * @return $this + */ + public function setSchedule($var) + { + GPBUtil::checkString($var, True); + $this->schedule = $var; + + return $this; + } + + /** + * Specifies time to start scheduling transfer runs. The first run will be + * scheduled at or after the start time according to a recurrence pattern + * defined in the schedule string. The start time can be changed at any + * moment. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 2; + * @return \Google\Protobuf\Timestamp|null + */ + public function getStartTime() + { + return $this->start_time; + } + + public function hasStartTime() + { + return isset($this->start_time); + } + + public function clearStartTime() + { + unset($this->start_time); + } + + /** + * Specifies time to start scheduling transfer runs. The first run will be + * scheduled at or after the start time according to a recurrence pattern + * defined in the schedule string. The start time can be changed at any + * moment. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 2; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setStartTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->start_time = $var; + + return $this; + } + + /** + * Defines time to stop scheduling transfer runs. A transfer run cannot be + * scheduled at or after the end time. The end time can be changed at any + * moment. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * Defines time to stop scheduling transfer runs. A transfer run cannot be + * scheduled at or after the end time. The end time can be changed at any + * moment. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + +} + diff --git a/BigQueryDataTransfer/src/V1/TransferConfig.php b/BigQueryDataTransfer/src/V1/TransferConfig.php index c1288effb4fa..e02892d345a5 100644 --- a/BigQueryDataTransfer/src/V1/TransferConfig.php +++ b/BigQueryDataTransfer/src/V1/TransferConfig.php @@ -78,6 +78,14 @@ class TransferConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24; */ protected $schedule_options = null; + /** + * Options customizing different types of data transfer schedule. + * This field replaces "schedule" and "schedule_options" fields. + * ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31; + */ + protected $schedule_options_v2 = null; /** * The number of days to look back to automatically refresh the data. * For example, if `data_refresh_window_days = 10`, then every day @@ -160,6 +168,13 @@ class TransferConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28; */ protected $encryption_configuration = null; + /** + * Output only. Error code with detailed information about reason of the + * latest config failure. + * + * Generated from protobuf field .google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $error = null; protected $destination; /** @@ -204,6 +219,10 @@ class TransferConfig extends \Google\Protobuf\Internal\Message * data source; refer to the documentation for your data source. * @type \Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptions $schedule_options * Options customizing the data transfer schedule. + * @type \Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptionsV2 $schedule_options_v2 + * Options customizing different types of data transfer schedule. + * This field replaces "schedule" and "schedule_options" fields. + * ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule. * @type int $data_refresh_window_days * The number of days to look back to automatically refresh the data. * For example, if `data_refresh_window_days = 10`, then every day @@ -242,6 +261,9 @@ class TransferConfig extends \Google\Protobuf\Internal\Message * granted permissions to use the key. Read methods will return the key name * applied in effect. Write methods will apply the key if it is present, or * otherwise try to apply project default keys if it is absent. + * @type \Google\Rpc\Status $error + * Output only. Error code with detailed information about reason of the + * latest config failure. * } */ public function __construct($data = NULL) { @@ -500,6 +522,46 @@ public function setScheduleOptions($var) return $this; } + /** + * Options customizing different types of data transfer schedule. + * This field replaces "schedule" and "schedule_options" fields. + * ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31; + * @return \Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptionsV2|null + */ + public function getScheduleOptionsV2() + { + return $this->schedule_options_v2; + } + + public function hasScheduleOptionsV2() + { + return isset($this->schedule_options_v2); + } + + public function clearScheduleOptionsV2() + { + unset($this->schedule_options_v2); + } + + /** + * Options customizing different types of data transfer schedule. + * This field replaces "schedule" and "schedule_options" fields. + * ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule. + * + * Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31; + * @param \Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptionsV2 $var + * @return $this + */ + public function setScheduleOptionsV2($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptionsV2::class); + $this->schedule_options_v2 = $var; + + return $this; + } + /** * The number of days to look back to automatically refresh the data. * For example, if `data_refresh_window_days = 10`, then every day @@ -868,6 +930,44 @@ public function setEncryptionConfiguration($var) return $this; } + /** + * Output only. Error code with detailed information about reason of the + * latest config failure. + * + * Generated from protobuf field .google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Rpc\Status|null + */ + public function getError() + { + return $this->error; + } + + public function hasError() + { + return isset($this->error); + } + + public function clearError() + { + unset($this->error); + } + + /** + * Output only. Error code with detailed information about reason of the + * latest config failure. + * + * Generated from protobuf field .google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Rpc\Status $var + * @return $this + */ + public function setError($var) + { + GPBUtil::checkMessage($var, \Google\Rpc\Status::class); + $this->error = $var; + + return $this; + } + /** * @return string */ From 132254fa537dfece87f3b836c51ed5248c230db4 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 1 Oct 2024 09:43:38 -0700 Subject: [PATCH 002/157] feat: add INTERVAL API (#7712) PiperOrigin-RevId: 680405503 Source-Link: https://github.com/googleapis/googleapis/commit/2c9fb377810d80ef2a14159229a68cdeab26351e Source-Link: https://github.com/googleapis/googleapis-gen/commit/317c7d1b1b801fe663f87bfd0bae54fd6526de87 Copy-Tag: eyJwIjoiU3Bhbm5lci8uT3dsQm90LnlhbWwiLCJoIjoiMzE3YzdkMWIxYjgwMWZlNjYzZjg3YmZkMGJhZTU0ZmQ2NTI2ZGU4NyJ9 feat: add new QueryMode enum values (WITH_STATS, WITH_PLAN_AND_STATS) docs: update comment for PROFILE QueryMode PiperOrigin-RevId: 680628448 Source-Link: https://github.com/googleapis/googleapis/commit/72a51519aec11b9ee28842b4a58ba4a4a82bc2e5 Source-Link: https://github.com/googleapis/googleapis-gen/commit/146c3e8da87738804709b7f3d264a8e33ae38d71 Copy-Tag: eyJwIjoiU3Bhbm5lci8uT3dsQm90LnlhbWwiLCJoIjoiMTQ2YzNlOGRhODc3Mzg4MDQ3MDliN2YzZDI2NGE4ZTMzYWUzOGQ3MSJ9 --- Spanner/metadata/V1/Spanner.php | Bin 11701 -> 11742 bytes Spanner/metadata/V1/Type.php | Bin 1501 -> 1515 bytes .../src/V1/ExecuteSqlRequest/QueryMode.php | 22 +++- Spanner/src/V1/StructType.php | 27 ++--- Spanner/src/V1/Type.php | 96 ++++++++++-------- Spanner/src/V1/TypeAnnotationCode.php | 21 ++-- Spanner/src/V1/TypeCode.php | 23 +++-- 7 files changed, 118 insertions(+), 71 deletions(-) diff --git a/Spanner/metadata/V1/Spanner.php b/Spanner/metadata/V1/Spanner.php index c5904d92a6e986818242f4f20afd005295b8d52f..fc4f6b042fe2b4b236ce5512d20ca6619dfaaa4f 100644 GIT binary patch delta 74 zcmdlQeJ^^01uNsl&6cdUI2k`|7U7p-W(=RKFQlg_#K*-I?iu0{9~|Ns5-h+hB+exa W<_GvV`o%l?xj-dYHpdD@NCN;r$rOqJ delta 46 zcmcZ?y)}A+1uNr<&6cdUI2n&`7U7p-X4IRkFQmt+w19<6Y_gt+*klcUtIfBCn56+= C0u49- diff --git a/Spanner/metadata/V1/Type.php b/Spanner/metadata/V1/Type.php index c024bfdf43aab9259f2e23e0981ca62f23d62c77..c5f753723320ba0517a5981065c346156a688a6b 100644 GIT binary patch delta 39 vcmcc1{hE6L6XU|oj7;ko8Lv*>zPROFILE = 2; */ const PROFILE = 2; + /** + * This mode returns the overall (but not operator-level) execution + * statistics along with the results. + * + * Generated from protobuf enum WITH_STATS = 3; + */ + const WITH_STATS = 3; + /** + * This mode returns the query plan, overall (but not operator-level) + * execution statistics along with the results. + * + * Generated from protobuf enum WITH_PLAN_AND_STATS = 4; + */ + const WITH_PLAN_AND_STATS = 4; private static $valueToName = [ self::NORMAL => 'NORMAL', self::PLAN => 'PLAN', self::PROFILE => 'PROFILE', + self::WITH_STATS => 'WITH_STATS', + self::WITH_PLAN_AND_STATS => 'WITH_PLAN_AND_STATS', ]; public static function name($value) diff --git a/Spanner/src/V1/StructType.php b/Spanner/src/V1/StructType.php index fd5d1b31fb0e..a67da0c0d598 100644 --- a/Spanner/src/V1/StructType.php +++ b/Spanner/src/V1/StructType.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * `StructType` defines the fields of a [STRUCT][google.spanner.v1.TypeCode.STRUCT] type. + * `StructType` defines the fields of a + * [STRUCT][google.spanner.v1.TypeCode.STRUCT] type. * * Generated from protobuf message google.spanner.v1.StructType */ @@ -19,9 +20,9 @@ class StructType extends \Google\Protobuf\Internal\Message * The list of fields that make up this struct. Order is * significant, because values of this struct type are represented as * lists, where the order of field values matches the order of - * fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields - * matches the order of columns in a read request, or the order of - * fields in the `SELECT` clause of a query. + * fields in the [StructType][google.spanner.v1.StructType]. In turn, the + * order of fields matches the order of columns in a read request, or the + * order of fields in the `SELECT` clause of a query. * * Generated from protobuf field repeated .google.spanner.v1.StructType.Field fields = 1; */ @@ -37,9 +38,9 @@ class StructType extends \Google\Protobuf\Internal\Message * The list of fields that make up this struct. Order is * significant, because values of this struct type are represented as * lists, where the order of field values matches the order of - * fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields - * matches the order of columns in a read request, or the order of - * fields in the `SELECT` clause of a query. + * fields in the [StructType][google.spanner.v1.StructType]. In turn, the + * order of fields matches the order of columns in a read request, or the + * order of fields in the `SELECT` clause of a query. * } */ public function __construct($data = NULL) { @@ -51,9 +52,9 @@ public function __construct($data = NULL) { * The list of fields that make up this struct. Order is * significant, because values of this struct type are represented as * lists, where the order of field values matches the order of - * fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields - * matches the order of columns in a read request, or the order of - * fields in the `SELECT` clause of a query. + * fields in the [StructType][google.spanner.v1.StructType]. In turn, the + * order of fields matches the order of columns in a read request, or the + * order of fields in the `SELECT` clause of a query. * * Generated from protobuf field repeated .google.spanner.v1.StructType.Field fields = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -67,9 +68,9 @@ public function getFields() * The list of fields that make up this struct. Order is * significant, because values of this struct type are represented as * lists, where the order of field values matches the order of - * fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields - * matches the order of columns in a read request, or the order of - * fields in the `SELECT` clause of a query. + * fields in the [StructType][google.spanner.v1.StructType]. In turn, the + * order of fields matches the order of columns in a read request, or the + * order of fields in the `SELECT` clause of a query. * * Generated from protobuf field repeated .google.spanner.v1.StructType.Field fields = 1; * @param array<\Google\Cloud\Spanner\V1\StructType\Field>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Spanner/src/V1/Type.php b/Spanner/src/V1/Type.php index 1a7c2f3a2f21..843c86552523 100644 --- a/Spanner/src/V1/Type.php +++ b/Spanner/src/V1/Type.php @@ -23,26 +23,30 @@ class Type extends \Google\Protobuf\Internal\Message */ private $code = 0; /** - * If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type` - * is the type of the array elements. + * If [code][google.spanner.v1.Type.code] == + * [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type` is the + * type of the array elements. * * Generated from protobuf field .google.spanner.v1.Type array_element_type = 2; */ private $array_element_type = null; /** - * If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type` - * provides type information for the struct's fields. + * If [code][google.spanner.v1.Type.code] == + * [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type` provides + * type information for the struct's fields. * * Generated from protobuf field .google.spanner.v1.StructType struct_type = 3; */ private $struct_type = null; /** - * The [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode] that disambiguates SQL type that Spanner will - * use to represent values of this type during query processing. This is - * necessary for some type codes because a single [TypeCode][google.spanner.v1.TypeCode] can be mapped - * to different SQL types depending on the SQL dialect. [type_annotation][google.spanner.v1.Type.type_annotation] - * typically is not needed to process the content of a value (it doesn't - * affect serialization) and clients can ignore it on the read path. + * The [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode] that + * disambiguates SQL type that Spanner will use to represent values of this + * type during query processing. This is necessary for some type codes because + * a single [TypeCode][google.spanner.v1.TypeCode] can be mapped to different + * SQL types depending on the SQL dialect. + * [type_annotation][google.spanner.v1.Type.type_annotation] typically is not + * needed to process the content of a value (it doesn't affect serialization) + * and clients can ignore it on the read path. * * Generated from protobuf field .google.spanner.v1.TypeAnnotationCode type_annotation = 4; */ @@ -67,18 +71,22 @@ class Type extends \Google\Protobuf\Internal\Message * @type int $code * Required. The [TypeCode][google.spanner.v1.TypeCode] for this type. * @type \Google\Cloud\Spanner\V1\Type $array_element_type - * If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type` - * is the type of the array elements. + * If [code][google.spanner.v1.Type.code] == + * [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type` is the + * type of the array elements. * @type \Google\Cloud\Spanner\V1\StructType $struct_type - * If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type` - * provides type information for the struct's fields. + * If [code][google.spanner.v1.Type.code] == + * [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type` provides + * type information for the struct's fields. * @type int $type_annotation - * The [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode] that disambiguates SQL type that Spanner will - * use to represent values of this type during query processing. This is - * necessary for some type codes because a single [TypeCode][google.spanner.v1.TypeCode] can be mapped - * to different SQL types depending on the SQL dialect. [type_annotation][google.spanner.v1.Type.type_annotation] - * typically is not needed to process the content of a value (it doesn't - * affect serialization) and clients can ignore it on the read path. + * The [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode] that + * disambiguates SQL type that Spanner will use to represent values of this + * type during query processing. This is necessary for some type codes because + * a single [TypeCode][google.spanner.v1.TypeCode] can be mapped to different + * SQL types depending on the SQL dialect. + * [type_annotation][google.spanner.v1.Type.type_annotation] typically is not + * needed to process the content of a value (it doesn't affect serialization) + * and clients can ignore it on the read path. * @type string $proto_type_fqn * If [code][google.spanner.v1.Type.code] == * [PROTO][google.spanner.v1.TypeCode.PROTO] or @@ -119,8 +127,9 @@ public function setCode($var) } /** - * If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type` - * is the type of the array elements. + * If [code][google.spanner.v1.Type.code] == + * [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type` is the + * type of the array elements. * * Generated from protobuf field .google.spanner.v1.Type array_element_type = 2; * @return \Google\Cloud\Spanner\V1\Type|null @@ -141,8 +150,9 @@ public function clearArrayElementType() } /** - * If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type` - * is the type of the array elements. + * If [code][google.spanner.v1.Type.code] == + * [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type` is the + * type of the array elements. * * Generated from protobuf field .google.spanner.v1.Type array_element_type = 2; * @param \Google\Cloud\Spanner\V1\Type $var @@ -157,8 +167,9 @@ public function setArrayElementType($var) } /** - * If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type` - * provides type information for the struct's fields. + * If [code][google.spanner.v1.Type.code] == + * [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type` provides + * type information for the struct's fields. * * Generated from protobuf field .google.spanner.v1.StructType struct_type = 3; * @return \Google\Cloud\Spanner\V1\StructType|null @@ -179,8 +190,9 @@ public function clearStructType() } /** - * If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type` - * provides type information for the struct's fields. + * If [code][google.spanner.v1.Type.code] == + * [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type` provides + * type information for the struct's fields. * * Generated from protobuf field .google.spanner.v1.StructType struct_type = 3; * @param \Google\Cloud\Spanner\V1\StructType $var @@ -195,12 +207,14 @@ public function setStructType($var) } /** - * The [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode] that disambiguates SQL type that Spanner will - * use to represent values of this type during query processing. This is - * necessary for some type codes because a single [TypeCode][google.spanner.v1.TypeCode] can be mapped - * to different SQL types depending on the SQL dialect. [type_annotation][google.spanner.v1.Type.type_annotation] - * typically is not needed to process the content of a value (it doesn't - * affect serialization) and clients can ignore it on the read path. + * The [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode] that + * disambiguates SQL type that Spanner will use to represent values of this + * type during query processing. This is necessary for some type codes because + * a single [TypeCode][google.spanner.v1.TypeCode] can be mapped to different + * SQL types depending on the SQL dialect. + * [type_annotation][google.spanner.v1.Type.type_annotation] typically is not + * needed to process the content of a value (it doesn't affect serialization) + * and clients can ignore it on the read path. * * Generated from protobuf field .google.spanner.v1.TypeAnnotationCode type_annotation = 4; * @return int @@ -211,12 +225,14 @@ public function getTypeAnnotation() } /** - * The [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode] that disambiguates SQL type that Spanner will - * use to represent values of this type during query processing. This is - * necessary for some type codes because a single [TypeCode][google.spanner.v1.TypeCode] can be mapped - * to different SQL types depending on the SQL dialect. [type_annotation][google.spanner.v1.Type.type_annotation] - * typically is not needed to process the content of a value (it doesn't - * affect serialization) and clients can ignore it on the read path. + * The [TypeAnnotationCode][google.spanner.v1.TypeAnnotationCode] that + * disambiguates SQL type that Spanner will use to represent values of this + * type during query processing. This is necessary for some type codes because + * a single [TypeCode][google.spanner.v1.TypeCode] can be mapped to different + * SQL types depending on the SQL dialect. + * [type_annotation][google.spanner.v1.Type.type_annotation] typically is not + * needed to process the content of a value (it doesn't affect serialization) + * and clients can ignore it on the read path. * * Generated from protobuf field .google.spanner.v1.TypeAnnotationCode type_annotation = 4; * @param int $var diff --git a/Spanner/src/V1/TypeAnnotationCode.php b/Spanner/src/V1/TypeAnnotationCode.php index 6575fb750544..5aa003011f3d 100644 --- a/Spanner/src/V1/TypeAnnotationCode.php +++ b/Spanner/src/V1/TypeAnnotationCode.php @@ -25,22 +25,23 @@ class TypeAnnotationCode const TYPE_ANNOTATION_CODE_UNSPECIFIED = 0; /** * PostgreSQL compatible NUMERIC type. This annotation needs to be applied to - * [Type][google.spanner.v1.Type] instances having [NUMERIC][google.spanner.v1.TypeCode.NUMERIC] - * type code to specify that values of this type should be treated as - * PostgreSQL NUMERIC values. Currently this annotation is always needed for - * [NUMERIC][google.spanner.v1.TypeCode.NUMERIC] when a client interacts with PostgreSQL-enabled - * Spanner databases. + * [Type][google.spanner.v1.Type] instances having + * [NUMERIC][google.spanner.v1.TypeCode.NUMERIC] type code to specify that + * values of this type should be treated as PostgreSQL NUMERIC values. + * Currently this annotation is always needed for + * [NUMERIC][google.spanner.v1.TypeCode.NUMERIC] when a client interacts with + * PostgreSQL-enabled Spanner databases. * * Generated from protobuf enum PG_NUMERIC = 2; */ const PG_NUMERIC = 2; /** * PostgreSQL compatible JSONB type. This annotation needs to be applied to - * [Type][google.spanner.v1.Type] instances having [JSON][google.spanner.v1.TypeCode.JSON] - * type code to specify that values of this type should be treated as - * PostgreSQL JSONB values. Currently this annotation is always needed for - * [JSON][google.spanner.v1.TypeCode.JSON] when a client interacts with PostgreSQL-enabled - * Spanner databases. + * [Type][google.spanner.v1.Type] instances having + * [JSON][google.spanner.v1.TypeCode.JSON] type code to specify that values of + * this type should be treated as PostgreSQL JSONB values. Currently this + * annotation is always needed for [JSON][google.spanner.v1.TypeCode.JSON] + * when a client interacts with PostgreSQL-enabled Spanner databases. * * Generated from protobuf enum PG_JSONB = 3; */ diff --git a/Spanner/src/V1/TypeCode.php b/Spanner/src/V1/TypeCode.php index 21c35fb44bd8..d3dd16b93303 100644 --- a/Spanner/src/V1/TypeCode.php +++ b/Spanner/src/V1/TypeCode.php @@ -98,13 +98,13 @@ class TypeCode const STRUCT = 9; /** * Encoded as `string`, in decimal format or scientific notation format. - *
Decimal format: - *
`[+-]Digits[.[Digits]]` or - *
`[+-][Digits].Digits` + * Decimal format: + * `[+-]Digits[.[Digits]]` or + * `[+-][Digits].Digits` * Scientific notation: - *
`[+-]Digits[.[Digits]][ExponentIndicator[+-]Digits]` or - *
`[+-][Digits].Digits[ExponentIndicator[+-]Digits]` - *
(ExponentIndicator is `"e"` or `"E"`) + * `[+-]Digits[.[Digits]][ExponentIndicator[+-]Digits]` or + * `[+-][Digits].Digits[ExponentIndicator[+-]Digits]` + * (ExponentIndicator is `"e"` or `"E"`) * * Generated from protobuf enum NUMERIC = 10; */ @@ -134,6 +134,16 @@ class TypeCode * Generated from protobuf enum ENUM = 14; */ const ENUM = 14; + /** + * Encoded as `string`, in `ISO8601` duration format - + * `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S` + * where `n` is an integer. + * For example, `P1Y2M3DT4H5M6.5S` represents time duration of 1 year, 2 + * months, 3 days, 4 hours, 5 minutes, and 6.5 seconds. + * + * Generated from protobuf enum INTERVAL = 16; + */ + const INTERVAL = 16; private static $valueToName = [ self::TYPE_CODE_UNSPECIFIED => 'TYPE_CODE_UNSPECIFIED', @@ -151,6 +161,7 @@ class TypeCode self::JSON => 'JSON', self::PROTO => 'PROTO', self::ENUM => 'ENUM', + self::INTERVAL => 'INTERVAL', ]; public static function name($value) From f3ffdb1a7b5439a861afa6b93bbbe05e8c662ce7 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 1 Oct 2024 09:45:55 -0700 Subject: [PATCH 003/157] docs: Clarify Batch only supports global custom instance template now (#7719) PiperOrigin-RevId: 680722756 Source-Link: https://github.com/googleapis/googleapis/commit/42f7085c6332271d9b4d95c77ce3c9d5d0509cfc Source-Link: https://github.com/googleapis/googleapis-gen/commit/8aafe35f7fb64040f3f2eb79b46164250bec8483 Copy-Tag: eyJwIjoiQmF0Y2gvLk93bEJvdC55YW1sIiwiaCI6IjhhYWZlMzVmN2ZiNjQwNDBmM2YyZWI3OWI0NjE2NDI1MGJlYzg0ODMifQ== --- .../V1/AllocationPolicy/InstancePolicyOrTemplate.php | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/Batch/src/V1/AllocationPolicy/InstancePolicyOrTemplate.php b/Batch/src/V1/AllocationPolicy/InstancePolicyOrTemplate.php index 1c67eddc43e6..c6dc0d5bb280 100644 --- a/Batch/src/V1/AllocationPolicy/InstancePolicyOrTemplate.php +++ b/Batch/src/V1/AllocationPolicy/InstancePolicyOrTemplate.php @@ -71,7 +71,9 @@ class InstancePolicyOrTemplate extends \Google\Protobuf\Internal\Message * @type string $instance_template * Name of an instance template used to create VMs. * Named the field as 'instance_template' instead of 'template' to avoid - * c++ keyword conflict. + * C++ keyword conflict. + * Batch only supports global instance templates. + * You can specify the global instance template as a full or partial URL. * @type bool $install_gpu_drivers * Set this field true if you want Batch to help fetch drivers from a third * party location and install them for GPUs specified in @@ -141,7 +143,9 @@ public function setPolicy($var) /** * Name of an instance template used to create VMs. * Named the field as 'instance_template' instead of 'template' to avoid - * c++ keyword conflict. + * C++ keyword conflict. + * Batch only supports global instance templates. + * You can specify the global instance template as a full or partial URL. * * Generated from protobuf field string instance_template = 2; * @return string @@ -159,7 +163,9 @@ public function hasInstanceTemplate() /** * Name of an instance template used to create VMs. * Named the field as 'instance_template' instead of 'template' to avoid - * c++ keyword conflict. + * C++ keyword conflict. + * Batch only supports global instance templates. + * You can specify the global instance template as a full or partial URL. * * Generated from protobuf field string instance_template = 2; * @param string $var From 2c483836197e47fbe9f2c9f284d56c0548d4946b Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 2 Oct 2024 09:04:26 -0700 Subject: [PATCH 004/157] feat: add psc_automation_configs to DeployIndex v1 (#7720) PiperOrigin-RevId: 680742448 Source-Link: https://github.com/googleapis/googleapis/commit/ce31830ddebce4442c987c7e5daff16d4905f7a3 Source-Link: https://github.com/googleapis/googleapis-gen/commit/5254135cd9089f35c9f537aba567dd29acce5413 Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiNTI1NDEzNWNkOTA4OWYzNWM5ZjUzN2FiYTU2N2RkMjlhY2NlNTQxMyJ9 --- AiPlatform/metadata/V1/IndexEndpoint.php | 7 +- AiPlatform/metadata/V1/ServiceNetworking.php | 8 +- AiPlatform/src/V1/DeployedIndex.php | 42 +++++++ AiPlatform/src/V1/PSCAutomationConfig.php | 122 +++++++++++++++++++ 4 files changed, 174 insertions(+), 5 deletions(-) create mode 100644 AiPlatform/src/V1/PSCAutomationConfig.php diff --git a/AiPlatform/metadata/V1/IndexEndpoint.php b/AiPlatform/metadata/V1/IndexEndpoint.php index d652e12e692d..8498e860b969 100644 --- a/AiPlatform/metadata/V1/IndexEndpoint.php +++ b/AiPlatform/metadata/V1/IndexEndpoint.php @@ -22,7 +22,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -‚ +Ø /google/cloud/aiplatform/v1/index_endpoint.protogoogle.cloud.aiplatform.v1google/api/resource.proto0google/cloud/aiplatform/v1/encryption_spec.proto2google/cloud/aiplatform/v1/machine_resources.proto3google/cloud/aiplatform/v1/service_networking.protogoogle/protobuf/timestamp.proto"€ IndexEndpoint name ( BàA @@ -45,7 +45,7 @@ public static function initOnce() { LabelsEntry key (  value ( :8:uêAr -\'aiplatform.googleapis.com/IndexEndpointGprojects/{project}/locations/{location}/indexEndpoints/{index_endpoint}"— +\'aiplatform.googleapis.com/IndexEndpointGprojects/{project}/locations/{location}/indexEndpoints/{index_endpoint}"í DeployedIndex id ( BàA6 index ( B\'àAúA! @@ -60,7 +60,8 @@ public static function initOnce() { deployed_index_auth_config ( 23.google.cloud.aiplatform.v1.DeployedIndexAuthConfigBàA reserved_ip_ranges ( BàA -deployment_group ( BàA"® +deployment_group ( BàAT +psc_automation_configs ( 2/.google.cloud.aiplatform.v1.PSCAutomationConfigBàA"® DeployedIndexAuthConfigW auth_provider ( 2@.google.cloud.aiplatform.v1.DeployedIndexAuthConfig.AuthProvider: AuthProvider diff --git a/AiPlatform/metadata/V1/ServiceNetworking.php b/AiPlatform/metadata/V1/ServiceNetworking.php index 46c4b377ad7f..62b5842e4a0b 100644 --- a/AiPlatform/metadata/V1/ServiceNetworking.php +++ b/AiPlatform/metadata/V1/ServiceNetworking.php @@ -18,8 +18,12 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -¢ -3google/cloud/aiplatform/v1/service_networking.protogoogle.cloud.aiplatform.v1google/api/resource.proto"† +è +3google/cloud/aiplatform/v1/service_networking.protogoogle.cloud.aiplatform.v1google/api/resource.proto"D +PSCAutomationConfig + +project_id ( BàA +network ( BàA"† PrivateServiceConnectConfig+ enable_private_service_connect (BàA project_allowlist (  diff --git a/AiPlatform/src/V1/DeployedIndex.php b/AiPlatform/src/V1/DeployedIndex.php index ea468ed0facc..d5a84822bdda 100644 --- a/AiPlatform/src/V1/DeployedIndex.php +++ b/AiPlatform/src/V1/DeployedIndex.php @@ -151,6 +151,14 @@ class DeployedIndex extends \Google\Protobuf\Internal\Message * Generated from protobuf field string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL]; */ protected $deployment_group = ''; + /** + * Optional. If set for PSC deployed index, PSC connection will be + * automatically created after deployment is done and the endpoint information + * is populated in private_endpoints.psc_automated_endpoints. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.PSCAutomationConfig psc_automation_configs = 19 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $psc_automation_configs; /** * Constructor. @@ -246,6 +254,10 @@ class DeployedIndex extends \Google\Protobuf\Internal\Message * has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or * [d, e] is disallowed. * Note: we only support up to 5 deployment groups(not including 'default'). + * @type array<\Google\Cloud\AIPlatform\V1\PSCAutomationConfig>|\Google\Protobuf\Internal\RepeatedField $psc_automation_configs + * Optional. If set for PSC deployed index, PSC connection will be + * automatically created after deployment is done and the endpoint information + * is populated in private_endpoints.psc_automated_endpoints. * } */ public function __construct($data = NULL) { @@ -753,5 +765,35 @@ public function setDeploymentGroup($var) return $this; } + /** + * Optional. If set for PSC deployed index, PSC connection will be + * automatically created after deployment is done and the endpoint information + * is populated in private_endpoints.psc_automated_endpoints. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.PSCAutomationConfig psc_automation_configs = 19 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPscAutomationConfigs() + { + return $this->psc_automation_configs; + } + + /** + * Optional. If set for PSC deployed index, PSC connection will be + * automatically created after deployment is done and the endpoint information + * is populated in private_endpoints.psc_automated_endpoints. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.PSCAutomationConfig psc_automation_configs = 19 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\AIPlatform\V1\PSCAutomationConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPscAutomationConfigs($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AIPlatform\V1\PSCAutomationConfig::class); + $this->psc_automation_configs = $arr; + + return $this; + } + } diff --git a/AiPlatform/src/V1/PSCAutomationConfig.php b/AiPlatform/src/V1/PSCAutomationConfig.php new file mode 100644 index 000000000000..2a61546a81af --- /dev/null +++ b/AiPlatform/src/V1/PSCAutomationConfig.php @@ -0,0 +1,122 @@ +google.cloud.aiplatform.v1.PSCAutomationConfig + */ +class PSCAutomationConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Project id used to create forwarding rule. + * + * Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $project_id = ''; + /** + * Required. The full name of the Google Compute Engine + * [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + * [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + * `projects/{project}/global/networks/{network}`. + * Where {project} is a project number, as in '12345', and {network} is + * network name. + * + * Generated from protobuf field string network = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $network = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $project_id + * Required. Project id used to create forwarding rule. + * @type string $network + * Required. The full name of the Google Compute Engine + * [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + * [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + * `projects/{project}/global/networks/{network}`. + * Where {project} is a project number, as in '12345', and {network} is + * network name. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\ServiceNetworking::initOnce(); + parent::__construct($data); + } + + /** + * Required. Project id used to create forwarding rule. + * + * Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getProjectId() + { + return $this->project_id; + } + + /** + * Required. Project id used to create forwarding rule. + * + * Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setProjectId($var) + { + GPBUtil::checkString($var, True); + $this->project_id = $var; + + return $this; + } + + /** + * Required. The full name of the Google Compute Engine + * [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + * [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + * `projects/{project}/global/networks/{network}`. + * Where {project} is a project number, as in '12345', and {network} is + * network name. + * + * Generated from protobuf field string network = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getNetwork() + { + return $this->network; + } + + /** + * Required. The full name of the Google Compute Engine + * [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + * [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + * `projects/{project}/global/networks/{network}`. + * Where {project} is a project number, as in '12345', and {network} is + * network name. + * + * Generated from protobuf field string network = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setNetwork($var) + { + GPBUtil::checkString($var, True); + $this->network = $var; + + return $this; + } + +} + From 291fface00973cde709993ce3f8687d3a7bb2867 Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Wed, 2 Oct 2024 18:10:40 -0600 Subject: [PATCH 005/157] chore: misc system test fixes and cleanup (#7717) --- .../backwards-compatibility-checks.yaml | 8 +- .../tests/System/V1/CloudRedisClientTest.php | 2 +- Storage/tests/System/ManageAclTest.php | 10 +-- Storage/tests/System/StorageTestCase.php | 5 -- Storage/tests/System/UniverseDomainTest.php | 88 ++++++++++++++----- dev/src/Command/ComponentInfoCommand.php | 3 +- 6 files changed, 76 insertions(+), 40 deletions(-) diff --git a/.github/workflows/backwards-compatibility-checks.yaml b/.github/workflows/backwards-compatibility-checks.yaml index 64995944328e..d70fede112d9 100644 --- a/.github/workflows/backwards-compatibility-checks.yaml +++ b/.github/workflows/backwards-compatibility-checks.yaml @@ -68,15 +68,17 @@ jobs: continue-on-error: true # OwlBot PRs which are not labelled feat should not add new files or methods run: | - ~/.composer/vendor/bin/roave-backward-compatibility-check --to=origin/main --format=github-actions + ~/.composer/vendor/bin/roave-backward-compatibility-check \ + --from=${{ github.ref_name }} \ + --to=origin/main --format=github-actions - name: "Print the action item" run: | if [[ "${{ steps.compatibility-checker.outcome }}" == 'failure' ]]; then - if [[ "${{ startsWith(github.event.pull_request.title, 'feat') }}" == "true" ]]; then + if [[ "${{ startsWith(github.event.pull_request.title, 'feat') }}" == "false" ]]; then echo "Action item: Change the conventional commit to use 'feat'" exit 1 fi - elif [[ "${{ startsWith(github.event.pull_request.title, 'feat') }}" == "false" ]]; then + elif [[ "${{ startsWith(github.event.pull_request.title, 'feat') }}" == "true" ]]; then echo "Action item: No features found, do not use 'feat' for the conventional commit" exit 1 fi diff --git a/Redis/tests/System/V1/CloudRedisClientTest.php b/Redis/tests/System/V1/CloudRedisClientTest.php index 2065ead61ac3..37cd2dd4cf21 100644 --- a/Redis/tests/System/V1/CloudRedisClientTest.php +++ b/Redis/tests/System/V1/CloudRedisClientTest.php @@ -109,7 +109,7 @@ public function testDeleteOperation() // Ensure delete op succeeded $instances = self::$client->listInstances(ListInstancesRequest::build(self::$parent)); $this->assertSame(0, count(array_map( - fn ($instance) => $instance->getName() === $instanceName, + fn ($instance) => $instance->getName() === self::$instanceName, iterator_to_array($instances->iterateAllElements()) ))); } diff --git a/Storage/tests/System/ManageAclTest.php b/Storage/tests/System/ManageAclTest.php index b3fedf4f9c7d..fdaf2097887b 100644 --- a/Storage/tests/System/ManageAclTest.php +++ b/Storage/tests/System/ManageAclTest.php @@ -21,8 +21,12 @@ use Google\Cloud\Core\Exception\NotFoundException; /** + * These tests are marked flakey because they often throw RateLimitExceeded and + * ServiceException. + * * @group storage * @group storage-acl + * @group flakey */ class ManageAclTest extends StorageTestCase { @@ -32,12 +36,6 @@ public function testManageBucketAcl() $this->assertAcl(self::$bucket->acl(), $kind); } - /** - * This test is marked flakey because it often throws a RateLimitExceeded - * error - * - * @group flakey - */ public function testManageDefaultObjectAcl() { $kind = 'storage#objectAccessControl'; diff --git a/Storage/tests/System/StorageTestCase.php b/Storage/tests/System/StorageTestCase.php index db13a7495ee6..161db8b211be 100644 --- a/Storage/tests/System/StorageTestCase.php +++ b/Storage/tests/System/StorageTestCase.php @@ -54,11 +54,6 @@ public static function setUpTestFixtures(): void self::$unauthenticatedClient = new StorageClient([ 'credentialsFetcher' => new AnonymousCredentials() ]); - self::$universeDomainClient = new StorageClient([ - 'keyFilePath' => getenv('TEST_UNIVERSE_DOMAIN_CREDENTIAL'), - 'projectId' => getenv('TEST_UNIVERSE_PROJECT_ID'), - 'universeDomain' => getenv('TEST_UNIVERSE_DOMAIN') - ]); self::$pubsubClient = new PubSubClient($config); self::$mainBucketName = getenv('BUCKET') ?: uniqid(self::TESTING_PREFIX); diff --git a/Storage/tests/System/UniverseDomainTest.php b/Storage/tests/System/UniverseDomainTest.php index 3f93e13e30e0..e8c559566e8a 100644 --- a/Storage/tests/System/UniverseDomainTest.php +++ b/Storage/tests/System/UniverseDomainTest.php @@ -17,52 +17,92 @@ namespace Google\Cloud\Storage\Tests\System; +use Google\Cloud\Core\Testing\System\SystemTestCase; use Google\Cloud\Storage\Bucket; +use Google\Cloud\Storage\StorageClient; -class UniverseDomainTest extends StorageTestCase +class UniverseDomainTest extends SystemTestCase { - private static $universeDomainBucket; - private static $bucketName; + private static $bucket; + private static $client; + /** - * Test creating a bucket with universe domain credentials + * @beforeClass + */ + public static function setUpTestFixtures(): void + { + if (!$keyFilePath = getenv('GOOGLE_CLOUD_PHP_TESTS_UNIVERSE_DOMAIN_KEY_PATH')) { + self::markTestSkipped('Set GOOGLE_CLOUD_PHP_TESTS_UNIVERSE_DOMAIN_KEY_PATH to run system tests'); + } + + $credentials = json_decode(file_get_contents($keyFilePath), true); + if (!isset($credentials['universe_domain'])) { + throw new \Exception('The provided key file does not contain universe domain credentials'); + } + + self::$client = new StorageClient([ + 'keyFilePath' => $keyFilePath, + 'projectId' => $credentials['project_id'] ?? null, + 'universeDomain' => $credentials['universe_domain'] ?? null + ]); + } + + /** + * Test creating a bucket with universe domain credentials */ public function testCreateBucketWithUniverseDomain() { - self::$bucketName = uniqid(self::TESTING_PREFIX); - self::$universeDomainBucket = self::createBucket( - self::$universeDomainClient, - self::$bucketName, - [ - 'location' => getenv('TEST_UNIVERSE_LOCATION') - ] + if (!$location = getenv('GOOGLE_CLOUD_PHP_TESTS_UNIVERSE_DOMAIN_LOCATION')) { + $this->markTestSkipped('Set GOOGLE_CLOUD_PHP_TESTS_UNIVERSE_DOMAIN_LOCATION to run system tests'); + } + $bucketName = uniqid(StorageTestCase::TESTING_PREFIX); + self::$bucket = self::createBucket( + self::$client, + $bucketName, + ['location' => $location] ); - $this->assertEquals(self::$bucketName, self::$universeDomainBucket->info()['name']); + $this->assertEquals($bucketName, self::$bucket->info()['name']); } /** - * Test uploading and retrieving objects to a bucket using universe domain credentials. + * Test uploading and retrieving objects to a bucket using universe domain credentials. + * + * @depends testCreateBucketWithUniverseDomain */ public function testListsObjectsWithUniverseDomain() { $foundObjects = []; $objectsToCreate = [ - uniqid(self::TESTING_PREFIX), - uniqid(self::TESTING_PREFIX) + uniqid(StorageTestCase::TESTING_PREFIX), + uniqid(StorageTestCase::TESTING_PREFIX) ]; foreach ($objectsToCreate as $objectToCreate) { - self::$universeDomainBucket->upload('data', ['name' => $objectToCreate]); + self::$bucket->upload('data', ['name' => $objectToCreate]); } - $objects = self::$universeDomainBucket->objects(['prefix' => self::TESTING_PREFIX]); + $objects = self::$bucket->objects(['prefix' => StorageTestCase::TESTING_PREFIX]); + + $foundObjects = array_filter( + iterator_to_array($objects), + fn ($object) => in_array($object->name(), $objectsToCreate) + ); - foreach ($objects as $object) { - foreach ($objectsToCreate as $key => $objectToCreate) { - if ($object->name() === $objectToCreate) { - $foundObjects[$key] = $object->name(); - } - } + $this->assertCount(2, $foundObjects); + } + /** + * Test uploading and retrieving objects to a bucket using universe domain credentials. + * + * @depends testCreateBucketWithUniverseDomain + */ + public function testDeleteBucketWithUniverseDomain() + { + foreach (self::$bucket->objects() as $object) { + $object->delete(); } - $this->assertEquals($objectsToCreate, $foundObjects); + self::$bucket->delete(); + $this->assertFalse(self::$bucket->exists()); + $buckets = self::$client->buckets(['prefix' => self::$bucket->name()]); + $this->assertCount(0, iterator_to_array($buckets)); } } diff --git a/dev/src/Command/ComponentInfoCommand.php b/dev/src/Command/ComponentInfoCommand.php index 82654e0184c6..a3984163cdb8 100644 --- a/dev/src/Command/ComponentInfoCommand.php +++ b/dev/src/Command/ComponentInfoCommand.php @@ -276,7 +276,7 @@ private function parseFilters(string $filterString): array { $filters = []; foreach (array_filter(explode(',', $filterString)) as $filter) { - if (!preg_match('/^(\w+?)(!~=|~=|!=|>=|<=|=|<|>)(.+)$/', $filter, $matches)) { + if (!preg_match('/^(\w+?)(!~=|~=|!=|>=|<=|=|<|>|\^=)(.+)$/', $filter, $matches)) { throw new \InvalidArgumentException(sprintf('Invalid filter: %s', $filter)); } $filters[] = [$matches[1], $matches[3], $matches[2]]; @@ -303,6 +303,7 @@ private function filterRow(array $row, array $filters): bool '!=' => ($row[$field] !== $value), '~=' => strpos($row[$field], $value) !== false, '!~=' => strpos($row[$field], $value) === false, + '^=' => str_starts_with($row[$field], $value) !== false, '>','<','>=','<=' => match($field) { 'downloads' => version_compare( str_replace(',' , '', $row[$field]), From 0c917c4b62bbde18fcdb5e3d18c67cebcc4daddb Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:33:54 -0700 Subject: [PATCH 006/157] feat: Add doc for permission settings & announcement space support (#7721) feat: Add doc for import mode external users support docs: Messages API dev docs improvement docs: Memberships API dev docs improvement docs: Discoverable space docs improvement PiperOrigin-RevId: 681521060 Source-Link: https://github.com/googleapis/googleapis/commit/c472cf7c64e401e8f55353fddab1b5cd81efb607 Source-Link: https://github.com/googleapis/googleapis-gen/commit/a905bb22c968ebdded136b282ef073992fc140c5 Copy-Tag: eyJwIjoiQXBwc0NoYXQvLk93bEJvdC55YW1sIiwiaCI6ImE5MDViYjIyYzk2OGViZGRlZDEzNmIyODJlZjA3Mzk5MmZjMTQwYzUifQ== --- AppsChat/metadata/Chat/V1/Space.php | Bin 3630 -> 4824 bytes .../ChatServiceClient/create_membership.php | 37 +- .../V1/ChatServiceClient/create_message.php | 30 +- .../V1/ChatServiceClient/create_space.php | 9 +- .../V1/ChatServiceClient/get_space_event.php | 3 + .../V1/ChatServiceClient/list_messages.php | 8 +- .../src/Chat/V1/Client/ChatServiceClient.php | 93 ++-- AppsChat/src/Chat/V1/CreateSpaceRequest.php | 28 +- .../src/Chat/V1/ListSpaceEventsResponse.php | 8 + AppsChat/src/Chat/V1/ListSpacesResponse.php | 8 + AppsChat/src/Chat/V1/Message.php | 100 ++--- AppsChat/src/Chat/V1/Space.php | 186 +++++--- AppsChat/src/Chat/V1/Space/AccessSettings.php | 32 +- .../V1/Space/AccessSettings/AccessState.php | 12 +- .../src/Chat/V1/Space/PermissionSetting.php | 102 +++++ .../src/Chat/V1/Space/PermissionSettings.php | 389 +++++++++++++++++ .../V1/Space/PredefinedPermissionSettings.php | 67 +++ AppsChat/src/Chat/V1/Thread.php | 8 +- AppsChat/src/Chat/V1/UpdateSpaceRequest.php | 398 ++++++++++-------- 19 files changed, 1139 insertions(+), 379 deletions(-) create mode 100644 AppsChat/src/Chat/V1/Space/PermissionSetting.php create mode 100644 AppsChat/src/Chat/V1/Space/PermissionSettings.php create mode 100644 AppsChat/src/Chat/V1/Space/PredefinedPermissionSettings.php diff --git a/AppsChat/metadata/Chat/V1/Space.php b/AppsChat/metadata/Chat/V1/Space.php index 674070b95f3a3ccf36ad084371f2379470f4c453..d677ec095933d709abd04fe77a26373767f8dc90 100644 GIT binary patch delta 1082 zcmaKr&2G~`6oq3ue@xocoix-<14T%PsuBT$1Z-H?i9?K1$BNS((#XZr)WWeXkE<%H ztdQ7eiTVnF6ds0UmxvWFfP}|MiX$7g_Wka;_uMm|>)#)I{lT(V2eY5-7xvrE{1eA= zN6-X!Js+F+%yO`aJnWAxLM+!o1P6iTjEGRX#~hZM%^9;%?KHHTTJ5G(Usg)_YcYE* zGTjX9fl6Ad{jgQ3c}QE;8YvC9h@M~Nb>>y=Lmt3n4eW!xvEdjajK+9;ihY6%$3!FF zz3_;@L;`OgQiYdEg>L2}!@xISXY88R*#r^Kc!!aR1H-b3z{cQa3d~Tr4a$K#8rc|~ zTO@G(iNM9M=P4LVu`YlY1S2B|r*;DBuVLFlHikY6xa${dLYWwf?< zB(T0utpm0bd4vMs7vs|)+O~U%%_xOMxEtPJl~B91_(LOBoc}6pGSmB0Q2*a+f(>w_ z4dk}mQB=8&GA=2r0mS<vS9bsa delta 41 zcmV+^0M`H5C9WK>=mG-!6_e@$uL6<_vzr3~1G7;FQvtL53k?C2iVZNc*9`#$S4$4H diff --git a/AppsChat/samples/V1/ChatServiceClient/create_membership.php b/AppsChat/samples/V1/ChatServiceClient/create_membership.php index 05291a57e064..00c98fef72c7 100644 --- a/AppsChat/samples/V1/ChatServiceClient/create_membership.php +++ b/AppsChat/samples/V1/ChatServiceClient/create_membership.php @@ -29,40 +29,25 @@ use Google\Apps\Chat\V1\Membership; /** - * Creates a human membership or app membership for the calling app. Creating - * memberships for other apps isn't supported. For an example, see - * [Invite or add a user or a Google Chat app to a - * space](https://developers.google.com/workspace/chat/create-members). + * Creates a membership for the calling Chat app, a user, or a Google Group. + * Creating memberships for other Chat apps isn't supported. * When creating a membership, if the specified member has their auto-accept * policy turned off, then they're invited, and must accept the space * invitation before joining. Otherwise, creating a membership adds the member - * directly to the specified space. Requires [user + * directly to the specified space. + * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * - * To specify the member to add, set the `membership.member.name` for the - * human or app member, or set the `membership.group_member.name` for the - * group member. + * For example usage, see: * - * - To add the calling app to a space or a direct message between two human - * users, use `users/app`. Unable to add other - * apps to the space. + * - [Invite or add a user to a + * space](https://developers.google.com/workspace/chat/create-members#create-user-membership). * - * - To add a human user, use `users/{user}`, where `{user}` can be the email - * address for the user. For users in the same Workspace organization `{user}` - * can also be the `id` for the person from the People API, or the `id` for - * the user in the Directory API. For example, if the People API Person - * profile ID for `user@example.com` is `123456789`, you can add the user to - * the space by setting the `membership.member.name` to - * `users/user@example.com` or `users/123456789`. + * - [Invite or add a Google Group to a + * space](https://developers.google.com/workspace/chat/create-members#create-group-membership). * - * - To add or invite a Google group in a named space, use - * `groups/{group}`, where `{group}` is the `id` for the group from the Cloud - * Identity Groups API. For example, you can use [Cloud Identity Groups lookup - * API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) - * to retrieve the ID `123456789` for group email `group@example.com`, then - * you can add or invite the group to a named space by setting the - * `membership.group_member.name` to `groups/123456789`. Group email is not - * supported, and Google groups can only be added as members in named spaces. + * - [Add the Chat app to a + * space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api). * * @param string $formattedParent The resource name of the space for which to create the * membership. diff --git a/AppsChat/samples/V1/ChatServiceClient/create_message.php b/AppsChat/samples/V1/ChatServiceClient/create_message.php index 9336aea02685..d25de7b6334b 100644 --- a/AppsChat/samples/V1/ChatServiceClient/create_message.php +++ b/AppsChat/samples/V1/ChatServiceClient/create_message.php @@ -29,18 +29,30 @@ use Google\Apps\Chat\V1\Message; /** - * Creates a message in a Google Chat space. The maximum message size, - * including text and cards, is 32,000 bytes. For an example, see [Send a + * Creates a message in a Google Chat space. For an example, see [Send a * message](https://developers.google.com/workspace/chat/create-messages). * - * Calling this method requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) - * and supports the following authentication types: + * The `create()` method requires either user or app authentication. Chat + * attributes the message sender differently depending on the type of + * authentication that you use in your request. * - * - For text messages, user authentication or app authentication are - * supported. - * - For card messages, only app authentication is supported. (Only Chat apps - * can create card messages.) + * The following image shows how Chat attributes a message when you use app + * authentication. Chat displays the Chat app as the message + * sender. The content of the message can contain text (`text`), cards + * (`cardsV2`), and accessory widgets (`accessoryWidgets`). + * + * ![Message sent with app + * authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) + * + * The following image shows how Chat attributes a message when you use user + * authentication. Chat displays the user as the message sender and attributes + * the Chat app to the message by displaying its name. The content of message + * can only contain text (`text`). + * + * ![Message sent with user + * authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) + * + * The maximum message size, including the message contents, is 32,000 bytes. * * @param string $formattedParent The resource name of the space in which to create a message. * diff --git a/AppsChat/samples/V1/ChatServiceClient/create_space.php b/AppsChat/samples/V1/ChatServiceClient/create_space.php index bd8d809c8ed3..c331bbca54b9 100644 --- a/AppsChat/samples/V1/ChatServiceClient/create_space.php +++ b/AppsChat/samples/V1/ChatServiceClient/create_space.php @@ -29,14 +29,19 @@ use Google\Apps\Chat\V1\Space; /** - * Creates a named space. Spaces grouped by topics aren't supported. For an - * example, see [Create a + * Creates a space with no members. Can be used to create a named space. + * Spaces grouped by topics aren't supported. For an example, see + * [Create a * space](https://developers.google.com/workspace/chat/create-spaces). * * If you receive the error message `ALREADY_EXISTS` when creating * a space, try a different `displayName`. An existing space within * the Google Workspace organization might already use this display name. * + * If you're a member of the [Developer Preview + * program](https://developers.google.com/workspace/preview), you can create a + * group chat in import mode using `spaceType.GROUP_CHAT`. + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * diff --git a/AppsChat/samples/V1/ChatServiceClient/get_space_event.php b/AppsChat/samples/V1/ChatServiceClient/get_space_event.php index 3a0bd5f76858..562dacb82ecc 100644 --- a/AppsChat/samples/V1/ChatServiceClient/get_space_event.php +++ b/AppsChat/samples/V1/ChatServiceClient/get_space_event.php @@ -36,6 +36,9 @@ * updated, the server returns the updated `Message` resource in the event * payload. * + * Note: The `permissionSettings` field is not returned in the Space + * object of the Space event data for this request. + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * To get an event, the authenticated user must be a member of the space. diff --git a/AppsChat/samples/V1/ChatServiceClient/list_messages.php b/AppsChat/samples/V1/ChatServiceClient/list_messages.php index ad08845a872f..5755838d98d7 100644 --- a/AppsChat/samples/V1/ChatServiceClient/list_messages.php +++ b/AppsChat/samples/V1/ChatServiceClient/list_messages.php @@ -31,8 +31,12 @@ /** * Lists messages in a space that the caller is a member of, including - * messages from blocked members and spaces. For an example, see - * [List messages](/chat/api/guides/v1/messages/list). + * messages from blocked members and spaces. If you list messages from a + * space with no messages, the response is an empty object. When using a + * REST/HTTP interface, the response contains an empty JSON object, `{}`. + * For an example, see + * [List + * messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * diff --git a/AppsChat/src/Chat/V1/Client/ChatServiceClient.php b/AppsChat/src/Chat/V1/Client/ChatServiceClient.php index 75ce95b1c79e..6f111785d59c 100644 --- a/AppsChat/src/Chat/V1/Client/ChatServiceClient.php +++ b/AppsChat/src/Chat/V1/Client/ChatServiceClient.php @@ -502,40 +502,25 @@ public function completeImportSpace( } /** - * Creates a human membership or app membership for the calling app. Creating - * memberships for other apps isn't supported. For an example, see - * [Invite or add a user or a Google Chat app to a - * space](https://developers.google.com/workspace/chat/create-members). + * Creates a membership for the calling Chat app, a user, or a Google Group. + * Creating memberships for other Chat apps isn't supported. * When creating a membership, if the specified member has their auto-accept * policy turned off, then they're invited, and must accept the space * invitation before joining. Otherwise, creating a membership adds the member - * directly to the specified space. Requires [user + * directly to the specified space. + * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * - * To specify the member to add, set the `membership.member.name` for the - * human or app member, or set the `membership.group_member.name` for the - * group member. - * - * - To add the calling app to a space or a direct message between two human - * users, use `users/app`. Unable to add other - * apps to the space. - * - * - To add a human user, use `users/{user}`, where `{user}` can be the email - * address for the user. For users in the same Workspace organization `{user}` - * can also be the `id` for the person from the People API, or the `id` for - * the user in the Directory API. For example, if the People API Person - * profile ID for `user@example.com` is `123456789`, you can add the user to - * the space by setting the `membership.member.name` to - * `users/user@example.com` or `users/123456789`. - * - * - To add or invite a Google group in a named space, use - * `groups/{group}`, where `{group}` is the `id` for the group from the Cloud - * Identity Groups API. For example, you can use [Cloud Identity Groups lookup - * API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) - * to retrieve the ID `123456789` for group email `group@example.com`, then - * you can add or invite the group to a named space by setting the - * `membership.group_member.name` to `groups/123456789`. Group email is not - * supported, and Google groups can only be added as members in named spaces. + * For example usage, see: + * + * - [Invite or add a user to a + * space](https://developers.google.com/workspace/chat/create-members#create-user-membership). + * + * - [Invite or add a Google Group to a + * space](https://developers.google.com/workspace/chat/create-members#create-group-membership). + * + * - [Add the Chat app to a + * space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api). * * The async variant is {@see ChatServiceClient::createMembershipAsync()} . * @@ -561,18 +546,30 @@ public function createMembership(CreateMembershipRequest $request, array $callOp } /** - * Creates a message in a Google Chat space. The maximum message size, - * including text and cards, is 32,000 bytes. For an example, see [Send a + * Creates a message in a Google Chat space. For an example, see [Send a * message](https://developers.google.com/workspace/chat/create-messages). * - * Calling this method requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) - * and supports the following authentication types: + * The `create()` method requires either user or app authentication. Chat + * attributes the message sender differently depending on the type of + * authentication that you use in your request. * - * - For text messages, user authentication or app authentication are - * supported. - * - For card messages, only app authentication is supported. (Only Chat apps - * can create card messages.) + * The following image shows how Chat attributes a message when you use app + * authentication. Chat displays the Chat app as the message + * sender. The content of the message can contain text (`text`), cards + * (`cardsV2`), and accessory widgets (`accessoryWidgets`). + * + * ![Message sent with app + * authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) + * + * The following image shows how Chat attributes a message when you use user + * authentication. Chat displays the user as the message sender and attributes + * the Chat app to the message by displaying its name. The content of message + * can only contain text (`text`). + * + * ![Message sent with user + * authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) + * + * The maximum message size, including the message contents, is 32,000 bytes. * * The async variant is {@see ChatServiceClient::createMessageAsync()} . * @@ -629,14 +626,19 @@ public function createReaction(CreateReactionRequest $request, array $callOption } /** - * Creates a named space. Spaces grouped by topics aren't supported. For an - * example, see [Create a + * Creates a space with no members. Can be used to create a named space. + * Spaces grouped by topics aren't supported. For an example, see + * [Create a * space](https://developers.google.com/workspace/chat/create-spaces). * * If you receive the error message `ALREADY_EXISTS` when creating * a space, try a different `displayName`. An existing space within * the Google Workspace organization might already use this display name. * + * If you're a member of the [Developer Preview + * program](https://developers.google.com/workspace/preview), you can create a + * group chat in import mode using `spaceType.GROUP_CHAT`. + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @@ -985,6 +987,9 @@ public function getSpace(GetSpaceRequest $request, array $callOptions = []): Spa * updated, the server returns the updated `Message` resource in the event * payload. * + * Note: The `permissionSettings` field is not returned in the Space + * object of the Space event data for this request. + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * To get an event, the authenticated user must be a member of the space. @@ -1126,8 +1131,12 @@ public function listMemberships(ListMembershipsRequest $request, array $callOpti /** * Lists messages in a space that the caller is a member of, including - * messages from blocked members and spaces. For an example, see - * [List messages](/chat/api/guides/v1/messages/list). + * messages from blocked members and spaces. If you list messages from a + * space with no messages, the response is an empty object. When using a + * REST/HTTP interface, the response contains an empty JSON object, `{}`. + * For an example, see + * [List + * messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * diff --git a/AppsChat/src/Chat/V1/CreateSpaceRequest.php b/AppsChat/src/Chat/V1/CreateSpaceRequest.php index 6de66b3cff27..0f89cf2aafdf 100644 --- a/AppsChat/src/Chat/V1/CreateSpaceRequest.php +++ b/AppsChat/src/Chat/V1/CreateSpaceRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * A request to create a named space. + * A request to create a named space with no members. * * Generated from protobuf message google.chat.v1.CreateSpaceRequest */ @@ -18,9 +18,12 @@ class CreateSpaceRequest extends \Google\Protobuf\Internal\Message /** * Required. The `displayName` and `spaceType` fields must be populated. Only * `SpaceType.SPACE` is supported. - * If you receive the error message `ALREADY_EXISTS` when creating a space, + * If you receive the error message `ALREADY_EXISTS`, * try a different `displayName`. An existing space within the Google * Workspace organization might already use this display name. + * If you're a member of the [Developer Preview + * program](https://developers.google.com/workspace/preview), + * `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true. * The space `name` is assigned on the server so anything specified in this * field will be ignored. * @@ -43,10 +46,14 @@ class CreateSpaceRequest extends \Google\Protobuf\Internal\Message * @param \Google\Apps\Chat\V1\Space $space Required. The `displayName` and `spaceType` fields must be populated. Only * `SpaceType.SPACE` is supported. * - * If you receive the error message `ALREADY_EXISTS` when creating a space, + * If you receive the error message `ALREADY_EXISTS`, * try a different `displayName`. An existing space within the Google * Workspace organization might already use this display name. * + * If you're a member of the [Developer Preview + * program](https://developers.google.com/workspace/preview), + * `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true. + * * The space `name` is assigned on the server so anything specified in this * field will be ignored. * @@ -69,9 +76,12 @@ public static function build(\Google\Apps\Chat\V1\Space $space): self * @type \Google\Apps\Chat\V1\Space $space * Required. The `displayName` and `spaceType` fields must be populated. Only * `SpaceType.SPACE` is supported. - * If you receive the error message `ALREADY_EXISTS` when creating a space, + * If you receive the error message `ALREADY_EXISTS`, * try a different `displayName`. An existing space within the Google * Workspace organization might already use this display name. + * If you're a member of the [Developer Preview + * program](https://developers.google.com/workspace/preview), + * `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true. * The space `name` is assigned on the server so anything specified in this * field will be ignored. * @type string $request_id @@ -91,9 +101,12 @@ public function __construct($data = NULL) { /** * Required. The `displayName` and `spaceType` fields must be populated. Only * `SpaceType.SPACE` is supported. - * If you receive the error message `ALREADY_EXISTS` when creating a space, + * If you receive the error message `ALREADY_EXISTS`, * try a different `displayName`. An existing space within the Google * Workspace organization might already use this display name. + * If you're a member of the [Developer Preview + * program](https://developers.google.com/workspace/preview), + * `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true. * The space `name` is assigned on the server so anything specified in this * field will be ignored. * @@ -118,9 +131,12 @@ public function clearSpace() /** * Required. The `displayName` and `spaceType` fields must be populated. Only * `SpaceType.SPACE` is supported. - * If you receive the error message `ALREADY_EXISTS` when creating a space, + * If you receive the error message `ALREADY_EXISTS`, * try a different `displayName`. An existing space within the Google * Workspace organization might already use this display name. + * If you're a member of the [Developer Preview + * program](https://developers.google.com/workspace/preview), + * `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true. * The space `name` is assigned on the server so anything specified in this * field will be ignored. * diff --git a/AppsChat/src/Chat/V1/ListSpaceEventsResponse.php b/AppsChat/src/Chat/V1/ListSpaceEventsResponse.php index e2c6a3830f47..9ed151c8bdda 100644 --- a/AppsChat/src/Chat/V1/ListSpaceEventsResponse.php +++ b/AppsChat/src/Chat/V1/ListSpaceEventsResponse.php @@ -17,6 +17,8 @@ class ListSpaceEventsResponse extends \Google\Protobuf\Internal\Message { /** * Results are returned in chronological order (oldest event first). + * Note: The `permissionSettings` field is not returned in the Space + * object for list requests. * * Generated from protobuf field repeated .google.chat.v1.SpaceEvent space_events = 1; */ @@ -37,6 +39,8 @@ class ListSpaceEventsResponse extends \Google\Protobuf\Internal\Message * * @type array<\Google\Apps\Chat\V1\SpaceEvent>|\Google\Protobuf\Internal\RepeatedField $space_events * Results are returned in chronological order (oldest event first). + * Note: The `permissionSettings` field is not returned in the Space + * object for list requests. * @type string $next_page_token * Continuation token used to fetch more events. * If this field is omitted, there are no subsequent pages. @@ -49,6 +53,8 @@ public function __construct($data = NULL) { /** * Results are returned in chronological order (oldest event first). + * Note: The `permissionSettings` field is not returned in the Space + * object for list requests. * * Generated from protobuf field repeated .google.chat.v1.SpaceEvent space_events = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -60,6 +66,8 @@ public function getSpaceEvents() /** * Results are returned in chronological order (oldest event first). + * Note: The `permissionSettings` field is not returned in the Space + * object for list requests. * * Generated from protobuf field repeated .google.chat.v1.SpaceEvent space_events = 1; * @param array<\Google\Apps\Chat\V1\SpaceEvent>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/AppsChat/src/Chat/V1/ListSpacesResponse.php b/AppsChat/src/Chat/V1/ListSpacesResponse.php index 64406b36ad8f..866249c6ff30 100644 --- a/AppsChat/src/Chat/V1/ListSpacesResponse.php +++ b/AppsChat/src/Chat/V1/ListSpacesResponse.php @@ -17,6 +17,8 @@ class ListSpacesResponse extends \Google\Protobuf\Internal\Message { /** * List of spaces in the requested (or first) page. + * Note: The `permissionSettings` field is not returned in the Space + * object for list requests. * * Generated from protobuf field repeated .google.chat.v1.Space spaces = 1; */ @@ -37,6 +39,8 @@ class ListSpacesResponse extends \Google\Protobuf\Internal\Message * * @type array<\Google\Apps\Chat\V1\Space>|\Google\Protobuf\Internal\RepeatedField $spaces * List of spaces in the requested (or first) page. + * Note: The `permissionSettings` field is not returned in the Space + * object for list requests. * @type string $next_page_token * You can send a token as `pageToken` to retrieve the next page of * results. If empty, there are no subsequent pages. @@ -49,6 +53,8 @@ public function __construct($data = NULL) { /** * List of spaces in the requested (or first) page. + * Note: The `permissionSettings` field is not returned in the Space + * object for list requests. * * Generated from protobuf field repeated .google.chat.v1.Space spaces = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -60,6 +66,8 @@ public function getSpaces() /** * List of spaces in the requested (or first) page. + * Note: The `permissionSettings` field is not returned in the Space + * object for list requests. * * Generated from protobuf field repeated .google.chat.v1.Space spaces = 1; * @param array<\Google\Apps\Chat\V1\Space>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/AppsChat/src/Chat/V1/Message.php b/AppsChat/src/Chat/V1/Message.php index 881bdf2e84a0..4a893b5e16de 100644 --- a/AppsChat/src/Chat/V1/Message.php +++ b/AppsChat/src/Chat/V1/Message.php @@ -74,8 +74,8 @@ class Message extends \Google\Protobuf\Internal\Message * You can also [@mention a Google Chat * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), * or everyone in the space. - * To learn about creating text messages, see [Send a text - * message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). + * To learn about creating text messages, see [Send a + * message](https://developers.google.com/workspace/chat/create-messages). * * Generated from protobuf field string text = 4; */ @@ -120,8 +120,8 @@ class Message extends \Google\Protobuf\Internal\Message * Only Chat apps can create cards. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * the messages can't contain cards. - * To learn about cards and how to create them, see [Send card - * messages](https://developers.google.com/workspace/chat/create-messages#create). + * To learn how to create a message that contains cards, see [Send a + * message](https://developers.google.com/workspace/chat/create-messages). * [Card builder](https://addons.gsuite.google.com/uikit/builder) * * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22; @@ -222,14 +222,15 @@ class Message extends \Google\Protobuf\Internal\Message /** * Immutable. Input for creating a message, otherwise output only. The user * that can view the message. When set, the message is private and only - * visible to the specified user and the Chat app. Link previews and - * attachments aren't supported for private messages. - * Only Chat apps can send private messages. If your Chat app [authenticates - * as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - * to send a message, the message can't be private and must omit this field. - * For details, see [Send private messages to Google Chat - * users](https://developers.google.com/workspace/chat/private-messages). + * visible to the specified user and the Chat app. To include this field in + * your request, you must call the Chat API using [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * and omit the following: + * * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) + * * [Accessory + * widgets](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget) + * For details, see [Send a message + * privately](https://developers.google.com/workspace/chat/create-messages#private). * * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE]; */ @@ -313,8 +314,8 @@ class Message extends \Google\Protobuf\Internal\Message * You can also [@mention a Google Chat * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), * or everyone in the space. - * To learn about creating text messages, see [Send a text - * message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). + * To learn about creating text messages, see [Send a + * message](https://developers.google.com/workspace/chat/create-messages). * @type string $formatted_text * Output only. Contains the message `text` with markups added to communicate * formatting. This field might not capture all formatting visible in the UI, @@ -346,8 +347,8 @@ class Message extends \Google\Protobuf\Internal\Message * Only Chat apps can create cards. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * the messages can't contain cards. - * To learn about cards and how to create them, see [Send card - * messages](https://developers.google.com/workspace/chat/create-messages#create). + * To learn how to create a message that contains cards, see [Send a + * message](https://developers.google.com/workspace/chat/create-messages). * [Card builder](https://addons.gsuite.google.com/uikit/builder) * @type array<\Google\Apps\Chat\V1\Annotation>|\Google\Protobuf\Internal\RepeatedField $annotations * Output only. Annotations associated with the `text` in this message. @@ -396,14 +397,15 @@ class Message extends \Google\Protobuf\Internal\Message * @type \Google\Apps\Chat\V1\User $private_message_viewer * Immutable. Input for creating a message, otherwise output only. The user * that can view the message. When set, the message is private and only - * visible to the specified user and the Chat app. Link previews and - * attachments aren't supported for private messages. - * Only Chat apps can send private messages. If your Chat app [authenticates - * as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - * to send a message, the message can't be private and must omit this field. - * For details, see [Send private messages to Google Chat - * users](https://developers.google.com/workspace/chat/private-messages). + * visible to the specified user and the Chat app. To include this field in + * your request, you must call the Chat API using [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * and omit the following: + * * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) + * * [Accessory + * widgets](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget) + * For details, see [Send a message + * privately](https://developers.google.com/workspace/chat/create-messages#private). * @type \Google\Apps\Chat\V1\DeletionMetadata $deletion_metadata * Output only. Information about a deleted message. A message is deleted when * `delete_time` is set. @@ -649,8 +651,8 @@ public function setDeleteTime($var) * You can also [@mention a Google Chat * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), * or everyone in the space. - * To learn about creating text messages, see [Send a text - * message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). + * To learn about creating text messages, see [Send a + * message](https://developers.google.com/workspace/chat/create-messages). * * Generated from protobuf field string text = 4; * @return string @@ -667,8 +669,8 @@ public function getText() * You can also [@mention a Google Chat * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), * or everyone in the space. - * To learn about creating text messages, see [Send a text - * message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). + * To learn about creating text messages, see [Send a + * message](https://developers.google.com/workspace/chat/create-messages). * * Generated from protobuf field string text = 4; * @param string $var @@ -786,8 +788,8 @@ public function setCards($var) * Only Chat apps can create cards. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * the messages can't contain cards. - * To learn about cards and how to create them, see [Send card - * messages](https://developers.google.com/workspace/chat/create-messages#create). + * To learn how to create a message that contains cards, see [Send a + * message](https://developers.google.com/workspace/chat/create-messages). * [Card builder](https://addons.gsuite.google.com/uikit/builder) * * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22; @@ -804,8 +806,8 @@ public function getCardsV2() * Only Chat apps can create cards. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * the messages can't contain cards. - * To learn about cards and how to create them, see [Send card - * messages](https://developers.google.com/workspace/chat/create-messages#create). + * To learn how to create a message that contains cards, see [Send a + * message](https://developers.google.com/workspace/chat/create-messages). * [Card builder](https://addons.gsuite.google.com/uikit/builder) * * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22; @@ -1225,14 +1227,15 @@ public function setEmojiReactionSummaries($var) /** * Immutable. Input for creating a message, otherwise output only. The user * that can view the message. When set, the message is private and only - * visible to the specified user and the Chat app. Link previews and - * attachments aren't supported for private messages. - * Only Chat apps can send private messages. If your Chat app [authenticates - * as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - * to send a message, the message can't be private and must omit this field. - * For details, see [Send private messages to Google Chat - * users](https://developers.google.com/workspace/chat/private-messages). + * visible to the specified user and the Chat app. To include this field in + * your request, you must call the Chat API using [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * and omit the following: + * * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) + * * [Accessory + * widgets](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget) + * For details, see [Send a message + * privately](https://developers.google.com/workspace/chat/create-messages#private). * * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE]; * @return \Google\Apps\Chat\V1\User|null @@ -1255,14 +1258,15 @@ public function clearPrivateMessageViewer() /** * Immutable. Input for creating a message, otherwise output only. The user * that can view the message. When set, the message is private and only - * visible to the specified user and the Chat app. Link previews and - * attachments aren't supported for private messages. - * Only Chat apps can send private messages. If your Chat app [authenticates - * as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - * to send a message, the message can't be private and must omit this field. - * For details, see [Send private messages to Google Chat - * users](https://developers.google.com/workspace/chat/private-messages). + * visible to the specified user and the Chat app. To include this field in + * your request, you must call the Chat API using [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * and omit the following: + * * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) + * * [Accessory + * widgets](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget) + * For details, see [Send a message + * privately](https://developers.google.com/workspace/chat/create-messages#private). * * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE]; * @param \Google\Apps\Chat\V1\User $var diff --git a/AppsChat/src/Chat/V1/Space.php b/AppsChat/src/Chat/V1/Space.php index 4713be4f4339..5ec5b13d3147 100644 --- a/AppsChat/src/Chat/V1/Space.php +++ b/AppsChat/src/Chat/V1/Space.php @@ -19,6 +19,12 @@ class Space extends \Google\Protobuf\Internal\Message /** * Resource name of the space. * Format: `spaces/{space}` + * Where `{space}` represents the system-assigned ID for the space. You can + * obtain the space ID by calling the + * [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) + * method or from the space URL. For example, if the space URL + * is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID + * is `AAAAAAAAA`. * * Generated from protobuf field string name = 1; */ @@ -55,11 +61,11 @@ class Space extends \Google\Protobuf\Internal\Message protected $threaded = false; /** * The space's display name. Required when [creating a - * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). - * If you receive the error message `ALREADY_EXISTS` when creating a space or - * updating the `displayName`, try a different `displayName`. An - * existing space within the Google Workspace organization might already use - * this display name. + * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) + * with a `spaceType` of `SPACE`. If you receive the error message + * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a + * different `displayName`. An existing space within the Google Workspace + * organization might already use this display name. * For direct messages, this field might be empty. * Supports up to 128 characters. * @@ -73,14 +79,6 @@ class Space extends \Google\Protobuf\Internal\Message * * The authenticated user uses a consumer account (unmanaged user * account). By default, a space created by a consumer account permits any * Google Chat user. - * * The space is used to [import data to Google Chat] - * (https://developers.google.com/chat/api/guides/import-data-overview) - * because import mode spaces must only permit members from the same - * Google Workspace organization. However, as part of the [Google - * Workspace Developer Preview - * Program](https://developers.google.com/workspace/preview), import mode - * spaces can permit any Google Chat user so this field can then be set - * for import mode spaces. * For existing spaces, this field is output only. * * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE]; @@ -161,6 +159,7 @@ class Space extends \Google\Protobuf\Internal\Message * Generated from protobuf field string space_uri = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $space_uri = ''; + protected $space_permission_settings; /** * Constructor. @@ -171,6 +170,12 @@ class Space extends \Google\Protobuf\Internal\Message * @type string $name * Resource name of the space. * Format: `spaces/{space}` + * Where `{space}` represents the system-assigned ID for the space. You can + * obtain the space ID by calling the + * [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) + * method or from the space URL. For example, if the space URL + * is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID + * is `AAAAAAAAA`. * @type int $type * Output only. Deprecated: Use `space_type` instead. * The type of a space. @@ -185,11 +190,11 @@ class Space extends \Google\Protobuf\Internal\Message * Whether messages are threaded in this space. * @type string $display_name * The space's display name. Required when [creating a - * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). - * If you receive the error message `ALREADY_EXISTS` when creating a space or - * updating the `displayName`, try a different `displayName`. An - * existing space within the Google Workspace organization might already use - * this display name. + * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) + * with a `spaceType` of `SPACE`. If you receive the error message + * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a + * different `displayName`. An existing space within the Google Workspace + * organization might already use this display name. * For direct messages, this field might be empty. * Supports up to 128 characters. * @type bool $external_user_allowed @@ -199,14 +204,6 @@ class Space extends \Google\Protobuf\Internal\Message * * The authenticated user uses a consumer account (unmanaged user * account). By default, a space created by a consumer account permits any * Google Chat user. - * * The space is used to [import data to Google Chat] - * (https://developers.google.com/chat/api/guides/import-data-overview) - * because import mode spaces must only permit members from the same - * Google Workspace organization. However, as part of the [Google - * Workspace Developer Preview - * Program](https://developers.google.com/workspace/preview), import mode - * spaces can permit any Google Chat user so this field can then be set - * for import mode spaces. * For existing spaces, this field is output only. * @type int $space_threading_state * Output only. The threading state in the Chat space. @@ -243,6 +240,15 @@ class Space extends \Google\Protobuf\Internal\Message * Only populated when the `space_type` is `SPACE`. * @type string $space_uri * Output only. The URI for a user to access the space. + * @type int $predefined_permission_settings + * Optional. Input only. Predefined space permission settings, input only + * when creating a space. If the field is not set, a collaboration space is + * created. After you create the space, settings are populated in the + * `PermissionSettings` field. + * @type \Google\Apps\Chat\V1\Space\PermissionSettings $permission_settings + * Optional. Space permission settings for existing spaces. Input for + * updating exact space permission settings, where existing permission + * settings are replaced. Output lists current permission settings. * } */ public function __construct($data = NULL) { @@ -253,6 +259,12 @@ public function __construct($data = NULL) { /** * Resource name of the space. * Format: `spaces/{space}` + * Where `{space}` represents the system-assigned ID for the space. You can + * obtain the space ID by calling the + * [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) + * method or from the space URL. For example, if the space URL + * is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID + * is `AAAAAAAAA`. * * Generated from protobuf field string name = 1; * @return string @@ -265,6 +277,12 @@ public function getName() /** * Resource name of the space. * Format: `spaces/{space}` + * Where `{space}` represents the system-assigned ID for the space. You can + * obtain the space ID by calling the + * [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) + * method or from the space URL. For example, if the space URL + * is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID + * is `AAAAAAAAA`. * * Generated from protobuf field string name = 1; * @param string $var @@ -400,11 +418,11 @@ public function setThreaded($var) /** * The space's display name. Required when [creating a - * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). - * If you receive the error message `ALREADY_EXISTS` when creating a space or - * updating the `displayName`, try a different `displayName`. An - * existing space within the Google Workspace organization might already use - * this display name. + * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) + * with a `spaceType` of `SPACE`. If you receive the error message + * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a + * different `displayName`. An existing space within the Google Workspace + * organization might already use this display name. * For direct messages, this field might be empty. * Supports up to 128 characters. * @@ -418,11 +436,11 @@ public function getDisplayName() /** * The space's display name. Required when [creating a - * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). - * If you receive the error message `ALREADY_EXISTS` when creating a space or - * updating the `displayName`, try a different `displayName`. An - * existing space within the Google Workspace organization might already use - * this display name. + * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) + * with a `spaceType` of `SPACE`. If you receive the error message + * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a + * different `displayName`. An existing space within the Google Workspace + * organization might already use this display name. * For direct messages, this field might be empty. * Supports up to 128 characters. * @@ -445,14 +463,6 @@ public function setDisplayName($var) * * The authenticated user uses a consumer account (unmanaged user * account). By default, a space created by a consumer account permits any * Google Chat user. - * * The space is used to [import data to Google Chat] - * (https://developers.google.com/chat/api/guides/import-data-overview) - * because import mode spaces must only permit members from the same - * Google Workspace organization. However, as part of the [Google - * Workspace Developer Preview - * Program](https://developers.google.com/workspace/preview), import mode - * spaces can permit any Google Chat user so this field can then be set - * for import mode spaces. * For existing spaces, this field is output only. * * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE]; @@ -470,14 +480,6 @@ public function getExternalUserAllowed() * * The authenticated user uses a consumer account (unmanaged user * account). By default, a space created by a consumer account permits any * Google Chat user. - * * The space is used to [import data to Google Chat] - * (https://developers.google.com/chat/api/guides/import-data-overview) - * because import mode spaces must only permit members from the same - * Google Workspace organization. However, as part of the [Google - * Workspace Developer Preview - * Program](https://developers.google.com/workspace/preview), import mode - * spaces can permit any Google Chat user so this field can then be set - * for import mode spaces. * For existing spaces, this field is output only. * * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE]; @@ -832,5 +834,85 @@ public function setSpaceUri($var) return $this; } + /** + * Optional. Input only. Predefined space permission settings, input only + * when creating a space. If the field is not set, a collaboration space is + * created. After you create the space, settings are populated in the + * `PermissionSettings` field. + * + * Generated from protobuf field .google.chat.v1.Space.PredefinedPermissionSettings predefined_permission_settings = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPredefinedPermissionSettings() + { + return $this->readOneof(26); + } + + public function hasPredefinedPermissionSettings() + { + return $this->hasOneof(26); + } + + /** + * Optional. Input only. Predefined space permission settings, input only + * when creating a space. If the field is not set, a collaboration space is + * created. After you create the space, settings are populated in the + * `PermissionSettings` field. + * + * Generated from protobuf field .google.chat.v1.Space.PredefinedPermissionSettings predefined_permission_settings = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPredefinedPermissionSettings($var) + { + GPBUtil::checkEnum($var, \Google\Apps\Chat\V1\Space\PredefinedPermissionSettings::class); + $this->writeOneof(26, $var); + + return $this; + } + + /** + * Optional. Space permission settings for existing spaces. Input for + * updating exact space permission settings, where existing permission + * settings are replaced. Output lists current permission settings. + * + * Generated from protobuf field .google.chat.v1.Space.PermissionSettings permission_settings = 27 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Apps\Chat\V1\Space\PermissionSettings|null + */ + public function getPermissionSettings() + { + return $this->readOneof(27); + } + + public function hasPermissionSettings() + { + return $this->hasOneof(27); + } + + /** + * Optional. Space permission settings for existing spaces. Input for + * updating exact space permission settings, where existing permission + * settings are replaced. Output lists current permission settings. + * + * Generated from protobuf field .google.chat.v1.Space.PermissionSettings permission_settings = 27 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Apps\Chat\V1\Space\PermissionSettings $var + * @return $this + */ + public function setPermissionSettings($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSettings::class); + $this->writeOneof(27, $var); + + return $this; + } + + /** + * @return string + */ + public function getSpacePermissionSettings() + { + return $this->whichOneof("space_permission_settings"); + } + } diff --git a/AppsChat/src/Chat/V1/Space/AccessSettings.php b/AppsChat/src/Chat/V1/Space/AccessSettings.php index c53a5f4ac500..4c89622cbf46 100644 --- a/AppsChat/src/Chat/V1/Space/AccessSettings.php +++ b/AppsChat/src/Chat/V1/Space/AccessSettings.php @@ -25,12 +25,16 @@ class AccessSettings extends \Google\Protobuf\Internal\Message /** * Optional. The resource name of the [target * audience](https://support.google.com/a/answer/9934697) who can discover - * the space, join the space, and preview the messages in the space. For - * details, see [Make a space discoverable to a target + * the space, join the space, and preview the messages in the space. If + * unset, only users or Google Groups who have been individually invited or + * added to the space can access it. For details, see [Make a space + * discoverable to a target * audience](https://developers.google.com/workspace/chat/space-target-audience). * Format: `audiences/{audience}` * To use the default target audience for the Google Workspace organization, * set to `audiences/default`. + * This field is not populated when using the `chat.bot` scope with [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * * Generated from protobuf field string audience = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -47,12 +51,16 @@ class AccessSettings extends \Google\Protobuf\Internal\Message * @type string $audience * Optional. The resource name of the [target * audience](https://support.google.com/a/answer/9934697) who can discover - * the space, join the space, and preview the messages in the space. For - * details, see [Make a space discoverable to a target + * the space, join the space, and preview the messages in the space. If + * unset, only users or Google Groups who have been individually invited or + * added to the space can access it. For details, see [Make a space + * discoverable to a target * audience](https://developers.google.com/workspace/chat/space-target-audience). * Format: `audiences/{audience}` * To use the default target audience for the Google Workspace organization, * set to `audiences/default`. + * This field is not populated when using the `chat.bot` scope with [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * } */ public function __construct($data = NULL) { @@ -89,12 +97,16 @@ public function setAccessState($var) /** * Optional. The resource name of the [target * audience](https://support.google.com/a/answer/9934697) who can discover - * the space, join the space, and preview the messages in the space. For - * details, see [Make a space discoverable to a target + * the space, join the space, and preview the messages in the space. If + * unset, only users or Google Groups who have been individually invited or + * added to the space can access it. For details, see [Make a space + * discoverable to a target * audience](https://developers.google.com/workspace/chat/space-target-audience). * Format: `audiences/{audience}` * To use the default target audience for the Google Workspace organization, * set to `audiences/default`. + * This field is not populated when using the `chat.bot` scope with [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * * Generated from protobuf field string audience = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -107,12 +119,16 @@ public function getAudience() /** * Optional. The resource name of the [target * audience](https://support.google.com/a/answer/9934697) who can discover - * the space, join the space, and preview the messages in the space. For - * details, see [Make a space discoverable to a target + * the space, join the space, and preview the messages in the space. If + * unset, only users or Google Groups who have been individually invited or + * added to the space can access it. For details, see [Make a space + * discoverable to a target * audience](https://developers.google.com/workspace/chat/space-target-audience). * Format: `audiences/{audience}` * To use the default target audience for the Google Workspace organization, * set to `audiences/default`. + * This field is not populated when using the `chat.bot` scope with [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * * Generated from protobuf field string audience = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/AppsChat/src/Chat/V1/Space/AccessSettings/AccessState.php b/AppsChat/src/Chat/V1/Space/AccessSettings/AccessState.php index 3e3f2d95cea8..280f8e0b4ad5 100644 --- a/AppsChat/src/Chat/V1/Space/AccessSettings/AccessState.php +++ b/AppsChat/src/Chat/V1/Space/AccessSettings/AccessState.php @@ -20,15 +20,19 @@ class AccessState */ const ACCESS_STATE_UNSPECIFIED = 0; /** - * Space is discoverable by added or invited members or groups. + * Only users or Google Groups that have been individually added or + * invited by other users or Google Workspace administrators can discover + * and access the space. * * Generated from protobuf enum PRIVATE = 1; */ const PBPRIVATE = 1; /** - * Space is discoverable by the selected [target - * audience](https://support.google.com/a/answer/9934697), as well as - * added or invited members or groups. + * A space manager has granted a target audience access to + * the space. Users or Google Groups that have been individually added or + * invited to the space can also discover and access the space. To learn + * more, see [Make a space discoverable to specific + * users](https://developers.google.com/workspace/chat/space-target-audience). * * Generated from protobuf enum DISCOVERABLE = 2; */ diff --git a/AppsChat/src/Chat/V1/Space/PermissionSetting.php b/AppsChat/src/Chat/V1/Space/PermissionSetting.php new file mode 100644 index 000000000000..8132b74f377a --- /dev/null +++ b/AppsChat/src/Chat/V1/Space/PermissionSetting.php @@ -0,0 +1,102 @@ +google.chat.v1.Space.PermissionSetting + */ +class PermissionSetting extends \Google\Protobuf\Internal\Message +{ + /** + * Whether spaces managers have this permission. + * + * Generated from protobuf field bool managers_allowed = 1; + */ + protected $managers_allowed = false; + /** + * Whether non-manager members have this permission. + * + * Generated from protobuf field bool members_allowed = 2; + */ + protected $members_allowed = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $managers_allowed + * Whether spaces managers have this permission. + * @type bool $members_allowed + * Whether non-manager members have this permission. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Chat\V1\Space::initOnce(); + parent::__construct($data); + } + + /** + * Whether spaces managers have this permission. + * + * Generated from protobuf field bool managers_allowed = 1; + * @return bool + */ + public function getManagersAllowed() + { + return $this->managers_allowed; + } + + /** + * Whether spaces managers have this permission. + * + * Generated from protobuf field bool managers_allowed = 1; + * @param bool $var + * @return $this + */ + public function setManagersAllowed($var) + { + GPBUtil::checkBool($var); + $this->managers_allowed = $var; + + return $this; + } + + /** + * Whether non-manager members have this permission. + * + * Generated from protobuf field bool members_allowed = 2; + * @return bool + */ + public function getMembersAllowed() + { + return $this->members_allowed; + } + + /** + * Whether non-manager members have this permission. + * + * Generated from protobuf field bool members_allowed = 2; + * @param bool $var + * @return $this + */ + public function setMembersAllowed($var) + { + GPBUtil::checkBool($var); + $this->members_allowed = $var; + + return $this; + } + +} + + diff --git a/AppsChat/src/Chat/V1/Space/PermissionSettings.php b/AppsChat/src/Chat/V1/Space/PermissionSettings.php new file mode 100644 index 000000000000..a582b37b674b --- /dev/null +++ b/AppsChat/src/Chat/V1/Space/PermissionSettings.php @@ -0,0 +1,389 @@ +google.chat.v1.Space.PermissionSettings + */ +class PermissionSettings extends \Google\Protobuf\Internal\Message +{ + /** + * Setting for managing members and groups in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1; + */ + protected $manage_members_and_groups = null; + /** + * Setting for updating space name, avatar, description and guidelines. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2; + */ + protected $modify_space_details = null; + /** + * Setting for toggling space history on and off. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3; + */ + protected $toggle_history = null; + /** + * Setting for using @all in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4; + */ + protected $use_at_mention_all = null; + /** + * Setting for managing apps in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5; + */ + protected $manage_apps = null; + /** + * Setting for managing webhooks in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6; + */ + protected $manage_webhooks = null; + /** + * Output only. Setting for posting messages in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting post_messages = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $post_messages = null; + /** + * Setting for replying to messages in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8; + */ + protected $reply_messages = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Apps\Chat\V1\Space\PermissionSetting $manage_members_and_groups + * Setting for managing members and groups in a space. + * @type \Google\Apps\Chat\V1\Space\PermissionSetting $modify_space_details + * Setting for updating space name, avatar, description and guidelines. + * @type \Google\Apps\Chat\V1\Space\PermissionSetting $toggle_history + * Setting for toggling space history on and off. + * @type \Google\Apps\Chat\V1\Space\PermissionSetting $use_at_mention_all + * Setting for using @all in a space. + * @type \Google\Apps\Chat\V1\Space\PermissionSetting $manage_apps + * Setting for managing apps in a space. + * @type \Google\Apps\Chat\V1\Space\PermissionSetting $manage_webhooks + * Setting for managing webhooks in a space. + * @type \Google\Apps\Chat\V1\Space\PermissionSetting $post_messages + * Output only. Setting for posting messages in a space. + * @type \Google\Apps\Chat\V1\Space\PermissionSetting $reply_messages + * Setting for replying to messages in a space. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Chat\V1\Space::initOnce(); + parent::__construct($data); + } + + /** + * Setting for managing members and groups in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1; + * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null + */ + public function getManageMembersAndGroups() + { + return $this->manage_members_and_groups; + } + + public function hasManageMembersAndGroups() + { + return isset($this->manage_members_and_groups); + } + + public function clearManageMembersAndGroups() + { + unset($this->manage_members_and_groups); + } + + /** + * Setting for managing members and groups in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1; + * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var + * @return $this + */ + public function setManageMembersAndGroups($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSetting::class); + $this->manage_members_and_groups = $var; + + return $this; + } + + /** + * Setting for updating space name, avatar, description and guidelines. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2; + * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null + */ + public function getModifySpaceDetails() + { + return $this->modify_space_details; + } + + public function hasModifySpaceDetails() + { + return isset($this->modify_space_details); + } + + public function clearModifySpaceDetails() + { + unset($this->modify_space_details); + } + + /** + * Setting for updating space name, avatar, description and guidelines. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2; + * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var + * @return $this + */ + public function setModifySpaceDetails($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSetting::class); + $this->modify_space_details = $var; + + return $this; + } + + /** + * Setting for toggling space history on and off. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3; + * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null + */ + public function getToggleHistory() + { + return $this->toggle_history; + } + + public function hasToggleHistory() + { + return isset($this->toggle_history); + } + + public function clearToggleHistory() + { + unset($this->toggle_history); + } + + /** + * Setting for toggling space history on and off. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3; + * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var + * @return $this + */ + public function setToggleHistory($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSetting::class); + $this->toggle_history = $var; + + return $this; + } + + /** + * Setting for using @all in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4; + * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null + */ + public function getUseAtMentionAll() + { + return $this->use_at_mention_all; + } + + public function hasUseAtMentionAll() + { + return isset($this->use_at_mention_all); + } + + public function clearUseAtMentionAll() + { + unset($this->use_at_mention_all); + } + + /** + * Setting for using @all in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4; + * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var + * @return $this + */ + public function setUseAtMentionAll($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSetting::class); + $this->use_at_mention_all = $var; + + return $this; + } + + /** + * Setting for managing apps in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5; + * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null + */ + public function getManageApps() + { + return $this->manage_apps; + } + + public function hasManageApps() + { + return isset($this->manage_apps); + } + + public function clearManageApps() + { + unset($this->manage_apps); + } + + /** + * Setting for managing apps in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5; + * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var + * @return $this + */ + public function setManageApps($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSetting::class); + $this->manage_apps = $var; + + return $this; + } + + /** + * Setting for managing webhooks in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6; + * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null + */ + public function getManageWebhooks() + { + return $this->manage_webhooks; + } + + public function hasManageWebhooks() + { + return isset($this->manage_webhooks); + } + + public function clearManageWebhooks() + { + unset($this->manage_webhooks); + } + + /** + * Setting for managing webhooks in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6; + * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var + * @return $this + */ + public function setManageWebhooks($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSetting::class); + $this->manage_webhooks = $var; + + return $this; + } + + /** + * Output only. Setting for posting messages in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting post_messages = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null + */ + public function getPostMessages() + { + return $this->post_messages; + } + + public function hasPostMessages() + { + return isset($this->post_messages); + } + + public function clearPostMessages() + { + unset($this->post_messages); + } + + /** + * Output only. Setting for posting messages in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting post_messages = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var + * @return $this + */ + public function setPostMessages($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSetting::class); + $this->post_messages = $var; + + return $this; + } + + /** + * Setting for replying to messages in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8; + * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null + */ + public function getReplyMessages() + { + return $this->reply_messages; + } + + public function hasReplyMessages() + { + return isset($this->reply_messages); + } + + public function clearReplyMessages() + { + unset($this->reply_messages); + } + + /** + * Setting for replying to messages in a space. + * + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8; + * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var + * @return $this + */ + public function setReplyMessages($var) + { + GPBUtil::checkMessage($var, \Google\Apps\Chat\V1\Space\PermissionSetting::class); + $this->reply_messages = $var; + + return $this; + } + +} + + diff --git a/AppsChat/src/Chat/V1/Space/PredefinedPermissionSettings.php b/AppsChat/src/Chat/V1/Space/PredefinedPermissionSettings.php new file mode 100644 index 000000000000..d0978e1b0e43 --- /dev/null +++ b/AppsChat/src/Chat/V1/Space/PredefinedPermissionSettings.php @@ -0,0 +1,67 @@ +google.chat.v1.Space.PredefinedPermissionSettings + */ +class PredefinedPermissionSettings +{ + /** + * Unspecified. Don't use. + * + * Generated from protobuf enum PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED = 0; + */ + const PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED = 0; + /** + * Setting to make the space a collaboration space where all members can + * post messages. + * + * Generated from protobuf enum COLLABORATION_SPACE = 1; + */ + const COLLABORATION_SPACE = 1; + /** + * Setting to make the space an announcement space where only space managers + * can post messages. + * + * Generated from protobuf enum ANNOUNCEMENT_SPACE = 2; + */ + const ANNOUNCEMENT_SPACE = 2; + + private static $valueToName = [ + self::PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED => 'PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED', + self::COLLABORATION_SPACE => 'COLLABORATION_SPACE', + self::ANNOUNCEMENT_SPACE => 'ANNOUNCEMENT_SPACE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AppsChat/src/Chat/V1/Thread.php b/AppsChat/src/Chat/V1/Thread.php index 199a101cc358..cef404ea9070 100644 --- a/AppsChat/src/Chat/V1/Thread.php +++ b/AppsChat/src/Chat/V1/Thread.php @@ -21,7 +21,7 @@ class Thread extends \Google\Protobuf\Internal\Message { /** - * Output only. Resource name of the thread. + * Resource name of the thread. * Example: `spaces/{space}/threads/{thread}` * * Generated from protobuf field string name = 1; @@ -47,7 +47,7 @@ class Thread extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Output only. Resource name of the thread. + * Resource name of the thread. * Example: `spaces/{space}/threads/{thread}` * @type string $thread_key * Optional. Input for creating or updating a thread. Otherwise, output only. @@ -65,7 +65,7 @@ public function __construct($data = NULL) { } /** - * Output only. Resource name of the thread. + * Resource name of the thread. * Example: `spaces/{space}/threads/{thread}` * * Generated from protobuf field string name = 1; @@ -77,7 +77,7 @@ public function getName() } /** - * Output only. Resource name of the thread. + * Resource name of the thread. * Example: `spaces/{space}/threads/{thread}` * * Generated from protobuf field string name = 1; diff --git a/AppsChat/src/Chat/V1/UpdateSpaceRequest.php b/AppsChat/src/Chat/V1/UpdateSpaceRequest.php index 0c6e81d62483..ef832bfb3be3 100644 --- a/AppsChat/src/Chat/V1/UpdateSpaceRequest.php +++ b/AppsChat/src/Chat/V1/UpdateSpaceRequest.php @@ -26,48 +26,57 @@ class UpdateSpaceRequest extends \Google\Protobuf\Internal\Message /** * Required. The updated field paths, comma separated if there are * multiple. - * Currently supported field paths: - * - `display_name` (Only supports changing the display name of a space with - * the `SPACE` type, or when also including the `space_type` mask to change a - * `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a - * `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument - * error. If you receive the error message `ALREADY_EXISTS` when updating the - * `displayName`, try a different `displayName`. An existing space within the - * Google Workspace organization might already use this display name.) - * - `space_type` (Only supports changing a `GROUP_CHAT` space type to + * You can update the following fields for a space: + * `space_details`: Updates the space's description. Supports up to 150 + * characters. + * `display_name`: Only supports updating the display name for spaces where + * `spaceType` field is `SPACE`. + * If you receive the error message `ALREADY_EXISTS`, try a different + * value. An existing space within the + * Google Workspace organization might already use this display name. + * `space_type`: Only supports changing a `GROUP_CHAT` space type to * `SPACE`. Include `display_name` together * with `space_type` in the update mask and ensure that the specified space * has a non-empty display name and the `SPACE` space type. Including the * `space_type` mask and the `SPACE` type in the specified space when updating * the display name is optional if the existing space already has the `SPACE` * type. Trying to update the space type in other ways results in an invalid - * argument error). - * `space_type` is not supported with admin access. - * - `space_details` - * - `space_history_state` (Supports [turning history on or off for the - * space](https://support.google.com/chat/answer/7664687) if [the organization - * allows users to change their history - * setting](https://support.google.com/a/answer/7664184). - * Warning: mutually exclusive with all other field paths.) - * `space_history_state` is not supported with admin access. - * - `access_settings.audience` (Supports changing the [access + * argument error. + * `space_type` is not supported with `useAdminAccess`. + * `space_history_state`: Updates [space history + * settings](https://support.google.com/chat/answer/7664687) by turning + * history on or off for the space. Only supported if history settings are + * enabled for the Google Workspace organization. To update the + * space history state, you must omit all other field masks in your request. + * `space_history_state` is not supported with `useAdminAccess`. + * `access_settings.audience`: Updates the [access * setting](https://support.google.com/chat/answer/11971020) of who can - * discover the space, join the space, and preview the messages in space. If - * no audience is specified in the access setting, the space's access setting - * is updated to private. Warning: mutually exclusive with all other field - * paths.) - * `access_settings.audience` is not supported with admin access. - * - Developer Preview: Supports changing the [permission - * settings](https://support.google.com/chat/answer/13340792) of a space, - * supported field paths - * include: `permission_settings.manage_members_and_groups`, - * `permission_settings.modify_space_details`, - * `permission_settings.toggle_history`, - * `permission_settings.use_at_mention_all`, - * `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, - * `permission_settings.reply_messages` - * (Warning: mutually exclusive with all other non-permission settings field - * paths). `permission_settings` is not supported with admin access. + * discover the space, join the space, and preview the messages in named space + * where `spaceType` field is `SPACE`. If the existing space has a + * target audience, you can remove the audience and restrict space access by + * omitting a value for this field mask. To update access settings for a + * space, the authenticating user must be a space manager and omit all other + * field masks in your request. You can't update this field if the space is in + * [import + * mode](https://developers.google.com/workspace/chat/import-data-overview). + * To learn more, see [Make a space discoverable to specific + * users](https://developers.google.com/workspace/chat/space-target-audience). + * `access_settings.audience` is not supported with `useAdminAccess`. + * `permission_settings`: Supports changing the + * [permission settings](https://support.google.com/chat/answer/13340792) + * of a space. + * When updating permission settings, you can only specify + * `permissionSettings` field masks; you cannot update other field masks + * at the same time. `permissionSettings` is not supported with + * `useAdminAccess`. + * The supported field masks include: + * - `permission_settings.manageMembersAndGroups` + * - `permission_settings.modifySpaceDetails` + * - `permission_settings.toggleHistory` + * - `permission_settings.useAtMentionAll` + * - `permission_settings.manageApps` + * - `permission_settings.manageWebhooks` + * - `permission_settings.replyMessages` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; */ @@ -94,54 +103,64 @@ class UpdateSpaceRequest extends \Google\Protobuf\Internal\Message * @param \Google\Protobuf\FieldMask $updateMask Required. The updated field paths, comma separated if there are * multiple. * - * Currently supported field paths: + * You can update the following fields for a space: * - * - `display_name` (Only supports changing the display name of a space with - * the `SPACE` type, or when also including the `space_type` mask to change a - * `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a - * `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument - * error. If you receive the error message `ALREADY_EXISTS` when updating the - * `displayName`, try a different `displayName`. An existing space within the - * Google Workspace organization might already use this display name.) + * `space_details`: Updates the space's description. Supports up to 150 + * characters. * - * - `space_type` (Only supports changing a `GROUP_CHAT` space type to + * `display_name`: Only supports updating the display name for spaces where + * `spaceType` field is `SPACE`. + * If you receive the error message `ALREADY_EXISTS`, try a different + * value. An existing space within the + * Google Workspace organization might already use this display name. + * + * `space_type`: Only supports changing a `GROUP_CHAT` space type to * `SPACE`. Include `display_name` together * with `space_type` in the update mask and ensure that the specified space * has a non-empty display name and the `SPACE` space type. Including the * `space_type` mask and the `SPACE` type in the specified space when updating * the display name is optional if the existing space already has the `SPACE` * type. Trying to update the space type in other ways results in an invalid - * argument error). - * `space_type` is not supported with admin access. - * - * - `space_details` + * argument error. + * `space_type` is not supported with `useAdminAccess`. * - * - `space_history_state` (Supports [turning history on or off for the - * space](https://support.google.com/chat/answer/7664687) if [the organization - * allows users to change their history - * setting](https://support.google.com/a/answer/7664184). - * Warning: mutually exclusive with all other field paths.) - * `space_history_state` is not supported with admin access. + * `space_history_state`: Updates [space history + * settings](https://support.google.com/chat/answer/7664687) by turning + * history on or off for the space. Only supported if history settings are + * enabled for the Google Workspace organization. To update the + * space history state, you must omit all other field masks in your request. + * `space_history_state` is not supported with `useAdminAccess`. * - * - `access_settings.audience` (Supports changing the [access + * `access_settings.audience`: Updates the [access * setting](https://support.google.com/chat/answer/11971020) of who can - * discover the space, join the space, and preview the messages in space. If - * no audience is specified in the access setting, the space's access setting - * is updated to private. Warning: mutually exclusive with all other field - * paths.) - * `access_settings.audience` is not supported with admin access. + * discover the space, join the space, and preview the messages in named space + * where `spaceType` field is `SPACE`. If the existing space has a + * target audience, you can remove the audience and restrict space access by + * omitting a value for this field mask. To update access settings for a + * space, the authenticating user must be a space manager and omit all other + * field masks in your request. You can't update this field if the space is in + * [import + * mode](https://developers.google.com/workspace/chat/import-data-overview). + * To learn more, see [Make a space discoverable to specific + * users](https://developers.google.com/workspace/chat/space-target-audience). + * `access_settings.audience` is not supported with `useAdminAccess`. + * + * `permission_settings`: Supports changing the + * [permission settings](https://support.google.com/chat/answer/13340792) + * of a space. + * When updating permission settings, you can only specify + * `permissionSettings` field masks; you cannot update other field masks + * at the same time. `permissionSettings` is not supported with + * `useAdminAccess`. + * The supported field masks include: * - * - Developer Preview: Supports changing the [permission - * settings](https://support.google.com/chat/answer/13340792) of a space, - * supported field paths - * include: `permission_settings.manage_members_and_groups`, - * `permission_settings.modify_space_details`, - * `permission_settings.toggle_history`, - * `permission_settings.use_at_mention_all`, - * `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, - * `permission_settings.reply_messages` - * (Warning: mutually exclusive with all other non-permission settings field - * paths). `permission_settings` is not supported with admin access. + * - `permission_settings.manageMembersAndGroups` + * - `permission_settings.modifySpaceDetails` + * - `permission_settings.toggleHistory` + * - `permission_settings.useAtMentionAll` + * - `permission_settings.manageApps` + * - `permission_settings.manageWebhooks` + * - `permission_settings.replyMessages` * * @return \Google\Apps\Chat\V1\UpdateSpaceRequest * @@ -167,48 +186,57 @@ public static function build(\Google\Apps\Chat\V1\Space $space, \Google\Protobuf * @type \Google\Protobuf\FieldMask $update_mask * Required. The updated field paths, comma separated if there are * multiple. - * Currently supported field paths: - * - `display_name` (Only supports changing the display name of a space with - * the `SPACE` type, or when also including the `space_type` mask to change a - * `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a - * `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument - * error. If you receive the error message `ALREADY_EXISTS` when updating the - * `displayName`, try a different `displayName`. An existing space within the - * Google Workspace organization might already use this display name.) - * - `space_type` (Only supports changing a `GROUP_CHAT` space type to + * You can update the following fields for a space: + * `space_details`: Updates the space's description. Supports up to 150 + * characters. + * `display_name`: Only supports updating the display name for spaces where + * `spaceType` field is `SPACE`. + * If you receive the error message `ALREADY_EXISTS`, try a different + * value. An existing space within the + * Google Workspace organization might already use this display name. + * `space_type`: Only supports changing a `GROUP_CHAT` space type to * `SPACE`. Include `display_name` together * with `space_type` in the update mask and ensure that the specified space * has a non-empty display name and the `SPACE` space type. Including the * `space_type` mask and the `SPACE` type in the specified space when updating * the display name is optional if the existing space already has the `SPACE` * type. Trying to update the space type in other ways results in an invalid - * argument error). - * `space_type` is not supported with admin access. - * - `space_details` - * - `space_history_state` (Supports [turning history on or off for the - * space](https://support.google.com/chat/answer/7664687) if [the organization - * allows users to change their history - * setting](https://support.google.com/a/answer/7664184). - * Warning: mutually exclusive with all other field paths.) - * `space_history_state` is not supported with admin access. - * - `access_settings.audience` (Supports changing the [access + * argument error. + * `space_type` is not supported with `useAdminAccess`. + * `space_history_state`: Updates [space history + * settings](https://support.google.com/chat/answer/7664687) by turning + * history on or off for the space. Only supported if history settings are + * enabled for the Google Workspace organization. To update the + * space history state, you must omit all other field masks in your request. + * `space_history_state` is not supported with `useAdminAccess`. + * `access_settings.audience`: Updates the [access * setting](https://support.google.com/chat/answer/11971020) of who can - * discover the space, join the space, and preview the messages in space. If - * no audience is specified in the access setting, the space's access setting - * is updated to private. Warning: mutually exclusive with all other field - * paths.) - * `access_settings.audience` is not supported with admin access. - * - Developer Preview: Supports changing the [permission - * settings](https://support.google.com/chat/answer/13340792) of a space, - * supported field paths - * include: `permission_settings.manage_members_and_groups`, - * `permission_settings.modify_space_details`, - * `permission_settings.toggle_history`, - * `permission_settings.use_at_mention_all`, - * `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, - * `permission_settings.reply_messages` - * (Warning: mutually exclusive with all other non-permission settings field - * paths). `permission_settings` is not supported with admin access. + * discover the space, join the space, and preview the messages in named space + * where `spaceType` field is `SPACE`. If the existing space has a + * target audience, you can remove the audience and restrict space access by + * omitting a value for this field mask. To update access settings for a + * space, the authenticating user must be a space manager and omit all other + * field masks in your request. You can't update this field if the space is in + * [import + * mode](https://developers.google.com/workspace/chat/import-data-overview). + * To learn more, see [Make a space discoverable to specific + * users](https://developers.google.com/workspace/chat/space-target-audience). + * `access_settings.audience` is not supported with `useAdminAccess`. + * `permission_settings`: Supports changing the + * [permission settings](https://support.google.com/chat/answer/13340792) + * of a space. + * When updating permission settings, you can only specify + * `permissionSettings` field masks; you cannot update other field masks + * at the same time. `permissionSettings` is not supported with + * `useAdminAccess`. + * The supported field masks include: + * - `permission_settings.manageMembersAndGroups` + * - `permission_settings.modifySpaceDetails` + * - `permission_settings.toggleHistory` + * - `permission_settings.useAtMentionAll` + * - `permission_settings.manageApps` + * - `permission_settings.manageWebhooks` + * - `permission_settings.replyMessages` * @type bool $use_admin_access * When `true`, the method runs using the user's Google Workspace * administrator privileges. @@ -269,48 +297,57 @@ public function setSpace($var) /** * Required. The updated field paths, comma separated if there are * multiple. - * Currently supported field paths: - * - `display_name` (Only supports changing the display name of a space with - * the `SPACE` type, or when also including the `space_type` mask to change a - * `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a - * `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument - * error. If you receive the error message `ALREADY_EXISTS` when updating the - * `displayName`, try a different `displayName`. An existing space within the - * Google Workspace organization might already use this display name.) - * - `space_type` (Only supports changing a `GROUP_CHAT` space type to + * You can update the following fields for a space: + * `space_details`: Updates the space's description. Supports up to 150 + * characters. + * `display_name`: Only supports updating the display name for spaces where + * `spaceType` field is `SPACE`. + * If you receive the error message `ALREADY_EXISTS`, try a different + * value. An existing space within the + * Google Workspace organization might already use this display name. + * `space_type`: Only supports changing a `GROUP_CHAT` space type to * `SPACE`. Include `display_name` together * with `space_type` in the update mask and ensure that the specified space * has a non-empty display name and the `SPACE` space type. Including the * `space_type` mask and the `SPACE` type in the specified space when updating * the display name is optional if the existing space already has the `SPACE` * type. Trying to update the space type in other ways results in an invalid - * argument error). - * `space_type` is not supported with admin access. - * - `space_details` - * - `space_history_state` (Supports [turning history on or off for the - * space](https://support.google.com/chat/answer/7664687) if [the organization - * allows users to change their history - * setting](https://support.google.com/a/answer/7664184). - * Warning: mutually exclusive with all other field paths.) - * `space_history_state` is not supported with admin access. - * - `access_settings.audience` (Supports changing the [access + * argument error. + * `space_type` is not supported with `useAdminAccess`. + * `space_history_state`: Updates [space history + * settings](https://support.google.com/chat/answer/7664687) by turning + * history on or off for the space. Only supported if history settings are + * enabled for the Google Workspace organization. To update the + * space history state, you must omit all other field masks in your request. + * `space_history_state` is not supported with `useAdminAccess`. + * `access_settings.audience`: Updates the [access * setting](https://support.google.com/chat/answer/11971020) of who can - * discover the space, join the space, and preview the messages in space. If - * no audience is specified in the access setting, the space's access setting - * is updated to private. Warning: mutually exclusive with all other field - * paths.) - * `access_settings.audience` is not supported with admin access. - * - Developer Preview: Supports changing the [permission - * settings](https://support.google.com/chat/answer/13340792) of a space, - * supported field paths - * include: `permission_settings.manage_members_and_groups`, - * `permission_settings.modify_space_details`, - * `permission_settings.toggle_history`, - * `permission_settings.use_at_mention_all`, - * `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, - * `permission_settings.reply_messages` - * (Warning: mutually exclusive with all other non-permission settings field - * paths). `permission_settings` is not supported with admin access. + * discover the space, join the space, and preview the messages in named space + * where `spaceType` field is `SPACE`. If the existing space has a + * target audience, you can remove the audience and restrict space access by + * omitting a value for this field mask. To update access settings for a + * space, the authenticating user must be a space manager and omit all other + * field masks in your request. You can't update this field if the space is in + * [import + * mode](https://developers.google.com/workspace/chat/import-data-overview). + * To learn more, see [Make a space discoverable to specific + * users](https://developers.google.com/workspace/chat/space-target-audience). + * `access_settings.audience` is not supported with `useAdminAccess`. + * `permission_settings`: Supports changing the + * [permission settings](https://support.google.com/chat/answer/13340792) + * of a space. + * When updating permission settings, you can only specify + * `permissionSettings` field masks; you cannot update other field masks + * at the same time. `permissionSettings` is not supported with + * `useAdminAccess`. + * The supported field masks include: + * - `permission_settings.manageMembersAndGroups` + * - `permission_settings.modifySpaceDetails` + * - `permission_settings.toggleHistory` + * - `permission_settings.useAtMentionAll` + * - `permission_settings.manageApps` + * - `permission_settings.manageWebhooks` + * - `permission_settings.replyMessages` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @return \Google\Protobuf\FieldMask|null @@ -333,48 +370,57 @@ public function clearUpdateMask() /** * Required. The updated field paths, comma separated if there are * multiple. - * Currently supported field paths: - * - `display_name` (Only supports changing the display name of a space with - * the `SPACE` type, or when also including the `space_type` mask to change a - * `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a - * `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument - * error. If you receive the error message `ALREADY_EXISTS` when updating the - * `displayName`, try a different `displayName`. An existing space within the - * Google Workspace organization might already use this display name.) - * - `space_type` (Only supports changing a `GROUP_CHAT` space type to + * You can update the following fields for a space: + * `space_details`: Updates the space's description. Supports up to 150 + * characters. + * `display_name`: Only supports updating the display name for spaces where + * `spaceType` field is `SPACE`. + * If you receive the error message `ALREADY_EXISTS`, try a different + * value. An existing space within the + * Google Workspace organization might already use this display name. + * `space_type`: Only supports changing a `GROUP_CHAT` space type to * `SPACE`. Include `display_name` together * with `space_type` in the update mask and ensure that the specified space * has a non-empty display name and the `SPACE` space type. Including the * `space_type` mask and the `SPACE` type in the specified space when updating * the display name is optional if the existing space already has the `SPACE` * type. Trying to update the space type in other ways results in an invalid - * argument error). - * `space_type` is not supported with admin access. - * - `space_details` - * - `space_history_state` (Supports [turning history on or off for the - * space](https://support.google.com/chat/answer/7664687) if [the organization - * allows users to change their history - * setting](https://support.google.com/a/answer/7664184). - * Warning: mutually exclusive with all other field paths.) - * `space_history_state` is not supported with admin access. - * - `access_settings.audience` (Supports changing the [access + * argument error. + * `space_type` is not supported with `useAdminAccess`. + * `space_history_state`: Updates [space history + * settings](https://support.google.com/chat/answer/7664687) by turning + * history on or off for the space. Only supported if history settings are + * enabled for the Google Workspace organization. To update the + * space history state, you must omit all other field masks in your request. + * `space_history_state` is not supported with `useAdminAccess`. + * `access_settings.audience`: Updates the [access * setting](https://support.google.com/chat/answer/11971020) of who can - * discover the space, join the space, and preview the messages in space. If - * no audience is specified in the access setting, the space's access setting - * is updated to private. Warning: mutually exclusive with all other field - * paths.) - * `access_settings.audience` is not supported with admin access. - * - Developer Preview: Supports changing the [permission - * settings](https://support.google.com/chat/answer/13340792) of a space, - * supported field paths - * include: `permission_settings.manage_members_and_groups`, - * `permission_settings.modify_space_details`, - * `permission_settings.toggle_history`, - * `permission_settings.use_at_mention_all`, - * `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, - * `permission_settings.reply_messages` - * (Warning: mutually exclusive with all other non-permission settings field - * paths). `permission_settings` is not supported with admin access. + * discover the space, join the space, and preview the messages in named space + * where `spaceType` field is `SPACE`. If the existing space has a + * target audience, you can remove the audience and restrict space access by + * omitting a value for this field mask. To update access settings for a + * space, the authenticating user must be a space manager and omit all other + * field masks in your request. You can't update this field if the space is in + * [import + * mode](https://developers.google.com/workspace/chat/import-data-overview). + * To learn more, see [Make a space discoverable to specific + * users](https://developers.google.com/workspace/chat/space-target-audience). + * `access_settings.audience` is not supported with `useAdminAccess`. + * `permission_settings`: Supports changing the + * [permission settings](https://support.google.com/chat/answer/13340792) + * of a space. + * When updating permission settings, you can only specify + * `permissionSettings` field masks; you cannot update other field masks + * at the same time. `permissionSettings` is not supported with + * `useAdminAccess`. + * The supported field masks include: + * - `permission_settings.manageMembersAndGroups` + * - `permission_settings.modifySpaceDetails` + * - `permission_settings.toggleHistory` + * - `permission_settings.useAtMentionAll` + * - `permission_settings.manageApps` + * - `permission_settings.manageWebhooks` + * - `permission_settings.replyMessages` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @param \Google\Protobuf\FieldMask $var From 0e366efa02e8d6100cf4a61e5b7fd731ad8157e4 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:34:42 -0700 Subject: [PATCH 007/157] feat: Define ReplicaComputeCapacity and AsymmetricAutoscalingOption (#7723) docs: A comment for field `node_count` in message `spanner.admin.instance.v1.Instance` is changed docs: A comment for field `processing_units` in message `spanner.admin.instance.v1.Instance` is changed PiperOrigin-RevId: 681615472 Source-Link: https://github.com/googleapis/googleapis/commit/dd47718199b804d06f99aadc5287cacf638e2241 Source-Link: https://github.com/googleapis/googleapis-gen/commit/7f0f9b7466cb517769b549c5e2c2b912492862f2 Copy-Tag: eyJwIjoiU3Bhbm5lci8uT3dsQm90LnlhbWwiLCJoIjoiN2YwZjliNzQ2NmNiNTE3NzY5YjU0OWM1ZTJjMmI5MTI0OTI4NjJmMiJ9 --- Spanner/metadata/Admin/Instance/V1/Common.php | Bin 1231 -> 1366 bytes .../Instance/V1/SpannerInstanceAdmin.php | Bin 15529 -> 16388 bytes .../Admin/Instance/V1/AutoscalingConfig.php | 62 +++++ .../AsymmetricAutoscalingOption.php | 133 +++++++++++ .../AutoscalingConfigOverrides.php | 129 +++++++++++ Spanner/src/Admin/Instance/V1/Instance.php | 218 +++++++++++++----- .../Instance/V1/ReplicaComputeCapacity.php | 169 ++++++++++++++ .../Admin/Instance/V1/ReplicaSelection.php | 67 ++++++ 8 files changed, 714 insertions(+), 64 deletions(-) create mode 100644 Spanner/src/Admin/Instance/V1/AutoscalingConfig/AsymmetricAutoscalingOption.php create mode 100644 Spanner/src/Admin/Instance/V1/AutoscalingConfig/AsymmetricAutoscalingOption/AutoscalingConfigOverrides.php create mode 100644 Spanner/src/Admin/Instance/V1/ReplicaComputeCapacity.php create mode 100644 Spanner/src/Admin/Instance/V1/ReplicaSelection.php diff --git a/Spanner/metadata/Admin/Instance/V1/Common.php b/Spanner/metadata/Admin/Instance/V1/Common.php index 4e83339471a1d21a0b2b153ece57ff0d84ca93c0..75e8043d35ca28feb87a1098616dd9f7961d5dba 100644 GIT binary patch delta 132 zcmX@ld5vqs8Ad_Jg3K7V%+#C|r__wZvdsLV$@dt=ChuU(W?93^r907EcX9}mlA@G+ zdVYR-PO5%EQGQ8&QfZogNoH fo{%UPM^1inB8V-)sKBVf>BRiNk!dpv^Jzu^IX*0A delta 27 jcmcb{b)Iv>8OF)%OyNuqSSBYh1x~)i)VH~t`7|Q{lQ0Tb diff --git a/Spanner/metadata/Admin/Instance/V1/SpannerInstanceAdmin.php b/Spanner/metadata/Admin/Instance/V1/SpannerInstanceAdmin.php index 24d377df44a07d7dcf45de3f651ffeae552f1f98..1e2e58c40e2cbb5bc005178fc1d3b852ce4d36e8 100644 GIT binary patch delta 560 zcmZ2k+0wwcVIm95q%tns$vkX|6LVxXUt(!zHQmI>B^H!gkdv95=$xNhP+F4eoLG>U zoLN#S6vQQ11d)j^PR&V8F3HT#lVDU})Zm_+&!;k3j)R>u7$!b>fsBYU6Ht!TgF#4& zOQ4`AKRLCyI5RIjzBDhhq*#I(A~$)yoG8-{j>*wnPql<JYq zV5!rLTvE8zOwQvvqHcIIz`{Y2L<;w9~60lfH hhD2z5GBiddgu%gS0d_br`b5xT9Apmj=I=b4^Z|&Dx=8>4 delta 50 zcmV-20L}k|fB~s_u#p4=w{HqPlMDtSk!&2Z(gcSE0`mit5DVqAa|{jv10v)GlS>b$ Ivr`bUFTkP^Hvj+t diff --git a/Spanner/src/Admin/Instance/V1/AutoscalingConfig.php b/Spanner/src/Admin/Instance/V1/AutoscalingConfig.php index 772557fed2ab..341c101be0f1 100644 --- a/Spanner/src/Admin/Instance/V1/AutoscalingConfig.php +++ b/Spanner/src/Admin/Instance/V1/AutoscalingConfig.php @@ -27,6 +27,19 @@ class AutoscalingConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.spanner.admin.instance.v1.AutoscalingConfig.AutoscalingTargets autoscaling_targets = 2 [(.google.api.field_behavior) = REQUIRED]; */ private $autoscaling_targets = null; + /** + * Optional. Optional asymmetric autoscaling options. + * Replicas matching the replica selection criteria will be autoscaled + * independently from other replicas. The autoscaler will scale the replicas + * based on the utilization of replicas identified by the replica selection. + * Replica selections should not overlap with each other. + * Other replicas (those do not match any replica selection) will be + * autoscaled together and will have the same compute capacity allocated to + * them. + * + * Generated from protobuf field repeated .google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption asymmetric_autoscaling_options = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $asymmetric_autoscaling_options; /** * Constructor. @@ -38,6 +51,15 @@ class AutoscalingConfig extends \Google\Protobuf\Internal\Message * Required. Autoscaling limits for an instance. * @type \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AutoscalingTargets $autoscaling_targets * Required. The autoscaling targets for an instance. + * @type array<\Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AsymmetricAutoscalingOption>|\Google\Protobuf\Internal\RepeatedField $asymmetric_autoscaling_options + * Optional. Optional asymmetric autoscaling options. + * Replicas matching the replica selection criteria will be autoscaled + * independently from other replicas. The autoscaler will scale the replicas + * based on the utilization of replicas identified by the replica selection. + * Replica selections should not overlap with each other. + * Other replicas (those do not match any replica selection) will be + * autoscaled together and will have the same compute capacity allocated to + * them. * } */ public function __construct($data = NULL) { @@ -117,5 +139,45 @@ public function setAutoscalingTargets($var) return $this; } + /** + * Optional. Optional asymmetric autoscaling options. + * Replicas matching the replica selection criteria will be autoscaled + * independently from other replicas. The autoscaler will scale the replicas + * based on the utilization of replicas identified by the replica selection. + * Replica selections should not overlap with each other. + * Other replicas (those do not match any replica selection) will be + * autoscaled together and will have the same compute capacity allocated to + * them. + * + * Generated from protobuf field repeated .google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption asymmetric_autoscaling_options = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAsymmetricAutoscalingOptions() + { + return $this->asymmetric_autoscaling_options; + } + + /** + * Optional. Optional asymmetric autoscaling options. + * Replicas matching the replica selection criteria will be autoscaled + * independently from other replicas. The autoscaler will scale the replicas + * based on the utilization of replicas identified by the replica selection. + * Replica selections should not overlap with each other. + * Other replicas (those do not match any replica selection) will be + * autoscaled together and will have the same compute capacity allocated to + * them. + * + * Generated from protobuf field repeated .google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption asymmetric_autoscaling_options = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AsymmetricAutoscalingOption>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAsymmetricAutoscalingOptions($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AsymmetricAutoscalingOption::class); + $this->asymmetric_autoscaling_options = $arr; + + return $this; + } + } diff --git a/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AsymmetricAutoscalingOption.php b/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AsymmetricAutoscalingOption.php new file mode 100644 index 000000000000..946771ada7dc --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AsymmetricAutoscalingOption.php @@ -0,0 +1,133 @@ +google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption + */ +class AsymmetricAutoscalingOption extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Selects the replicas to which this AsymmetricAutoscalingOption + * applies. Only read-only replicas are supported. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.ReplicaSelection replica_selection = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $replica_selection = null; + /** + * Optional. Overrides applied to the top-level autoscaling configuration + * for the selected replicas. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption.AutoscalingConfigOverrides overrides = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $overrides = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaSelection $replica_selection + * Required. Selects the replicas to which this AsymmetricAutoscalingOption + * applies. Only read-only replicas are supported. + * @type \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AsymmetricAutoscalingOption\AutoscalingConfigOverrides $overrides + * Optional. Overrides applied to the top-level autoscaling configuration + * for the selected replicas. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Spanner\Admin\Instance\V1\SpannerInstanceAdmin::initOnce(); + parent::__construct($data); + } + + /** + * Required. Selects the replicas to which this AsymmetricAutoscalingOption + * applies. Only read-only replicas are supported. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.ReplicaSelection replica_selection = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaSelection|null + */ + public function getReplicaSelection() + { + return $this->replica_selection; + } + + public function hasReplicaSelection() + { + return isset($this->replica_selection); + } + + public function clearReplicaSelection() + { + unset($this->replica_selection); + } + + /** + * Required. Selects the replicas to which this AsymmetricAutoscalingOption + * applies. Only read-only replicas are supported. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.ReplicaSelection replica_selection = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaSelection $var + * @return $this + */ + public function setReplicaSelection($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaSelection::class); + $this->replica_selection = $var; + + return $this; + } + + /** + * Optional. Overrides applied to the top-level autoscaling configuration + * for the selected replicas. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption.AutoscalingConfigOverrides overrides = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AsymmetricAutoscalingOption\AutoscalingConfigOverrides|null + */ + public function getOverrides() + { + return $this->overrides; + } + + public function hasOverrides() + { + return isset($this->overrides); + } + + public function clearOverrides() + { + unset($this->overrides); + } + + /** + * Optional. Overrides applied to the top-level autoscaling configuration + * for the selected replicas. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption.AutoscalingConfigOverrides overrides = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AsymmetricAutoscalingOption\AutoscalingConfigOverrides $var + * @return $this + */ + public function setOverrides($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AsymmetricAutoscalingOption\AutoscalingConfigOverrides::class); + $this->overrides = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(AsymmetricAutoscalingOption::class, \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig_AsymmetricAutoscalingOption::class); + diff --git a/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AsymmetricAutoscalingOption/AutoscalingConfigOverrides.php b/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AsymmetricAutoscalingOption/AutoscalingConfigOverrides.php new file mode 100644 index 000000000000..584720806a65 --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/AutoscalingConfig/AsymmetricAutoscalingOption/AutoscalingConfigOverrides.php @@ -0,0 +1,129 @@ +google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption.AutoscalingConfigOverrides + */ +class AutoscalingConfigOverrides extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. If specified, overrides the min/max limit in the top-level + * autoscaling configuration for the selected replicas. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.AutoscalingConfig.AutoscalingLimits autoscaling_limits = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $autoscaling_limits = null; + /** + * Optional. If specified, overrides the autoscaling target + * high_priority_cpu_utilization_percent in the top-level autoscaling + * configuration for the selected replicas. + * + * Generated from protobuf field int32 autoscaling_target_high_priority_cpu_utilization_percent = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $autoscaling_target_high_priority_cpu_utilization_percent = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AutoscalingLimits $autoscaling_limits + * Optional. If specified, overrides the min/max limit in the top-level + * autoscaling configuration for the selected replicas. + * @type int $autoscaling_target_high_priority_cpu_utilization_percent + * Optional. If specified, overrides the autoscaling target + * high_priority_cpu_utilization_percent in the top-level autoscaling + * configuration for the selected replicas. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Spanner\Admin\Instance\V1\SpannerInstanceAdmin::initOnce(); + parent::__construct($data); + } + + /** + * Optional. If specified, overrides the min/max limit in the top-level + * autoscaling configuration for the selected replicas. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.AutoscalingConfig.AutoscalingLimits autoscaling_limits = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AutoscalingLimits|null + */ + public function getAutoscalingLimits() + { + return $this->autoscaling_limits; + } + + public function hasAutoscalingLimits() + { + return isset($this->autoscaling_limits); + } + + public function clearAutoscalingLimits() + { + unset($this->autoscaling_limits); + } + + /** + * Optional. If specified, overrides the min/max limit in the top-level + * autoscaling configuration for the selected replicas. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.AutoscalingConfig.AutoscalingLimits autoscaling_limits = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AutoscalingLimits $var + * @return $this + */ + public function setAutoscalingLimits($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig\AutoscalingLimits::class); + $this->autoscaling_limits = $var; + + return $this; + } + + /** + * Optional. If specified, overrides the autoscaling target + * high_priority_cpu_utilization_percent in the top-level autoscaling + * configuration for the selected replicas. + * + * Generated from protobuf field int32 autoscaling_target_high_priority_cpu_utilization_percent = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getAutoscalingTargetHighPriorityCpuUtilizationPercent() + { + return $this->autoscaling_target_high_priority_cpu_utilization_percent; + } + + /** + * Optional. If specified, overrides the autoscaling target + * high_priority_cpu_utilization_percent in the top-level autoscaling + * configuration for the selected replicas. + * + * Generated from protobuf field int32 autoscaling_target_high_priority_cpu_utilization_percent = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setAutoscalingTargetHighPriorityCpuUtilizationPercent($var) + { + GPBUtil::checkInt32($var); + $this->autoscaling_target_high_priority_cpu_utilization_percent = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(AutoscalingConfigOverrides::class, \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig_AsymmetricAutoscalingOption_AutoscalingConfigOverrides::class); + diff --git a/Spanner/src/Admin/Instance/V1/Instance.php b/Spanner/src/Admin/Instance/V1/Instance.php index 4d2fffe9f4f1..f16c7ca56c88 100644 --- a/Spanner/src/Admin/Instance/V1/Instance.php +++ b/Spanner/src/Admin/Instance/V1/Instance.php @@ -41,33 +41,53 @@ class Instance extends \Google\Protobuf\Internal\Message */ private $display_name = ''; /** - * The number of nodes allocated to this instance. At most one of either - * node_count or processing_units should be present in the message. - * Users can set the node_count field to specify the target number of nodes + * The number of nodes allocated to this instance. At most, one of either + * `node_count` or `processing_units` should be present in the message. + * Users can set the `node_count` field to specify the target number of nodes * allocated to the instance. - * This may be zero in API responses for instances that are not yet in state - * `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/compute-capacity) - * for more information about nodes and processing units. + * If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` + * field and reflects the current number of nodes allocated to the instance. + * This might be zero in API responses for instances that are not yet in the + * `READY` state. + * If the instance has varying node count across replicas (achieved by + * setting asymmetric_autoscaling_options in autoscaling config), the + * node_count here is the maximum node count across all replicas. + * For more information, see + * [Compute capacity, nodes, and processing + * units](https://cloud.google.com/spanner/docs/compute-capacity). * * Generated from protobuf field int32 node_count = 5; */ private $node_count = 0; /** - * The number of processing units allocated to this instance. At most one of - * processing_units or node_count should be present in the message. - * Users can set the processing_units field to specify the target number of + * The number of processing units allocated to this instance. At most, one of + * either `processing_units` or `node_count` should be present in the message. + * Users can set the `processing_units` field to specify the target number of * processing units allocated to the instance. - * This may be zero in API responses for instances that are not yet in state - * `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/compute-capacity) - * for more information about nodes and processing units. + * If autoscaling is enabled, `processing_units` is treated as an + * `OUTPUT_ONLY` field and reflects the current number of processing units + * allocated to the instance. + * This might be zero in API responses for instances that are not yet in the + * `READY` state. + * If the instance has varying processing units per replica + * (achieved by setting asymmetric_autoscaling_options in autoscaling config), + * the processing_units here is the maximum processing units across all + * replicas. + * For more information, see + * [Compute capacity, nodes and processing + * units](https://cloud.google.com/spanner/docs/compute-capacity). * * Generated from protobuf field int32 processing_units = 9; */ private $processing_units = 0; + /** + * Output only. Lists the compute capacity per ReplicaSelection. A replica + * selection identifies a set of replicas with common properties. Replicas + * identified by a ReplicaSelection are scaled with the same compute capacity. + * + * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $replica_compute_capacity; /** * Optional. The autoscaling configuration. Autoscaling is enabled if this * field is set. When autoscaling is enabled, node_count and processing_units @@ -155,25 +175,41 @@ class Instance extends \Google\Protobuf\Internal\Message * Required. The descriptive name for this instance as it appears in UIs. * Must be unique per project and between 4 and 30 characters in length. * @type int $node_count - * The number of nodes allocated to this instance. At most one of either - * node_count or processing_units should be present in the message. - * Users can set the node_count field to specify the target number of nodes + * The number of nodes allocated to this instance. At most, one of either + * `node_count` or `processing_units` should be present in the message. + * Users can set the `node_count` field to specify the target number of nodes * allocated to the instance. - * This may be zero in API responses for instances that are not yet in state - * `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/compute-capacity) - * for more information about nodes and processing units. + * If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` + * field and reflects the current number of nodes allocated to the instance. + * This might be zero in API responses for instances that are not yet in the + * `READY` state. + * If the instance has varying node count across replicas (achieved by + * setting asymmetric_autoscaling_options in autoscaling config), the + * node_count here is the maximum node count across all replicas. + * For more information, see + * [Compute capacity, nodes, and processing + * units](https://cloud.google.com/spanner/docs/compute-capacity). * @type int $processing_units - * The number of processing units allocated to this instance. At most one of - * processing_units or node_count should be present in the message. - * Users can set the processing_units field to specify the target number of + * The number of processing units allocated to this instance. At most, one of + * either `processing_units` or `node_count` should be present in the message. + * Users can set the `processing_units` field to specify the target number of * processing units allocated to the instance. - * This may be zero in API responses for instances that are not yet in state - * `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/compute-capacity) - * for more information about nodes and processing units. + * If autoscaling is enabled, `processing_units` is treated as an + * `OUTPUT_ONLY` field and reflects the current number of processing units + * allocated to the instance. + * This might be zero in API responses for instances that are not yet in the + * `READY` state. + * If the instance has varying processing units per replica + * (achieved by setting asymmetric_autoscaling_options in autoscaling config), + * the processing_units here is the maximum processing units across all + * replicas. + * For more information, see + * [Compute capacity, nodes and processing + * units](https://cloud.google.com/spanner/docs/compute-capacity). + * @type array<\Google\Cloud\Spanner\Admin\Instance\V1\ReplicaComputeCapacity>|\Google\Protobuf\Internal\RepeatedField $replica_compute_capacity + * Output only. Lists the compute capacity per ReplicaSelection. A replica + * selection identifies a set of replicas with common properties. Replicas + * identified by a ReplicaSelection are scaled with the same compute capacity. * @type \Google\Cloud\Spanner\Admin\Instance\V1\AutoscalingConfig $autoscaling_config * Optional. The autoscaling configuration. Autoscaling is enabled if this * field is set. When autoscaling is enabled, node_count and processing_units @@ -312,15 +348,20 @@ public function setDisplayName($var) } /** - * The number of nodes allocated to this instance. At most one of either - * node_count or processing_units should be present in the message. - * Users can set the node_count field to specify the target number of nodes + * The number of nodes allocated to this instance. At most, one of either + * `node_count` or `processing_units` should be present in the message. + * Users can set the `node_count` field to specify the target number of nodes * allocated to the instance. - * This may be zero in API responses for instances that are not yet in state - * `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/compute-capacity) - * for more information about nodes and processing units. + * If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` + * field and reflects the current number of nodes allocated to the instance. + * This might be zero in API responses for instances that are not yet in the + * `READY` state. + * If the instance has varying node count across replicas (achieved by + * setting asymmetric_autoscaling_options in autoscaling config), the + * node_count here is the maximum node count across all replicas. + * For more information, see + * [Compute capacity, nodes, and processing + * units](https://cloud.google.com/spanner/docs/compute-capacity). * * Generated from protobuf field int32 node_count = 5; * @return int @@ -331,15 +372,20 @@ public function getNodeCount() } /** - * The number of nodes allocated to this instance. At most one of either - * node_count or processing_units should be present in the message. - * Users can set the node_count field to specify the target number of nodes + * The number of nodes allocated to this instance. At most, one of either + * `node_count` or `processing_units` should be present in the message. + * Users can set the `node_count` field to specify the target number of nodes * allocated to the instance. - * This may be zero in API responses for instances that are not yet in state - * `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/compute-capacity) - * for more information about nodes and processing units. + * If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` + * field and reflects the current number of nodes allocated to the instance. + * This might be zero in API responses for instances that are not yet in the + * `READY` state. + * If the instance has varying node count across replicas (achieved by + * setting asymmetric_autoscaling_options in autoscaling config), the + * node_count here is the maximum node count across all replicas. + * For more information, see + * [Compute capacity, nodes, and processing + * units](https://cloud.google.com/spanner/docs/compute-capacity). * * Generated from protobuf field int32 node_count = 5; * @param int $var @@ -354,15 +400,22 @@ public function setNodeCount($var) } /** - * The number of processing units allocated to this instance. At most one of - * processing_units or node_count should be present in the message. - * Users can set the processing_units field to specify the target number of + * The number of processing units allocated to this instance. At most, one of + * either `processing_units` or `node_count` should be present in the message. + * Users can set the `processing_units` field to specify the target number of * processing units allocated to the instance. - * This may be zero in API responses for instances that are not yet in state - * `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/compute-capacity) - * for more information about nodes and processing units. + * If autoscaling is enabled, `processing_units` is treated as an + * `OUTPUT_ONLY` field and reflects the current number of processing units + * allocated to the instance. + * This might be zero in API responses for instances that are not yet in the + * `READY` state. + * If the instance has varying processing units per replica + * (achieved by setting asymmetric_autoscaling_options in autoscaling config), + * the processing_units here is the maximum processing units across all + * replicas. + * For more information, see + * [Compute capacity, nodes and processing + * units](https://cloud.google.com/spanner/docs/compute-capacity). * * Generated from protobuf field int32 processing_units = 9; * @return int @@ -373,15 +426,22 @@ public function getProcessingUnits() } /** - * The number of processing units allocated to this instance. At most one of - * processing_units or node_count should be present in the message. - * Users can set the processing_units field to specify the target number of + * The number of processing units allocated to this instance. At most, one of + * either `processing_units` or `node_count` should be present in the message. + * Users can set the `processing_units` field to specify the target number of * processing units allocated to the instance. - * This may be zero in API responses for instances that are not yet in state - * `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/compute-capacity) - * for more information about nodes and processing units. + * If autoscaling is enabled, `processing_units` is treated as an + * `OUTPUT_ONLY` field and reflects the current number of processing units + * allocated to the instance. + * This might be zero in API responses for instances that are not yet in the + * `READY` state. + * If the instance has varying processing units per replica + * (achieved by setting asymmetric_autoscaling_options in autoscaling config), + * the processing_units here is the maximum processing units across all + * replicas. + * For more information, see + * [Compute capacity, nodes and processing + * units](https://cloud.google.com/spanner/docs/compute-capacity). * * Generated from protobuf field int32 processing_units = 9; * @param int $var @@ -395,6 +455,36 @@ public function setProcessingUnits($var) return $this; } + /** + * Output only. Lists the compute capacity per ReplicaSelection. A replica + * selection identifies a set of replicas with common properties. Replicas + * identified by a ReplicaSelection are scaled with the same compute capacity. + * + * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getReplicaComputeCapacity() + { + return $this->replica_compute_capacity; + } + + /** + * Output only. Lists the compute capacity per ReplicaSelection. A replica + * selection identifies a set of replicas with common properties. Replicas + * identified by a ReplicaSelection are scaled with the same compute capacity. + * + * Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaComputeCapacity replica_compute_capacity = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array<\Google\Cloud\Spanner\Admin\Instance\V1\ReplicaComputeCapacity>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setReplicaComputeCapacity($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaComputeCapacity::class); + $this->replica_compute_capacity = $arr; + + return $this; + } + /** * Optional. The autoscaling configuration. Autoscaling is enabled if this * field is set. When autoscaling is enabled, node_count and processing_units diff --git a/Spanner/src/Admin/Instance/V1/ReplicaComputeCapacity.php b/Spanner/src/Admin/Instance/V1/ReplicaComputeCapacity.php new file mode 100644 index 000000000000..a4e880f0b6c3 --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/ReplicaComputeCapacity.php @@ -0,0 +1,169 @@ +google.spanner.admin.instance.v1.ReplicaComputeCapacity + */ +class ReplicaComputeCapacity extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Identifies replicas by specified properties. + * All replicas in the selection have the same amount of compute capacity. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.ReplicaSelection replica_selection = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $replica_selection = null; + protected $compute_capacity; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaSelection $replica_selection + * Required. Identifies replicas by specified properties. + * All replicas in the selection have the same amount of compute capacity. + * @type int $node_count + * The number of nodes allocated to each replica. + * This may be zero in API responses for instances that are not yet in + * state `READY`. + * @type int $processing_units + * The number of processing units allocated to each replica. + * This may be zero in API responses for instances that are not yet in + * state `READY`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Spanner\Admin\Instance\V1\SpannerInstanceAdmin::initOnce(); + parent::__construct($data); + } + + /** + * Required. Identifies replicas by specified properties. + * All replicas in the selection have the same amount of compute capacity. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.ReplicaSelection replica_selection = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaSelection|null + */ + public function getReplicaSelection() + { + return $this->replica_selection; + } + + public function hasReplicaSelection() + { + return isset($this->replica_selection); + } + + public function clearReplicaSelection() + { + unset($this->replica_selection); + } + + /** + * Required. Identifies replicas by specified properties. + * All replicas in the selection have the same amount of compute capacity. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.ReplicaSelection replica_selection = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaSelection $var + * @return $this + */ + public function setReplicaSelection($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\Admin\Instance\V1\ReplicaSelection::class); + $this->replica_selection = $var; + + return $this; + } + + /** + * The number of nodes allocated to each replica. + * This may be zero in API responses for instances that are not yet in + * state `READY`. + * + * Generated from protobuf field int32 node_count = 2; + * @return int + */ + public function getNodeCount() + { + return $this->readOneof(2); + } + + public function hasNodeCount() + { + return $this->hasOneof(2); + } + + /** + * The number of nodes allocated to each replica. + * This may be zero in API responses for instances that are not yet in + * state `READY`. + * + * Generated from protobuf field int32 node_count = 2; + * @param int $var + * @return $this + */ + public function setNodeCount($var) + { + GPBUtil::checkInt32($var); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * The number of processing units allocated to each replica. + * This may be zero in API responses for instances that are not yet in + * state `READY`. + * + * Generated from protobuf field int32 processing_units = 3; + * @return int + */ + public function getProcessingUnits() + { + return $this->readOneof(3); + } + + public function hasProcessingUnits() + { + return $this->hasOneof(3); + } + + /** + * The number of processing units allocated to each replica. + * This may be zero in API responses for instances that are not yet in + * state `READY`. + * + * Generated from protobuf field int32 processing_units = 3; + * @param int $var + * @return $this + */ + public function setProcessingUnits($var) + { + GPBUtil::checkInt32($var); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * @return string + */ + public function getComputeCapacity() + { + return $this->whichOneof("compute_capacity"); + } + +} + diff --git a/Spanner/src/Admin/Instance/V1/ReplicaSelection.php b/Spanner/src/Admin/Instance/V1/ReplicaSelection.php new file mode 100644 index 000000000000..556dad423abf --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/ReplicaSelection.php @@ -0,0 +1,67 @@ +google.spanner.admin.instance.v1.ReplicaSelection + */ +class ReplicaSelection extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the location of the replicas (e.g., "us-central1"). + * + * Generated from protobuf field string location = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $location = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $location + * Required. Name of the location of the replicas (e.g., "us-central1"). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Spanner\Admin\Instance\V1\Common::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the location of the replicas (e.g., "us-central1"). + * + * Generated from protobuf field string location = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getLocation() + { + return $this->location; + } + + /** + * Required. Name of the location of the replicas (e.g., "us-central1"). + * + * Generated from protobuf field string location = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setLocation($var) + { + GPBUtil::checkString($var, True); + $this->location = $var; + + return $this; + } + +} + From 7674a3ea25e138f41ebfb4c3becceaf3221556b4 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:35:10 -0700 Subject: [PATCH 008/157] feat: add a dynamic retrieval API (#7724) PiperOrigin-RevId: 681780557 Source-Link: https://github.com/googleapis/googleapis/commit/475669fc7ac4b360159901fdafac4ffd06e7abd2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/bbbb240a38b4a4457451f63a3efacbb8068a67ed Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiYmJiYjI0MGEzOGI0YTQ0NTc0NTFmNjNhM2VmYWNiYjgwNjhhNjdlZCJ9 feat: add continuous sync option in feature_view.proto PiperOrigin-RevId: 681665991 Source-Link: https://github.com/googleapis/googleapis/commit/8d1759518953018930e6de2eac6fc579bb738869 Source-Link: https://github.com/googleapis/googleapis-gen/commit/ceb528d37950013e1e12edd4b0e99b2d2207c7f9 Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiY2ViNTI4ZDM3OTUwMDEzZTFlMTJlZGQ0YjBlOTliMmQyMjA3YzdmOSJ9 --- AiPlatform/metadata/V1/Content.php | Bin 7024 -> 7208 bytes AiPlatform/metadata/V1/FeatureView.php | Bin 3192 -> 3217 bytes AiPlatform/metadata/V1/Tool.php | Bin 2200 -> 2491 bytes AiPlatform/src/V1/DynamicRetrievalConfig.php | 115 ++++++++++++++++++ .../src/V1/DynamicRetrievalConfig/Mode.php | 55 +++++++++ AiPlatform/src/V1/FeatureView/SyncConfig.php | 38 ++++++ AiPlatform/src/V1/GoogleSearchRetrieval.php | 44 +++++++ AiPlatform/src/V1/GroundingMetadata.php | 44 +++++++ AiPlatform/src/V1/RetrievalMetadata.php | 83 +++++++++++++ 9 files changed, 379 insertions(+) create mode 100644 AiPlatform/src/V1/DynamicRetrievalConfig.php create mode 100644 AiPlatform/src/V1/DynamicRetrievalConfig/Mode.php create mode 100644 AiPlatform/src/V1/RetrievalMetadata.php diff --git a/AiPlatform/metadata/V1/Content.php b/AiPlatform/metadata/V1/Content.php index 6b5b5ae57d095b4e200c96856151147b3da3c4c9..2f518197707f8ef06b56007a2eab203c024376e4 100644 GIT binary patch delta 196 zcmexhw!&fqFEi5x!_EB6uSA#@GjIMaF3ZR(6vib~lv+}hnOc^ZGnrdh*CzG}ETIjJzyQY!Njb2F3U5vCL;=NF|)Fexx%xaVTxqDxLJ-_nwimfvK5<@q>wllS8{${NoHPYerd4; TlLDg#hZFMyN5;(|Y$|L3Umy`! delta 37 tcmbOz`9osEWG0r`!d$u&y>%xaVTxqjv008;nwe2*vK5=u=3F)vHUQ?p3a0=7 diff --git a/AiPlatform/metadata/V1/Tool.php b/AiPlatform/metadata/V1/Tool.php index bd6a39c0b483fbb7e57684cf7b7ffa0f897631f7..56d59e12d73d6bf9d59f14590161b9ee4ac77416 100644 GIT binary patch delta 296 zcmbOsxLbI`F(#JPyj-diy;V2AXYyvY$>kDt&(BZKNexa-EK1G@N-ZhMOf5^y5engw zNU6+A%*{-WFMgoogle.cloud.aiplatform.v1.DynamicRetrievalConfig + */ +class DynamicRetrievalConfig extends \Google\Protobuf\Internal\Message +{ + /** + * The mode of the predictor to be used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.DynamicRetrievalConfig.Mode mode = 1; + */ + protected $mode = 0; + /** + * Optional. The threshold to be used in dynamic retrieval. + * If not set, a system default value is used. + * + * Generated from protobuf field optional float dynamic_threshold = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $dynamic_threshold = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $mode + * The mode of the predictor to be used in dynamic retrieval. + * @type float $dynamic_threshold + * Optional. The threshold to be used in dynamic retrieval. + * If not set, a system default value is used. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\Tool::initOnce(); + parent::__construct($data); + } + + /** + * The mode of the predictor to be used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.DynamicRetrievalConfig.Mode mode = 1; + * @return int + */ + public function getMode() + { + return $this->mode; + } + + /** + * The mode of the predictor to be used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.DynamicRetrievalConfig.Mode mode = 1; + * @param int $var + * @return $this + */ + public function setMode($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\DynamicRetrievalConfig\Mode::class); + $this->mode = $var; + + return $this; + } + + /** + * Optional. The threshold to be used in dynamic retrieval. + * If not set, a system default value is used. + * + * Generated from protobuf field optional float dynamic_threshold = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return float + */ + public function getDynamicThreshold() + { + return isset($this->dynamic_threshold) ? $this->dynamic_threshold : 0.0; + } + + public function hasDynamicThreshold() + { + return isset($this->dynamic_threshold); + } + + public function clearDynamicThreshold() + { + unset($this->dynamic_threshold); + } + + /** + * Optional. The threshold to be used in dynamic retrieval. + * If not set, a system default value is used. + * + * Generated from protobuf field optional float dynamic_threshold = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param float $var + * @return $this + */ + public function setDynamicThreshold($var) + { + GPBUtil::checkFloat($var); + $this->dynamic_threshold = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/DynamicRetrievalConfig/Mode.php b/AiPlatform/src/V1/DynamicRetrievalConfig/Mode.php new file mode 100644 index 000000000000..77641a620db8 --- /dev/null +++ b/AiPlatform/src/V1/DynamicRetrievalConfig/Mode.php @@ -0,0 +1,55 @@ +google.cloud.aiplatform.v1.DynamicRetrievalConfig.Mode + */ +class Mode +{ + /** + * Always trigger retrieval. + * + * Generated from protobuf enum MODE_UNSPECIFIED = 0; + */ + const MODE_UNSPECIFIED = 0; + /** + * Run retrieval only when system decides it is necessary. + * + * Generated from protobuf enum MODE_DYNAMIC = 1; + */ + const MODE_DYNAMIC = 1; + + private static $valueToName = [ + self::MODE_UNSPECIFIED => 'MODE_UNSPECIFIED', + self::MODE_DYNAMIC => 'MODE_DYNAMIC', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AiPlatform/src/V1/FeatureView/SyncConfig.php b/AiPlatform/src/V1/FeatureView/SyncConfig.php index 2d3ea23f9625..0c1f94be63a7 100644 --- a/AiPlatform/src/V1/FeatureView/SyncConfig.php +++ b/AiPlatform/src/V1/FeatureView/SyncConfig.php @@ -26,6 +26,13 @@ class SyncConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field string cron = 1; */ protected $cron = ''; + /** + * Optional. If true, syncs the FeatureView in a continuous manner to Online + * Store. + * + * Generated from protobuf field bool continuous = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $continuous = false; /** * Constructor. @@ -40,6 +47,9 @@ class SyncConfig extends \Google\Protobuf\Internal\Message * The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone * database. For example, "CRON_TZ=America/New_York 1 * * * *", or * "TZ=America/New_York 1 * * * *". + * @type bool $continuous + * Optional. If true, syncs the FeatureView in a continuous manner to Online + * Store. * } */ public function __construct($data = NULL) { @@ -83,6 +93,34 @@ public function setCron($var) return $this; } + /** + * Optional. If true, syncs the FeatureView in a continuous manner to Online + * Store. + * + * Generated from protobuf field bool continuous = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getContinuous() + { + return $this->continuous; + } + + /** + * Optional. If true, syncs the FeatureView in a continuous manner to Online + * Store. + * + * Generated from protobuf field bool continuous = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setContinuous($var) + { + GPBUtil::checkBool($var); + $this->continuous = $var; + + return $this; + } + } diff --git a/AiPlatform/src/V1/GoogleSearchRetrieval.php b/AiPlatform/src/V1/GoogleSearchRetrieval.php index cc36184fedd3..214e0c41028e 100644 --- a/AiPlatform/src/V1/GoogleSearchRetrieval.php +++ b/AiPlatform/src/V1/GoogleSearchRetrieval.php @@ -15,6 +15,12 @@ */ class GoogleSearchRetrieval extends \Google\Protobuf\Internal\Message { + /** + * Specifies the dynamic retrieval configuration for the given source. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.DynamicRetrievalConfig dynamic_retrieval_config = 2; + */ + protected $dynamic_retrieval_config = null; /** * Constructor. @@ -22,6 +28,8 @@ class GoogleSearchRetrieval extends \Google\Protobuf\Internal\Message * @param array $data { * Optional. Data for populating the Message object. * + * @type \Google\Cloud\AIPlatform\V1\DynamicRetrievalConfig $dynamic_retrieval_config + * Specifies the dynamic retrieval configuration for the given source. * } */ public function __construct($data = NULL) { @@ -29,5 +37,41 @@ public function __construct($data = NULL) { parent::__construct($data); } + /** + * Specifies the dynamic retrieval configuration for the given source. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.DynamicRetrievalConfig dynamic_retrieval_config = 2; + * @return \Google\Cloud\AIPlatform\V1\DynamicRetrievalConfig|null + */ + public function getDynamicRetrievalConfig() + { + return $this->dynamic_retrieval_config; + } + + public function hasDynamicRetrievalConfig() + { + return isset($this->dynamic_retrieval_config); + } + + public function clearDynamicRetrievalConfig() + { + unset($this->dynamic_retrieval_config); + } + + /** + * Specifies the dynamic retrieval configuration for the given source. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.DynamicRetrievalConfig dynamic_retrieval_config = 2; + * @param \Google\Cloud\AIPlatform\V1\DynamicRetrievalConfig $var + * @return $this + */ + public function setDynamicRetrievalConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\DynamicRetrievalConfig::class); + $this->dynamic_retrieval_config = $var; + + return $this; + } + } diff --git a/AiPlatform/src/V1/GroundingMetadata.php b/AiPlatform/src/V1/GroundingMetadata.php index 3fa308284dd7..8b7c22d3f7a7 100644 --- a/AiPlatform/src/V1/GroundingMetadata.php +++ b/AiPlatform/src/V1/GroundingMetadata.php @@ -39,6 +39,12 @@ class GroundingMetadata extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $grounding_supports; + /** + * Optional. Output only. Retrieval metadata. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $retrieval_metadata = null; /** * Constructor. @@ -54,6 +60,8 @@ class GroundingMetadata extends \Google\Protobuf\Internal\Message * List of supporting references retrieved from specified grounding source. * @type array<\Google\Cloud\AIPlatform\V1\GroundingSupport>|\Google\Protobuf\Internal\RepeatedField $grounding_supports * Optional. List of grounding support. + * @type \Google\Cloud\AIPlatform\V1\RetrievalMetadata $retrieval_metadata + * Optional. Output only. Retrieval metadata. * } */ public function __construct($data = NULL) { @@ -175,5 +183,41 @@ public function setGroundingSupports($var) return $this; } + /** + * Optional. Output only. Retrieval metadata. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\AIPlatform\V1\RetrievalMetadata|null + */ + public function getRetrievalMetadata() + { + return $this->retrieval_metadata; + } + + public function hasRetrievalMetadata() + { + return isset($this->retrieval_metadata); + } + + public function clearRetrievalMetadata() + { + unset($this->retrieval_metadata); + } + + /** + * Optional. Output only. Retrieval metadata. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\AIPlatform\V1\RetrievalMetadata $var + * @return $this + */ + public function setRetrievalMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\RetrievalMetadata::class); + $this->retrieval_metadata = $var; + + return $this; + } + } diff --git a/AiPlatform/src/V1/RetrievalMetadata.php b/AiPlatform/src/V1/RetrievalMetadata.php new file mode 100644 index 000000000000..8cf571a16f22 --- /dev/null +++ b/AiPlatform/src/V1/RetrievalMetadata.php @@ -0,0 +1,83 @@ +google.cloud.aiplatform.v1.RetrievalMetadata + */ +class RetrievalMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Score indicating how likely information from google search could + * help answer the prompt. The score is in the range `[0, 1]`, where 0 is the + * least likely and 1 is the most likely. This score is only populated when + * google search grounding and dynamic retrieval is enabled. It will be + * compared to the threshold to determine whether to trigger google search. + * + * Generated from protobuf field float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $google_search_dynamic_retrieval_score = 0.0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type float $google_search_dynamic_retrieval_score + * Optional. Score indicating how likely information from google search could + * help answer the prompt. The score is in the range `[0, 1]`, where 0 is the + * least likely and 1 is the most likely. This score is only populated when + * google search grounding and dynamic retrieval is enabled. It will be + * compared to the threshold to determine whether to trigger google search. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\Content::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Score indicating how likely information from google search could + * help answer the prompt. The score is in the range `[0, 1]`, where 0 is the + * least likely and 1 is the most likely. This score is only populated when + * google search grounding and dynamic retrieval is enabled. It will be + * compared to the threshold to determine whether to trigger google search. + * + * Generated from protobuf field float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return float + */ + public function getGoogleSearchDynamicRetrievalScore() + { + return $this->google_search_dynamic_retrieval_score; + } + + /** + * Optional. Score indicating how likely information from google search could + * help answer the prompt. The score is in the range `[0, 1]`, where 0 is the + * least likely and 1 is the most likely. This score is only populated when + * google search grounding and dynamic retrieval is enabled. It will be + * compared to the threshold to determine whether to trigger google search. + * + * Generated from protobuf field float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param float $var + * @return $this + */ + public function setGoogleSearchDynamicRetrievalScore($var) + { + GPBUtil::checkFloat($var); + $this->google_search_dynamic_retrieval_score = $var; + + return $this; + } + +} + From 061fec1d38d476d0d955acf7e2a5d09d8b1b1e2e Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:39:22 -0700 Subject: [PATCH 009/157] docs: adding some more information about supplemental data sources (#7726) PiperOrigin-RevId: 681900944 Source-Link: https://github.com/googleapis/googleapis/commit/78d1fb208e4af3022a0aaf27bafa578ff326326e Source-Link: https://github.com/googleapis/googleapis-gen/commit/19badfac8741859ca06f191977455b370e84e14b Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudERhdGFTb3VyY2VzLy5Pd2xCb3QueWFtbCIsImgiOiIxOWJhZGZhYzg3NDE4NTljYTA2ZjE5MTk3NzQ1NWIzNzBlODRlMTRiIn0= --- .../PrimaryProductDataSource/DefaultRule.php | 24 ++++++++++++------- .../V1beta/SupplementalProductDataSource.php | 7 +++++- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/ShoppingMerchantDataSources/src/V1beta/PrimaryProductDataSource/DefaultRule.php b/ShoppingMerchantDataSources/src/V1beta/PrimaryProductDataSource/DefaultRule.php index bb519afedb51..29179ed03b30 100644 --- a/ShoppingMerchantDataSources/src/V1beta/PrimaryProductDataSource/DefaultRule.php +++ b/ShoppingMerchantDataSources/src/V1beta/PrimaryProductDataSource/DefaultRule.php @@ -24,8 +24,10 @@ class DefaultRule extends \Google\Protobuf\Internal\Message * The list must not be empty. * To link the data source to the default rule, you need to add a * new reference to this list (in sequential order). - * To unlink the data source from the default rule, you need to - * remove the given reference from this list. + * To unlink the data source from the default rule, you need to remove the + * given reference from this list. To create attribute rules that are + * different from the default rule, see [Set up your attribute + * rules](//support.google.com/merchants/answer/14994083). * Changing the order of this list will result in changing the priority of * data sources in the default rule. * For example, providing the following list: [`1001`, `self`] will @@ -51,8 +53,10 @@ class DefaultRule extends \Google\Protobuf\Internal\Message * The list must not be empty. * To link the data source to the default rule, you need to add a * new reference to this list (in sequential order). - * To unlink the data source from the default rule, you need to - * remove the given reference from this list. + * To unlink the data source from the default rule, you need to remove the + * given reference from this list. To create attribute rules that are + * different from the default rule, see [Set up your attribute + * rules](//support.google.com/merchants/answer/14994083). * Changing the order of this list will result in changing the priority of * data sources in the default rule. * For example, providing the following list: [`1001`, `self`] will @@ -74,8 +78,10 @@ public function __construct($data = NULL) { * The list must not be empty. * To link the data source to the default rule, you need to add a * new reference to this list (in sequential order). - * To unlink the data source from the default rule, you need to - * remove the given reference from this list. + * To unlink the data source from the default rule, you need to remove the + * given reference from this list. To create attribute rules that are + * different from the default rule, see [Set up your attribute + * rules](//support.google.com/merchants/answer/14994083). * Changing the order of this list will result in changing the priority of * data sources in the default rule. * For example, providing the following list: [`1001`, `self`] will @@ -99,8 +105,10 @@ public function getTakeFromDataSources() * The list must not be empty. * To link the data source to the default rule, you need to add a * new reference to this list (in sequential order). - * To unlink the data source from the default rule, you need to - * remove the given reference from this list. + * To unlink the data source from the default rule, you need to remove the + * given reference from this list. To create attribute rules that are + * different from the default rule, see [Set up your attribute + * rules](//support.google.com/merchants/answer/14994083). * Changing the order of this list will result in changing the priority of * data sources in the default rule. * For example, providing the following list: [`1001`, `self`] will diff --git a/ShoppingMerchantDataSources/src/V1beta/SupplementalProductDataSource.php b/ShoppingMerchantDataSources/src/V1beta/SupplementalProductDataSource.php index 342d480790b7..9b74dcc9c2bd 100644 --- a/ShoppingMerchantDataSources/src/V1beta/SupplementalProductDataSource.php +++ b/ShoppingMerchantDataSources/src/V1beta/SupplementalProductDataSource.php @@ -9,7 +9,12 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The supplemental data source for local and online products. + * The supplemental data source for local and online products. Supplemental API + * data sources must not have `feedLabel` and `contentLanguage` fields set. You + * can only use supplemental data sources to update existing products. For + * information about creating a supplemental data source, see [Create a + * supplemental data source and link it to the primary data + * source](/merchant/api/guides/data-sources/overview#create-supplemental-data-source). * * Generated from protobuf message google.shopping.merchant.datasources.v1beta.SupplementalProductDataSource */ From aa62991dc2d9b7df26abbb19306564fabdffdee9 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:39:55 -0700 Subject: [PATCH 010/157] feat: Add support for primary_admin_email as customer_identity for ImportCustomer (#7727) feat: Add support for importing team customer from a different reseller feat: Add support to look up team customer Cloud Identity information docs: Clarify the expected value of the domain field for team type customers PiperOrigin-RevId: 682051698 Source-Link: https://github.com/googleapis/googleapis/commit/b6a27d13a2f0223051ef720e4e9d0d52323560e6 Source-Link: https://github.com/googleapis/googleapis-gen/commit/efd321b69d8e4032c2690c19e8131d7b1702f977 Copy-Tag: eyJwIjoiQ2hhbm5lbC8uT3dsQm90LnlhbWwiLCJoIjoiZWZkMzIxYjY5ZDhlNDAzMmMyNjkwYzE5ZTgxMzFkN2IxNzAyZjk3NyJ9 --- Channel/metadata/V1/Service.php | Bin 24151 -> 24345 bytes .../check_cloud_identity_accounts_exist.php | 4 +- ...CheckCloudIdentityAccountsExistRequest.php | 54 ++++++++++++- .../src/V1/CloudIdentityCustomerAccount.php | 72 ++++++++++++++++++ Channel/src/V1/ImportCustomerRequest.php | 33 ++++++++ 5 files changed, 158 insertions(+), 5 deletions(-) diff --git a/Channel/metadata/V1/Service.php b/Channel/metadata/V1/Service.php index 71319ee1a15dbad3afaf2751feef1f276169fc1b..7e02d5f6bc992a865e762c134476649dee8c976b 100644 GIT binary patch delta 200 zcmcb`vj>{DLPx5CCl5Ltp>^ delta 53 zcmV-50LuTFz5&;~0kA3t1=_Cx3MG?K2pF?R29^Q=Qj^{YQUW4+lT`_Nvq}o}0s)qj LKn+r}whd!Z^du5L diff --git a/Channel/samples/V1/CloudChannelServiceClient/check_cloud_identity_accounts_exist.php b/Channel/samples/V1/CloudChannelServiceClient/check_cloud_identity_accounts_exist.php index 4397b7e99b51..4485be4347b3 100644 --- a/Channel/samples/V1/CloudChannelServiceClient/check_cloud_identity_accounts_exist.php +++ b/Channel/samples/V1/CloudChannelServiceClient/check_cloud_identity_accounts_exist.php @@ -51,7 +51,9 @@ * * @param string $parent The reseller account's resource name. * Parent uses the format: accounts/{account_id} - * @param string $domain Domain to fetch for Cloud Identity account customer. + * @param string $domain Domain to fetch for Cloud Identity account customers, including + * domain and team customers. For team customers, please use the domain for + * their emails. */ function check_cloud_identity_accounts_exist_sample(string $parent, string $domain): void { diff --git a/Channel/src/V1/CheckCloudIdentityAccountsExistRequest.php b/Channel/src/V1/CheckCloudIdentityAccountsExistRequest.php index 519cdf4fcaed..39dde78e6f22 100644 --- a/Channel/src/V1/CheckCloudIdentityAccountsExistRequest.php +++ b/Channel/src/V1/CheckCloudIdentityAccountsExistRequest.php @@ -24,11 +24,20 @@ class CheckCloudIdentityAccountsExistRequest extends \Google\Protobuf\Internal\M */ protected $parent = ''; /** - * Required. Domain to fetch for Cloud Identity account customer. + * Required. Domain to fetch for Cloud Identity account customers, including + * domain and team customers. For team customers, please use the domain for + * their emails. * * Generated from protobuf field string domain = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $domain = ''; + /** + * Optional. Primary admin email to fetch for Cloud Identity account team + * customer. + * + * Generated from protobuf field string primary_admin_email = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $primary_admin_email = ''; /** * Constructor. @@ -40,7 +49,12 @@ class CheckCloudIdentityAccountsExistRequest extends \Google\Protobuf\Internal\M * Required. The reseller account's resource name. * Parent uses the format: accounts/{account_id} * @type string $domain - * Required. Domain to fetch for Cloud Identity account customer. + * Required. Domain to fetch for Cloud Identity account customers, including + * domain and team customers. For team customers, please use the domain for + * their emails. + * @type string $primary_admin_email + * Optional. Primary admin email to fetch for Cloud Identity account team + * customer. * } */ public function __construct($data = NULL) { @@ -77,7 +91,9 @@ public function setParent($var) } /** - * Required. Domain to fetch for Cloud Identity account customer. + * Required. Domain to fetch for Cloud Identity account customers, including + * domain and team customers. For team customers, please use the domain for + * their emails. * * Generated from protobuf field string domain = 2 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -88,7 +104,9 @@ public function getDomain() } /** - * Required. Domain to fetch for Cloud Identity account customer. + * Required. Domain to fetch for Cloud Identity account customers, including + * domain and team customers. For team customers, please use the domain for + * their emails. * * Generated from protobuf field string domain = 2 [(.google.api.field_behavior) = REQUIRED]; * @param string $var @@ -102,5 +120,33 @@ public function setDomain($var) return $this; } + /** + * Optional. Primary admin email to fetch for Cloud Identity account team + * customer. + * + * Generated from protobuf field string primary_admin_email = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPrimaryAdminEmail() + { + return $this->primary_admin_email; + } + + /** + * Optional. Primary admin email to fetch for Cloud Identity account team + * customer. + * + * Generated from protobuf field string primary_admin_email = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPrimaryAdminEmail($var) + { + GPBUtil::checkString($var, True); + $this->primary_admin_email = $var; + + return $this; + } + } diff --git a/Channel/src/V1/CloudIdentityCustomerAccount.php b/Channel/src/V1/CloudIdentityCustomerAccount.php index a49e1dea73ac..d0826c87fe24 100644 --- a/Channel/src/V1/CloudIdentityCustomerAccount.php +++ b/Channel/src/V1/CloudIdentityCustomerAccount.php @@ -44,6 +44,19 @@ class CloudIdentityCustomerAccount extends \Google\Protobuf\Internal\Message * Generated from protobuf field string customer_cloud_identity_id = 4; */ protected $customer_cloud_identity_id = ''; + /** + * If existing = true, the type of the customer. + * + * Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo.CustomerType customer_type = 5; + */ + protected $customer_type = 0; + /** + * If existing = true, and is 2-tier customer, the channel partner of the + * customer. + * + * Generated from protobuf field string channel_partner_cloud_identity_id = 6; + */ + protected $channel_partner_cloud_identity_id = ''; /** * Constructor. @@ -63,6 +76,11 @@ class CloudIdentityCustomerAccount extends \Google\Protobuf\Internal\Message * accounts/{account_id}/customers/{customer_id} * @type string $customer_cloud_identity_id * If existing = true, the Cloud Identity ID of the customer. + * @type int $customer_type + * If existing = true, the type of the customer. + * @type string $channel_partner_cloud_identity_id + * If existing = true, and is 2-tier customer, the channel partner of the + * customer. * } */ public function __construct($data = NULL) { @@ -182,5 +200,59 @@ public function setCustomerCloudIdentityId($var) return $this; } + /** + * If existing = true, the type of the customer. + * + * Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo.CustomerType customer_type = 5; + * @return int + */ + public function getCustomerType() + { + return $this->customer_type; + } + + /** + * If existing = true, the type of the customer. + * + * Generated from protobuf field .google.cloud.channel.v1.CloudIdentityInfo.CustomerType customer_type = 5; + * @param int $var + * @return $this + */ + public function setCustomerType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Channel\V1\CloudIdentityInfo\CustomerType::class); + $this->customer_type = $var; + + return $this; + } + + /** + * If existing = true, and is 2-tier customer, the channel partner of the + * customer. + * + * Generated from protobuf field string channel_partner_cloud_identity_id = 6; + * @return string + */ + public function getChannelPartnerCloudIdentityId() + { + return $this->channel_partner_cloud_identity_id; + } + + /** + * If existing = true, and is 2-tier customer, the channel partner of the + * customer. + * + * Generated from protobuf field string channel_partner_cloud_identity_id = 6; + * @param string $var + * @return $this + */ + public function setChannelPartnerCloudIdentityId($var) + { + GPBUtil::checkString($var, True); + $this->channel_partner_cloud_identity_id = $var; + + return $this; + } + } diff --git a/Channel/src/V1/ImportCustomerRequest.php b/Channel/src/V1/ImportCustomerRequest.php index b33687134d58..66b9c2eb6a15 100644 --- a/Channel/src/V1/ImportCustomerRequest.php +++ b/Channel/src/V1/ImportCustomerRequest.php @@ -70,6 +70,8 @@ class ImportCustomerRequest extends \Google\Protobuf\Internal\Message * Required. Customer domain. * @type string $cloud_identity_id * Required. Customer's Cloud Identity ID + * @type string $primary_admin_email + * Required. Customer's primary admin email. * @type string $parent * Required. The resource name of the reseller's account. * Parent takes the format: accounts/{account_id} or @@ -161,6 +163,37 @@ public function setCloudIdentityId($var) return $this; } + /** + * Required. Customer's primary admin email. + * + * Generated from protobuf field string primary_admin_email = 8 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getPrimaryAdminEmail() + { + return $this->readOneof(8); + } + + public function hasPrimaryAdminEmail() + { + return $this->hasOneof(8); + } + + /** + * Required. Customer's primary admin email. + * + * Generated from protobuf field string primary_admin_email = 8 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setPrimaryAdminEmail($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(8, $var); + + return $this; + } + /** * Required. The resource name of the reseller's account. * Parent takes the format: accounts/{account_id} or From 72a941468c6d3970fffef3da6ad9af05e5b3e2ab Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Sat, 5 Oct 2024 00:48:47 +0000 Subject: [PATCH 011/157] docs: minor documentation formatting fix for Parallelstore (#7722) PiperOrigin-RevId: 681538037 Source-Link: https://github.com/googleapis/googleapis/commit/917e347c536bec36446ac434455da0cb2e7ddf46 Source-Link: https://github.com/googleapis/googleapis-gen/commit/ed8a66ee826a7aaa27450e2d533eb325cb31b77f Copy-Tag: eyJwIjoiUGFyYWxsZWxzdG9yZS8uT3dsQm90LnlhbWwiLCJoIjoiZWQ4YTY2ZWU4MjZhN2FhYTI3NDUwZTJkNTMzZWIzMjVjYjMxYjc3ZiJ9 * docs: minor documentation formatting fix for Parallelstore PiperOrigin-RevId: 681948084 Source-Link: https://github.com/googleapis/googleapis/commit/3708fdf26f073ba5cb83c3f3a3778f701c80458d Source-Link: https://github.com/googleapis/googleapis-gen/commit/1a535dedd7a34b71f1aa1afdcb9f458594772c60 Copy-Tag: eyJwIjoiUGFyYWxsZWxzdG9yZS8uT3dsQm90LnlhbWwiLCJoIjoiMWE1MzVkZWRkN2EzNGI3MWYxYWExYWZkY2I5ZjQ1ODU5NDc3MmM2MCJ9 Co-authored-by: Brent Shaffer --- Parallelstore/src/V1beta/ExportDataRequest.php | 16 ++++++++-------- Parallelstore/src/V1beta/ImportDataRequest.php | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/Parallelstore/src/V1beta/ExportDataRequest.php b/Parallelstore/src/V1beta/ExportDataRequest.php index 2bb95ee6c34f..b5b2af48db2a 100644 --- a/Parallelstore/src/V1beta/ExportDataRequest.php +++ b/Parallelstore/src/V1beta/ExportDataRequest.php @@ -41,9 +41,9 @@ class ExportDataRequest extends \Google\Protobuf\Internal\Message * Optional. User-specified Service Account (SA) credentials to be used when * performing the transfer. * Use one of the following formats: - * * {EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` - * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` * If unspecified, the Parallelstore service agent is used: * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` * @@ -81,9 +81,9 @@ class ExportDataRequest extends \Google\Protobuf\Internal\Message * Optional. User-specified Service Account (SA) credentials to be used when * performing the transfer. * Use one of the following formats: - * * {EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` - * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` * If unspecified, the Parallelstore service agent is used: * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` * } @@ -231,9 +231,9 @@ public function setRequestId($var) * Optional. User-specified Service Account (SA) credentials to be used when * performing the transfer. * Use one of the following formats: - * * {EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` - * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` * If unspecified, the Parallelstore service agent is used: * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` * @@ -249,9 +249,9 @@ public function getServiceAccount() * Optional. User-specified Service Account (SA) credentials to be used when * performing the transfer. * Use one of the following formats: - * * {EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` - * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` * If unspecified, the Parallelstore service agent is used: * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` * diff --git a/Parallelstore/src/V1beta/ImportDataRequest.php b/Parallelstore/src/V1beta/ImportDataRequest.php index 8adf8e031c1e..7c2e0471a0dc 100644 --- a/Parallelstore/src/V1beta/ImportDataRequest.php +++ b/Parallelstore/src/V1beta/ImportDataRequest.php @@ -41,9 +41,9 @@ class ImportDataRequest extends \Google\Protobuf\Internal\Message * Optional. User-specified service account credentials to be used when * performing the transfer. * Use one of the following formats: - * * {EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` - * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` * If unspecified, the Parallelstore service agent is used: * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` * @@ -81,9 +81,9 @@ class ImportDataRequest extends \Google\Protobuf\Internal\Message * Optional. User-specified service account credentials to be used when * performing the transfer. * Use one of the following formats: - * * {EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` - * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` * If unspecified, the Parallelstore service agent is used: * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` * } @@ -231,9 +231,9 @@ public function setRequestId($var) * Optional. User-specified service account credentials to be used when * performing the transfer. * Use one of the following formats: - * * {EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` - * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` * If unspecified, the Parallelstore service agent is used: * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` * @@ -249,9 +249,9 @@ public function getServiceAccount() * Optional. User-specified service account credentials to be used when * performing the transfer. * Use one of the following formats: - * * {EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` - * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` * If unspecified, the Parallelstore service agent is used: * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` * From 3b7f251e0d73d9aa5c42a696a783f38087e3fbe1 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Sat, 5 Oct 2024 00:49:38 +0000 Subject: [PATCH 012/157] feat: add Builds API(#7725) docs: fixed formatting of some documentation feat: add Service Mesh configuration to Services feat: add GPU configuration to Services feat: add INGRESS_TRAFFIC_NONE to Services feat: add ServiceScaling to Services PiperOrigin-RevId: 681696446 Source-Link: https://github.com/googleapis/googleapis/commit/4fe2139be5d934a40005c41b9dc132a143457ad0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/cb5e78c3c478f81a8c813af5887757dc692052f3 Copy-Tag: eyJwIjoiUnVuLy5Pd2xCb3QueWFtbCIsImgiOiJjYjVlNzhjM2M0NzhmODFhOGM4MTNhZjU4ODc3NTdkYzY5MjA1MmYzIn0= Co-authored-by: Brent Shaffer --- Run/metadata/V2/Build.php | Bin 0 -> 2450 bytes Run/metadata/V2/Job.php | Bin 6706 -> 6807 bytes Run/metadata/V2/Revision.php | 10 +- Run/metadata/V2/RevisionTemplate.php | 11 +- Run/metadata/V2/Service.php | 12 +- Run/metadata/V2/VendorSettings.php | Bin 1909 -> 2442 bytes Run/samples/V2/BuildsClient/submit_build.php | 94 +++++ Run/src/V2/BinaryAuthorization.php | 10 +- Run/src/V2/Client/BuildsClient.php | 237 ++++++++++++ Run/src/V2/Client/JobsClient.php | 48 +++ Run/src/V2/Client/ServicesClient.php | 68 ++++ Run/src/V2/IngressTraffic.php | 7 + Run/src/V2/NodeSelector.php | 67 ++++ Run/src/V2/Revision.php | 88 +++++ Run/src/V2/RevisionScaling.php | 16 +- Run/src/V2/RevisionTemplate.php | 100 ++++- Run/src/V2/Service.php | 172 ++++++--- Run/src/V2/ServiceMesh.php | 76 ++++ Run/src/V2/ServiceScaling.php | 42 ++- Run/src/V2/ServiceScaling/ScalingMode.php | 63 ++++ Run/src/V2/StorageSource.php | 155 ++++++++ Run/src/V2/SubmitBuildRequest.php | 356 ++++++++++++++++++ .../V2/SubmitBuildRequest/BuildpacksBuild.php | 271 +++++++++++++ Run/src/V2/SubmitBuildRequest/DockerBuild.php | 34 ++ Run/src/V2/SubmitBuildResponse.php | 149 ++++++++ Run/src/V2/VpcAccess.php | 16 +- Run/src/V2/gapic_metadata.json | 14 + .../V2/resources/builds_client_config.json | 27 ++ .../V2/resources/builds_descriptor_config.php | 43 +++ .../resources/builds_rest_client_config.php | 88 +++++ .../V2/resources/jobs_descriptor_config.php | 3 + .../resources/services_descriptor_config.php | 4 + Run/tests/Unit/V2/Client/BuildsClientTest.php | 197 ++++++++++ .../Unit/V2/Client/ServicesClientTest.php | 10 + 34 files changed, 2400 insertions(+), 88 deletions(-) create mode 100644 Run/metadata/V2/Build.php create mode 100644 Run/samples/V2/BuildsClient/submit_build.php create mode 100644 Run/src/V2/Client/BuildsClient.php create mode 100644 Run/src/V2/NodeSelector.php create mode 100644 Run/src/V2/ServiceMesh.php create mode 100644 Run/src/V2/ServiceScaling/ScalingMode.php create mode 100644 Run/src/V2/StorageSource.php create mode 100644 Run/src/V2/SubmitBuildRequest.php create mode 100644 Run/src/V2/SubmitBuildRequest/BuildpacksBuild.php create mode 100644 Run/src/V2/SubmitBuildRequest/DockerBuild.php create mode 100644 Run/src/V2/SubmitBuildResponse.php create mode 100644 Run/src/V2/resources/builds_client_config.json create mode 100644 Run/src/V2/resources/builds_descriptor_config.php create mode 100644 Run/src/V2/resources/builds_rest_client_config.php create mode 100644 Run/tests/Unit/V2/Client/BuildsClientTest.php diff --git a/Run/metadata/V2/Build.php b/Run/metadata/V2/Build.php new file mode 100644 index 0000000000000000000000000000000000000000..d54649f835f7a54acab79d2e68ebac1315f85d5f GIT binary patch literal 2450 zcmb7G&u<$=6lR^qO~y$hHiEboh`|lSiP~M^N(DI$Xx$`jRUjd$ii9k!X4hkT$a-g) znROH*AK+i$#DzbFKY$}hoQuSX8&^)uk6nB7OHFfdRy*%~^WOK~_ufAIEEy!=4t$Jb z%#grc7@R;cz%XG{(2zzjNP9iZU`U4vi7;~@+}?v#{UT7636CVxFK7!^ivWFR(yeBv9wEcI!M+Zk>ZP?!0Jj0uV-s zbJ$ky;1odlm!v^NLdXRY^4}`qK8cASC?em>sJCDbMI1}di?+Qq4h5kxR1SM_h#TwB zU@F_ygvu?Z6N?a!0c^V7MVia|@F%KC@1ZDfuwAJckF`-MnX{=}0Dmc=E4HILl zbs@+tC|HV%w?oLVNLjq8<5mFU$y4VNn!JQ`yf~(c1sd~KYnsy(;wr~S5y7!|J)d2I zqi!1y(1=j>daegJYmI9M`8kdIvU6e*_d9!uYRIdT)OEY}Daoqjb-Rbkvln~k5ia^uPwH!_z^b|{ekkOPG+%9;sjEn5( zPIeSc6L#q&VPjPPxeV;XG#C=0b#Q>cOEDMrGAJjA$vCPOv>Nm6nU`M4_P{MJ8x-}i zZ%D6}*cP`1vIW(q+TDcnF$s6|DV4e&WK*~sUW(s`(mb8qea*urdRK20GKfWCM zLd1>^U%7Mr^u)5CfrTy&k1)#sXEosc>jG|T-yG~6u*5MNkr4YR3~4HvDd*u^l9|de zW$G#=^y*E0a`&ZY{pWoMR&}X$QrX?In%t4Y&iz_DDSg{-f*S($d36rX7{0CABB&IC zsQp<2OXsqbb-F2ANRT1U3RS9Fwv06&N4`KzjuKrcT}6EwqHuuyOA2AxD*yzDXNS55 znOh3p!tsbO8V_Y#_#?y!3L?y_vohdH^Q-I9dM*QJXA1fv$J~hpJ5eoT*&l!^j@3mz zN(CLNx$LKj9P09BRe(8dR@(%(uLQCyVCD#)7=r9YFgrp~iVY>L(kE7X4wOwlw-;pg zY909EB*FC`EUKGU})wfWb=aW+~$tFat@oGauSN-9SfBgMZ=|TM?wX9FgSlN>6TE)xV4L72pnZfSH z*erA2;#%M>YooUNn`f&jX+})0oZmfXAVk7ju6ulZeD2Vdtuip*2=|f*i5_Lc_OBLL zk&?SC>Ne19=%u`GeY0*-&u5yHX`kwE4SBiDKn9ZpoBH=3k6csT-X!1C>}g!c`!uIu q?3yv6CIWX)3o~ULl%=Df_tz#n=dM}wh3|qZzX`OZ+1+C>2H<}@%pJM_ literal 0 HcmV?d00001 diff --git a/Run/metadata/V2/Job.php b/Run/metadata/V2/Job.php index 086bf75692859de25f415a1a15b60f2b641e39a4..f04aa7b7517d80a67f221929ccd91e2fa22497c3 100644 GIT binary patch delta 68 zcmdmFGTn58AM@lRELxKrn0XhwGBdH9(&Unz+{h*}F`jdB8tX|$We`U&wIVgSv?Mb> UPp_aTza(Eu2PC@Lh3%a%0RF@lU;qFB delta 33 pcmbPky2)gNAM@ru=I@LwOEtM(3u*uW diff --git a/Run/metadata/V2/Revision.php b/Run/metadata/V2/Revision.php index 1ef84a040295..9d79c58305c9 100644 --- a/Run/metadata/V2/Revision.php +++ b/Run/metadata/V2/Revision.php @@ -29,7 +29,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -Â +´ "google/cloud/run/v2/revision.protogoogle.cloud.run.v2google/api/client.protogoogle/api/field_behavior.protogoogle/api/launch_stage.protogoogle/api/resource.protogoogle/api/routing.proto#google/cloud/run/v2/condition.proto!google/cloud/run/v2/k8s.min.proto google/cloud/run/v2/status.proto)google/cloud/run/v2/vendor_settings.proto#google/longrunning/operations.protogoogle/protobuf/duration.protogoogle/protobuf/timestamp.proto"G GetRevisionRequest1 name ( B#àAúA @@ -47,7 +47,7 @@ public static function initOnce() { name ( B#àAúA run.googleapis.com/Revision validate_only ( -etag ( "í +etag ( "ß Revision name ( BàA uid ( BàA @@ -74,7 +74,8 @@ public static function initOnce() { volumes ( 2.google.cloud.run.v2.VolumeH execution_environment (2).google.cloud.run.v2.ExecutionEnvironment> encryption_key ( B&úA# -!cloudkms.googleapis.com/CryptoKey\\ +!cloudkms.googleapis.com/CryptoKey6 + service_mesh ( 2 .google.cloud.run.v2.ServiceMesh\\ encryption_key_revocation_action (22.google.cloud.run.v2.EncryptionKeyRevocationActionC encryption_key_shutdown_duration ( 2.google.protobuf.Duration reconciling (BàA7 @@ -84,7 +85,8 @@ public static function initOnce() { log_uri! ( BàA satisfies_pzs% (BàA session_affinity& (G -scaling_status\' ( 2*.google.cloud.run.v2.RevisionScalingStatusBàA +scaling_status\' ( 2*.google.cloud.run.v2.RevisionScalingStatusBàA8 + node_selector( ( 2!.google.cloud.run.v2.NodeSelector etagc ( BàA- LabelsEntry key (  diff --git a/Run/metadata/V2/RevisionTemplate.php b/Run/metadata/V2/RevisionTemplate.php index 55ab1ab45ba0..51eb821e6f7a 100644 --- a/Run/metadata/V2/RevisionTemplate.php +++ b/Run/metadata/V2/RevisionTemplate.php @@ -21,8 +21,9 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Duration::initOnce(); $pool->internalAddGeneratedFile( ' -§ -+google/cloud/run/v2/revision_template.protogoogle.cloud.run.v2google/api/resource.proto!google/cloud/run/v2/k8s.min.proto)google/cloud/run/v2/vendor_settings.protogoogle/protobuf/duration.proto"ò +£ + ++google/cloud/run/v2/revision_template.protogoogle.cloud.run.v2google/api/resource.proto!google/cloud/run/v2/k8s.min.proto)google/cloud/run/v2/vendor_settings.protogoogle/protobuf/duration.proto"î RevisionTemplate5 revision ( B#àAúA run.googleapis.com/RevisionF @@ -40,9 +41,11 @@ public static function initOnce() { execution_environment (2).google.cloud.run.v2.ExecutionEnvironmentBàA> encryption_key ( B&úA# !cloudkms.googleapis.com/CryptoKey- - max_instance_request_concurrency (BàA + max_instance_request_concurrency (BàA; + service_mesh ( 2 .google.cloud.run.v2.ServiceMeshBàA session_affinity (BàA" -health_check_disabled (BàA- +health_check_disabled (BàA= + node_selector ( 2!.google.cloud.run.v2.NodeSelectorBàA- LabelsEntry key (  value ( :82 diff --git a/Run/metadata/V2/Service.php b/Run/metadata/V2/Service.php index b5a84216ba3f..784370ba87dd 100644 --- a/Run/metadata/V2/Service.php +++ b/Run/metadata/V2/Service.php @@ -31,7 +31,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -“% +É% !google/cloud/run/v2/service.protogoogle.cloud.run.v2google/api/client.protogoogle/api/field_behavior.protogoogle/api/launch_stage.protogoogle/api/resource.protogoogle/api/routing.proto#google/cloud/run/v2/condition.proto+google/cloud/run/v2/revision_template.proto(google/cloud/run/v2/traffic_target.proto)google/cloud/run/v2/vendor_settings.protogoogle/iam/v1/iam_policy.protogoogle/iam/v1/policy.proto#google/longrunning/operations.proto google/protobuf/field_mask.protogoogle/protobuf/timestamp.proto"® CreateServiceRequest2 parent ( B"àAúArun.googleapis.com/Service2 @@ -60,7 +60,7 @@ public static function initOnce() { name ( B"àAúA run.googleapis.com/Service validate_only ( -etag ( "Ê +etag ( "€ Service name (  description (  @@ -84,7 +84,10 @@ public static function initOnce() { template ( 2%.google.cloud.run.v2.RevisionTemplateBàA8 traffic ( 2".google.cloud.run.v2.TrafficTargetBàA9 scaling ( 2#.google.cloud.run.v2.ServiceScalingBàA! -default_uri_disabled (BàA +invoker_iam_disabled (BàA! +default_uri_disabled (BàA +urls ( BàA +custom_audiences% (  observed_generation (BàA? terminal_condition ( 2.google.cloud.run.v2.ConditionBàA7 @@ -94,8 +97,7 @@ public static function initOnce() { latest_created_revision" ( B#àAúA run.googleapis.com/RevisionG traffic_statuses# ( 2(.google.cloud.run.v2.TrafficTargetStatusBàA -uri$ ( BàA -custom_audiences% (  +uri$ ( BàA satisfies_pzs& (BàA reconcilingb (BàA etagc ( BàA- diff --git a/Run/metadata/V2/VendorSettings.php b/Run/metadata/V2/VendorSettings.php index 60b296955fad6e9eae3579b68a2fee50c825cd3f..c96bdb10ec7926db738b43f24ea381b84394ff92 100644 GIT binary patch delta 610 zcmey$*Co8cpNZ)c@8&?Jhm4FHCL6ODJ2`W)73Ak+CRa)@D==zsIvGB2Wc=l*&83-? znU`2pnOItqkzbTql~|IQpQo3epP!zSnpluote2dhs~-T?IJt^tlBX*dcW`P^S!Qyo zZ)$OdkQoYx%Tbj}IWM)OJijQr7^18g-7t_orK60Kd07qXg}k_Uijxy_ zGV{{obMsSD!EWO-(ueBNOU}tJP0=eV&C@G0(u3L?3{kHKrG0_goS1>0QE~%14I&2; z6O!SQ2zGY#@$_?#_w{#ijSuw;4sdn$bn|p|5nvGF<>GV0tlbT$TUnC^K#hsX(4CECh0=ZDX0dq+H#bk`ct3wXR{@sEw^%setBucket($storageSourceBucket) + ->setObject($storageSourceObject); + $request = (new SubmitBuildRequest()) + ->setParent($parent) + ->setStorageSource($storageSource) + ->setImageUri($imageUri); + + // Call the API and handle any network failures. + try { + /** @var SubmitBuildResponse $response */ + $response = $buildsClient->submitBuild($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $parent = '[PARENT]'; + $storageSourceBucket = '[BUCKET]'; + $storageSourceObject = '[OBJECT]'; + $imageUri = '[IMAGE_URI]'; + + submit_build_sample($parent, $storageSourceBucket, $storageSourceObject, $imageUri); +} +// [END run_v2_generated_Builds_SubmitBuild_sync] diff --git a/Run/src/V2/BinaryAuthorization.php b/Run/src/V2/BinaryAuthorization.php index a5e1fdc009fb..c0169d3c5d71 100644 --- a/Run/src/V2/BinaryAuthorization.php +++ b/Run/src/V2/BinaryAuthorization.php @@ -37,7 +37,7 @@ class BinaryAuthorization extends \Google\Protobuf\Internal\Message * authorization policy. If False, binary authorization will be disabled. * @type string $policy * Optional. The path to a binary authorization policy. - * Format: projects/{project}/platforms/cloudRun/{policy-name} + * Format: `projects/{project}/platforms/cloudRun/{policy-name}` * @type string $breakglass_justification * Optional. If present, indicates to use Breakglass using this justification. * If use_default is False, then it must be empty. @@ -85,9 +85,9 @@ public function setUseDefault($var) /** * Optional. The path to a binary authorization policy. - * Format: projects/{project}/platforms/cloudRun/{policy-name} + * Format: `projects/{project}/platforms/cloudRun/{policy-name}` * - * Generated from protobuf field string policy = 3 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field string policy = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string */ public function getPolicy() @@ -102,9 +102,9 @@ public function hasPolicy() /** * Optional. The path to a binary authorization policy. - * Format: projects/{project}/platforms/cloudRun/{policy-name} + * Format: `projects/{project}/platforms/cloudRun/{policy-name}` * - * Generated from protobuf field string policy = 3 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field string policy = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var * @return $this */ diff --git a/Run/src/V2/Client/BuildsClient.php b/Run/src/V2/Client/BuildsClient.php new file mode 100644 index 000000000000..f801387ac125 --- /dev/null +++ b/Run/src/V2/Client/BuildsClient.php @@ -0,0 +1,237 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/builds_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/builds_descriptor_config.php', + 'gcpApiConfigPath' => __DIR__ . '/../resources/builds_grpc_config.json', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/builds_rest_client_config.php', + ], + ], + ]; + } + + /** + * Formats a string containing the fully-qualified path to represent a worker_pool + * resource. + * + * @param string $project + * @param string $location + * @param string $workerPool + * + * @return string The formatted worker_pool resource. + */ + public static function workerPoolName(string $project, string $location, string $workerPool): string + { + return self::getPathTemplate('workerPool')->render([ + 'project' => $project, + 'location' => $location, + 'worker_pool' => $workerPool, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - workerPool: projects/{project}/locations/{location}/workerPools/{worker_pool} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'run.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. May be either the string + * `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. + * *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'grpc' => [...], + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and + * {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * Submits a build in a given project. + * + * The async variant is {@see BuildsClient::submitBuildAsync()} . + * + * @example samples/V2/BuildsClient/submit_build.php + * + * @param SubmitBuildRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return SubmitBuildResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function submitBuild(SubmitBuildRequest $request, array $callOptions = []): SubmitBuildResponse + { + return $this->startApiCall('SubmitBuild', $request, $callOptions)->wait(); + } +} diff --git a/Run/src/V2/Client/JobsClient.php b/Run/src/V2/Client/JobsClient.php index 570ee809b563..8cd57be3122d 100644 --- a/Run/src/V2/Client/JobsClient.php +++ b/Run/src/V2/Client/JobsClient.php @@ -267,6 +267,51 @@ public static function locationName(string $project, string $location): string ]); } + /** + * Formats a string containing the fully-qualified path to represent a + * location_policy resource. + * + * @param string $location + * + * @return string The formatted location_policy resource. + */ + public static function locationPolicyName(string $location): string + { + return self::getPathTemplate('locationPolicy')->render([ + 'location' => $location, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a policy + * resource. + * + * @param string $project + * + * @return string The formatted policy resource. + */ + public static function policyName(string $project): string + { + return self::getPathTemplate('policy')->render([ + 'project' => $project, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * project_policy resource. + * + * @param string $project + * + * @return string The formatted project_policy resource. + */ + public static function projectPolicyName(string $project): string + { + return self::getPathTemplate('projectPolicy')->render([ + 'project' => $project, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a secret * resource. @@ -312,6 +357,9 @@ public static function secretVersionName(string $project, string $secret, string * - execution: projects/{project}/locations/{location}/jobs/{job}/executions/{execution} * - job: projects/{project}/locations/{location}/jobs/{job} * - location: projects/{project}/locations/{location} + * - locationPolicy: locations/{location}/policy + * - policy: projects/{project}/policy + * - projectPolicy: projects/{project}/policy * - secret: projects/{project}/secrets/{secret} * - secretVersion: projects/{project}/secrets/{secret}/versions/{version} * diff --git a/Run/src/V2/Client/ServicesClient.php b/Run/src/V2/Client/ServicesClient.php index 794121b04e1c..d6e89a0c64dd 100644 --- a/Run/src/V2/Client/ServicesClient.php +++ b/Run/src/V2/Client/ServicesClient.php @@ -224,6 +224,70 @@ public static function locationName(string $project, string $location): string ]); } + /** + * Formats a string containing the fully-qualified path to represent a + * location_policy resource. + * + * @param string $location + * + * @return string The formatted location_policy resource. + */ + public static function locationPolicyName(string $location): string + { + return self::getPathTemplate('locationPolicy')->render([ + 'location' => $location, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a mesh + * resource. + * + * @param string $project + * @param string $location + * @param string $mesh + * + * @return string The formatted mesh resource. + */ + public static function meshName(string $project, string $location, string $mesh): string + { + return self::getPathTemplate('mesh')->render([ + 'project' => $project, + 'location' => $location, + 'mesh' => $mesh, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a policy + * resource. + * + * @param string $project + * + * @return string The formatted policy resource. + */ + public static function policyName(string $project): string + { + return self::getPathTemplate('policy')->render([ + 'project' => $project, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * project_policy resource. + * + * @param string $project + * + * @return string The formatted project_policy resource. + */ + public static function projectPolicyName(string $project): string + { + return self::getPathTemplate('projectPolicy')->render([ + 'project' => $project, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a revision * resource. @@ -307,6 +371,10 @@ public static function serviceName(string $project, string $location, string $se * - connector: projects/{project}/locations/{location}/connectors/{connector} * - cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} * - location: projects/{project}/locations/{location} + * - locationPolicy: locations/{location}/policy + * - mesh: projects/{project}/locations/{location}/meshes/{mesh} + * - policy: projects/{project}/policy + * - projectPolicy: projects/{project}/policy * - revision: projects/{project}/locations/{location}/services/{service}/revisions/{revision} * - secret: projects/{project}/secrets/{secret} * - secretVersion: projects/{project}/secrets/{secret}/versions/{version} diff --git a/Run/src/V2/IngressTraffic.php b/Run/src/V2/IngressTraffic.php index 4bcff9e224cb..c9e391f2e464 100644 --- a/Run/src/V2/IngressTraffic.php +++ b/Run/src/V2/IngressTraffic.php @@ -37,12 +37,19 @@ class IngressTraffic * Generated from protobuf enum INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER = 3; */ const INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER = 3; + /** + * No ingress traffic is allowed. + * + * Generated from protobuf enum INGRESS_TRAFFIC_NONE = 4; + */ + const INGRESS_TRAFFIC_NONE = 4; private static $valueToName = [ self::INGRESS_TRAFFIC_UNSPECIFIED => 'INGRESS_TRAFFIC_UNSPECIFIED', self::INGRESS_TRAFFIC_ALL => 'INGRESS_TRAFFIC_ALL', self::INGRESS_TRAFFIC_INTERNAL_ONLY => 'INGRESS_TRAFFIC_INTERNAL_ONLY', self::INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER => 'INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER', + self::INGRESS_TRAFFIC_NONE => 'INGRESS_TRAFFIC_NONE', ]; public static function name($value) diff --git a/Run/src/V2/NodeSelector.php b/Run/src/V2/NodeSelector.php new file mode 100644 index 000000000000..54fd94337d57 --- /dev/null +++ b/Run/src/V2/NodeSelector.php @@ -0,0 +1,67 @@ +google.cloud.run.v2.NodeSelector + */ +class NodeSelector extends \Google\Protobuf\Internal\Message +{ + /** + * Required. GPU accelerator type to attach to an instance. + * + * Generated from protobuf field string accelerator = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $accelerator = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $accelerator + * Required. GPU accelerator type to attach to an instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Run\V2\VendorSettings::initOnce(); + parent::__construct($data); + } + + /** + * Required. GPU accelerator type to attach to an instance. + * + * Generated from protobuf field string accelerator = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getAccelerator() + { + return $this->accelerator; + } + + /** + * Required. GPU accelerator type to attach to an instance. + * + * Generated from protobuf field string accelerator = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setAccelerator($var) + { + GPBUtil::checkString($var, True); + $this->accelerator = $var; + + return $this; + } + +} + diff --git a/Run/src/V2/Revision.php b/Run/src/V2/Revision.php index 18c074852e0b..f3bdf65355ab 100644 --- a/Run/src/V2/Revision.php +++ b/Run/src/V2/Revision.php @@ -164,6 +164,12 @@ class Revision extends \Google\Protobuf\Internal\Message * Generated from protobuf field string encryption_key = 21 [(.google.api.resource_reference) = { */ protected $encryption_key = ''; + /** + * Enables service mesh connectivity. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceMesh service_mesh = 22; + */ + protected $service_mesh = null; /** * The action to take if the encryption key is revoked. * @@ -225,6 +231,12 @@ class Revision extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.run.v2.RevisionScalingStatus scaling_status = 39 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $scaling_status = null; + /** + * The node selector for the revision. + * + * Generated from protobuf field .google.cloud.run.v2.NodeSelector node_selector = 40; + */ + protected $node_selector = null; /** * Output only. A system-generated fingerprint for this version of the * resource. May be used to detect modification conflict during updates. @@ -306,6 +318,8 @@ class Revision extends \Google\Protobuf\Internal\Message * A reference to a customer managed encryption key (CMEK) to use to encrypt * this container image. For more information, go to * https://cloud.google.com/run/docs/securing/using-cmek + * @type \Google\Cloud\Run\V2\ServiceMesh $service_mesh + * Enables service mesh connectivity. * @type int $encryption_key_revocation_action * The action to take if the encryption key is revoked. * @type \Google\Protobuf\Duration $encryption_key_shutdown_duration @@ -331,6 +345,8 @@ class Revision extends \Google\Protobuf\Internal\Message * Enable session affinity. * @type \Google\Cloud\Run\V2\RevisionScalingStatus $scaling_status * Output only. The current effective scaling settings for the revision. + * @type \Google\Cloud\Run\V2\NodeSelector $node_selector + * The node selector for the revision. * @type string $etag * Output only. A system-generated fingerprint for this version of the * resource. May be used to detect modification conflict during updates. @@ -985,6 +1001,42 @@ public function setEncryptionKey($var) return $this; } + /** + * Enables service mesh connectivity. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceMesh service_mesh = 22; + * @return \Google\Cloud\Run\V2\ServiceMesh|null + */ + public function getServiceMesh() + { + return $this->service_mesh; + } + + public function hasServiceMesh() + { + return isset($this->service_mesh); + } + + public function clearServiceMesh() + { + unset($this->service_mesh); + } + + /** + * Enables service mesh connectivity. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceMesh service_mesh = 22; + * @param \Google\Cloud\Run\V2\ServiceMesh $var + * @return $this + */ + public function setServiceMesh($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Run\V2\ServiceMesh::class); + $this->service_mesh = $var; + + return $this; + } + /** * The action to take if the encryption key is revoked. * @@ -1253,6 +1305,42 @@ public function setScalingStatus($var) return $this; } + /** + * The node selector for the revision. + * + * Generated from protobuf field .google.cloud.run.v2.NodeSelector node_selector = 40; + * @return \Google\Cloud\Run\V2\NodeSelector|null + */ + public function getNodeSelector() + { + return $this->node_selector; + } + + public function hasNodeSelector() + { + return isset($this->node_selector); + } + + public function clearNodeSelector() + { + unset($this->node_selector); + } + + /** + * The node selector for the revision. + * + * Generated from protobuf field .google.cloud.run.v2.NodeSelector node_selector = 40; + * @param \Google\Cloud\Run\V2\NodeSelector $var + * @return $this + */ + public function setNodeSelector($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Run\V2\NodeSelector::class); + $this->node_selector = $var; + + return $this; + } + /** * Output only. A system-generated fingerprint for this version of the * resource. May be used to detect modification conflict during updates. diff --git a/Run/src/V2/RevisionScaling.php b/Run/src/V2/RevisionScaling.php index 892c5df3338c..5536c70fe0a4 100644 --- a/Run/src/V2/RevisionScaling.php +++ b/Run/src/V2/RevisionScaling.php @@ -24,7 +24,9 @@ class RevisionScaling extends \Google\Protobuf\Internal\Message protected $min_instance_count = 0; /** * Optional. Maximum number of serving instances that this resource should - * have. + * have. When unspecified, the field is set to the server default value of + * 100. For more information see + * https://cloud.google.com/run/docs/configuring/max-instances * * Generated from protobuf field int32 max_instance_count = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -41,7 +43,9 @@ class RevisionScaling extends \Google\Protobuf\Internal\Message * have. * @type int $max_instance_count * Optional. Maximum number of serving instances that this resource should - * have. + * have. When unspecified, the field is set to the server default value of + * 100. For more information see + * https://cloud.google.com/run/docs/configuring/max-instances * } */ public function __construct($data = NULL) { @@ -79,7 +83,9 @@ public function setMinInstanceCount($var) /** * Optional. Maximum number of serving instances that this resource should - * have. + * have. When unspecified, the field is set to the server default value of + * 100. For more information see + * https://cloud.google.com/run/docs/configuring/max-instances * * Generated from protobuf field int32 max_instance_count = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -91,7 +97,9 @@ public function getMaxInstanceCount() /** * Optional. Maximum number of serving instances that this resource should - * have. + * have. When unspecified, the field is set to the server default value of + * 100. For more information see + * https://cloud.google.com/run/docs/configuring/max-instances * * Generated from protobuf field int32 max_instance_count = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var diff --git a/Run/src/V2/RevisionTemplate.php b/Run/src/V2/RevisionTemplate.php index 868e51c42159..4ba3f6a2eb08 100644 --- a/Run/src/V2/RevisionTemplate.php +++ b/Run/src/V2/RevisionTemplate.php @@ -110,11 +110,18 @@ class RevisionTemplate extends \Google\Protobuf\Internal\Message protected $encryption_key = ''; /** * Optional. Sets the maximum number of requests that each serving instance - * can receive. + * can receive. If not specified or 0, defaults to 80 when requested + * `CPU >= 1` and defaults to 1 when requested `CPU < 1`. * * Generated from protobuf field int32 max_instance_request_concurrency = 15 [(.google.api.field_behavior) = OPTIONAL]; */ protected $max_instance_request_concurrency = 0; + /** + * Optional. Enables service mesh connectivity. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceMesh service_mesh = 16 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $service_mesh = null; /** * Optional. Enable session affinity. * @@ -127,6 +134,12 @@ class RevisionTemplate extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool health_check_disabled = 20 [(.google.api.field_behavior) = OPTIONAL]; */ protected $health_check_disabled = false; + /** + * Optional. The node selector for the revision template. + * + * Generated from protobuf field .google.cloud.run.v2.NodeSelector node_selector = 21 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $node_selector = null; /** * Constructor. @@ -184,11 +197,16 @@ class RevisionTemplate extends \Google\Protobuf\Internal\Message * https://cloud.google.com/run/docs/securing/using-cmek * @type int $max_instance_request_concurrency * Optional. Sets the maximum number of requests that each serving instance - * can receive. + * can receive. If not specified or 0, defaults to 80 when requested + * `CPU >= 1` and defaults to 1 when requested `CPU < 1`. + * @type \Google\Cloud\Run\V2\ServiceMesh $service_mesh + * Optional. Enables service mesh connectivity. * @type bool $session_affinity * Optional. Enable session affinity. * @type bool $health_check_disabled * Optional. Disables health checking containers during deployment. + * @type \Google\Cloud\Run\V2\NodeSelector $node_selector + * Optional. The node selector for the revision template. * } */ public function __construct($data = NULL) { @@ -566,7 +584,8 @@ public function setEncryptionKey($var) /** * Optional. Sets the maximum number of requests that each serving instance - * can receive. + * can receive. If not specified or 0, defaults to 80 when requested + * `CPU >= 1` and defaults to 1 when requested `CPU < 1`. * * Generated from protobuf field int32 max_instance_request_concurrency = 15 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -578,7 +597,8 @@ public function getMaxInstanceRequestConcurrency() /** * Optional. Sets the maximum number of requests that each serving instance - * can receive. + * can receive. If not specified or 0, defaults to 80 when requested + * `CPU >= 1` and defaults to 1 when requested `CPU < 1`. * * Generated from protobuf field int32 max_instance_request_concurrency = 15 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -592,6 +612,42 @@ public function setMaxInstanceRequestConcurrency($var) return $this; } + /** + * Optional. Enables service mesh connectivity. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceMesh service_mesh = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Run\V2\ServiceMesh|null + */ + public function getServiceMesh() + { + return $this->service_mesh; + } + + public function hasServiceMesh() + { + return isset($this->service_mesh); + } + + public function clearServiceMesh() + { + unset($this->service_mesh); + } + + /** + * Optional. Enables service mesh connectivity. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceMesh service_mesh = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Run\V2\ServiceMesh $var + * @return $this + */ + public function setServiceMesh($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Run\V2\ServiceMesh::class); + $this->service_mesh = $var; + + return $this; + } + /** * Optional. Enable session affinity. * @@ -644,5 +700,41 @@ public function setHealthCheckDisabled($var) return $this; } + /** + * Optional. The node selector for the revision template. + * + * Generated from protobuf field .google.cloud.run.v2.NodeSelector node_selector = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Run\V2\NodeSelector|null + */ + public function getNodeSelector() + { + return $this->node_selector; + } + + public function hasNodeSelector() + { + return isset($this->node_selector); + } + + public function clearNodeSelector() + { + unset($this->node_selector); + } + + /** + * Optional. The node selector for the revision template. + * + * Generated from protobuf field .google.cloud.run.v2.NodeSelector node_selector = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Run\V2\NodeSelector $var + * @return $this + */ + public function setNodeSelector($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Run\V2\NodeSelector::class); + $this->node_selector = $var; + + return $this; + } + } diff --git a/Run/src/V2/Service.php b/Run/src/V2/Service.php index 379f89b04695..ad7d6330dc2a 100644 --- a/Run/src/V2/Service.php +++ b/Run/src/V2/Service.php @@ -181,12 +181,35 @@ class Service extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL]; */ protected $scaling = null; + /** + * Optional. Disables IAM permission check for run.routes.invoke for callers + * of this service. This setting should not be used with external ingress. + * + * Generated from protobuf field bool invoker_iam_disabled = 21 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $invoker_iam_disabled = false; /** * Optional. Disables public resolution of the default URI of this service. * * Generated from protobuf field bool default_uri_disabled = 22 [(.google.api.field_behavior) = OPTIONAL]; */ protected $default_uri_disabled = false; + /** + * Output only. All URLs serving traffic for this Service. + * + * Generated from protobuf field repeated string urls = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $urls; + /** + * One or more custom audiences that you want this service to support. Specify + * each custom audience as the full URL in a string. The custom audiences are + * encoded in the token and used to authenticate requests. For more + * information, see + * https://cloud.google.com/run/docs/configuring/custom-audiences. + * + * Generated from protobuf field repeated string custom_audiences = 37; + */ + private $custom_audiences; /** * Output only. The generation of this Service currently serving traffic. See * comments in `reconciling` for additional information on reconciliation @@ -245,16 +268,6 @@ class Service extends \Google\Protobuf\Internal\Message * Generated from protobuf field string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $uri = ''; - /** - * One or more custom audiences that you want this service to support. Specify - * each custom audience as the full URL in a string. The custom audiences are - * encoded in the token and used to authenticate requests. For more - * information, see - * https://cloud.google.com/run/docs/configuring/custom-audiences. - * - * Generated from protobuf field repeated string custom_audiences = 37; - */ - private $custom_audiences; /** * Output only. Reserved for future use. * @@ -381,8 +394,19 @@ class Service extends \Google\Protobuf\Internal\Message * defaults to 100% traffic to the latest `Ready` Revision. * @type \Google\Cloud\Run\V2\ServiceScaling $scaling * Optional. Specifies service-level scaling settings + * @type bool $invoker_iam_disabled + * Optional. Disables IAM permission check for run.routes.invoke for callers + * of this service. This setting should not be used with external ingress. * @type bool $default_uri_disabled * Optional. Disables public resolution of the default URI of this service. + * @type array|\Google\Protobuf\Internal\RepeatedField $urls + * Output only. All URLs serving traffic for this Service. + * @type array|\Google\Protobuf\Internal\RepeatedField $custom_audiences + * One or more custom audiences that you want this service to support. Specify + * each custom audience as the full URL in a string. The custom audiences are + * encoded in the token and used to authenticate requests. For more + * information, see + * https://cloud.google.com/run/docs/configuring/custom-audiences. * @type int|string $observed_generation * Output only. The generation of this Service currently serving traffic. See * comments in `reconciling` for additional information on reconciliation @@ -413,12 +437,6 @@ class Service extends \Google\Protobuf\Internal\Message * process in Cloud Run. * @type string $uri * Output only. The main URI in which this Service is serving traffic. - * @type array|\Google\Protobuf\Internal\RepeatedField $custom_audiences - * One or more custom audiences that you want this service to support. Specify - * each custom audience as the full URL in a string. The custom audiences are - * encoded in the token and used to authenticate requests. For more - * information, see - * https://cloud.google.com/run/docs/configuring/custom-audiences. * @type bool $satisfies_pzs * Output only. Reserved for future use. * @type bool $reconciling @@ -1125,6 +1143,34 @@ public function setScaling($var) return $this; } + /** + * Optional. Disables IAM permission check for run.routes.invoke for callers + * of this service. This setting should not be used with external ingress. + * + * Generated from protobuf field bool invoker_iam_disabled = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getInvokerIamDisabled() + { + return $this->invoker_iam_disabled; + } + + /** + * Optional. Disables IAM permission check for run.routes.invoke for callers + * of this service. This setting should not be used with external ingress. + * + * Generated from protobuf field bool invoker_iam_disabled = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setInvokerIamDisabled($var) + { + GPBUtil::checkBool($var); + $this->invoker_iam_disabled = $var; + + return $this; + } + /** * Optional. Disables public resolution of the default URI of this service. * @@ -1151,6 +1197,66 @@ public function setDefaultUriDisabled($var) return $this; } + /** + * Output only. All URLs serving traffic for this Service. + * + * Generated from protobuf field repeated string urls = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUrls() + { + return $this->urls; + } + + /** + * Output only. All URLs serving traffic for this Service. + * + * Generated from protobuf field repeated string urls = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUrls($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->urls = $arr; + + return $this; + } + + /** + * One or more custom audiences that you want this service to support. Specify + * each custom audience as the full URL in a string. The custom audiences are + * encoded in the token and used to authenticate requests. For more + * information, see + * https://cloud.google.com/run/docs/configuring/custom-audiences. + * + * Generated from protobuf field repeated string custom_audiences = 37; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCustomAudiences() + { + return $this->custom_audiences; + } + + /** + * One or more custom audiences that you want this service to support. Specify + * each custom audience as the full URL in a string. The custom audiences are + * encoded in the token and used to authenticate requests. For more + * information, see + * https://cloud.google.com/run/docs/configuring/custom-audiences. + * + * Generated from protobuf field repeated string custom_audiences = 37; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCustomAudiences($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->custom_audiences = $arr; + + return $this; + } + /** * Output only. The generation of this Service currently serving traffic. See * comments in `reconciling` for additional information on reconciliation @@ -1375,40 +1481,6 @@ public function setUri($var) return $this; } - /** - * One or more custom audiences that you want this service to support. Specify - * each custom audience as the full URL in a string. The custom audiences are - * encoded in the token and used to authenticate requests. For more - * information, see - * https://cloud.google.com/run/docs/configuring/custom-audiences. - * - * Generated from protobuf field repeated string custom_audiences = 37; - * @return \Google\Protobuf\Internal\RepeatedField - */ - public function getCustomAudiences() - { - return $this->custom_audiences; - } - - /** - * One or more custom audiences that you want this service to support. Specify - * each custom audience as the full URL in a string. The custom audiences are - * encoded in the token and used to authenticate requests. For more - * information, see - * https://cloud.google.com/run/docs/configuring/custom-audiences. - * - * Generated from protobuf field repeated string custom_audiences = 37; - * @param array|\Google\Protobuf\Internal\RepeatedField $var - * @return $this - */ - public function setCustomAudiences($var) - { - $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); - $this->custom_audiences = $arr; - - return $this; - } - /** * Output only. Reserved for future use. * diff --git a/Run/src/V2/ServiceMesh.php b/Run/src/V2/ServiceMesh.php new file mode 100644 index 000000000000..19cd1b0263c1 --- /dev/null +++ b/Run/src/V2/ServiceMesh.php @@ -0,0 +1,76 @@ +google.cloud.run.v2.ServiceMesh + */ +class ServiceMesh extends \Google\Protobuf\Internal\Message +{ + /** + * The Mesh resource name. Format: + * `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can + * be project id or number. + * + * Generated from protobuf field string mesh = 1 [(.google.api.resource_reference) = { + */ + protected $mesh = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $mesh + * The Mesh resource name. Format: + * `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can + * be project id or number. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Run\V2\VendorSettings::initOnce(); + parent::__construct($data); + } + + /** + * The Mesh resource name. Format: + * `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can + * be project id or number. + * + * Generated from protobuf field string mesh = 1 [(.google.api.resource_reference) = { + * @return string + */ + public function getMesh() + { + return $this->mesh; + } + + /** + * The Mesh resource name. Format: + * `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can + * be project id or number. + * + * Generated from protobuf field string mesh = 1 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setMesh($var) + { + GPBUtil::checkString($var, True); + $this->mesh = $var; + + return $this; + } + +} + diff --git a/Run/src/V2/ServiceScaling.php b/Run/src/V2/ServiceScaling.php index e8bad225cc66..eff3cf1badc1 100644 --- a/Run/src/V2/ServiceScaling.php +++ b/Run/src/V2/ServiceScaling.php @@ -19,11 +19,17 @@ class ServiceScaling extends \Google\Protobuf\Internal\Message /** * Optional. total min instances for the service. This number of instances is * divided among all revisions with specified traffic based on the percent - * of traffic they are receiving. (BETA) + * of traffic they are receiving. * * Generated from protobuf field int32 min_instance_count = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $min_instance_count = 0; + /** + * Optional. The scaling mode for the service. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceScaling.ScalingMode scaling_mode = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $scaling_mode = 0; /** * Constructor. @@ -34,7 +40,9 @@ class ServiceScaling extends \Google\Protobuf\Internal\Message * @type int $min_instance_count * Optional. total min instances for the service. This number of instances is * divided among all revisions with specified traffic based on the percent - * of traffic they are receiving. (BETA) + * of traffic they are receiving. + * @type int $scaling_mode + * Optional. The scaling mode for the service. * } */ public function __construct($data = NULL) { @@ -45,7 +53,7 @@ public function __construct($data = NULL) { /** * Optional. total min instances for the service. This number of instances is * divided among all revisions with specified traffic based on the percent - * of traffic they are receiving. (BETA) + * of traffic they are receiving. * * Generated from protobuf field int32 min_instance_count = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -58,7 +66,7 @@ public function getMinInstanceCount() /** * Optional. total min instances for the service. This number of instances is * divided among all revisions with specified traffic based on the percent - * of traffic they are receiving. (BETA) + * of traffic they are receiving. * * Generated from protobuf field int32 min_instance_count = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -72,5 +80,31 @@ public function setMinInstanceCount($var) return $this; } + /** + * Optional. The scaling mode for the service. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceScaling.ScalingMode scaling_mode = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getScalingMode() + { + return $this->scaling_mode; + } + + /** + * Optional. The scaling mode for the service. + * + * Generated from protobuf field .google.cloud.run.v2.ServiceScaling.ScalingMode scaling_mode = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setScalingMode($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Run\V2\ServiceScaling\ScalingMode::class); + $this->scaling_mode = $var; + + return $this; + } + } diff --git a/Run/src/V2/ServiceScaling/ScalingMode.php b/Run/src/V2/ServiceScaling/ScalingMode.php new file mode 100644 index 000000000000..3df73f6e4af0 --- /dev/null +++ b/Run/src/V2/ServiceScaling/ScalingMode.php @@ -0,0 +1,63 @@ +google.cloud.run.v2.ServiceScaling.ScalingMode + */ +class ScalingMode +{ + /** + * Unspecified. + * + * Generated from protobuf enum SCALING_MODE_UNSPECIFIED = 0; + */ + const SCALING_MODE_UNSPECIFIED = 0; + /** + * Scale based on traffic between min and max instances. + * + * Generated from protobuf enum AUTOMATIC = 1; + */ + const AUTOMATIC = 1; + /** + * Scale to exactly min instances and ignore max instances. + * + * Generated from protobuf enum MANUAL = 2; + */ + const MANUAL = 2; + + private static $valueToName = [ + self::SCALING_MODE_UNSPECIFIED => 'SCALING_MODE_UNSPECIFIED', + self::AUTOMATIC => 'AUTOMATIC', + self::MANUAL => 'MANUAL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Run/src/V2/StorageSource.php b/Run/src/V2/StorageSource.php new file mode 100644 index 000000000000..a577d719f1a5 --- /dev/null +++ b/Run/src/V2/StorageSource.php @@ -0,0 +1,155 @@ +google.cloud.run.v2.StorageSource + */ +class StorageSource extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Google Cloud Storage bucket containing the source (see + * [Bucket Name + * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + * + * Generated from protobuf field string bucket = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $bucket = ''; + /** + * Required. Google Cloud Storage object containing the source. + * This object must be a gzipped archive file (`.tar.gz`) containing source to + * build. + * + * Generated from protobuf field string object = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $object = ''; + /** + * Optional. Google Cloud Storage generation for the object. If the generation + * is omitted, the latest generation will be used. + * + * Generated from protobuf field int64 generation = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $generation = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $bucket + * Required. Google Cloud Storage bucket containing the source (see + * [Bucket Name + * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + * @type string $object + * Required. Google Cloud Storage object containing the source. + * This object must be a gzipped archive file (`.tar.gz`) containing source to + * build. + * @type int|string $generation + * Optional. Google Cloud Storage generation for the object. If the generation + * is omitted, the latest generation will be used. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Run\V2\Build::initOnce(); + parent::__construct($data); + } + + /** + * Required. Google Cloud Storage bucket containing the source (see + * [Bucket Name + * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + * + * Generated from protobuf field string bucket = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getBucket() + { + return $this->bucket; + } + + /** + * Required. Google Cloud Storage bucket containing the source (see + * [Bucket Name + * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + * + * Generated from protobuf field string bucket = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setBucket($var) + { + GPBUtil::checkString($var, True); + $this->bucket = $var; + + return $this; + } + + /** + * Required. Google Cloud Storage object containing the source. + * This object must be a gzipped archive file (`.tar.gz`) containing source to + * build. + * + * Generated from protobuf field string object = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getObject() + { + return $this->object; + } + + /** + * Required. Google Cloud Storage object containing the source. + * This object must be a gzipped archive file (`.tar.gz`) containing source to + * build. + * + * Generated from protobuf field string object = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setObject($var) + { + GPBUtil::checkString($var, True); + $this->object = $var; + + return $this; + } + + /** + * Optional. Google Cloud Storage generation for the object. If the generation + * is omitted, the latest generation will be used. + * + * Generated from protobuf field int64 generation = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getGeneration() + { + return $this->generation; + } + + /** + * Optional. Google Cloud Storage generation for the object. If the generation + * is omitted, the latest generation will be used. + * + * Generated from protobuf field int64 generation = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setGeneration($var) + { + GPBUtil::checkInt64($var); + $this->generation = $var; + + return $this; + } + +} + diff --git a/Run/src/V2/SubmitBuildRequest.php b/Run/src/V2/SubmitBuildRequest.php new file mode 100644 index 000000000000..cb260e21eed3 --- /dev/null +++ b/Run/src/V2/SubmitBuildRequest.php @@ -0,0 +1,356 @@ +google.cloud.run.v2.SubmitBuildRequest + */ +class SubmitBuildRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The project and location to build in. Location must be a region, + * e.g., 'us-central1' or 'global' if the global builder is to be used. + * Format: + * `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $parent = ''; + /** + * Required. Artifact Registry URI to store the built image. + * + * Generated from protobuf field string image_uri = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $image_uri = ''; + /** + * Optional. The service account to use for the build. If not set, the default + * Cloud Build service account for the project will be used. + * + * Generated from protobuf field string service_account = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $service_account = ''; + /** + * Optional. Name of the Cloud Build Custom Worker Pool that should be used to + * build the function. The format of this field is + * `projects/{project}/locations/{region}/workerPools/{workerPool}` where + * `{project}` and `{region}` are the project id and region respectively where + * the worker pool is defined and `{workerPool}` is the short name of the + * worker pool. + * + * Generated from protobuf field string worker_pool = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $worker_pool = ''; + /** + * Optional. Additional tags to annotate the build. + * + * Generated from protobuf field repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $tags; + protected $source; + protected $build_type; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The project and location to build in. Location must be a region, + * e.g., 'us-central1' or 'global' if the global builder is to be used. + * Format: + * `projects/{project}/locations/{location}` + * @type \Google\Cloud\Run\V2\StorageSource $storage_source + * Required. Source for the build. + * @type string $image_uri + * Required. Artifact Registry URI to store the built image. + * @type \Google\Cloud\Run\V2\SubmitBuildRequest\BuildpacksBuild $buildpack_build + * Build the source using Buildpacks. + * @type \Google\Cloud\Run\V2\SubmitBuildRequest\DockerBuild $docker_build + * Build the source using Docker. This means the source has a Dockerfile. + * @type string $service_account + * Optional. The service account to use for the build. If not set, the default + * Cloud Build service account for the project will be used. + * @type string $worker_pool + * Optional. Name of the Cloud Build Custom Worker Pool that should be used to + * build the function. The format of this field is + * `projects/{project}/locations/{region}/workerPools/{workerPool}` where + * `{project}` and `{region}` are the project id and region respectively where + * the worker pool is defined and `{workerPool}` is the short name of the + * worker pool. + * @type array|\Google\Protobuf\Internal\RepeatedField $tags + * Optional. Additional tags to annotate the build. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Run\V2\Build::initOnce(); + parent::__construct($data); + } + + /** + * Required. The project and location to build in. Location must be a region, + * e.g., 'us-central1' or 'global' if the global builder is to be used. + * Format: + * `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The project and location to build in. Location must be a region, + * e.g., 'us-central1' or 'global' if the global builder is to be used. + * Format: + * `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. Source for the build. + * + * Generated from protobuf field .google.cloud.run.v2.StorageSource storage_source = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Run\V2\StorageSource|null + */ + public function getStorageSource() + { + return $this->readOneof(2); + } + + public function hasStorageSource() + { + return $this->hasOneof(2); + } + + /** + * Required. Source for the build. + * + * Generated from protobuf field .google.cloud.run.v2.StorageSource storage_source = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Run\V2\StorageSource $var + * @return $this + */ + public function setStorageSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Run\V2\StorageSource::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Required. Artifact Registry URI to store the built image. + * + * Generated from protobuf field string image_uri = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getImageUri() + { + return $this->image_uri; + } + + /** + * Required. Artifact Registry URI to store the built image. + * + * Generated from protobuf field string image_uri = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setImageUri($var) + { + GPBUtil::checkString($var, True); + $this->image_uri = $var; + + return $this; + } + + /** + * Build the source using Buildpacks. + * + * Generated from protobuf field .google.cloud.run.v2.SubmitBuildRequest.BuildpacksBuild buildpack_build = 4; + * @return \Google\Cloud\Run\V2\SubmitBuildRequest\BuildpacksBuild|null + */ + public function getBuildpackBuild() + { + return $this->readOneof(4); + } + + public function hasBuildpackBuild() + { + return $this->hasOneof(4); + } + + /** + * Build the source using Buildpacks. + * + * Generated from protobuf field .google.cloud.run.v2.SubmitBuildRequest.BuildpacksBuild buildpack_build = 4; + * @param \Google\Cloud\Run\V2\SubmitBuildRequest\BuildpacksBuild $var + * @return $this + */ + public function setBuildpackBuild($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Run\V2\SubmitBuildRequest\BuildpacksBuild::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * Build the source using Docker. This means the source has a Dockerfile. + * + * Generated from protobuf field .google.cloud.run.v2.SubmitBuildRequest.DockerBuild docker_build = 5; + * @return \Google\Cloud\Run\V2\SubmitBuildRequest\DockerBuild|null + */ + public function getDockerBuild() + { + return $this->readOneof(5); + } + + public function hasDockerBuild() + { + return $this->hasOneof(5); + } + + /** + * Build the source using Docker. This means the source has a Dockerfile. + * + * Generated from protobuf field .google.cloud.run.v2.SubmitBuildRequest.DockerBuild docker_build = 5; + * @param \Google\Cloud\Run\V2\SubmitBuildRequest\DockerBuild $var + * @return $this + */ + public function setDockerBuild($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Run\V2\SubmitBuildRequest\DockerBuild::class); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * Optional. The service account to use for the build. If not set, the default + * Cloud Build service account for the project will be used. + * + * Generated from protobuf field string service_account = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getServiceAccount() + { + return $this->service_account; + } + + /** + * Optional. The service account to use for the build. If not set, the default + * Cloud Build service account for the project will be used. + * + * Generated from protobuf field string service_account = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->service_account = $var; + + return $this; + } + + /** + * Optional. Name of the Cloud Build Custom Worker Pool that should be used to + * build the function. The format of this field is + * `projects/{project}/locations/{region}/workerPools/{workerPool}` where + * `{project}` and `{region}` are the project id and region respectively where + * the worker pool is defined and `{workerPool}` is the short name of the + * worker pool. + * + * Generated from protobuf field string worker_pool = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getWorkerPool() + { + return $this->worker_pool; + } + + /** + * Optional. Name of the Cloud Build Custom Worker Pool that should be used to + * build the function. The format of this field is + * `projects/{project}/locations/{region}/workerPools/{workerPool}` where + * `{project}` and `{region}` are the project id and region respectively where + * the worker pool is defined and `{workerPool}` is the short name of the + * worker pool. + * + * Generated from protobuf field string worker_pool = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setWorkerPool($var) + { + GPBUtil::checkString($var, True); + $this->worker_pool = $var; + + return $this; + } + + /** + * Optional. Additional tags to annotate the build. + * + * Generated from protobuf field repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTags() + { + return $this->tags; + } + + /** + * Optional. Additional tags to annotate the build. + * + * Generated from protobuf field repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTags($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->tags = $arr; + + return $this; + } + + /** + * @return string + */ + public function getSource() + { + return $this->whichOneof("source"); + } + + /** + * @return string + */ + public function getBuildType() + { + return $this->whichOneof("build_type"); + } + +} + diff --git a/Run/src/V2/SubmitBuildRequest/BuildpacksBuild.php b/Run/src/V2/SubmitBuildRequest/BuildpacksBuild.php new file mode 100644 index 000000000000..b7256e54523a --- /dev/null +++ b/Run/src/V2/SubmitBuildRequest/BuildpacksBuild.php @@ -0,0 +1,271 @@ +google.cloud.run.v2.SubmitBuildRequest.BuildpacksBuild + */ +class BuildpacksBuild extends \Google\Protobuf\Internal\Message +{ + /** + * The runtime name, e.g. 'go113'. Leave blank for generic builds. + * + * Generated from protobuf field string runtime = 1 [deprecated = true]; + * @deprecated + */ + protected $runtime = ''; + /** + * Optional. Name of the function target if the source is a function source. + * Required for function builds. + * + * Generated from protobuf field string function_target = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $function_target = ''; + /** + * Optional. cache_image_uri is the GCR/AR URL where the cache image will be + * stored. cache_image_uri is optional and omitting it will disable caching. + * This URL must be stable across builds. It is used to derive a + * build-specific temporary URL by substituting the tag with the build ID. + * The build will clean up the temporary image on a best-effort basis. + * + * Generated from protobuf field string cache_image_uri = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $cache_image_uri = ''; + /** + * Optional. The base image used to opt into automatic base image updates. + * + * Generated from protobuf field string base_image = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $base_image = ''; + /** + * Optional. User-provided build-time environment variables. + * + * Generated from protobuf field map environment_variables = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $environment_variables; + /** + * Optional. Whether or not the application container will be enrolled in + * automatic base image updates. When true, the application will be built on + * a scratch base image, so the base layers can be appended at run time. + * + * Generated from protobuf field bool enable_automatic_updates = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_automatic_updates = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $runtime + * The runtime name, e.g. 'go113'. Leave blank for generic builds. + * @type string $function_target + * Optional. Name of the function target if the source is a function source. + * Required for function builds. + * @type string $cache_image_uri + * Optional. cache_image_uri is the GCR/AR URL where the cache image will be + * stored. cache_image_uri is optional and omitting it will disable caching. + * This URL must be stable across builds. It is used to derive a + * build-specific temporary URL by substituting the tag with the build ID. + * The build will clean up the temporary image on a best-effort basis. + * @type string $base_image + * Optional. The base image used to opt into automatic base image updates. + * @type array|\Google\Protobuf\Internal\MapField $environment_variables + * Optional. User-provided build-time environment variables. + * @type bool $enable_automatic_updates + * Optional. Whether or not the application container will be enrolled in + * automatic base image updates. When true, the application will be built on + * a scratch base image, so the base layers can be appended at run time. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Run\V2\Build::initOnce(); + parent::__construct($data); + } + + /** + * The runtime name, e.g. 'go113'. Leave blank for generic builds. + * + * Generated from protobuf field string runtime = 1 [deprecated = true]; + * @return string + * @deprecated + */ + public function getRuntime() + { + @trigger_error('runtime is deprecated.', E_USER_DEPRECATED); + return $this->runtime; + } + + /** + * The runtime name, e.g. 'go113'. Leave blank for generic builds. + * + * Generated from protobuf field string runtime = 1 [deprecated = true]; + * @param string $var + * @return $this + * @deprecated + */ + public function setRuntime($var) + { + @trigger_error('runtime is deprecated.', E_USER_DEPRECATED); + GPBUtil::checkString($var, True); + $this->runtime = $var; + + return $this; + } + + /** + * Optional. Name of the function target if the source is a function source. + * Required for function builds. + * + * Generated from protobuf field string function_target = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFunctionTarget() + { + return $this->function_target; + } + + /** + * Optional. Name of the function target if the source is a function source. + * Required for function builds. + * + * Generated from protobuf field string function_target = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFunctionTarget($var) + { + GPBUtil::checkString($var, True); + $this->function_target = $var; + + return $this; + } + + /** + * Optional. cache_image_uri is the GCR/AR URL where the cache image will be + * stored. cache_image_uri is optional and omitting it will disable caching. + * This URL must be stable across builds. It is used to derive a + * build-specific temporary URL by substituting the tag with the build ID. + * The build will clean up the temporary image on a best-effort basis. + * + * Generated from protobuf field string cache_image_uri = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getCacheImageUri() + { + return $this->cache_image_uri; + } + + /** + * Optional. cache_image_uri is the GCR/AR URL where the cache image will be + * stored. cache_image_uri is optional and omitting it will disable caching. + * This URL must be stable across builds. It is used to derive a + * build-specific temporary URL by substituting the tag with the build ID. + * The build will clean up the temporary image on a best-effort basis. + * + * Generated from protobuf field string cache_image_uri = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setCacheImageUri($var) + { + GPBUtil::checkString($var, True); + $this->cache_image_uri = $var; + + return $this; + } + + /** + * Optional. The base image used to opt into automatic base image updates. + * + * Generated from protobuf field string base_image = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getBaseImage() + { + return $this->base_image; + } + + /** + * Optional. The base image used to opt into automatic base image updates. + * + * Generated from protobuf field string base_image = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setBaseImage($var) + { + GPBUtil::checkString($var, True); + $this->base_image = $var; + + return $this; + } + + /** + * Optional. User-provided build-time environment variables. + * + * Generated from protobuf field map environment_variables = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getEnvironmentVariables() + { + return $this->environment_variables; + } + + /** + * Optional. User-provided build-time environment variables. + * + * Generated from protobuf field map environment_variables = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setEnvironmentVariables($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->environment_variables = $arr; + + return $this; + } + + /** + * Optional. Whether or not the application container will be enrolled in + * automatic base image updates. When true, the application will be built on + * a scratch base image, so the base layers can be appended at run time. + * + * Generated from protobuf field bool enable_automatic_updates = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnableAutomaticUpdates() + { + return $this->enable_automatic_updates; + } + + /** + * Optional. Whether or not the application container will be enrolled in + * automatic base image updates. When true, the application will be built on + * a scratch base image, so the base layers can be appended at run time. + * + * Generated from protobuf field bool enable_automatic_updates = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnableAutomaticUpdates($var) + { + GPBUtil::checkBool($var); + $this->enable_automatic_updates = $var; + + return $this; + } + +} + + diff --git a/Run/src/V2/SubmitBuildRequest/DockerBuild.php b/Run/src/V2/SubmitBuildRequest/DockerBuild.php new file mode 100644 index 000000000000..5b8a06980739 --- /dev/null +++ b/Run/src/V2/SubmitBuildRequest/DockerBuild.php @@ -0,0 +1,34 @@ +google.cloud.run.v2.SubmitBuildRequest.DockerBuild + */ +class DockerBuild extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Run\V2\Build::initOnce(); + parent::__construct($data); + } + +} + + diff --git a/Run/src/V2/SubmitBuildResponse.php b/Run/src/V2/SubmitBuildResponse.php new file mode 100644 index 000000000000..42440dbfebd4 --- /dev/null +++ b/Run/src/V2/SubmitBuildResponse.php @@ -0,0 +1,149 @@ +google.cloud.run.v2.SubmitBuildResponse + */ +class SubmitBuildResponse extends \Google\Protobuf\Internal\Message +{ + /** + * Cloud Build operation to be polled via CloudBuild API. + * + * Generated from protobuf field .google.longrunning.Operation build_operation = 1; + */ + protected $build_operation = null; + /** + * URI of the base builder image in Artifact Registry being used in the build. + * Used to opt into automatic base image updates. + * + * Generated from protobuf field string base_image_uri = 2; + */ + protected $base_image_uri = ''; + /** + * Warning message for the base image. + * + * Generated from protobuf field string base_image_warning = 3; + */ + protected $base_image_warning = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\LongRunning\Operation $build_operation + * Cloud Build operation to be polled via CloudBuild API. + * @type string $base_image_uri + * URI of the base builder image in Artifact Registry being used in the build. + * Used to opt into automatic base image updates. + * @type string $base_image_warning + * Warning message for the base image. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Run\V2\Build::initOnce(); + parent::__construct($data); + } + + /** + * Cloud Build operation to be polled via CloudBuild API. + * + * Generated from protobuf field .google.longrunning.Operation build_operation = 1; + * @return \Google\LongRunning\Operation|null + */ + public function getBuildOperation() + { + return $this->build_operation; + } + + public function hasBuildOperation() + { + return isset($this->build_operation); + } + + public function clearBuildOperation() + { + unset($this->build_operation); + } + + /** + * Cloud Build operation to be polled via CloudBuild API. + * + * Generated from protobuf field .google.longrunning.Operation build_operation = 1; + * @param \Google\LongRunning\Operation $var + * @return $this + */ + public function setBuildOperation($var) + { + GPBUtil::checkMessage($var, \Google\LongRunning\Operation::class); + $this->build_operation = $var; + + return $this; + } + + /** + * URI of the base builder image in Artifact Registry being used in the build. + * Used to opt into automatic base image updates. + * + * Generated from protobuf field string base_image_uri = 2; + * @return string + */ + public function getBaseImageUri() + { + return $this->base_image_uri; + } + + /** + * URI of the base builder image in Artifact Registry being used in the build. + * Used to opt into automatic base image updates. + * + * Generated from protobuf field string base_image_uri = 2; + * @param string $var + * @return $this + */ + public function setBaseImageUri($var) + { + GPBUtil::checkString($var, True); + $this->base_image_uri = $var; + + return $this; + } + + /** + * Warning message for the base image. + * + * Generated from protobuf field string base_image_warning = 3; + * @return string + */ + public function getBaseImageWarning() + { + return $this->base_image_warning; + } + + /** + * Warning message for the base image. + * + * Generated from protobuf field string base_image_warning = 3; + * @param string $var + * @return $this + */ + public function setBaseImageWarning($var) + { + GPBUtil::checkString($var, True); + $this->base_image_warning = $var; + + return $this; + } + +} + diff --git a/Run/src/V2/VpcAccess.php b/Run/src/V2/VpcAccess.php index f38ecdf80556..2edc5d9e89bc 100644 --- a/Run/src/V2/VpcAccess.php +++ b/Run/src/V2/VpcAccess.php @@ -18,8 +18,8 @@ class VpcAccess extends \Google\Protobuf\Internal\Message { /** * VPC Access connector name. - * Format: projects/{project}/locations/{location}/connectors/{connector}, - * where {project} can be project id or number. + * Format: `projects/{project}/locations/{location}/connectors/{connector}`, + * where `{project}` can be project id or number. * For more information on sending traffic to a VPC network via a connector, * visit https://cloud.google.com/run/docs/configuring/vpc-connectors. * @@ -49,8 +49,8 @@ class VpcAccess extends \Google\Protobuf\Internal\Message * * @type string $connector * VPC Access connector name. - * Format: projects/{project}/locations/{location}/connectors/{connector}, - * where {project} can be project id or number. + * Format: `projects/{project}/locations/{location}/connectors/{connector}`, + * where `{project}` can be project id or number. * For more information on sending traffic to a VPC network via a connector, * visit https://cloud.google.com/run/docs/configuring/vpc-connectors. * @type int $egress @@ -68,8 +68,8 @@ public function __construct($data = NULL) { /** * VPC Access connector name. - * Format: projects/{project}/locations/{location}/connectors/{connector}, - * where {project} can be project id or number. + * Format: `projects/{project}/locations/{location}/connectors/{connector}`, + * where `{project}` can be project id or number. * For more information on sending traffic to a VPC network via a connector, * visit https://cloud.google.com/run/docs/configuring/vpc-connectors. * @@ -83,8 +83,8 @@ public function getConnector() /** * VPC Access connector name. - * Format: projects/{project}/locations/{location}/connectors/{connector}, - * where {project} can be project id or number. + * Format: `projects/{project}/locations/{location}/connectors/{connector}`, + * where `{project}` can be project id or number. * For more information on sending traffic to a VPC network via a connector, * visit https://cloud.google.com/run/docs/configuring/vpc-connectors. * diff --git a/Run/src/V2/gapic_metadata.json b/Run/src/V2/gapic_metadata.json index 300fbd7d62bd..2bf7b36f81c0 100644 --- a/Run/src/V2/gapic_metadata.json +++ b/Run/src/V2/gapic_metadata.json @@ -5,6 +5,20 @@ "protoPackage": "google.cloud.run.v2", "libraryPackage": "Google\\Cloud\\Run\\V2", "services": { + "Builds": { + "clients": { + "grpc": { + "libraryClient": "BuildsGapicClient", + "rpcs": { + "SubmitBuild": { + "methods": [ + "submitBuild" + ] + } + } + } + } + }, "Executions": { "clients": { "grpc": { diff --git a/Run/src/V2/resources/builds_client_config.json b/Run/src/V2/resources/builds_client_config.json new file mode 100644 index 000000000000..b09e6e721847 --- /dev/null +++ b/Run/src/V2/resources/builds_client_config.json @@ -0,0 +1,27 @@ +{ + "interfaces": { + "google.cloud.run.v2.Builds": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "SubmitBuild": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/Run/src/V2/resources/builds_descriptor_config.php b/Run/src/V2/resources/builds_descriptor_config.php new file mode 100644 index 000000000000..5cb8ed8624cb --- /dev/null +++ b/Run/src/V2/resources/builds_descriptor_config.php @@ -0,0 +1,43 @@ + [ + 'google.cloud.run.v2.Builds' => [ + 'SubmitBuild' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Run\V2\SubmitBuildResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'workerPool' => 'projects/{project}/locations/{location}/workerPools/{worker_pool}', + ], + ], + ], +]; diff --git a/Run/src/V2/resources/builds_rest_client_config.php b/Run/src/V2/resources/builds_rest_client_config.php new file mode 100644 index 000000000000..5654061ec5f6 --- /dev/null +++ b/Run/src/V2/resources/builds_rest_client_config.php @@ -0,0 +1,88 @@ + [ + 'google.cloud.run.v2.Builds' => [ + 'SubmitBuild' => [ + 'method' => 'post', + 'uriTemplate' => '/v2/{parent=projects/*/locations/*}/builds:submit', + 'body' => '*', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'DeleteOperation' => [ + 'method' => 'delete', + 'uriTemplate' => '/v2/{name=projects/*/locations/*/operations/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*/locations/*/operations/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListOperations' => [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*/locations/*}/operations', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'WaitOperation' => [ + 'method' => 'post', + 'uriTemplate' => '/v2/{name=projects/*/locations/*/operations/*}:wait', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/Run/src/V2/resources/jobs_descriptor_config.php b/Run/src/V2/resources/jobs_descriptor_config.php index 33bd0d89d3f4..dabd773405ac 100644 --- a/Run/src/V2/resources/jobs_descriptor_config.php +++ b/Run/src/V2/resources/jobs_descriptor_config.php @@ -180,6 +180,9 @@ 'execution' => 'projects/{project}/locations/{location}/jobs/{job}/executions/{execution}', 'job' => 'projects/{project}/locations/{location}/jobs/{job}', 'location' => 'projects/{project}/locations/{location}', + 'locationPolicy' => 'locations/{location}/policy', + 'policy' => 'projects/{project}/policy', + 'projectPolicy' => 'projects/{project}/policy', 'secret' => 'projects/{project}/secrets/{secret}', 'secretVersion' => 'projects/{project}/secrets/{secret}/versions/{version}', ], diff --git a/Run/src/V2/resources/services_descriptor_config.php b/Run/src/V2/resources/services_descriptor_config.php index 82c5c01c31d6..3264c3a5d624 100644 --- a/Run/src/V2/resources/services_descriptor_config.php +++ b/Run/src/V2/resources/services_descriptor_config.php @@ -158,6 +158,10 @@ 'connector' => 'projects/{project}/locations/{location}/connectors/{connector}', 'cryptoKey' => 'projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}', 'location' => 'projects/{project}/locations/{location}', + 'locationPolicy' => 'locations/{location}/policy', + 'mesh' => 'projects/{project}/locations/{location}/meshes/{mesh}', + 'policy' => 'projects/{project}/policy', + 'projectPolicy' => 'projects/{project}/policy', 'revision' => 'projects/{project}/locations/{location}/services/{service}/revisions/{revision}', 'secret' => 'projects/{project}/secrets/{secret}', 'secretVersion' => 'projects/{project}/secrets/{secret}/versions/{version}', diff --git a/Run/tests/Unit/V2/Client/BuildsClientTest.php b/Run/tests/Unit/V2/Client/BuildsClientTest.php new file mode 100644 index 000000000000..dbea8b8c64b4 --- /dev/null +++ b/Run/tests/Unit/V2/Client/BuildsClientTest.php @@ -0,0 +1,197 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return BuildsClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new BuildsClient($options); + } + + /** @test */ + public function submitBuildTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $baseImageUri = 'baseImageUri2088954010'; + $baseImageWarning = 'baseImageWarning-2033873974'; + $expectedResponse = new SubmitBuildResponse(); + $expectedResponse->setBaseImageUri($baseImageUri); + $expectedResponse->setBaseImageWarning($baseImageWarning); + $transport->addResponse($expectedResponse); + // Mock request + $parent = 'parent-995424086'; + $storageSource = new StorageSource(); + $storageSourceBucket = 'storageSourceBucket608605184'; + $storageSource->setBucket($storageSourceBucket); + $storageSourceObject = 'storageSourceObject963439957'; + $storageSource->setObject($storageSourceObject); + $imageUri = 'imageUri-877823864'; + $request = (new SubmitBuildRequest()) + ->setParent($parent) + ->setStorageSource($storageSource) + ->setImageUri($imageUri); + $response = $gapicClient->submitBuild($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.run.v2.Builds/SubmitBuild', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($parent, $actualValue); + $actualValue = $actualRequestObject->getStorageSource(); + $this->assertProtobufEquals($storageSource, $actualValue); + $actualValue = $actualRequestObject->getImageUri(); + $this->assertProtobufEquals($imageUri, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function submitBuildExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $parent = 'parent-995424086'; + $storageSource = new StorageSource(); + $storageSourceBucket = 'storageSourceBucket608605184'; + $storageSource->setBucket($storageSourceBucket); + $storageSourceObject = 'storageSourceObject963439957'; + $storageSource->setObject($storageSourceObject); + $imageUri = 'imageUri-877823864'; + $request = (new SubmitBuildRequest()) + ->setParent($parent) + ->setStorageSource($storageSource) + ->setImageUri($imageUri); + try { + $gapicClient->submitBuild($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function submitBuildAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $baseImageUri = 'baseImageUri2088954010'; + $baseImageWarning = 'baseImageWarning-2033873974'; + $expectedResponse = new SubmitBuildResponse(); + $expectedResponse->setBaseImageUri($baseImageUri); + $expectedResponse->setBaseImageWarning($baseImageWarning); + $transport->addResponse($expectedResponse); + // Mock request + $parent = 'parent-995424086'; + $storageSource = new StorageSource(); + $storageSourceBucket = 'storageSourceBucket608605184'; + $storageSource->setBucket($storageSourceBucket); + $storageSourceObject = 'storageSourceObject963439957'; + $storageSource->setObject($storageSourceObject); + $imageUri = 'imageUri-877823864'; + $request = (new SubmitBuildRequest()) + ->setParent($parent) + ->setStorageSource($storageSource) + ->setImageUri($imageUri); + $response = $gapicClient->submitBuildAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.run.v2.Builds/SubmitBuild', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($parent, $actualValue); + $actualValue = $actualRequestObject->getStorageSource(); + $this->assertProtobufEquals($storageSource, $actualValue); + $actualValue = $actualRequestObject->getImageUri(); + $this->assertProtobufEquals($imageUri, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/Run/tests/Unit/V2/Client/ServicesClientTest.php b/Run/tests/Unit/V2/Client/ServicesClientTest.php index e9f9c5834b8e..68727e2c70f0 100644 --- a/Run/tests/Unit/V2/Client/ServicesClientTest.php +++ b/Run/tests/Unit/V2/Client/ServicesClientTest.php @@ -106,6 +106,7 @@ public function createServiceTest() $lastModifier = 'lastModifier-28366240'; $client = 'client-1357712437'; $clientVersion = 'clientVersion-1506231196'; + $invokerIamDisabled = false; $defaultUriDisabled = false; $observedGeneration = 900833007; $latestReadyRevision = 'latestReadyRevision-853854545'; @@ -123,6 +124,7 @@ public function createServiceTest() $expectedResponse->setLastModifier($lastModifier); $expectedResponse->setClient($client); $expectedResponse->setClientVersion($clientVersion); + $expectedResponse->setInvokerIamDisabled($invokerIamDisabled); $expectedResponse->setDefaultUriDisabled($defaultUriDisabled); $expectedResponse->setObservedGeneration($observedGeneration); $expectedResponse->setLatestReadyRevision($latestReadyRevision); @@ -278,6 +280,7 @@ public function deleteServiceTest() $lastModifier = 'lastModifier-28366240'; $client = 'client-1357712437'; $clientVersion = 'clientVersion-1506231196'; + $invokerIamDisabled = false; $defaultUriDisabled = false; $observedGeneration = 900833007; $latestReadyRevision = 'latestReadyRevision-853854545'; @@ -295,6 +298,7 @@ public function deleteServiceTest() $expectedResponse->setLastModifier($lastModifier); $expectedResponse->setClient($client); $expectedResponse->setClientVersion($clientVersion); + $expectedResponse->setInvokerIamDisabled($invokerIamDisabled); $expectedResponse->setDefaultUriDisabled($defaultUriDisabled); $expectedResponse->setObservedGeneration($observedGeneration); $expectedResponse->setLatestReadyRevision($latestReadyRevision); @@ -487,6 +491,7 @@ public function getServiceTest() $lastModifier = 'lastModifier-28366240'; $client = 'client-1357712437'; $clientVersion = 'clientVersion-1506231196'; + $invokerIamDisabled = false; $defaultUriDisabled = false; $observedGeneration = 900833007; $latestReadyRevision = 'latestReadyRevision-853854545'; @@ -504,6 +509,7 @@ public function getServiceTest() $expectedResponse->setLastModifier($lastModifier); $expectedResponse->setClient($client); $expectedResponse->setClientVersion($clientVersion); + $expectedResponse->setInvokerIamDisabled($invokerIamDisabled); $expectedResponse->setDefaultUriDisabled($defaultUriDisabled); $expectedResponse->setObservedGeneration($observedGeneration); $expectedResponse->setLatestReadyRevision($latestReadyRevision); @@ -803,6 +809,7 @@ public function updateServiceTest() $lastModifier = 'lastModifier-28366240'; $client = 'client-1357712437'; $clientVersion = 'clientVersion-1506231196'; + $invokerIamDisabled = false; $defaultUriDisabled = false; $observedGeneration = 900833007; $latestReadyRevision = 'latestReadyRevision-853854545'; @@ -820,6 +827,7 @@ public function updateServiceTest() $expectedResponse->setLastModifier($lastModifier); $expectedResponse->setClient($client); $expectedResponse->setClientVersion($clientVersion); + $expectedResponse->setInvokerIamDisabled($invokerIamDisabled); $expectedResponse->setDefaultUriDisabled($defaultUriDisabled); $expectedResponse->setObservedGeneration($observedGeneration); $expectedResponse->setLatestReadyRevision($latestReadyRevision); @@ -961,6 +969,7 @@ public function createServiceAsyncTest() $lastModifier = 'lastModifier-28366240'; $client = 'client-1357712437'; $clientVersion = 'clientVersion-1506231196'; + $invokerIamDisabled = false; $defaultUriDisabled = false; $observedGeneration = 900833007; $latestReadyRevision = 'latestReadyRevision-853854545'; @@ -978,6 +987,7 @@ public function createServiceAsyncTest() $expectedResponse->setLastModifier($lastModifier); $expectedResponse->setClient($client); $expectedResponse->setClientVersion($clientVersion); + $expectedResponse->setInvokerIamDisabled($invokerIamDisabled); $expectedResponse->setDefaultUriDisabled($defaultUriDisabled); $expectedResponse->setObservedGeneration($observedGeneration); $expectedResponse->setLatestReadyRevision($latestReadyRevision); From 4021aec302618a592dd095956e58925390ff3911 Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Fri, 4 Oct 2024 21:59:14 -0700 Subject: [PATCH 013/157] chore(main): release 0.262.0 (#7716) --- AiPlatform/VERSION | 2 +- AppsChat/VERSION | 2 +- Batch/VERSION | 2 +- BigQueryDataTransfer/VERSION | 2 +- CHANGELOG.md | 154 ++++++++++++++++++++++++++++ Channel/VERSION | 2 +- Parallelstore/VERSION | 2 +- Redis/VERSION | 2 +- Run/VERSION | 2 +- ShoppingMerchantAccounts/VERSION | 2 +- ShoppingMerchantDataSources/VERSION | 2 +- Spanner/VERSION | 2 +- Spanner/src/SpannerClient.php | 2 +- Storage/VERSION | 2 +- Storage/src/StorageClient.php | 2 +- composer.json | 24 ++--- 16 files changed, 180 insertions(+), 26 deletions(-) diff --git a/AiPlatform/VERSION b/AiPlatform/VERSION index bd8bf882d061..27f9cd322bb9 100644 --- a/AiPlatform/VERSION +++ b/AiPlatform/VERSION @@ -1 +1 @@ -1.7.0 +1.8.0 diff --git a/AppsChat/VERSION b/AppsChat/VERSION index 8f0916f768f0..a918a2aa18d5 100644 --- a/AppsChat/VERSION +++ b/AppsChat/VERSION @@ -1 +1 @@ -0.5.0 +0.6.0 diff --git a/Batch/VERSION b/Batch/VERSION index 9084fa2f716a..524cb55242b5 100644 --- a/Batch/VERSION +++ b/Batch/VERSION @@ -1 +1 @@ -1.1.0 +1.1.1 diff --git a/BigQueryDataTransfer/VERSION b/BigQueryDataTransfer/VERSION index 227cea215648..7ec1d6db4087 100644 --- a/BigQueryDataTransfer/VERSION +++ b/BigQueryDataTransfer/VERSION @@ -1 +1 @@ -2.0.0 +2.1.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index a16d0a0d2e2d..212fce24d2e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,159 @@ # Changelog +## 0.262.0 + +
google/cloud-ai-platform 1.8.0 + + + +### Features + +* Add a dynamic retrieval API ([#7724](https://github.com/googleapis/google-cloud-php/issues/7724)) ([7674a3e](https://github.com/googleapis/google-cloud-php/commit/7674a3ea25e138f41ebfb4c3becceaf3221556b4)) +* Add continuous sync option in feature_view.proto ([7674a3e](https://github.com/googleapis/google-cloud-php/commit/7674a3ea25e138f41ebfb4c3becceaf3221556b4)) +* Add psc_automation_configs to DeployIndex v1 ([#7720](https://github.com/googleapis/google-cloud-php/issues/7720)) ([2c48383](https://github.com/googleapis/google-cloud-php/commit/2c483836197e47fbe9f2c9f284d56c0548d4946b)) + +
+ +
google/apps-chat 0.6.0 + + + +### Features + +* Add doc for import mode external users support ([0c917c4](https://github.com/googleapis/google-cloud-php/commit/0c917c4b62bbde18fcdb5e3d18c67cebcc4daddb)) +* Add doc for permission settings & announcement space support ([#7721](https://github.com/googleapis/google-cloud-php/issues/7721)) ([0c917c4](https://github.com/googleapis/google-cloud-php/commit/0c917c4b62bbde18fcdb5e3d18c67cebcc4daddb)) + + +### Documentation + +* Discoverable space docs improvement ([0c917c4](https://github.com/googleapis/google-cloud-php/commit/0c917c4b62bbde18fcdb5e3d18c67cebcc4daddb)) +* Memberships API dev docs improvement ([0c917c4](https://github.com/googleapis/google-cloud-php/commit/0c917c4b62bbde18fcdb5e3d18c67cebcc4daddb)) +* Messages API dev docs improvement ([0c917c4](https://github.com/googleapis/google-cloud-php/commit/0c917c4b62bbde18fcdb5e3d18c67cebcc4daddb)) + +
+ +
google/cloud-batch 1.1.1 + + + +### Documentation + +* Clarify Batch only supports global custom instance template now ([#7719](https://github.com/googleapis/google-cloud-php/issues/7719)) ([f3ffdb1](https://github.com/googleapis/google-cloud-php/commit/f3ffdb1a7b5439a861afa6b93bbbe05e8c662ce7)) + +
+ +
google/cloud-bigquerydatatransfer 2.1.0 + + + +### Features + +* Add scheduleOptionsV2 and Error fields for TransferConfig ([#7718](https://github.com/googleapis/google-cloud-php/issues/7718)) ([1cb914b](https://github.com/googleapis/google-cloud-php/commit/1cb914be9a7d3577acf2f69ff9405be1757e62e6)) + +
+ +
google/cloud-channel 2.1.0 + + + +### Features + +* Add support for importing team customer from a different reseller ([aa62991](https://github.com/googleapis/google-cloud-php/commit/aa62991dc2d9b7df26abbb19306564fabdffdee9)) +* Add support for primary_admin_email as customer_identity for ImportCustomer ([#7727](https://github.com/googleapis/google-cloud-php/issues/7727)) ([aa62991](https://github.com/googleapis/google-cloud-php/commit/aa62991dc2d9b7df26abbb19306564fabdffdee9)) +* Add support to look up team customer Cloud Identity information ([aa62991](https://github.com/googleapis/google-cloud-php/commit/aa62991dc2d9b7df26abbb19306564fabdffdee9)) + + +### Documentation + +* Clarify the expected value of the domain field for team type customers ([aa62991](https://github.com/googleapis/google-cloud-php/commit/aa62991dc2d9b7df26abbb19306564fabdffdee9)) + +
+ +
google/cloud-parallelstore 0.6.1 + + + +### Documentation + +* Minor documentation formatting fix for Parallelstore ([#7722](https://github.com/googleapis/google-cloud-php/issues/7722)) ([72a9414](https://github.com/googleapis/google-cloud-php/commit/72a941468c6d3970fffef3da6ad9af05e5b3e2ab)) + +
+ +
google/cloud-redis 2.1.1 + + + +
+ +
google/cloud-run 1.2.0 + + + +### Features + +* Add Builds API([#7725](https://github.com/googleapis/google-cloud-php/issues/7725)) ([3b7f251](https://github.com/googleapis/google-cloud-php/commit/3b7f251e0d73d9aa5c42a696a783f38087e3fbe1)) +* Add GPU configuration to Services ([3b7f251](https://github.com/googleapis/google-cloud-php/commit/3b7f251e0d73d9aa5c42a696a783f38087e3fbe1)) +* Add INGRESS_TRAFFIC_NONE to Services ([3b7f251](https://github.com/googleapis/google-cloud-php/commit/3b7f251e0d73d9aa5c42a696a783f38087e3fbe1)) +* Add Service Mesh configuration to Services ([3b7f251](https://github.com/googleapis/google-cloud-php/commit/3b7f251e0d73d9aa5c42a696a783f38087e3fbe1)) +* Add ServiceScaling to Services ([3b7f251](https://github.com/googleapis/google-cloud-php/commit/3b7f251e0d73d9aa5c42a696a783f38087e3fbe1)) + + +### Documentation + +* Fixed formatting of some documentation ([3b7f251](https://github.com/googleapis/google-cloud-php/commit/3b7f251e0d73d9aa5c42a696a783f38087e3fbe1)) + +
+ +
google/shopping-merchant-accounts 0.3.0 + + + +### Features + +* Add 'force' parameter for accounts.delete method ([#7714](https://github.com/googleapis/google-cloud-php/issues/7714)) ([7bbcfd6](https://github.com/googleapis/google-cloud-php/commit/7bbcfd6d641eb2a1fd9c626e47620d09374db9b5)) + + +### Documentation + +* Updated descriptions for the DeleteAccount and ListAccounts RPCs ([7bbcfd6](https://github.com/googleapis/google-cloud-php/commit/7bbcfd6d641eb2a1fd9c626e47620d09374db9b5)) + +
+ +
google/shopping-merchant-datasources 0.2.1 + + + +### Documentation + +* Adding some more information about supplemental data sources ([#7726](https://github.com/googleapis/google-cloud-php/issues/7726)) ([061fec1](https://github.com/googleapis/google-cloud-php/commit/061fec1d38d476d0d955acf7e2a5d09d8b1b1e2e)) + +
+ +
google/cloud-spanner 1.86.0 + + + +### Features + +* Add INTERVAL API ([#7712](https://github.com/googleapis/google-cloud-php/issues/7712)) ([132254f](https://github.com/googleapis/google-cloud-php/commit/132254fa537dfece87f3b836c51ed5248c230db4)) +* Add new QueryMode enum values (WITH_STATS, WITH_PLAN_AND_STATS) ([132254f](https://github.com/googleapis/google-cloud-php/commit/132254fa537dfece87f3b836c51ed5248c230db4)) +* Define ReplicaComputeCapacity and AsymmetricAutoscalingOption ([#7723](https://github.com/googleapis/google-cloud-php/issues/7723)) ([0e366ef](https://github.com/googleapis/google-cloud-php/commit/0e366efa02e8d6100cf4a61e5b7fd731ad8157e4)) + + +### Documentation + +* A comment for field `node_count` in message `spanner.admin.instance.v1.Instance` is changed ([0e366ef](https://github.com/googleapis/google-cloud-php/commit/0e366efa02e8d6100cf4a61e5b7fd731ad8157e4)) +* A comment for field `processing_units` in message `spanner.admin.instance.v1.Instance` is changed ([0e366ef](https://github.com/googleapis/google-cloud-php/commit/0e366efa02e8d6100cf4a61e5b7fd731ad8157e4)) +* Update comment for PROFILE QueryMode ([132254f](https://github.com/googleapis/google-cloud-php/commit/132254fa537dfece87f3b836c51ed5248c230db4)) + +
+ +
google/cloud-storage 1.43.1 + + + +
+ ## 0.261.0
google/ads-marketingplatform-admin 0.1.0 diff --git a/Channel/VERSION b/Channel/VERSION index 227cea215648..7ec1d6db4087 100644 --- a/Channel/VERSION +++ b/Channel/VERSION @@ -1 +1 @@ -2.0.0 +2.1.0 diff --git a/Parallelstore/VERSION b/Parallelstore/VERSION index a918a2aa18d5..ee6cdce3c290 100644 --- a/Parallelstore/VERSION +++ b/Parallelstore/VERSION @@ -1 +1 @@ -0.6.0 +0.6.1 diff --git a/Redis/VERSION b/Redis/VERSION index 7ec1d6db4087..3e3c2f1e5edb 100644 --- a/Redis/VERSION +++ b/Redis/VERSION @@ -1 +1 @@ -2.1.0 +2.1.1 diff --git a/Run/VERSION b/Run/VERSION index 9084fa2f716a..26aaba0e8663 100644 --- a/Run/VERSION +++ b/Run/VERSION @@ -1 +1 @@ -1.1.0 +1.2.0 diff --git a/ShoppingMerchantAccounts/VERSION b/ShoppingMerchantAccounts/VERSION index 0ea3a944b399..0d91a54c7d43 100644 --- a/ShoppingMerchantAccounts/VERSION +++ b/ShoppingMerchantAccounts/VERSION @@ -1 +1 @@ -0.2.0 +0.3.0 diff --git a/ShoppingMerchantDataSources/VERSION b/ShoppingMerchantDataSources/VERSION index 0ea3a944b399..0c62199f16ac 100644 --- a/ShoppingMerchantDataSources/VERSION +++ b/ShoppingMerchantDataSources/VERSION @@ -1 +1 @@ -0.2.0 +0.2.1 diff --git a/Spanner/VERSION b/Spanner/VERSION index f288d11142d1..b7844a6ffdcb 100644 --- a/Spanner/VERSION +++ b/Spanner/VERSION @@ -1 +1 @@ -1.85.0 +1.86.0 diff --git a/Spanner/src/SpannerClient.php b/Spanner/src/SpannerClient.php index 817e69f00156..64ad7f2c1c6c 100644 --- a/Spanner/src/SpannerClient.php +++ b/Spanner/src/SpannerClient.php @@ -120,7 +120,7 @@ class SpannerClient use LROTrait; use ValidateTrait; - const VERSION = '1.85.0'; + const VERSION = '1.86.0'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/spanner.data'; const ADMIN_SCOPE = 'https://www.googleapis.com/auth/spanner.admin'; diff --git a/Storage/VERSION b/Storage/VERSION index b978278f05f5..3987c472943e 100644 --- a/Storage/VERSION +++ b/Storage/VERSION @@ -1 +1 @@ -1.43.0 +1.43.1 diff --git a/Storage/src/StorageClient.php b/Storage/src/StorageClient.php index ba3020d2c260..2eef4fb0f9f1 100644 --- a/Storage/src/StorageClient.php +++ b/Storage/src/StorageClient.php @@ -47,7 +47,7 @@ class StorageClient use ArrayTrait; use ClientTrait; - const VERSION = '1.43.0'; + const VERSION = '1.43.1'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/devstorage.full_control'; const READ_ONLY_SCOPE = 'https://www.googleapis.com/auth/devstorage.read_only'; diff --git a/composer.json b/composer.json index 7c0e7a4e27f6..cef449693376 100644 --- a/composer.json +++ b/composer.json @@ -71,12 +71,12 @@ "google/ads-marketingplatform-admin": "0.1.0", "google/analytics-admin": "0.24.0", "google/analytics-data": "0.19.0", - "google/apps-chat": "0.5.0", + "google/apps-chat": "0.6.0", "google/apps-events-subscriptions": "0.1.3", "google/apps-meet": "0.2.3", "google/cloud-access-approval": "2.0.1", "google/cloud-advisorynotifications": "1.0.0", - "google/cloud-ai-platform": "1.7.0", + "google/cloud-ai-platform": "1.8.0", "google/cloud-alloydb": "1.0.0", "google/cloud-api-gateway": "2.0.0", "google/cloud-api-keys": "1.0.0", @@ -91,7 +91,7 @@ "google/cloud-automl": "2.0.0", "google/cloud-backupdr": "0.3.0", "google/cloud-bare-metal-solution": "1.0.0", - "google/cloud-batch": "1.1.0", + "google/cloud-batch": "1.1.1", "google/cloud-beyondcorp-appconnections": "1.0.0", "google/cloud-beyondcorp-appconnectors": "1.0.0", "google/cloud-beyondcorp-appgateways": "1.0.0", @@ -105,14 +105,14 @@ "google/cloud-bigquery-migration": "1.1.0", "google/cloud-bigquery-reservation": "2.0.1", "google/cloud-bigquery-storage": "2.0.0", - "google/cloud-bigquerydatatransfer": "2.0.0", + "google/cloud-bigquerydatatransfer": "2.1.0", "google/cloud-bigtable": "2.5.0", "google/cloud-billing": "2.0.0", "google/cloud-billing-budgets": "2.0.1", "google/cloud-binary-authorization": "1.0.1", "google/cloud-build": "1.0.0", "google/cloud-certificate-manager": "1.0.0", - "google/cloud-channel": "2.0.0", + "google/cloud-channel": "2.1.0", "google/cloud-cloudcontrolspartner": "0.2.0", "google/cloud-commerce-consumer-procurement": "1.0.0", "google/cloud-common-protos": "0.6.0", @@ -185,7 +185,7 @@ "google/cloud-org-policy": "1.1.0", "google/cloud-osconfig": "2.0.0", "google/cloud-oslogin": "2.0.1", - "google/cloud-parallelstore": "0.6.0", + "google/cloud-parallelstore": "0.6.1", "google/cloud-policy-troubleshooter": "2.0.1", "google/cloud-policysimulator": "1.0.0", "google/cloud-policytroubleshooter-iam": "0.2.6", @@ -198,12 +198,12 @@ "google/cloud-recaptcha-enterprise": "1.15.0", "google/cloud-recommendations-ai": "0.7.5", "google/cloud-recommender": "2.0.1", - "google/cloud-redis": "2.1.0", + "google/cloud-redis": "2.1.1", "google/cloud-redis-cluster": "0.3.0", "google/cloud-resource-manager": "1.0.0", "google/cloud-resource-settings": "2.0.1", "google/cloud-retail": "2.0.0", - "google/cloud-run": "1.1.0", + "google/cloud-run": "1.2.0", "google/cloud-scheduler": "2.0.0", "google/cloud-secret-manager": "1.15.2", "google/cloud-securesourcemanager": "1.1.0", @@ -217,10 +217,10 @@ "google/cloud-service-usage": "2.0.0", "google/cloud-servicehealth": "0.1.6", "google/cloud-shell": "2.0.1", - "google/cloud-spanner": "1.85.0", + "google/cloud-spanner": "1.86.0", "google/cloud-speech": "1.19.0", "google/cloud-sql-admin": "1.2.0", - "google/cloud-storage": "1.43.0", + "google/cloud-storage": "1.43.1", "google/cloud-storage-control": "1.0.0", "google/cloud-storage-transfer": "2.0.0", "google/cloud-storageinsights": "1.0.0", @@ -252,9 +252,9 @@ "google/maps-routeoptimization": "0.3.0", "google/shopping-common-protos": "0.4.0", "google/shopping-css": "0.2.9", - "google/shopping-merchant-accounts": "0.2.0", + "google/shopping-merchant-accounts": "0.3.0", "google/shopping-merchant-conversions": "0.1.2", - "google/shopping-merchant-datasources": "0.2.0", + "google/shopping-merchant-datasources": "0.2.1", "google/shopping-merchant-inventories": "0.5.0", "google/shopping-merchant-lfp": "0.1.0", "google/shopping-merchant-notifications": "0.1.0", From 534f3670edc86f7407c0224da4c4a48ea69d18fc Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:12:51 -0700 Subject: [PATCH 014/157] feat: Add import / export IssueModel (#7731) feat: Add CMEK InitializeLroSpec feat: Add metadata import to IngestConversations feat: Add sampling to IngestConversations docs: Add a comment for valid `order_by` values in ListConversations docs: Add a comment for valid `update_mask` values in UpdateConversation PiperOrigin-RevId: 683188578 Source-Link: https://github.com/googleapis/googleapis/commit/d0eeab38c8f11c090f05c332f2374b556ae36644 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4d5b300a7249ce24278fbe77c16983a06d6e4a5d Copy-Tag: eyJwIjoiQ29udGFjdENlbnRlckluc2lnaHRzLy5Pd2xCb3QueWFtbCIsImgiOiI0ZDViMzAwYTcyNDljZTI0Mjc4ZmJlNzdjMTY5ODNhMDZkNmU0YTVkIn0= --- .../metadata/V1/ContactCenterInsights.php | Bin 22895 -> 25609 bytes .../metadata/V1/Resources.php | Bin 17721 -> 18494 bytes .../create_conversation.php | 2 + .../export_issue_model.php | 87 ++++ .../get_encryption_spec.php | 71 +++ .../import_issue_model.php | 83 ++++ .../initialize_encryption_spec.php | 93 ++++ .../upload_conversation.php | 4 +- .../AnalysisResult/CallAnalysisMetadata.php | 44 ++ .../SummarizationModel.php | 7 + .../V1/Client/ContactCenterInsightsClient.php | 147 +++++- ContactCenterInsights/src/V1/Conversation.php | 42 ++ .../src/V1/ConversationLevelSilence.php | 111 +++++ .../src/V1/EncryptionSpec.php | 126 +++++ .../src/V1/ExportIssueModelMetadata.php | 165 ++++++ .../src/V1/ExportIssueModelRequest.php | 123 +++++ .../GcsDestination.php | 68 +++ .../src/V1/ExportIssueModelResponse.php | 33 ++ .../src/V1/GetEncryptionSpecRequest.php | 81 +++ .../src/V1/ImportIssueModelMetadata.php | 165 ++++++ .../src/V1/ImportIssueModelRequest.php | 165 ++++++ .../V1/ImportIssueModelRequest/GcsSource.php | 68 +++ .../src/V1/ImportIssueModelResponse.php | 33 ++ .../src/V1/IngestConversationsRequest.php | 56 +++ .../ConversationConfig.php | 30 +- .../IngestConversationsRequest/GcsSource.php | 114 +++++ .../V1/InitializeEncryptionSpecMetadata.php | 203 ++++++++ .../V1/InitializeEncryptionSpecRequest.php | 105 ++++ .../V1/InitializeEncryptionSpecResponse.php | 33 ++ ContactCenterInsights/src/V1/Issue.php | 34 ++ .../src/V1/ListConversationsRequest.php | 90 +++- .../src/V1/RedactionConfig.php | 6 + .../src/V1/RuntimeAnnotation.php | 44 ++ .../src/V1/RuntimeAnnotation/UserInput.php | 144 ++++++ .../UserInput/QuerySource.php | 63 +++ ContactCenterInsights/src/V1/Settings.php | 63 ++- ContactCenterInsights/src/V1/SpeechConfig.php | 4 + .../src/V1/UpdateConversationRequest.php | 71 ++- .../src/V1/UploadConversationMetadata.php | 2 +- .../src/V1/gapic_metadata.json | 20 + ...contact_center_insights_client_config.json | 20 + ...tact_center_insights_descriptor_config.php | 71 +++ ...act_center_insights_rest_client_config.php | 48 ++ .../ContactCenterInsightsClientTest.php | 469 ++++++++++++++++++ 44 files changed, 3370 insertions(+), 38 deletions(-) create mode 100644 ContactCenterInsights/samples/V1/ContactCenterInsightsClient/export_issue_model.php create mode 100644 ContactCenterInsights/samples/V1/ContactCenterInsightsClient/get_encryption_spec.php create mode 100644 ContactCenterInsights/samples/V1/ContactCenterInsightsClient/import_issue_model.php create mode 100644 ContactCenterInsights/samples/V1/ContactCenterInsightsClient/initialize_encryption_spec.php create mode 100644 ContactCenterInsights/src/V1/ConversationLevelSilence.php create mode 100644 ContactCenterInsights/src/V1/EncryptionSpec.php create mode 100644 ContactCenterInsights/src/V1/ExportIssueModelMetadata.php create mode 100644 ContactCenterInsights/src/V1/ExportIssueModelRequest.php create mode 100644 ContactCenterInsights/src/V1/ExportIssueModelRequest/GcsDestination.php create mode 100644 ContactCenterInsights/src/V1/ExportIssueModelResponse.php create mode 100644 ContactCenterInsights/src/V1/GetEncryptionSpecRequest.php create mode 100644 ContactCenterInsights/src/V1/ImportIssueModelMetadata.php create mode 100644 ContactCenterInsights/src/V1/ImportIssueModelRequest.php create mode 100644 ContactCenterInsights/src/V1/ImportIssueModelRequest/GcsSource.php create mode 100644 ContactCenterInsights/src/V1/ImportIssueModelResponse.php create mode 100644 ContactCenterInsights/src/V1/InitializeEncryptionSpecMetadata.php create mode 100644 ContactCenterInsights/src/V1/InitializeEncryptionSpecRequest.php create mode 100644 ContactCenterInsights/src/V1/InitializeEncryptionSpecResponse.php create mode 100644 ContactCenterInsights/src/V1/RuntimeAnnotation/UserInput.php create mode 100644 ContactCenterInsights/src/V1/RuntimeAnnotation/UserInput/QuerySource.php diff --git a/ContactCenterInsights/metadata/V1/ContactCenterInsights.php b/ContactCenterInsights/metadata/V1/ContactCenterInsights.php index d959670b94293ca15a91452d731a0d2bca7db09a..2e0d9949d501e2b921d41218b7388e2f486f3105 100644 GIT binary patch delta 1585 zcmZ`&OH30{6lGrd^%eOHrEMC4GJ>rrzaprB!4{BKEa4Z!f-o7T4;Y~{b!Lj9F$8s? zE==@A6J4l@?o1FIH*Sb=Wzd)yH-;4^t~3TUapTIFX=!Qe>|S#3J@=l^+kQdZcuTB4 z$<4dBPQaeq13k+3+?N*O8-84R%T@sk1u=|7dTP;8;37O`ziG=yC=F#d0eELtUX_mm zimZediHSt#5iM~Sk=~c5_XWUpf^dEYxWx9fkF0~`5hOEVMrP=#7(0h#Iwo=sQxZ0i zqqdVZ(8|UnS%}cd?m4t5If`5+j~TDn#`pSd(3&cypqw1E;fGcmcG*V`O+&Ir;1`f6 zF)}Cc>U)}-Ayq!i4B};)3p%udQ<&@9K7Z3UveIR z#pwmo4xuo07O`=SlBWXy9%$JGKsli!`#dQs@Didni0oo0;Q-kLEv$$b8PPJHbdBK^ z&oS-duFQ+6tEvLQ$p00XgiupJ5@I5Y8~}&R4f_mwHRhvwpGx|*w`-{qmL?A1(Rn(e z39DzJP>+tY7Mhb2#%dJ8{5Ys4ME2%gLSz>4Dc7t$TTmoaF9=v`pkgoo=yFfoBoR2{7~2GWzQEi~c5+6LvB_XhwU zPAd=Ebz8$P-NLi>QmOx1Ko P9bA%)>X>358_)X(uahV; delta 141 zcmV;80CN9{$N}%N0kES41^uW23PX`gL$m7yv<5DExkXJu}5Uuk3*0U!Y= v36nM$Rvz?S=n|jdD(&CS{CgP#sk4>@(fi!KpO^c^tNyZYBY}VbR zl8fR^i(qv;D5&7Eh@h+pg7xp{rL^_f-aQCHceky^<9pxFeBXOt=Gz+hu?{}%K=^cx z?ZNM0%YMggz>zo#wP;7HX&sH+wc5Hgd=5L~@uyekPLHLSi7XApf?emdwfaj6l zsyC@#rBc8F1Ie50vo94a(pB12j|4kE^oE;iASu()asVe)Ow^wt*Ti!+!2!CZa(t} z?8^_(1vco5zK9LkkH;nH^t*HF;Ih}G^o0ZE)g3(3-n z|HFU&lV#UV^{_-41^P;S7D?rbvT&QIbCrdRLMkP7Uda@41tlw^rd{+YxRhy+=;?o%^Isr~!vOCCP++v_(jL9oX*ZykU;Y(t(M d#xWF0%c@c=loT>MmsN^nDM_Y9X#bKk+#!tM(6j&m delta 117 zcmV-*0E+*wE&_6Dj6!Zl|)Um`$R(nQrj%R diff --git a/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/create_conversation.php b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/create_conversation.php index de5e391e5049..351839a113a1 100644 --- a/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/create_conversation.php +++ b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/create_conversation.php @@ -30,6 +30,8 @@ /** * Creates a conversation. + * Note that this method does not support audio transcription or redaction. + * Use `conversations.upload` instead. * * @param string $formattedParent The parent resource of the conversation. Please see * {@see ContactCenterInsightsClient::locationName()} for help formatting this field. diff --git a/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/export_issue_model.php b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/export_issue_model.php new file mode 100644 index 000000000000..5f3b0fbb3c28 --- /dev/null +++ b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/export_issue_model.php @@ -0,0 +1,87 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $contactCenterInsightsClient->exportIssueModel($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var ExportIssueModelResponse $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 +{ + $formattedName = ContactCenterInsightsClient::issueModelName( + '[PROJECT]', + '[LOCATION]', + '[ISSUE_MODEL]' + ); + + export_issue_model_sample($formattedName); +} +// [END contactcenterinsights_v1_generated_ContactCenterInsights_ExportIssueModel_sync] diff --git a/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/get_encryption_spec.php b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/get_encryption_spec.php new file mode 100644 index 000000000000..82178006a7dc --- /dev/null +++ b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/get_encryption_spec.php @@ -0,0 +1,71 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var EncryptionSpec $response */ + $response = $contactCenterInsightsClient->getEncryptionSpec($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = ContactCenterInsightsClient::encryptionSpecName('[PROJECT]', '[LOCATION]'); + + get_encryption_spec_sample($formattedName); +} +// [END contactcenterinsights_v1_generated_ContactCenterInsights_GetEncryptionSpec_sync] diff --git a/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/import_issue_model.php b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/import_issue_model.php new file mode 100644 index 000000000000..5b023a1d1f7f --- /dev/null +++ b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/import_issue_model.php @@ -0,0 +1,83 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $contactCenterInsightsClient->importIssueModel($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var ImportIssueModelResponse $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 +{ + $formattedParent = ContactCenterInsightsClient::locationName('[PROJECT]', '[LOCATION]'); + + import_issue_model_sample($formattedParent); +} +// [END contactcenterinsights_v1_generated_ContactCenterInsights_ImportIssueModel_sync] diff --git a/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/initialize_encryption_spec.php b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/initialize_encryption_spec.php new file mode 100644 index 000000000000..044a638387ec --- /dev/null +++ b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/initialize_encryption_spec.php @@ -0,0 +1,93 @@ +setKmsKey($encryptionSpecKmsKey); + $request = (new InitializeEncryptionSpecRequest()) + ->setEncryptionSpec($encryptionSpec); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $contactCenterInsightsClient->initializeEncryptionSpec($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var InitializeEncryptionSpecResponse $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 +{ + $encryptionSpecKmsKey = '[KMS_KEY]'; + + initialize_encryption_spec_sample($encryptionSpecKmsKey); +} +// [END contactcenterinsights_v1_generated_ContactCenterInsights_InitializeEncryptionSpec_sync] diff --git a/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/upload_conversation.php b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/upload_conversation.php index 282718b15db1..61a2fe2f44ad 100644 --- a/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/upload_conversation.php +++ b/ContactCenterInsights/samples/V1/ContactCenterInsightsClient/upload_conversation.php @@ -31,8 +31,8 @@ use Google\Rpc\Status; /** - * Create a longrunning conversation upload operation. This method differs - * from CreateConversation by allowing audio transcription and optional DLP + * Create a long-running conversation upload operation. This method differs + * from `CreateConversation` by allowing audio transcription and optional DLP * redaction. * * @param string $formattedParent The parent resource of the conversation. Please see diff --git a/ContactCenterInsights/src/V1/AnalysisResult/CallAnalysisMetadata.php b/ContactCenterInsights/src/V1/AnalysisResult/CallAnalysisMetadata.php index e5eaf71af190..e3e9ab449b5f 100644 --- a/ContactCenterInsights/src/V1/AnalysisResult/CallAnalysisMetadata.php +++ b/ContactCenterInsights/src/V1/AnalysisResult/CallAnalysisMetadata.php @@ -33,6 +33,12 @@ class CallAnalysisMetadata extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.contactcenterinsights.v1.ConversationLevelSentiment sentiments = 4; */ private $sentiments; + /** + * Overall conversation-level silence during the call. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ConversationLevelSilence silence = 11; + */ + protected $silence = null; /** * All the matched intents in the call. * @@ -64,6 +70,8 @@ class CallAnalysisMetadata extends \Google\Protobuf\Internal\Message * All the entities in the call. * @type array<\Google\Cloud\ContactCenterInsights\V1\ConversationLevelSentiment>|\Google\Protobuf\Internal\RepeatedField $sentiments * Overall conversation-level sentiment for each channel of the call. + * @type \Google\Cloud\ContactCenterInsights\V1\ConversationLevelSilence $silence + * Overall conversation-level silence during the call. * @type array|\Google\Protobuf\Internal\MapField $intents * All the matched intents in the call. * @type array|\Google\Protobuf\Internal\MapField $phrase_matchers @@ -155,6 +163,42 @@ public function setSentiments($var) return $this; } + /** + * Overall conversation-level silence during the call. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ConversationLevelSilence silence = 11; + * @return \Google\Cloud\ContactCenterInsights\V1\ConversationLevelSilence|null + */ + public function getSilence() + { + return $this->silence; + } + + public function hasSilence() + { + return isset($this->silence); + } + + public function clearSilence() + { + unset($this->silence); + } + + /** + * Overall conversation-level silence during the call. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ConversationLevelSilence silence = 11; + * @param \Google\Cloud\ContactCenterInsights\V1\ConversationLevelSilence $var + * @return $this + */ + public function setSilence($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\ConversationLevelSilence::class); + $this->silence = $var; + + return $this; + } + /** * All the matched intents in the call. * diff --git a/ContactCenterInsights/src/V1/AnnotatorSelector/SummarizationConfig/SummarizationModel.php b/ContactCenterInsights/src/V1/AnnotatorSelector/SummarizationConfig/SummarizationModel.php index e291cb1d1482..c6be9e6691d7 100644 --- a/ContactCenterInsights/src/V1/AnnotatorSelector/SummarizationConfig/SummarizationModel.php +++ b/ContactCenterInsights/src/V1/AnnotatorSelector/SummarizationConfig/SummarizationModel.php @@ -25,10 +25,17 @@ class SummarizationModel * Generated from protobuf enum BASELINE_MODEL = 1; */ const BASELINE_MODEL = 1; + /** + * The CCAI baseline model, V2.0. + * + * Generated from protobuf enum BASELINE_MODEL_V2_0 = 2; + */ + const BASELINE_MODEL_V2_0 = 2; private static $valueToName = [ self::SUMMARIZATION_MODEL_UNSPECIFIED => 'SUMMARIZATION_MODEL_UNSPECIFIED', self::BASELINE_MODEL => 'BASELINE_MODEL', + self::BASELINE_MODEL_V2_0 => 'BASELINE_MODEL_V2_0', ]; public static function name($value) diff --git a/ContactCenterInsights/src/V1/Client/ContactCenterInsightsClient.php b/ContactCenterInsights/src/V1/Client/ContactCenterInsightsClient.php index fca384bdd4f0..8a87b9d496f1 100644 --- a/ContactCenterInsights/src/V1/Client/ContactCenterInsightsClient.php +++ b/ContactCenterInsights/src/V1/Client/ContactCenterInsightsClient.php @@ -54,15 +54,20 @@ use Google\Cloud\ContactCenterInsights\V1\DeletePhraseMatcherRequest; use Google\Cloud\ContactCenterInsights\V1\DeleteViewRequest; use Google\Cloud\ContactCenterInsights\V1\DeployIssueModelRequest; +use Google\Cloud\ContactCenterInsights\V1\EncryptionSpec; use Google\Cloud\ContactCenterInsights\V1\ExportInsightsDataRequest; +use Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest; use Google\Cloud\ContactCenterInsights\V1\GetAnalysisRequest; use Google\Cloud\ContactCenterInsights\V1\GetConversationRequest; +use Google\Cloud\ContactCenterInsights\V1\GetEncryptionSpecRequest; use Google\Cloud\ContactCenterInsights\V1\GetIssueModelRequest; use Google\Cloud\ContactCenterInsights\V1\GetIssueRequest; use Google\Cloud\ContactCenterInsights\V1\GetPhraseMatcherRequest; use Google\Cloud\ContactCenterInsights\V1\GetSettingsRequest; use Google\Cloud\ContactCenterInsights\V1\GetViewRequest; +use Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest; use Google\Cloud\ContactCenterInsights\V1\IngestConversationsRequest; +use Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecRequest; use Google\Cloud\ContactCenterInsights\V1\Issue; use Google\Cloud\ContactCenterInsights\V1\IssueModel; use Google\Cloud\ContactCenterInsights\V1\ListAnalysesRequest; @@ -116,14 +121,18 @@ * @method PromiseInterface deleteViewAsync(DeleteViewRequest $request, array $optionalArgs = []) * @method PromiseInterface deployIssueModelAsync(DeployIssueModelRequest $request, array $optionalArgs = []) * @method PromiseInterface exportInsightsDataAsync(ExportInsightsDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportIssueModelAsync(ExportIssueModelRequest $request, array $optionalArgs = []) * @method PromiseInterface getAnalysisAsync(GetAnalysisRequest $request, array $optionalArgs = []) * @method PromiseInterface getConversationAsync(GetConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEncryptionSpecAsync(GetEncryptionSpecRequest $request, array $optionalArgs = []) * @method PromiseInterface getIssueAsync(GetIssueRequest $request, array $optionalArgs = []) * @method PromiseInterface getIssueModelAsync(GetIssueModelRequest $request, array $optionalArgs = []) * @method PromiseInterface getPhraseMatcherAsync(GetPhraseMatcherRequest $request, array $optionalArgs = []) * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) * @method PromiseInterface getViewAsync(GetViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface importIssueModelAsync(ImportIssueModelRequest $request, array $optionalArgs = []) * @method PromiseInterface ingestConversationsAsync(IngestConversationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest $request, array $optionalArgs = []) * @method PromiseInterface listAnalysesAsync(ListAnalysesRequest $request, array $optionalArgs = []) * @method PromiseInterface listConversationsAsync(ListConversationsRequest $request, array $optionalArgs = []) * @method PromiseInterface listIssueModelsAsync(ListIssueModelsRequest $request, array $optionalArgs = []) @@ -303,6 +312,23 @@ public static function conversationProfileName( ]); } + /** + * Formats a string containing the fully-qualified path to represent a + * encryption_spec resource. + * + * @param string $project + * @param string $location + * + * @return string The formatted encryption_spec resource. + */ + public static function encryptionSpecName(string $project, string $location): string + { + return self::getPathTemplate('encryptionSpec')->render([ + 'project' => $project, + 'location' => $location, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a issue * resource. @@ -507,6 +533,7 @@ public static function viewName(string $project, string $location, string $view) * - analysis: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} * - conversation: projects/{project}/locations/{location}/conversations/{conversation} * - conversationProfile: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + * - encryptionSpec: projects/{project}/locations/{location}/encryptionSpec * - issue: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} * - issueModel: projects/{project}/locations/{location}/issueModels/{issue_model} * - location: projects/{project}/locations/{location} @@ -750,6 +777,8 @@ public function createAnalysis(CreateAnalysisRequest $request, array $callOption /** * Creates a conversation. + * Note that this method does not support audio transcription or redaction. + * Use `conversations.upload` instead. * * The async variant is * {@see ContactCenterInsightsClient::createConversationAsync()} . @@ -1059,6 +1088,33 @@ public function exportInsightsData(ExportInsightsDataRequest $request, array $ca return $this->startApiCall('ExportInsightsData', $request, $callOptions)->wait(); } + /** + * Exports an issue model to the provided destination. + * + * The async variant is {@see ContactCenterInsightsClient::exportIssueModelAsync()} + * . + * + * @example samples/V1/ContactCenterInsightsClient/export_issue_model.php + * + * @param ExportIssueModelRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function exportIssueModel(ExportIssueModelRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('ExportIssueModel', $request, $callOptions)->wait(); + } + /** * Gets an analysis. * @@ -1112,6 +1168,33 @@ public function getConversation(GetConversationRequest $request, array $callOpti return $this->startApiCall('GetConversation', $request, $callOptions)->wait(); } + /** + * Gets location-level encryption key specification. + * + * The async variant is + * {@see ContactCenterInsightsClient::getEncryptionSpecAsync()} . + * + * @example samples/V1/ContactCenterInsightsClient/get_encryption_spec.php + * + * @param GetEncryptionSpecRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return EncryptionSpec + * + * @throws ApiException Thrown if the API call fails. + */ + public function getEncryptionSpec(GetEncryptionSpecRequest $request, array $callOptions = []): EncryptionSpec + { + return $this->startApiCall('GetEncryptionSpec', $request, $callOptions)->wait(); + } + /** * Gets an issue. * @@ -1243,6 +1326,33 @@ public function getView(GetViewRequest $request, array $callOptions = []): View return $this->startApiCall('GetView', $request, $callOptions)->wait(); } + /** + * Imports an issue model from a Cloud Storage bucket. + * + * The async variant is {@see ContactCenterInsightsClient::importIssueModelAsync()} + * . + * + * @example samples/V1/ContactCenterInsightsClient/import_issue_model.php + * + * @param ImportIssueModelRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function importIssueModel(ImportIssueModelRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('ImportIssueModel', $request, $callOptions)->wait(); + } + /** * Imports conversations and processes them according to the user's * configuration. @@ -1271,6 +1381,39 @@ public function ingestConversations(IngestConversationsRequest $request, array $ return $this->startApiCall('IngestConversations', $request, $callOptions)->wait(); } + /** + * Initializes a location-level encryption key specification. An error will + * be thrown if the location has resources already created before the + * initialization. Once the encryption specification is initialized at a + * location, it is immutable and all newly created resources under the + * location will be encrypted with the existing specification. + * + * The async variant is + * {@see ContactCenterInsightsClient::initializeEncryptionSpecAsync()} . + * + * @example samples/V1/ContactCenterInsightsClient/initialize_encryption_spec.php + * + * @param InitializeEncryptionSpecRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function initializeEncryptionSpec( + InitializeEncryptionSpecRequest $request, + array $callOptions = [] + ): OperationResponse { + return $this->startApiCall('InitializeEncryptionSpec', $request, $callOptions)->wait(); + } + /** * Lists analyses. * @@ -1618,8 +1761,8 @@ public function updateView(UpdateViewRequest $request, array $callOptions = []): } /** - * Create a longrunning conversation upload operation. This method differs - * from CreateConversation by allowing audio transcription and optional DLP + * Create a long-running conversation upload operation. This method differs + * from `CreateConversation` by allowing audio transcription and optional DLP * redaction. * * The async variant is diff --git a/ContactCenterInsights/src/V1/Conversation.php b/ContactCenterInsights/src/V1/Conversation.php index 1de28cfd8c8d..be3e5078a267 100644 --- a/ContactCenterInsights/src/V1/Conversation.php +++ b/ContactCenterInsights/src/V1/Conversation.php @@ -73,6 +73,14 @@ class Conversation extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.contactcenterinsights.v1.Conversation.QualityMetadata quality_metadata = 24; */ protected $quality_metadata = null; + /** + * Input only. JSON Metadata encoded as a string. + * This field is primarily used by Insights integrations with various telphony + * systems and must be in one of Insights' supported formats. + * + * Generated from protobuf field string metadata_json = 25 [(.google.api.field_behavior) = INPUT_ONLY]; + */ + protected $metadata_json = ''; /** * Output only. The conversation transcript. * @@ -170,6 +178,10 @@ class Conversation extends \Google\Protobuf\Internal\Message * conversation is allowed, with a maximum of 256 characters per entry. * @type \Google\Cloud\ContactCenterInsights\V1\Conversation\QualityMetadata $quality_metadata * Conversation metadata related to quality management. + * @type string $metadata_json + * Input only. JSON Metadata encoded as a string. + * This field is primarily used by Insights integrations with various telphony + * systems and must be in one of Insights' supported formats. * @type \Google\Cloud\ContactCenterInsights\V1\Conversation\Transcript $transcript * Output only. The conversation transcript. * @type int $medium @@ -588,6 +600,36 @@ public function setQualityMetadata($var) return $this; } + /** + * Input only. JSON Metadata encoded as a string. + * This field is primarily used by Insights integrations with various telphony + * systems and must be in one of Insights' supported formats. + * + * Generated from protobuf field string metadata_json = 25 [(.google.api.field_behavior) = INPUT_ONLY]; + * @return string + */ + public function getMetadataJson() + { + return $this->metadata_json; + } + + /** + * Input only. JSON Metadata encoded as a string. + * This field is primarily used by Insights integrations with various telphony + * systems and must be in one of Insights' supported formats. + * + * Generated from protobuf field string metadata_json = 25 [(.google.api.field_behavior) = INPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setMetadataJson($var) + { + GPBUtil::checkString($var, True); + $this->metadata_json = $var; + + return $this; + } + /** * Output only. The conversation transcript. * diff --git a/ContactCenterInsights/src/V1/ConversationLevelSilence.php b/ContactCenterInsights/src/V1/ConversationLevelSilence.php new file mode 100644 index 000000000000..859ffc656498 --- /dev/null +++ b/ContactCenterInsights/src/V1/ConversationLevelSilence.php @@ -0,0 +1,111 @@ +google.cloud.contactcenterinsights.v1.ConversationLevelSilence + */ +class ConversationLevelSilence extends \Google\Protobuf\Internal\Message +{ + /** + * Amount of time calculated to be in silence. + * + * Generated from protobuf field .google.protobuf.Duration silence_duration = 1; + */ + protected $silence_duration = null; + /** + * Percentage of the total conversation spent in silence. + * + * Generated from protobuf field float silence_percentage = 2; + */ + protected $silence_percentage = 0.0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Duration $silence_duration + * Amount of time calculated to be in silence. + * @type float $silence_percentage + * Percentage of the total conversation spent in silence. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Amount of time calculated to be in silence. + * + * Generated from protobuf field .google.protobuf.Duration silence_duration = 1; + * @return \Google\Protobuf\Duration|null + */ + public function getSilenceDuration() + { + return $this->silence_duration; + } + + public function hasSilenceDuration() + { + return isset($this->silence_duration); + } + + public function clearSilenceDuration() + { + unset($this->silence_duration); + } + + /** + * Amount of time calculated to be in silence. + * + * Generated from protobuf field .google.protobuf.Duration silence_duration = 1; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setSilenceDuration($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->silence_duration = $var; + + return $this; + } + + /** + * Percentage of the total conversation spent in silence. + * + * Generated from protobuf field float silence_percentage = 2; + * @return float + */ + public function getSilencePercentage() + { + return $this->silence_percentage; + } + + /** + * Percentage of the total conversation spent in silence. + * + * Generated from protobuf field float silence_percentage = 2; + * @param float $var + * @return $this + */ + public function setSilencePercentage($var) + { + GPBUtil::checkFloat($var); + $this->silence_percentage = $var; + + return $this; + } + +} + diff --git a/ContactCenterInsights/src/V1/EncryptionSpec.php b/ContactCenterInsights/src/V1/EncryptionSpec.php new file mode 100644 index 000000000000..d3efccef926d --- /dev/null +++ b/ContactCenterInsights/src/V1/EncryptionSpec.php @@ -0,0 +1,126 @@ +google.cloud.contactcenterinsights.v1.EncryptionSpec + */ +class EncryptionSpec extends \Google\Protobuf\Internal\Message +{ + /** + * Immutable. The resource name of the encryption key specification resource. + * Format: + * projects/{project}/locations/{location}/encryptionSpec + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; + */ + protected $name = ''; + /** + * Required. The name of customer-managed encryption key that is used to + * secure a resource and its sub-resources. If empty, the resource is secured + * by the default Google encryption key. Only the key in the same location as + * this resource is allowed to be used for encryption. Format: + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + * + * Generated from protobuf field string kms_key = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $kms_key = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Immutable. The resource name of the encryption key specification resource. + * Format: + * projects/{project}/locations/{location}/encryptionSpec + * @type string $kms_key + * Required. The name of customer-managed encryption key that is used to + * secure a resource and its sub-resources. If empty, the resource is secured + * by the default Google encryption key. Only the key in the same location as + * this resource is allowed to be used for encryption. Format: + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Immutable. The resource name of the encryption key specification resource. + * Format: + * projects/{project}/locations/{location}/encryptionSpec + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Immutable. The resource name of the encryption key specification resource. + * Format: + * projects/{project}/locations/{location}/encryptionSpec + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Required. The name of customer-managed encryption key that is used to + * secure a resource and its sub-resources. If empty, the resource is secured + * by the default Google encryption key. Only the key in the same location as + * this resource is allowed to be used for encryption. Format: + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + * + * Generated from protobuf field string kms_key = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getKmsKey() + { + return $this->kms_key; + } + + /** + * Required. The name of customer-managed encryption key that is used to + * secure a resource and its sub-resources. If empty, the resource is secured + * by the default Google encryption key. Only the key in the same location as + * this resource is allowed to be used for encryption. Format: + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + * + * Generated from protobuf field string kms_key = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setKmsKey($var) + { + GPBUtil::checkString($var, True); + $this->kms_key = $var; + + return $this; + } + +} + diff --git a/ContactCenterInsights/src/V1/ExportIssueModelMetadata.php b/ContactCenterInsights/src/V1/ExportIssueModelMetadata.php new file mode 100644 index 000000000000..7a6e77bd3038 --- /dev/null +++ b/ContactCenterInsights/src/V1/ExportIssueModelMetadata.php @@ -0,0 +1,165 @@ +google.cloud.contactcenterinsights.v1.ExportIssueModelMetadata + */ +class ExportIssueModelMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1; + */ + protected $create_time = null; + /** + * The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + */ + protected $end_time = null; + /** + * The original export request. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ExportIssueModelRequest request = 3; + */ + protected $request = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Timestamp $create_time + * The time the operation was created. + * @type \Google\Protobuf\Timestamp $end_time + * The time the operation finished running. + * @type \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest $request + * The original export request. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + + /** + * The original export request. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ExportIssueModelRequest request = 3; + * @return \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest|null + */ + public function getRequest() + { + return $this->request; + } + + public function hasRequest() + { + return isset($this->request); + } + + public function clearRequest() + { + unset($this->request); + } + + /** + * The original export request. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ExportIssueModelRequest request = 3; + * @param \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest $var + * @return $this + */ + public function setRequest($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest::class); + $this->request = $var; + + return $this; + } + +} + diff --git a/ContactCenterInsights/src/V1/ExportIssueModelRequest.php b/ContactCenterInsights/src/V1/ExportIssueModelRequest.php new file mode 100644 index 000000000000..5fc916d35604 --- /dev/null +++ b/ContactCenterInsights/src/V1/ExportIssueModelRequest.php @@ -0,0 +1,123 @@ +google.cloud.contactcenterinsights.v1.ExportIssueModelRequest + */ +class ExportIssueModelRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The issue model to export. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + protected $Destination; + + /** + * @param string $name Required. The issue model to export. Please see + * {@see ContactCenterInsightsClient::issueModelName()} for help formatting this field. + * + * @return \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest\GcsDestination $gcs_destination + * Google Cloud Storage URI to export the issue model to. + * @type string $name + * Required. The issue model to export. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * Google Cloud Storage URI to export the issue model to. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ExportIssueModelRequest.GcsDestination gcs_destination = 2; + * @return \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest\GcsDestination|null + */ + public function getGcsDestination() + { + return $this->readOneof(2); + } + + public function hasGcsDestination() + { + return $this->hasOneof(2); + } + + /** + * Google Cloud Storage URI to export the issue model to. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ExportIssueModelRequest.GcsDestination gcs_destination = 2; + * @param \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest\GcsDestination $var + * @return $this + */ + public function setGcsDestination($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest\GcsDestination::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Required. The issue model to export. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The issue model to export. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * @return string + */ + public function getDestination() + { + return $this->whichOneof("Destination"); + } + +} + diff --git a/ContactCenterInsights/src/V1/ExportIssueModelRequest/GcsDestination.php b/ContactCenterInsights/src/V1/ExportIssueModelRequest/GcsDestination.php new file mode 100644 index 000000000000..780157daa136 --- /dev/null +++ b/ContactCenterInsights/src/V1/ExportIssueModelRequest/GcsDestination.php @@ -0,0 +1,68 @@ +google.cloud.contactcenterinsights.v1.ExportIssueModelRequest.GcsDestination + */ +class GcsDestination extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Format: `gs:///` + * + * Generated from protobuf field string object_uri = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $object_uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $object_uri + * Required. Format: `gs:///` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * Required. Format: `gs:///` + * + * Generated from protobuf field string object_uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getObjectUri() + { + return $this->object_uri; + } + + /** + * Required. Format: `gs:///` + * + * Generated from protobuf field string object_uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setObjectUri($var) + { + GPBUtil::checkString($var, True); + $this->object_uri = $var; + + return $this; + } + +} + + diff --git a/ContactCenterInsights/src/V1/ExportIssueModelResponse.php b/ContactCenterInsights/src/V1/ExportIssueModelResponse.php new file mode 100644 index 000000000000..cb2c757dea28 --- /dev/null +++ b/ContactCenterInsights/src/V1/ExportIssueModelResponse.php @@ -0,0 +1,33 @@ +google.cloud.contactcenterinsights.v1.ExportIssueModelResponse + */ +class ExportIssueModelResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + +} + diff --git a/ContactCenterInsights/src/V1/GetEncryptionSpecRequest.php b/ContactCenterInsights/src/V1/GetEncryptionSpecRequest.php new file mode 100644 index 000000000000..c0076eb9be97 --- /dev/null +++ b/ContactCenterInsights/src/V1/GetEncryptionSpecRequest.php @@ -0,0 +1,81 @@ +google.cloud.contactcenterinsights.v1.GetEncryptionSpecRequest + */ +class GetEncryptionSpecRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the encryption spec resource to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the encryption spec resource to get. Please see + * {@see ContactCenterInsightsClient::encryptionSpecName()} for help formatting this field. + * + * @return \Google\Cloud\ContactCenterInsights\V1\GetEncryptionSpecRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the encryption spec resource to get. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the encryption spec resource to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the encryption spec resource to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/ContactCenterInsights/src/V1/ImportIssueModelMetadata.php b/ContactCenterInsights/src/V1/ImportIssueModelMetadata.php new file mode 100644 index 000000000000..ed2259957dce --- /dev/null +++ b/ContactCenterInsights/src/V1/ImportIssueModelMetadata.php @@ -0,0 +1,165 @@ +google.cloud.contactcenterinsights.v1.ImportIssueModelMetadata + */ +class ImportIssueModelMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1; + */ + protected $create_time = null; + /** + * The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + */ + protected $end_time = null; + /** + * The original import request. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ImportIssueModelRequest request = 3; + */ + protected $request = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Timestamp $create_time + * The time the operation was created. + * @type \Google\Protobuf\Timestamp $end_time + * The time the operation finished running. + * @type \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest $request + * The original import request. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + + /** + * The original import request. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ImportIssueModelRequest request = 3; + * @return \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest|null + */ + public function getRequest() + { + return $this->request; + } + + public function hasRequest() + { + return isset($this->request); + } + + public function clearRequest() + { + unset($this->request); + } + + /** + * The original import request. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ImportIssueModelRequest request = 3; + * @param \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest $var + * @return $this + */ + public function setRequest($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest::class); + $this->request = $var; + + return $this; + } + +} + diff --git a/ContactCenterInsights/src/V1/ImportIssueModelRequest.php b/ContactCenterInsights/src/V1/ImportIssueModelRequest.php new file mode 100644 index 000000000000..871dd620e2c9 --- /dev/null +++ b/ContactCenterInsights/src/V1/ImportIssueModelRequest.php @@ -0,0 +1,165 @@ +google.cloud.contactcenterinsights.v1.ImportIssueModelRequest + */ +class ImportIssueModelRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent resource of the issue model. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. If set to true, will create an issue model from the imported file + * with randomly generated IDs for the issue model and corresponding issues. + * Otherwise, replaces an existing model with the same ID as the file. + * + * Generated from protobuf field bool create_new_model = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $create_new_model = false; + protected $Source; + + /** + * @param string $parent Required. The parent resource of the issue model. Please see + * {@see ContactCenterInsightsClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest\GcsSource $gcs_source + * Google Cloud Storage source message. + * @type string $parent + * Required. The parent resource of the issue model. + * @type bool $create_new_model + * Optional. If set to true, will create an issue model from the imported file + * with randomly generated IDs for the issue model and corresponding issues. + * Otherwise, replaces an existing model with the same ID as the file. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * Google Cloud Storage source message. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ImportIssueModelRequest.GcsSource gcs_source = 2; + * @return \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest\GcsSource|null + */ + public function getGcsSource() + { + return $this->readOneof(2); + } + + public function hasGcsSource() + { + return $this->hasOneof(2); + } + + /** + * Google Cloud Storage source message. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.ImportIssueModelRequest.GcsSource gcs_source = 2; + * @param \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest\GcsSource $var + * @return $this + */ + public function setGcsSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest\GcsSource::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Required. The parent resource of the issue model. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent resource of the issue model. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. If set to true, will create an issue model from the imported file + * with randomly generated IDs for the issue model and corresponding issues. + * Otherwise, replaces an existing model with the same ID as the file. + * + * Generated from protobuf field bool create_new_model = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getCreateNewModel() + { + return $this->create_new_model; + } + + /** + * Optional. If set to true, will create an issue model from the imported file + * with randomly generated IDs for the issue model and corresponding issues. + * Otherwise, replaces an existing model with the same ID as the file. + * + * Generated from protobuf field bool create_new_model = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setCreateNewModel($var) + { + GPBUtil::checkBool($var); + $this->create_new_model = $var; + + return $this; + } + + /** + * @return string + */ + public function getSource() + { + return $this->whichOneof("Source"); + } + +} + diff --git a/ContactCenterInsights/src/V1/ImportIssueModelRequest/GcsSource.php b/ContactCenterInsights/src/V1/ImportIssueModelRequest/GcsSource.php new file mode 100644 index 000000000000..3080f8b29f24 --- /dev/null +++ b/ContactCenterInsights/src/V1/ImportIssueModelRequest/GcsSource.php @@ -0,0 +1,68 @@ +google.cloud.contactcenterinsights.v1.ImportIssueModelRequest.GcsSource + */ +class GcsSource extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Format: `gs:///` + * + * Generated from protobuf field string object_uri = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $object_uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $object_uri + * Required. Format: `gs:///` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * Required. Format: `gs:///` + * + * Generated from protobuf field string object_uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getObjectUri() + { + return $this->object_uri; + } + + /** + * Required. Format: `gs:///` + * + * Generated from protobuf field string object_uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setObjectUri($var) + { + GPBUtil::checkString($var, True); + $this->object_uri = $var; + + return $this; + } + +} + + diff --git a/ContactCenterInsights/src/V1/ImportIssueModelResponse.php b/ContactCenterInsights/src/V1/ImportIssueModelResponse.php new file mode 100644 index 000000000000..0bd1db15abb5 --- /dev/null +++ b/ContactCenterInsights/src/V1/ImportIssueModelResponse.php @@ -0,0 +1,33 @@ +google.cloud.contactcenterinsights.v1.ImportIssueModelResponse + */ +class ImportIssueModelResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + +} + diff --git a/ContactCenterInsights/src/V1/IngestConversationsRequest.php b/ContactCenterInsights/src/V1/IngestConversationsRequest.php index 96c359e2ee87..435d372507c8 100644 --- a/ContactCenterInsights/src/V1/IngestConversationsRequest.php +++ b/ContactCenterInsights/src/V1/IngestConversationsRequest.php @@ -41,6 +41,15 @@ class IngestConversationsRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.contactcenterinsights.v1.SpeechConfig speech_config = 6 [(.google.api.field_behavior) = OPTIONAL]; */ protected $speech_config = null; + /** + * Optional. If set, this fields indicates the number of objects to ingest + * from the Cloud Storage bucket. If empty, the entire bucket will be + * ingested. Unless they are first deleted, conversations produced through + * sampling won't be ingested by subsequent ingest requests. + * + * Generated from protobuf field optional int32 sample_size = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $sample_size = null; protected $source; protected $object_config; @@ -79,6 +88,11 @@ public static function build(string $parent): self * @type \Google\Cloud\ContactCenterInsights\V1\SpeechConfig $speech_config * Optional. Default Speech-to-Text configuration. Optional, will default to * the config specified in Settings. + * @type int $sample_size + * Optional. If set, this fields indicates the number of objects to ingest + * from the Cloud Storage bucket. If empty, the entire bucket will be + * ingested. Unless they are first deleted, conversations produced through + * sampling won't be ingested by subsequent ingest requests. * } */ public function __construct($data = NULL) { @@ -288,6 +302,48 @@ public function setSpeechConfig($var) return $this; } + /** + * Optional. If set, this fields indicates the number of objects to ingest + * from the Cloud Storage bucket. If empty, the entire bucket will be + * ingested. Unless they are first deleted, conversations produced through + * sampling won't be ingested by subsequent ingest requests. + * + * Generated from protobuf field optional int32 sample_size = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSampleSize() + { + return isset($this->sample_size) ? $this->sample_size : 0; + } + + public function hasSampleSize() + { + return isset($this->sample_size); + } + + public function clearSampleSize() + { + unset($this->sample_size); + } + + /** + * Optional. If set, this fields indicates the number of objects to ingest + * from the Cloud Storage bucket. If empty, the entire bucket will be + * ingested. Unless they are first deleted, conversations produced through + * sampling won't be ingested by subsequent ingest requests. + * + * Generated from protobuf field optional int32 sample_size = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSampleSize($var) + { + GPBUtil::checkInt32($var); + $this->sample_size = $var; + + return $this; + } + /** * @return string */ diff --git a/ContactCenterInsights/src/V1/IngestConversationsRequest/ConversationConfig.php b/ContactCenterInsights/src/V1/IngestConversationsRequest/ConversationConfig.php index d1fce0b70425..0c6d03321d54 100644 --- a/ContactCenterInsights/src/V1/IngestConversationsRequest/ConversationConfig.php +++ b/ContactCenterInsights/src/V1/IngestConversationsRequest/ConversationConfig.php @@ -16,10 +16,12 @@ class ConversationConfig extends \Google\Protobuf\Internal\Message { /** - * An opaque, user-specified string representing the human agent who handled - * the conversations. + * Optional. An opaque, user-specified string representing a human agent who + * handled all conversations in the import. Note that this will be + * overridden if per-conversation metadata is provided through the + * `metadata_bucket_uri`. * - * Generated from protobuf field string agent_id = 1; + * Generated from protobuf field string agent_id = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $agent_id = ''; /** @@ -46,8 +48,10 @@ class ConversationConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $agent_id - * An opaque, user-specified string representing the human agent who handled - * the conversations. + * Optional. An opaque, user-specified string representing a human agent who + * handled all conversations in the import. Note that this will be + * overridden if per-conversation metadata is provided through the + * `metadata_bucket_uri`. * @type int $agent_channel * Optional. Indicates which of the channels, 1 or 2, contains the agent. * Note that this must be set for conversations to be properly displayed and @@ -64,10 +68,12 @@ public function __construct($data = NULL) { } /** - * An opaque, user-specified string representing the human agent who handled - * the conversations. + * Optional. An opaque, user-specified string representing a human agent who + * handled all conversations in the import. Note that this will be + * overridden if per-conversation metadata is provided through the + * `metadata_bucket_uri`. * - * Generated from protobuf field string agent_id = 1; + * Generated from protobuf field string agent_id = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getAgentId() @@ -76,10 +82,12 @@ public function getAgentId() } /** - * An opaque, user-specified string representing the human agent who handled - * the conversations. + * Optional. An opaque, user-specified string representing a human agent who + * handled all conversations in the import. Note that this will be + * overridden if per-conversation metadata is provided through the + * `metadata_bucket_uri`. * - * Generated from protobuf field string agent_id = 1; + * Generated from protobuf field string agent_id = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/ContactCenterInsights/src/V1/IngestConversationsRequest/GcsSource.php b/ContactCenterInsights/src/V1/IngestConversationsRequest/GcsSource.php index ac6730cabde1..b09e2ad81e11 100644 --- a/ContactCenterInsights/src/V1/IngestConversationsRequest/GcsSource.php +++ b/ContactCenterInsights/src/V1/IngestConversationsRequest/GcsSource.php @@ -27,6 +27,27 @@ class GcsSource extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.contactcenterinsights.v1.IngestConversationsRequest.GcsSource.BucketObjectType bucket_object_type = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $bucket_object_type = 0; + /** + * Optional. The Cloud Storage path to the conversation metadata. Note that: + * [1] Metadata files are expected to be in JSON format. + * [2] Metadata and source files (transcripts or audio) must be in + * separate buckets. + * [3] A source file and its corresponding metadata file must share the same + * name to + * be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and + * `gs://bucket/metadata/conversation1.json`. + * + * Generated from protobuf field optional string metadata_bucket_uri = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $metadata_bucket_uri = null; + /** + * Optional. Custom keys to extract as conversation labels from metadata + * files in `metadata_bucket_uri`. Keys not included in this field will be + * ignored. Note that there is a limit of 20 labels per conversation. + * + * Generated from protobuf field repeated string custom_metadata_keys = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $custom_metadata_keys; /** * Constructor. @@ -38,6 +59,19 @@ class GcsSource extends \Google\Protobuf\Internal\Message * Required. The Cloud Storage bucket containing source objects. * @type int $bucket_object_type * Optional. Specifies the type of the objects in `bucket_uri`. + * @type string $metadata_bucket_uri + * Optional. The Cloud Storage path to the conversation metadata. Note that: + * [1] Metadata files are expected to be in JSON format. + * [2] Metadata and source files (transcripts or audio) must be in + * separate buckets. + * [3] A source file and its corresponding metadata file must share the same + * name to + * be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and + * `gs://bucket/metadata/conversation1.json`. + * @type array|\Google\Protobuf\Internal\RepeatedField $custom_metadata_keys + * Optional. Custom keys to extract as conversation labels from metadata + * files in `metadata_bucket_uri`. Keys not included in this field will be + * ignored. Note that there is a limit of 20 labels per conversation. * } */ public function __construct($data = NULL) { @@ -97,6 +131,86 @@ public function setBucketObjectType($var) return $this; } + /** + * Optional. The Cloud Storage path to the conversation metadata. Note that: + * [1] Metadata files are expected to be in JSON format. + * [2] Metadata and source files (transcripts or audio) must be in + * separate buckets. + * [3] A source file and its corresponding metadata file must share the same + * name to + * be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and + * `gs://bucket/metadata/conversation1.json`. + * + * Generated from protobuf field optional string metadata_bucket_uri = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getMetadataBucketUri() + { + return isset($this->metadata_bucket_uri) ? $this->metadata_bucket_uri : ''; + } + + public function hasMetadataBucketUri() + { + return isset($this->metadata_bucket_uri); + } + + public function clearMetadataBucketUri() + { + unset($this->metadata_bucket_uri); + } + + /** + * Optional. The Cloud Storage path to the conversation metadata. Note that: + * [1] Metadata files are expected to be in JSON format. + * [2] Metadata and source files (transcripts or audio) must be in + * separate buckets. + * [3] A source file and its corresponding metadata file must share the same + * name to + * be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and + * `gs://bucket/metadata/conversation1.json`. + * + * Generated from protobuf field optional string metadata_bucket_uri = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setMetadataBucketUri($var) + { + GPBUtil::checkString($var, True); + $this->metadata_bucket_uri = $var; + + return $this; + } + + /** + * Optional. Custom keys to extract as conversation labels from metadata + * files in `metadata_bucket_uri`. Keys not included in this field will be + * ignored. Note that there is a limit of 20 labels per conversation. + * + * Generated from protobuf field repeated string custom_metadata_keys = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCustomMetadataKeys() + { + return $this->custom_metadata_keys; + } + + /** + * Optional. Custom keys to extract as conversation labels from metadata + * files in `metadata_bucket_uri`. Keys not included in this field will be + * ignored. Note that there is a limit of 20 labels per conversation. + * + * Generated from protobuf field repeated string custom_metadata_keys = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCustomMetadataKeys($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->custom_metadata_keys = $arr; + + return $this; + } + } diff --git a/ContactCenterInsights/src/V1/InitializeEncryptionSpecMetadata.php b/ContactCenterInsights/src/V1/InitializeEncryptionSpecMetadata.php new file mode 100644 index 000000000000..c0baf71e1a3d --- /dev/null +++ b/ContactCenterInsights/src/V1/InitializeEncryptionSpecMetadata.php @@ -0,0 +1,203 @@ +google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecMetadata + */ +class InitializeEncryptionSpecMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $end_time = null; + /** + * Output only. The original request for initialization. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecRequest request = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $request = null; + /** + * Partial errors during initialising operation that might cause the operation + * output to be incomplete. + * + * Generated from protobuf field repeated .google.rpc.Status partial_errors = 4; + */ + private $partial_errors; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time the operation was created. + * @type \Google\Protobuf\Timestamp $end_time + * Output only. The time the operation finished running. + * @type \Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecRequest $request + * Output only. The original request for initialization. + * @type array<\Google\Rpc\Status>|\Google\Protobuf\Internal\RepeatedField $partial_errors + * Partial errors during initialising operation that might cause the operation + * output to be incomplete. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + + /** + * Output only. The original request for initialization. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecRequest request = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecRequest|null + */ + public function getRequest() + { + return $this->request; + } + + public function hasRequest() + { + return isset($this->request); + } + + public function clearRequest() + { + unset($this->request); + } + + /** + * Output only. The original request for initialization. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecRequest request = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecRequest $var + * @return $this + */ + public function setRequest($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecRequest::class); + $this->request = $var; + + return $this; + } + + /** + * Partial errors during initialising operation that might cause the operation + * output to be incomplete. + * + * Generated from protobuf field repeated .google.rpc.Status partial_errors = 4; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPartialErrors() + { + return $this->partial_errors; + } + + /** + * Partial errors during initialising operation that might cause the operation + * output to be incomplete. + * + * Generated from protobuf field repeated .google.rpc.Status partial_errors = 4; + * @param array<\Google\Rpc\Status>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPartialErrors($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Rpc\Status::class); + $this->partial_errors = $arr; + + return $this; + } + +} + diff --git a/ContactCenterInsights/src/V1/InitializeEncryptionSpecRequest.php b/ContactCenterInsights/src/V1/InitializeEncryptionSpecRequest.php new file mode 100644 index 000000000000..a140e2788c3e --- /dev/null +++ b/ContactCenterInsights/src/V1/InitializeEncryptionSpecRequest.php @@ -0,0 +1,105 @@ +google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecRequest + */ +class InitializeEncryptionSpecRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The encryption spec used for CMEK encryption. It is required that + * the kms key is in the same region as the endpoint. The same key will be + * used for all provisioned resources, if encryption is available. If the + * kms_key_name is left empty, no encryption will be enforced. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.EncryptionSpec encryption_spec = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $encryption_spec = null; + + /** + * @param \Google\Cloud\ContactCenterInsights\V1\EncryptionSpec $encryptionSpec Required. The encryption spec used for CMEK encryption. It is required that + * the kms key is in the same region as the endpoint. The same key will be + * used for all provisioned resources, if encryption is available. If the + * kms_key_name is left empty, no encryption will be enforced. + * + * @return \Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecRequest + * + * @experimental + */ + public static function build(\Google\Cloud\ContactCenterInsights\V1\EncryptionSpec $encryptionSpec): self + { + return (new self()) + ->setEncryptionSpec($encryptionSpec); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\ContactCenterInsights\V1\EncryptionSpec $encryption_spec + * Required. The encryption spec used for CMEK encryption. It is required that + * the kms key is in the same region as the endpoint. The same key will be + * used for all provisioned resources, if encryption is available. If the + * kms_key_name is left empty, no encryption will be enforced. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + + /** + * Required. The encryption spec used for CMEK encryption. It is required that + * the kms key is in the same region as the endpoint. The same key will be + * used for all provisioned resources, if encryption is available. If the + * kms_key_name is left empty, no encryption will be enforced. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.EncryptionSpec encryption_spec = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\ContactCenterInsights\V1\EncryptionSpec|null + */ + public function getEncryptionSpec() + { + return $this->encryption_spec; + } + + public function hasEncryptionSpec() + { + return isset($this->encryption_spec); + } + + public function clearEncryptionSpec() + { + unset($this->encryption_spec); + } + + /** + * Required. The encryption spec used for CMEK encryption. It is required that + * the kms key is in the same region as the endpoint. The same key will be + * used for all provisioned resources, if encryption is available. If the + * kms_key_name is left empty, no encryption will be enforced. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.EncryptionSpec encryption_spec = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\ContactCenterInsights\V1\EncryptionSpec $var + * @return $this + */ + public function setEncryptionSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\EncryptionSpec::class); + $this->encryption_spec = $var; + + return $this; + } + +} + diff --git a/ContactCenterInsights/src/V1/InitializeEncryptionSpecResponse.php b/ContactCenterInsights/src/V1/InitializeEncryptionSpecResponse.php new file mode 100644 index 000000000000..a56abe51d282 --- /dev/null +++ b/ContactCenterInsights/src/V1/InitializeEncryptionSpecResponse.php @@ -0,0 +1,33 @@ +google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecResponse + */ +class InitializeEncryptionSpecResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce(); + parent::__construct($data); + } + +} + diff --git a/ContactCenterInsights/src/V1/Issue.php b/ContactCenterInsights/src/V1/Issue.php index 7c46c7d9df38..710d57742358 100644 --- a/ContactCenterInsights/src/V1/Issue.php +++ b/ContactCenterInsights/src/V1/Issue.php @@ -48,6 +48,12 @@ class Issue extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated string sample_utterances = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $sample_utterances; + /** + * Representative description of the issue. + * + * Generated from protobuf field string display_description = 14; + */ + protected $display_description = ''; /** * Constructor. @@ -68,6 +74,8 @@ class Issue extends \Google\Protobuf\Internal\Message * @type array|\Google\Protobuf\Internal\RepeatedField $sample_utterances * Output only. Resource names of the sample representative utterances that * match to this issue. + * @type string $display_description + * Representative description of the issue. * } */ public function __construct($data = NULL) { @@ -231,5 +239,31 @@ public function setSampleUtterances($var) return $this; } + /** + * Representative description of the issue. + * + * Generated from protobuf field string display_description = 14; + * @return string + */ + public function getDisplayDescription() + { + return $this->display_description; + } + + /** + * Representative description of the issue. + * + * Generated from protobuf field string display_description = 14; + * @param string $var + * @return $this + */ + public function setDisplayDescription($var) + { + GPBUtil::checkString($var, True); + $this->display_description = $var; + + return $this; + } + } diff --git a/ContactCenterInsights/src/V1/ListConversationsRequest.php b/ContactCenterInsights/src/V1/ListConversationsRequest.php index cfe31fa3fb41..42dfc06a5ec7 100644 --- a/ContactCenterInsights/src/V1/ListConversationsRequest.php +++ b/ContactCenterInsights/src/V1/ListConversationsRequest.php @@ -23,7 +23,7 @@ class ListConversationsRequest extends \Google\Protobuf\Internal\Message protected $parent = ''; /** * The maximum number of conversations to return in the response. A valid page - * size ranges from 0 to 1,000 inclusive. If the page size is zero or + * size ranges from 0 to 100,000 inclusive. If the page size is zero or * unspecified, a default page size of 100 will be chosen. Note that a call * might return fewer results than the requested page size. * @@ -45,6 +45,24 @@ class ListConversationsRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field string filter = 4; */ protected $filter = ''; + /** + * Optional. The attribute by which to order conversations in the response. + * If empty, conversations will be ordered by descending creation time. + * Supported values are one of the following: + * * create_time + * * customer_satisfaction_rating + * * duration + * * latest_analysis + * * start_time + * * turn_count + * The default sort order is ascending. To specify order, append `asc` or + * `desc` (`create_time desc`). + * For more details, see [Google AIPs + * Ordering](https://google.aip.dev/132#ordering). + * + * Generated from protobuf field string order_by = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; /** * The level of details of the conversation. Default is `BASIC`. * @@ -76,7 +94,7 @@ public static function build(string $parent): self * Required. The parent resource of the conversation. * @type int $page_size * The maximum number of conversations to return in the response. A valid page - * size ranges from 0 to 1,000 inclusive. If the page size is zero or + * size ranges from 0 to 100,000 inclusive. If the page size is zero or * unspecified, a default page size of 100 will be chosen. Note that a call * might return fewer results than the requested page size. * @type string $page_token @@ -86,6 +104,20 @@ public static function build(string $parent): self * @type string $filter * A filter to reduce results to a specific subset. Useful for querying * conversations with specific properties. + * @type string $order_by + * Optional. The attribute by which to order conversations in the response. + * If empty, conversations will be ordered by descending creation time. + * Supported values are one of the following: + * * create_time + * * customer_satisfaction_rating + * * duration + * * latest_analysis + * * start_time + * * turn_count + * The default sort order is ascending. To specify order, append `asc` or + * `desc` (`create_time desc`). + * For more details, see [Google AIPs + * Ordering](https://google.aip.dev/132#ordering). * @type int $view * The level of details of the conversation. Default is `BASIC`. * } @@ -123,7 +155,7 @@ public function setParent($var) /** * The maximum number of conversations to return in the response. A valid page - * size ranges from 0 to 1,000 inclusive. If the page size is zero or + * size ranges from 0 to 100,000 inclusive. If the page size is zero or * unspecified, a default page size of 100 will be chosen. Note that a call * might return fewer results than the requested page size. * @@ -137,7 +169,7 @@ public function getPageSize() /** * The maximum number of conversations to return in the response. A valid page - * size ranges from 0 to 1,000 inclusive. If the page size is zero or + * size ranges from 0 to 100,000 inclusive. If the page size is zero or * unspecified, a default page size of 100 will be chosen. Note that a call * might return fewer results than the requested page size. * @@ -211,6 +243,56 @@ public function setFilter($var) return $this; } + /** + * Optional. The attribute by which to order conversations in the response. + * If empty, conversations will be ordered by descending creation time. + * Supported values are one of the following: + * * create_time + * * customer_satisfaction_rating + * * duration + * * latest_analysis + * * start_time + * * turn_count + * The default sort order is ascending. To specify order, append `asc` or + * `desc` (`create_time desc`). + * For more details, see [Google AIPs + * Ordering](https://google.aip.dev/132#ordering). + * + * Generated from protobuf field string order_by = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The attribute by which to order conversations in the response. + * If empty, conversations will be ordered by descending creation time. + * Supported values are one of the following: + * * create_time + * * customer_satisfaction_rating + * * duration + * * latest_analysis + * * start_time + * * turn_count + * The default sort order is ascending. To specify order, append `asc` or + * `desc` (`create_time desc`). + * For more details, see [Google AIPs + * Ordering](https://google.aip.dev/132#ordering). + * + * Generated from protobuf field string order_by = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + /** * The level of details of the conversation. Default is `BASIC`. * diff --git a/ContactCenterInsights/src/V1/RedactionConfig.php b/ContactCenterInsights/src/V1/RedactionConfig.php index ebcf981ef8e4..293547129dc3 100644 --- a/ContactCenterInsights/src/V1/RedactionConfig.php +++ b/ContactCenterInsights/src/V1/RedactionConfig.php @@ -10,6 +10,12 @@ /** * DLP resources used for redaction while ingesting conversations. + * DLP settings are applied to conversations ingested from the + * `UploadConversation` and `IngestConversations` endpoints, including + * conversation coming from CCAI Platform. They are not applied to conversations + * ingested from the `CreateConversation` endpoint or the Dialogflow / Agent + * Assist runtime integrations. When using Dialogflow / Agent Assist runtime + * integrations, redaction should be performed in Dialogflow / Agent Assist. * * Generated from protobuf message google.cloud.contactcenterinsights.v1.RedactionConfig */ diff --git a/ContactCenterInsights/src/V1/RuntimeAnnotation.php b/ContactCenterInsights/src/V1/RuntimeAnnotation.php index 6d27085452d2..4c7f365eabe0 100644 --- a/ContactCenterInsights/src/V1/RuntimeAnnotation.php +++ b/ContactCenterInsights/src/V1/RuntimeAnnotation.php @@ -47,6 +47,12 @@ class RuntimeAnnotation extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.contactcenterinsights.v1.AnswerFeedback answer_feedback = 5; */ protected $answer_feedback = null; + /** + * Explicit input used for generating the answer + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput user_input = 16; + */ + protected $user_input = null; protected $data; /** @@ -79,6 +85,8 @@ class RuntimeAnnotation extends \Google\Protobuf\Internal\Message * The boundary in the conversation where the annotation ends, inclusive. * @type \Google\Cloud\ContactCenterInsights\V1\AnswerFeedback $answer_feedback * The feedback that the customer has about the answer in `data`. + * @type \Google\Cloud\ContactCenterInsights\V1\RuntimeAnnotation\UserInput $user_input + * Explicit input used for generating the answer * } */ public function __construct($data = NULL) { @@ -446,6 +454,42 @@ public function setAnswerFeedback($var) return $this; } + /** + * Explicit input used for generating the answer + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput user_input = 16; + * @return \Google\Cloud\ContactCenterInsights\V1\RuntimeAnnotation\UserInput|null + */ + public function getUserInput() + { + return $this->user_input; + } + + public function hasUserInput() + { + return isset($this->user_input); + } + + public function clearUserInput() + { + unset($this->user_input); + } + + /** + * Explicit input used for generating the answer + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput user_input = 16; + * @param \Google\Cloud\ContactCenterInsights\V1\RuntimeAnnotation\UserInput $var + * @return $this + */ + public function setUserInput($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\RuntimeAnnotation\UserInput::class); + $this->user_input = $var; + + return $this; + } + /** * @return string */ diff --git a/ContactCenterInsights/src/V1/RuntimeAnnotation/UserInput.php b/ContactCenterInsights/src/V1/RuntimeAnnotation/UserInput.php new file mode 100644 index 000000000000..276d80d14d1a --- /dev/null +++ b/ContactCenterInsights/src/V1/RuntimeAnnotation/UserInput.php @@ -0,0 +1,144 @@ +google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput + */ +class UserInput extends \Google\Protobuf\Internal\Message +{ + /** + * Query text. Article Search uses this to store the input query used + * to generate the search results. + * + * Generated from protobuf field string query = 1; + */ + protected $query = ''; + /** + * The resource name of associated generator. Format: + * `projects//locations//generators/` + * + * Generated from protobuf field string generator_name = 2; + */ + protected $generator_name = ''; + /** + * Query source for the answer. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput.QuerySource query_source = 3; + */ + protected $query_source = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $query + * Query text. Article Search uses this to store the input query used + * to generate the search results. + * @type string $generator_name + * The resource name of associated generator. Format: + * `projects//locations//generators/` + * @type int $query_source + * Query source for the answer. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Query text. Article Search uses this to store the input query used + * to generate the search results. + * + * Generated from protobuf field string query = 1; + * @return string + */ + public function getQuery() + { + return $this->query; + } + + /** + * Query text. Article Search uses this to store the input query used + * to generate the search results. + * + * Generated from protobuf field string query = 1; + * @param string $var + * @return $this + */ + public function setQuery($var) + { + GPBUtil::checkString($var, True); + $this->query = $var; + + return $this; + } + + /** + * The resource name of associated generator. Format: + * `projects//locations//generators/` + * + * Generated from protobuf field string generator_name = 2; + * @return string + */ + public function getGeneratorName() + { + return $this->generator_name; + } + + /** + * The resource name of associated generator. Format: + * `projects//locations//generators/` + * + * Generated from protobuf field string generator_name = 2; + * @param string $var + * @return $this + */ + public function setGeneratorName($var) + { + GPBUtil::checkString($var, True); + $this->generator_name = $var; + + return $this; + } + + /** + * Query source for the answer. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput.QuerySource query_source = 3; + * @return int + */ + public function getQuerySource() + { + return $this->query_source; + } + + /** + * Query source for the answer. + * + * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput.QuerySource query_source = 3; + * @param int $var + * @return $this + */ + public function setQuerySource($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\ContactCenterInsights\V1\RuntimeAnnotation\UserInput\QuerySource::class); + $this->query_source = $var; + + return $this; + } + +} + + diff --git a/ContactCenterInsights/src/V1/RuntimeAnnotation/UserInput/QuerySource.php b/ContactCenterInsights/src/V1/RuntimeAnnotation/UserInput/QuerySource.php new file mode 100644 index 000000000000..5edc374d4137 --- /dev/null +++ b/ContactCenterInsights/src/V1/RuntimeAnnotation/UserInput/QuerySource.php @@ -0,0 +1,63 @@ +google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput.QuerySource + */ +class QuerySource +{ + /** + * Unknown query source. + * + * Generated from protobuf enum QUERY_SOURCE_UNSPECIFIED = 0; + */ + const QUERY_SOURCE_UNSPECIFIED = 0; + /** + * The query is from agents. + * + * Generated from protobuf enum AGENT_QUERY = 1; + */ + const AGENT_QUERY = 1; + /** + * The query is a query from previous suggestions, e.g. from a preceding + * SuggestKnowledgeAssist response. + * + * Generated from protobuf enum SUGGESTED_QUERY = 2; + */ + const SUGGESTED_QUERY = 2; + + private static $valueToName = [ + self::QUERY_SOURCE_UNSPECIFIED => 'QUERY_SOURCE_UNSPECIFIED', + self::AGENT_QUERY => 'AGENT_QUERY', + self::SUGGESTED_QUERY => 'SUGGESTED_QUERY', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/ContactCenterInsights/src/V1/Settings.php b/ContactCenterInsights/src/V1/Settings.php index 4c92a6b67f20..a728e5d6bc4f 100644 --- a/ContactCenterInsights/src/V1/Settings.php +++ b/ContactCenterInsights/src/V1/Settings.php @@ -9,7 +9,12 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The settings resource. + * The CCAI Insights project wide settings. + * Use these settings to configure the behavior of Insights. + * View these settings with + * [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) + * and change the settings with + * [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). * * Generated from protobuf message google.cloud.contactcenterinsights.v1.Settings */ @@ -61,8 +66,11 @@ class Settings extends \Google\Protobuf\Internal\Message * * "create-analysis": Notify each time an analysis is created. * * "create-conversation": Notify each time a conversation is created. * * "export-insights-data": Notify each time an export is complete. + * * "ingest-conversations": Notify each time an IngestConversations LRO is + * complete. * * "update-conversation": Notify each time a conversation is updated via * UpdateConversation. + * * "upload-conversation": Notify when an UploadConversation LRO is complete. * Values are Pub/Sub topics. The format of each Pub/Sub topic is: * projects/{project}/topics/{topic} * @@ -77,14 +85,19 @@ class Settings extends \Google\Protobuf\Internal\Message protected $analysis_config = null; /** * Default DLP redaction resources to be applied while ingesting - * conversations. + * conversations. This applies to conversations ingested from the + * `UploadConversation` and `IngestConversations` endpoints, including + * conversations coming from CCAI Platform. * * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RedactionConfig redaction_config = 10; */ protected $redaction_config = null; /** - * Optional. Default Speech-to-Text resources to be used while ingesting audio - * files. Optional, CCAI Insights will create a default if not provided. + * Optional. Default Speech-to-Text resources to use while ingesting audio + * files. Optional, CCAI Insights will create a default if not provided. This + * applies to conversations ingested from the `UploadConversation` and + * `IngestConversations` endpoints, including conversations coming from CCAI + * Platform. * * Generated from protobuf field .google.cloud.contactcenterinsights.v1.SpeechConfig speech_config = 11 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -122,18 +135,26 @@ class Settings extends \Google\Protobuf\Internal\Message * * "create-analysis": Notify each time an analysis is created. * * "create-conversation": Notify each time a conversation is created. * * "export-insights-data": Notify each time an export is complete. + * * "ingest-conversations": Notify each time an IngestConversations LRO is + * complete. * * "update-conversation": Notify each time a conversation is updated via * UpdateConversation. + * * "upload-conversation": Notify when an UploadConversation LRO is complete. * Values are Pub/Sub topics. The format of each Pub/Sub topic is: * projects/{project}/topics/{topic} * @type \Google\Cloud\ContactCenterInsights\V1\Settings\AnalysisConfig $analysis_config * Default analysis settings. * @type \Google\Cloud\ContactCenterInsights\V1\RedactionConfig $redaction_config * Default DLP redaction resources to be applied while ingesting - * conversations. + * conversations. This applies to conversations ingested from the + * `UploadConversation` and `IngestConversations` endpoints, including + * conversations coming from CCAI Platform. * @type \Google\Cloud\ContactCenterInsights\V1\SpeechConfig $speech_config - * Optional. Default Speech-to-Text resources to be used while ingesting audio - * files. Optional, CCAI Insights will create a default if not provided. + * Optional. Default Speech-to-Text resources to use while ingesting audio + * files. Optional, CCAI Insights will create a default if not provided. This + * applies to conversations ingested from the `UploadConversation` and + * `IngestConversations` endpoints, including conversations coming from CCAI + * Platform. * } */ public function __construct($data = NULL) { @@ -324,8 +345,11 @@ public function setConversationTtl($var) * * "create-analysis": Notify each time an analysis is created. * * "create-conversation": Notify each time a conversation is created. * * "export-insights-data": Notify each time an export is complete. + * * "ingest-conversations": Notify each time an IngestConversations LRO is + * complete. * * "update-conversation": Notify each time a conversation is updated via * UpdateConversation. + * * "upload-conversation": Notify when an UploadConversation LRO is complete. * Values are Pub/Sub topics. The format of each Pub/Sub topic is: * projects/{project}/topics/{topic} * @@ -346,8 +370,11 @@ public function getPubsubNotificationSettings() * * "create-analysis": Notify each time an analysis is created. * * "create-conversation": Notify each time a conversation is created. * * "export-insights-data": Notify each time an export is complete. + * * "ingest-conversations": Notify each time an IngestConversations LRO is + * complete. * * "update-conversation": Notify each time a conversation is updated via * UpdateConversation. + * * "upload-conversation": Notify when an UploadConversation LRO is complete. * Values are Pub/Sub topics. The format of each Pub/Sub topic is: * projects/{project}/topics/{topic} * @@ -401,7 +428,9 @@ public function setAnalysisConfig($var) /** * Default DLP redaction resources to be applied while ingesting - * conversations. + * conversations. This applies to conversations ingested from the + * `UploadConversation` and `IngestConversations` endpoints, including + * conversations coming from CCAI Platform. * * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RedactionConfig redaction_config = 10; * @return \Google\Cloud\ContactCenterInsights\V1\RedactionConfig|null @@ -423,7 +452,9 @@ public function clearRedactionConfig() /** * Default DLP redaction resources to be applied while ingesting - * conversations. + * conversations. This applies to conversations ingested from the + * `UploadConversation` and `IngestConversations` endpoints, including + * conversations coming from CCAI Platform. * * Generated from protobuf field .google.cloud.contactcenterinsights.v1.RedactionConfig redaction_config = 10; * @param \Google\Cloud\ContactCenterInsights\V1\RedactionConfig $var @@ -438,8 +469,11 @@ public function setRedactionConfig($var) } /** - * Optional. Default Speech-to-Text resources to be used while ingesting audio - * files. Optional, CCAI Insights will create a default if not provided. + * Optional. Default Speech-to-Text resources to use while ingesting audio + * files. Optional, CCAI Insights will create a default if not provided. This + * applies to conversations ingested from the `UploadConversation` and + * `IngestConversations` endpoints, including conversations coming from CCAI + * Platform. * * Generated from protobuf field .google.cloud.contactcenterinsights.v1.SpeechConfig speech_config = 11 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\ContactCenterInsights\V1\SpeechConfig|null @@ -460,8 +494,11 @@ public function clearSpeechConfig() } /** - * Optional. Default Speech-to-Text resources to be used while ingesting audio - * files. Optional, CCAI Insights will create a default if not provided. + * Optional. Default Speech-to-Text resources to use while ingesting audio + * files. Optional, CCAI Insights will create a default if not provided. This + * applies to conversations ingested from the `UploadConversation` and + * `IngestConversations` endpoints, including conversations coming from CCAI + * Platform. * * Generated from protobuf field .google.cloud.contactcenterinsights.v1.SpeechConfig speech_config = 11 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\ContactCenterInsights\V1\SpeechConfig $var diff --git a/ContactCenterInsights/src/V1/SpeechConfig.php b/ContactCenterInsights/src/V1/SpeechConfig.php index 26829b4fdee5..714218e8fcc2 100644 --- a/ContactCenterInsights/src/V1/SpeechConfig.php +++ b/ContactCenterInsights/src/V1/SpeechConfig.php @@ -10,6 +10,10 @@ /** * Speech-to-Text configuration. + * Speech-to-Text settings are applied to conversations ingested from the + * `UploadConversation` and `IngestConversations` endpoints, including + * conversation coming from CCAI Platform. They are not applied to conversations + * ingested from the `CreateConversation` endpoint. * * Generated from protobuf message google.cloud.contactcenterinsights.v1.SpeechConfig */ diff --git a/ContactCenterInsights/src/V1/UpdateConversationRequest.php b/ContactCenterInsights/src/V1/UpdateConversationRequest.php index 454731ba405c..94c6827f7a67 100644 --- a/ContactCenterInsights/src/V1/UpdateConversationRequest.php +++ b/ContactCenterInsights/src/V1/UpdateConversationRequest.php @@ -22,7 +22,19 @@ class UpdateConversationRequest extends \Google\Protobuf\Internal\Message */ protected $conversation = null; /** - * The list of fields to be updated. + * The list of fields to be updated. All possible fields can be updated by + * passing `*`, or a subset of the following updateable fields can be + * provided: + * * `agent_id` + * * `language_code` + * * `labels` + * * `metadata` + * * `quality_metadata` + * * `call_metadata` + * * `start_time` + * * `expire_time` or `ttl` + * * `data_source.gcs_source.audio_uri` or + * `data_source.dialogflow_source.audio_uri` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; */ @@ -30,7 +42,20 @@ class UpdateConversationRequest extends \Google\Protobuf\Internal\Message /** * @param \Google\Cloud\ContactCenterInsights\V1\Conversation $conversation Required. The new values for the conversation. - * @param \Google\Protobuf\FieldMask $updateMask The list of fields to be updated. + * @param \Google\Protobuf\FieldMask $updateMask The list of fields to be updated. All possible fields can be updated by + * passing `*`, or a subset of the following updateable fields can be + * provided: + * + * * `agent_id` + * * `language_code` + * * `labels` + * * `metadata` + * * `quality_metadata` + * * `call_metadata` + * * `start_time` + * * `expire_time` or `ttl` + * * `data_source.gcs_source.audio_uri` or + * `data_source.dialogflow_source.audio_uri` * * @return \Google\Cloud\ContactCenterInsights\V1\UpdateConversationRequest * @@ -52,7 +77,19 @@ public static function build(\Google\Cloud\ContactCenterInsights\V1\Conversation * @type \Google\Cloud\ContactCenterInsights\V1\Conversation $conversation * Required. The new values for the conversation. * @type \Google\Protobuf\FieldMask $update_mask - * The list of fields to be updated. + * The list of fields to be updated. All possible fields can be updated by + * passing `*`, or a subset of the following updateable fields can be + * provided: + * * `agent_id` + * * `language_code` + * * `labels` + * * `metadata` + * * `quality_metadata` + * * `call_metadata` + * * `start_time` + * * `expire_time` or `ttl` + * * `data_source.gcs_source.audio_uri` or + * `data_source.dialogflow_source.audio_uri` * } */ public function __construct($data = NULL) { @@ -97,7 +134,19 @@ public function setConversation($var) } /** - * The list of fields to be updated. + * The list of fields to be updated. All possible fields can be updated by + * passing `*`, or a subset of the following updateable fields can be + * provided: + * * `agent_id` + * * `language_code` + * * `labels` + * * `metadata` + * * `quality_metadata` + * * `call_metadata` + * * `start_time` + * * `expire_time` or `ttl` + * * `data_source.gcs_source.audio_uri` or + * `data_source.dialogflow_source.audio_uri` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @return \Google\Protobuf\FieldMask|null @@ -118,7 +167,19 @@ public function clearUpdateMask() } /** - * The list of fields to be updated. + * The list of fields to be updated. All possible fields can be updated by + * passing `*`, or a subset of the following updateable fields can be + * provided: + * * `agent_id` + * * `language_code` + * * `labels` + * * `metadata` + * * `quality_metadata` + * * `call_metadata` + * * `start_time` + * * `expire_time` or `ttl` + * * `data_source.gcs_source.audio_uri` or + * `data_source.dialogflow_source.audio_uri` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @param \Google\Protobuf\FieldMask $var diff --git a/ContactCenterInsights/src/V1/UploadConversationMetadata.php b/ContactCenterInsights/src/V1/UploadConversationMetadata.php index 3d20791c0681..b893a1d41d46 100644 --- a/ContactCenterInsights/src/V1/UploadConversationMetadata.php +++ b/ContactCenterInsights/src/V1/UploadConversationMetadata.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The metadata for an UploadConversation operation. + * The metadata for an `UploadConversation` operation. * * Generated from protobuf message google.cloud.contactcenterinsights.v1.UploadConversationMetadata */ diff --git a/ContactCenterInsights/src/V1/gapic_metadata.json b/ContactCenterInsights/src/V1/gapic_metadata.json index 66263ef3f61f..a1bab090cfad 100644 --- a/ContactCenterInsights/src/V1/gapic_metadata.json +++ b/ContactCenterInsights/src/V1/gapic_metadata.json @@ -95,6 +95,11 @@ "exportInsightsData" ] }, + "ExportIssueModel": { + "methods": [ + "exportIssueModel" + ] + }, "GetAnalysis": { "methods": [ "getAnalysis" @@ -105,6 +110,11 @@ "getConversation" ] }, + "GetEncryptionSpec": { + "methods": [ + "getEncryptionSpec" + ] + }, "GetIssue": { "methods": [ "getIssue" @@ -130,11 +140,21 @@ "getView" ] }, + "ImportIssueModel": { + "methods": [ + "importIssueModel" + ] + }, "IngestConversations": { "methods": [ "ingestConversations" ] }, + "InitializeEncryptionSpec": { + "methods": [ + "initializeEncryptionSpec" + ] + }, "ListAnalyses": { "methods": [ "listAnalyses" diff --git a/ContactCenterInsights/src/V1/resources/contact_center_insights_client_config.json b/ContactCenterInsights/src/V1/resources/contact_center_insights_client_config.json index 38c4895e8611..4f2e84193db6 100644 --- a/ContactCenterInsights/src/V1/resources/contact_center_insights_client_config.json +++ b/ContactCenterInsights/src/V1/resources/contact_center_insights_client_config.json @@ -113,6 +113,11 @@ "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "ExportIssueModel": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, "GetAnalysis": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", @@ -123,6 +128,11 @@ "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "GetEncryptionSpec": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, "GetIssue": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", @@ -148,11 +158,21 @@ "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "ImportIssueModel": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, "IngestConversations": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "InitializeEncryptionSpec": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, "ListAnalyses": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", diff --git a/ContactCenterInsights/src/V1/resources/contact_center_insights_descriptor_config.php b/ContactCenterInsights/src/V1/resources/contact_center_insights_descriptor_config.php index aa0bfa54c9d4..b529d00be28f 100644 --- a/ContactCenterInsights/src/V1/resources/contact_center_insights_descriptor_config.php +++ b/ContactCenterInsights/src/V1/resources/contact_center_insights_descriptor_config.php @@ -156,6 +156,44 @@ ], ], ], + 'ExportIssueModel' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\ContactCenterInsights\V1\ExportIssueModelResponse', + 'metadataReturnType' => '\Google\Cloud\ContactCenterInsights\V1\ExportIssueModelMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ImportIssueModel' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\ContactCenterInsights\V1\ImportIssueModelResponse', + 'metadataReturnType' => '\Google\Cloud\ContactCenterInsights\V1\ImportIssueModelMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'IngestConversations' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\ContactCenterInsights\V1\IngestConversationsResponse', @@ -175,6 +213,26 @@ ], ], ], + 'InitializeEncryptionSpec' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecResponse', + 'metadataReturnType' => '\Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'encryption_spec.name', + 'fieldAccessors' => [ + 'getEncryptionSpec', + 'getName', + ], + ], + ], + ], 'UndeployIssueModel' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\ContactCenterInsights\V1\UndeployIssueModelResponse', @@ -357,6 +415,18 @@ ], ], ], + 'GetEncryptionSpec' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\ContactCenterInsights\V1\EncryptionSpec', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'GetIssue' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\ContactCenterInsights\V1\Issue', @@ -603,6 +673,7 @@ 'analysis' => 'projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}', 'conversation' => 'projects/{project}/locations/{location}/conversations/{conversation}', 'conversationProfile' => 'projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}', + 'encryptionSpec' => 'projects/{project}/locations/{location}/encryptionSpec', 'issue' => 'projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}', 'issueModel' => 'projects/{project}/locations/{location}/issueModels/{issue_model}', 'location' => 'projects/{project}/locations/{location}', diff --git a/ContactCenterInsights/src/V1/resources/contact_center_insights_rest_client_config.php b/ContactCenterInsights/src/V1/resources/contact_center_insights_rest_client_config.php index 1da13d22d3a7..a3735d966ff5 100644 --- a/ContactCenterInsights/src/V1/resources/contact_center_insights_rest_client_config.php +++ b/ContactCenterInsights/src/V1/resources/contact_center_insights_rest_client_config.php @@ -219,6 +219,18 @@ ], ], ], + 'ExportIssueModel' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/issueModels/*}:export', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetAnalysis' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/conversations/*/analyses/*}', @@ -241,6 +253,17 @@ ], ], ], + 'GetEncryptionSpec' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/encryptionSpec}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetIssue' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/issueModels/*/issues/*}', @@ -296,6 +319,18 @@ ], ], ], + 'ImportIssueModel' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/issueModels:import', + 'body' => '*', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'IngestConversations' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/conversations:ingest', @@ -308,6 +343,19 @@ ], ], ], + 'InitializeEncryptionSpec' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{encryption_spec.name=projects/*/locations/*/encryptionSpec}:initialize', + 'body' => '*', + 'placeholders' => [ + 'encryption_spec.name' => [ + 'getters' => [ + 'getEncryptionSpec', + 'getName', + ], + ], + ], + ], 'ListAnalyses' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*/conversations/*}/analyses', diff --git a/ContactCenterInsights/tests/Unit/V1/Client/ContactCenterInsightsClientTest.php b/ContactCenterInsights/tests/Unit/V1/Client/ContactCenterInsightsClientTest.php index 3d50510bcf7a..bfce002f77dd 100644 --- a/ContactCenterInsights/tests/Unit/V1/Client/ContactCenterInsightsClientTest.php +++ b/ContactCenterInsights/tests/Unit/V1/Client/ContactCenterInsightsClientTest.php @@ -50,17 +50,25 @@ use Google\Cloud\ContactCenterInsights\V1\DeleteViewRequest; use Google\Cloud\ContactCenterInsights\V1\DeployIssueModelRequest; use Google\Cloud\ContactCenterInsights\V1\DeployIssueModelResponse; +use Google\Cloud\ContactCenterInsights\V1\EncryptionSpec; use Google\Cloud\ContactCenterInsights\V1\ExportInsightsDataRequest; use Google\Cloud\ContactCenterInsights\V1\ExportInsightsDataResponse; +use Google\Cloud\ContactCenterInsights\V1\ExportIssueModelRequest; +use Google\Cloud\ContactCenterInsights\V1\ExportIssueModelResponse; use Google\Cloud\ContactCenterInsights\V1\GetAnalysisRequest; use Google\Cloud\ContactCenterInsights\V1\GetConversationRequest; +use Google\Cloud\ContactCenterInsights\V1\GetEncryptionSpecRequest; use Google\Cloud\ContactCenterInsights\V1\GetIssueModelRequest; use Google\Cloud\ContactCenterInsights\V1\GetIssueRequest; use Google\Cloud\ContactCenterInsights\V1\GetPhraseMatcherRequest; use Google\Cloud\ContactCenterInsights\V1\GetSettingsRequest; use Google\Cloud\ContactCenterInsights\V1\GetViewRequest; +use Google\Cloud\ContactCenterInsights\V1\ImportIssueModelRequest; +use Google\Cloud\ContactCenterInsights\V1\ImportIssueModelResponse; use Google\Cloud\ContactCenterInsights\V1\IngestConversationsRequest; use Google\Cloud\ContactCenterInsights\V1\IngestConversationsResponse; +use Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecRequest; +use Google\Cloud\ContactCenterInsights\V1\InitializeEncryptionSpecResponse; use Google\Cloud\ContactCenterInsights\V1\Issue; use Google\Cloud\ContactCenterInsights\V1\IssueModel; use Google\Cloud\ContactCenterInsights\V1\ListAnalysesRequest; @@ -674,12 +682,14 @@ public function createConversationTest() $name = 'name3373707'; $languageCode = 'languageCode-412800396'; $agentId = 'agentId1469158549'; + $metadataJson = 'metadataJson-2002268168'; $turnCount = 428155597; $obfuscatedUserId = 'obfuscatedUserId-227848300'; $expectedResponse = new Conversation(); $expectedResponse->setName($name); $expectedResponse->setLanguageCode($languageCode); $expectedResponse->setAgentId($agentId); + $expectedResponse->setMetadataJson($metadataJson); $expectedResponse->setTurnCount($turnCount); $expectedResponse->setObfuscatedUserId($obfuscatedUserId); $transport->addResponse($expectedResponse); @@ -1730,6 +1740,131 @@ public function exportInsightsDataExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function exportIssueModelTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/exportIssueModelTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new ExportIssueModelResponse(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/exportIssueModelTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->issueModelName('[PROJECT]', '[LOCATION]', '[ISSUE_MODEL]'); + $request = (new ExportIssueModelRequest())->setName($formattedName); + $response = $gapicClient->exportIssueModel($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.contactcenterinsights.v1.ContactCenterInsights/ExportIssueModel', + $actualApiFuncCall + ); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/exportIssueModelTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function exportIssueModelExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/exportIssueModelTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->issueModelName('[PROJECT]', '[LOCATION]', '[ISSUE_MODEL]'); + $request = (new ExportIssueModelRequest())->setName($formattedName); + $response = $gapicClient->exportIssueModel($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/exportIssueModelTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function getAnalysisTest() { @@ -1807,12 +1942,14 @@ public function getConversationTest() $name2 = 'name2-1052831874'; $languageCode = 'languageCode-412800396'; $agentId = 'agentId1469158549'; + $metadataJson = 'metadataJson-2002268168'; $turnCount = 428155597; $obfuscatedUserId = 'obfuscatedUserId-227848300'; $expectedResponse = new Conversation(); $expectedResponse->setName($name2); $expectedResponse->setLanguageCode($languageCode); $expectedResponse->setAgentId($agentId); + $expectedResponse->setMetadataJson($metadataJson); $expectedResponse->setTurnCount($turnCount); $expectedResponse->setObfuscatedUserId($obfuscatedUserId); $transport->addResponse($expectedResponse); @@ -1871,6 +2008,76 @@ public function getConversationExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function getEncryptionSpecTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $kmsKey = 'kmsKey-591635343'; + $expectedResponse = new EncryptionSpec(); + $expectedResponse->setName($name2); + $expectedResponse->setKmsKey($kmsKey); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->encryptionSpecName('[PROJECT]', '[LOCATION]'); + $request = (new GetEncryptionSpecRequest())->setName($formattedName); + $response = $gapicClient->getEncryptionSpec($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.contactcenterinsights.v1.ContactCenterInsights/GetEncryptionSpec', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getEncryptionSpecExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->encryptionSpecName('[PROJECT]', '[LOCATION]'); + $request = (new GetEncryptionSpecRequest())->setName($formattedName); + try { + $gapicClient->getEncryptionSpec($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function getIssueTest() { @@ -1882,9 +2089,11 @@ public function getIssueTest() // Mock response $name2 = 'name2-1052831874'; $displayName = 'displayName1615086568'; + $displayDescription = 'displayDescription-1876039681'; $expectedResponse = new Issue(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDisplayDescription($displayDescription); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->issueName('[PROJECT]', '[LOCATION]', '[ISSUE_MODEL]', '[ISSUE]'); @@ -2224,6 +2433,131 @@ public function getViewExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function importIssueModelTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/importIssueModelTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new ImportIssueModelResponse(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/importIssueModelTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ImportIssueModelRequest())->setParent($formattedParent); + $response = $gapicClient->importIssueModel($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.contactcenterinsights.v1.ContactCenterInsights/ImportIssueModel', + $actualApiFuncCall + ); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/importIssueModelTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function importIssueModelExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/importIssueModelTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ImportIssueModelRequest())->setParent($formattedParent); + $response = $gapicClient->importIssueModel($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/importIssueModelTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function ingestConversationsTest() { @@ -2349,6 +2683,135 @@ public function ingestConversationsExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function initializeEncryptionSpecTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/initializeEncryptionSpecTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new InitializeEncryptionSpecResponse(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/initializeEncryptionSpecTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $encryptionSpec = new EncryptionSpec(); + $encryptionSpecKmsKey = 'encryptionSpecKmsKey627607756'; + $encryptionSpec->setKmsKey($encryptionSpecKmsKey); + $request = (new InitializeEncryptionSpecRequest())->setEncryptionSpec($encryptionSpec); + $response = $gapicClient->initializeEncryptionSpec($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.contactcenterinsights.v1.ContactCenterInsights/InitializeEncryptionSpec', + $actualApiFuncCall + ); + $actualValue = $actualApiRequestObject->getEncryptionSpec(); + $this->assertProtobufEquals($encryptionSpec, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/initializeEncryptionSpecTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function initializeEncryptionSpecExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/initializeEncryptionSpecTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $encryptionSpec = new EncryptionSpec(); + $encryptionSpecKmsKey = 'encryptionSpecKmsKey627607756'; + $encryptionSpec->setKmsKey($encryptionSpecKmsKey); + $request = (new InitializeEncryptionSpecRequest())->setEncryptionSpec($encryptionSpec); + $response = $gapicClient->initializeEncryptionSpec($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/initializeEncryptionSpecTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function listAnalysesTest() { @@ -2905,12 +3368,14 @@ public function updateConversationTest() $name = 'name3373707'; $languageCode = 'languageCode-412800396'; $agentId = 'agentId1469158549'; + $metadataJson = 'metadataJson-2002268168'; $turnCount = 428155597; $obfuscatedUserId = 'obfuscatedUserId-227848300'; $expectedResponse = new Conversation(); $expectedResponse->setName($name); $expectedResponse->setLanguageCode($languageCode); $expectedResponse->setAgentId($agentId); + $expectedResponse->setMetadataJson($metadataJson); $expectedResponse->setTurnCount($turnCount); $expectedResponse->setObfuscatedUserId($obfuscatedUserId); $transport->addResponse($expectedResponse); @@ -2980,9 +3445,11 @@ public function updateIssueTest() // Mock response $name = 'name3373707'; $displayName = 'displayName1615086568'; + $displayDescription = 'displayDescription-1876039681'; $expectedResponse = new Issue(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDisplayDescription($displayDescription); $transport->addResponse($expectedResponse); // Mock request $issue = new Issue(); @@ -3357,12 +3824,14 @@ public function uploadConversationTest() $name = 'name3373707'; $languageCode = 'languageCode-412800396'; $agentId = 'agentId1469158549'; + $metadataJson = 'metadataJson-2002268168'; $turnCount = 428155597; $obfuscatedUserId = 'obfuscatedUserId-227848300'; $expectedResponse = new Conversation(); $expectedResponse->setName($name); $expectedResponse->setLanguageCode($languageCode); $expectedResponse->setAgentId($agentId); + $expectedResponse->setMetadataJson($metadataJson); $expectedResponse->setTurnCount($turnCount); $expectedResponse->setObfuscatedUserId($obfuscatedUserId); $anyResponse = new Any(); From ce39c2ef70b75bda13fde63335fd6810480d606d Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:13:49 -0700 Subject: [PATCH 015/157] feat: Add low latency journey option to proto (#7740) feat: Add CustomPronunciationParams for upcoming feature work PiperOrigin-RevId: 684229364 Source-Link: https://github.com/googleapis/googleapis/commit/10b8dc3b54c9a609dcfda8060b8c4c734a942e8c Source-Link: https://github.com/googleapis/googleapis-gen/commit/deaa9f319f1c6c19a9d36ea233ae307566b60c09 Copy-Tag: eyJwIjoiVGV4dFRvU3BlZWNoLy5Pd2xCb3QueWFtbCIsImgiOiJkZWFhOWYzMTlmMWM2YzE5YTlkMzZlYTIzM2FlMzA3NTY2YjYwYzA5In0= --- TextToSpeech/metadata/V1/CloudTts.php | Bin 3799 -> 4560 bytes TextToSpeech/src/V1/AdvancedVoiceOptions.php | 81 ++++++++ .../src/V1/CustomPronunciationParams.php | 177 ++++++++++++++++++ .../PhoneticEncoding.php | 66 +++++++ TextToSpeech/src/V1/CustomPronunciations.php | 67 +++++++ .../src/V1/Gapic/TextToSpeechGapicClient.php | 9 + TextToSpeech/src/V1/SynthesisInput.php | 80 ++++++++ .../src/V1/SynthesizeSpeechRequest.php | 44 +++++ 8 files changed, 524 insertions(+) create mode 100644 TextToSpeech/src/V1/AdvancedVoiceOptions.php create mode 100644 TextToSpeech/src/V1/CustomPronunciationParams.php create mode 100644 TextToSpeech/src/V1/CustomPronunciationParams/PhoneticEncoding.php create mode 100644 TextToSpeech/src/V1/CustomPronunciations.php diff --git a/TextToSpeech/metadata/V1/CloudTts.php b/TextToSpeech/metadata/V1/CloudTts.php index a86c3cb37db2dccc4318e238459be291e9ab8c95..3125c7df3ed56a36b203843004a7237903f7e3ab 100644 GIT binary patch delta 690 zcmaJ;%SyvQ6m`;8?G;NMtEOtCrY?#U5jU=r8ch(}fY03!(r6-frgT!Jxad;1S`a@& z@DKC{+zEo9OSgW3=|gC>y1Q`hx#ym9o~5Vs-GdN*lpuSxnZ5rME|6PkA*MoEQKkqG>9iG;q=_rT* zPs3=rTU-nU@kDhYz+?vTpCmjFlBpN++K!PUT0U1;Gx8f`H@|IaIb+?>>TB@$r zJBF#m5tbnN8#*A{%2ogiY7~Y@+q9Yh9E?A#s&R;so`2;dNOXBle}~9%0b)Iy&E`Xy vk(JdTrr9paH=`Z9e2W@~k>we@2NQOyn_fLGhMI-<>y4|SHwE3_M3m?k9Sh^o delta 45 zcmV+|0Mh@^Bi9|U!U6=!7YZzqODwbU0*3(t=>e1B1nC4KKnf0%`wJeECkPO;j|f2t Dhyf3l diff --git a/TextToSpeech/src/V1/AdvancedVoiceOptions.php b/TextToSpeech/src/V1/AdvancedVoiceOptions.php new file mode 100644 index 000000000000..ed664e1ba685 --- /dev/null +++ b/TextToSpeech/src/V1/AdvancedVoiceOptions.php @@ -0,0 +1,81 @@ +google.cloud.texttospeech.v1.AdvancedVoiceOptions + */ +class AdvancedVoiceOptions extends \Google\Protobuf\Internal\Message +{ + /** + * Only for Journey voices. If false, the synthesis will be context aware + * and have higher latency. + * + * Generated from protobuf field optional bool low_latency_journey_synthesis = 1; + */ + private $low_latency_journey_synthesis = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $low_latency_journey_synthesis + * Only for Journey voices. If false, the synthesis will be context aware + * and have higher latency. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Texttospeech\V1\CloudTts::initOnce(); + parent::__construct($data); + } + + /** + * Only for Journey voices. If false, the synthesis will be context aware + * and have higher latency. + * + * Generated from protobuf field optional bool low_latency_journey_synthesis = 1; + * @return bool + */ + public function getLowLatencyJourneySynthesis() + { + return isset($this->low_latency_journey_synthesis) ? $this->low_latency_journey_synthesis : false; + } + + public function hasLowLatencyJourneySynthesis() + { + return isset($this->low_latency_journey_synthesis); + } + + public function clearLowLatencyJourneySynthesis() + { + unset($this->low_latency_journey_synthesis); + } + + /** + * Only for Journey voices. If false, the synthesis will be context aware + * and have higher latency. + * + * Generated from protobuf field optional bool low_latency_journey_synthesis = 1; + * @param bool $var + * @return $this + */ + public function setLowLatencyJourneySynthesis($var) + { + GPBUtil::checkBool($var); + $this->low_latency_journey_synthesis = $var; + + return $this; + } + +} + diff --git a/TextToSpeech/src/V1/CustomPronunciationParams.php b/TextToSpeech/src/V1/CustomPronunciationParams.php new file mode 100644 index 000000000000..b7ae33a3dadf --- /dev/null +++ b/TextToSpeech/src/V1/CustomPronunciationParams.php @@ -0,0 +1,177 @@ +google.cloud.texttospeech.v1.CustomPronunciationParams + */ +class CustomPronunciationParams extends \Google\Protobuf\Internal\Message +{ + /** + * The phrase to which the customization will be applied. + * The phrase can be multiple words (in the case of proper nouns etc), but + * should not span to a whole sentence. + * + * Generated from protobuf field optional string phrase = 1; + */ + private $phrase = null; + /** + * The phonetic encoding of the phrase. + * + * Generated from protobuf field optional .google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding phonetic_encoding = 2; + */ + private $phonetic_encoding = null; + /** + * The pronunciation of the phrase. This must be in the phonetic encoding + * specified above. + * + * Generated from protobuf field optional string pronunciation = 3; + */ + private $pronunciation = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $phrase + * The phrase to which the customization will be applied. + * The phrase can be multiple words (in the case of proper nouns etc), but + * should not span to a whole sentence. + * @type int $phonetic_encoding + * The phonetic encoding of the phrase. + * @type string $pronunciation + * The pronunciation of the phrase. This must be in the phonetic encoding + * specified above. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Texttospeech\V1\CloudTts::initOnce(); + parent::__construct($data); + } + + /** + * The phrase to which the customization will be applied. + * The phrase can be multiple words (in the case of proper nouns etc), but + * should not span to a whole sentence. + * + * Generated from protobuf field optional string phrase = 1; + * @return string + */ + public function getPhrase() + { + return isset($this->phrase) ? $this->phrase : ''; + } + + public function hasPhrase() + { + return isset($this->phrase); + } + + public function clearPhrase() + { + unset($this->phrase); + } + + /** + * The phrase to which the customization will be applied. + * The phrase can be multiple words (in the case of proper nouns etc), but + * should not span to a whole sentence. + * + * Generated from protobuf field optional string phrase = 1; + * @param string $var + * @return $this + */ + public function setPhrase($var) + { + GPBUtil::checkString($var, True); + $this->phrase = $var; + + return $this; + } + + /** + * The phonetic encoding of the phrase. + * + * Generated from protobuf field optional .google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding phonetic_encoding = 2; + * @return int + */ + public function getPhoneticEncoding() + { + return isset($this->phonetic_encoding) ? $this->phonetic_encoding : 0; + } + + public function hasPhoneticEncoding() + { + return isset($this->phonetic_encoding); + } + + public function clearPhoneticEncoding() + { + unset($this->phonetic_encoding); + } + + /** + * The phonetic encoding of the phrase. + * + * Generated from protobuf field optional .google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding phonetic_encoding = 2; + * @param int $var + * @return $this + */ + public function setPhoneticEncoding($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\TextToSpeech\V1\CustomPronunciationParams\PhoneticEncoding::class); + $this->phonetic_encoding = $var; + + return $this; + } + + /** + * The pronunciation of the phrase. This must be in the phonetic encoding + * specified above. + * + * Generated from protobuf field optional string pronunciation = 3; + * @return string + */ + public function getPronunciation() + { + return isset($this->pronunciation) ? $this->pronunciation : ''; + } + + public function hasPronunciation() + { + return isset($this->pronunciation); + } + + public function clearPronunciation() + { + unset($this->pronunciation); + } + + /** + * The pronunciation of the phrase. This must be in the phonetic encoding + * specified above. + * + * Generated from protobuf field optional string pronunciation = 3; + * @param string $var + * @return $this + */ + public function setPronunciation($var) + { + GPBUtil::checkString($var, True); + $this->pronunciation = $var; + + return $this; + } + +} + diff --git a/TextToSpeech/src/V1/CustomPronunciationParams/PhoneticEncoding.php b/TextToSpeech/src/V1/CustomPronunciationParams/PhoneticEncoding.php new file mode 100644 index 000000000000..d7631a1efee4 --- /dev/null +++ b/TextToSpeech/src/V1/CustomPronunciationParams/PhoneticEncoding.php @@ -0,0 +1,66 @@ +google.cloud.texttospeech.v1.CustomPronunciationParams.PhoneticEncoding + */ +class PhoneticEncoding +{ + /** + * Not specified. + * + * Generated from protobuf enum PHONETIC_ENCODING_UNSPECIFIED = 0; + */ + const PHONETIC_ENCODING_UNSPECIFIED = 0; + /** + * IPA. (e.g. apple -> ˈæpÉ™l ) + * https://en.wikipedia.org/wiki/International_Phonetic_Alphabet + * + * Generated from protobuf enum PHONETIC_ENCODING_IPA = 1; + */ + const PHONETIC_ENCODING_IPA = 1; + /** + * X-SAMPA (e.g. apple -> "{p@l" ) + * https://en.wikipedia.org/wiki/X-SAMPA + * + * Generated from protobuf enum PHONETIC_ENCODING_X_SAMPA = 2; + */ + const PHONETIC_ENCODING_X_SAMPA = 2; + + private static $valueToName = [ + self::PHONETIC_ENCODING_UNSPECIFIED => 'PHONETIC_ENCODING_UNSPECIFIED', + self::PHONETIC_ENCODING_IPA => 'PHONETIC_ENCODING_IPA', + self::PHONETIC_ENCODING_X_SAMPA => 'PHONETIC_ENCODING_X_SAMPA', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(PhoneticEncoding::class, \Google\Cloud\TextToSpeech\V1\CustomPronunciationParams_PhoneticEncoding::class); + diff --git a/TextToSpeech/src/V1/CustomPronunciations.php b/TextToSpeech/src/V1/CustomPronunciations.php new file mode 100644 index 000000000000..fffc75dae4d1 --- /dev/null +++ b/TextToSpeech/src/V1/CustomPronunciations.php @@ -0,0 +1,67 @@ +google.cloud.texttospeech.v1.CustomPronunciations + */ +class CustomPronunciations extends \Google\Protobuf\Internal\Message +{ + /** + * The pronunciation customizations to be applied. + * + * Generated from protobuf field repeated .google.cloud.texttospeech.v1.CustomPronunciationParams pronunciations = 1; + */ + private $pronunciations; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\TextToSpeech\V1\CustomPronunciationParams>|\Google\Protobuf\Internal\RepeatedField $pronunciations + * The pronunciation customizations to be applied. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Texttospeech\V1\CloudTts::initOnce(); + parent::__construct($data); + } + + /** + * The pronunciation customizations to be applied. + * + * Generated from protobuf field repeated .google.cloud.texttospeech.v1.CustomPronunciationParams pronunciations = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPronunciations() + { + return $this->pronunciations; + } + + /** + * The pronunciation customizations to be applied. + * + * Generated from protobuf field repeated .google.cloud.texttospeech.v1.CustomPronunciationParams pronunciations = 1; + * @param array<\Google\Cloud\TextToSpeech\V1\CustomPronunciationParams>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPronunciations($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\TextToSpeech\V1\CustomPronunciationParams::class); + $this->pronunciations = $arr; + + return $this; + } + +} + diff --git a/TextToSpeech/src/V1/Gapic/TextToSpeechGapicClient.php b/TextToSpeech/src/V1/Gapic/TextToSpeechGapicClient.php index ec3eccecb963..04752180f014 100644 --- a/TextToSpeech/src/V1/Gapic/TextToSpeechGapicClient.php +++ b/TextToSpeech/src/V1/Gapic/TextToSpeechGapicClient.php @@ -33,6 +33,7 @@ use Google\ApiCore\Transport\TransportInterface; use Google\ApiCore\ValidationException; use Google\Auth\FetchAuthTokenInterface; +use Google\Cloud\TextToSpeech\V1\AdvancedVoiceOptions; use Google\Cloud\TextToSpeech\V1\AudioConfig; use Google\Cloud\TextToSpeech\V1\ListVoicesRequest; use Google\Cloud\TextToSpeech\V1\ListVoicesResponse; @@ -407,6 +408,8 @@ public function streamingSynthesize(array $optionalArgs = []) * @param array $optionalArgs { * Optional. * + * @type AdvancedVoiceOptions $advancedVoiceOptions + * Advanced voice options. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -427,6 +430,12 @@ public function synthesizeSpeech( $request->setInput($input); $request->setVoice($voice); $request->setAudioConfig($audioConfig); + if (isset($optionalArgs['advancedVoiceOptions'])) { + $request->setAdvancedVoiceOptions( + $optionalArgs['advancedVoiceOptions'] + ); + } + return $this->startCall( 'SynthesizeSpeech', SynthesizeSpeechResponse::class, diff --git a/TextToSpeech/src/V1/SynthesisInput.php b/TextToSpeech/src/V1/SynthesisInput.php index 4e8f0065c3c2..8c54e52eaaff 100644 --- a/TextToSpeech/src/V1/SynthesisInput.php +++ b/TextToSpeech/src/V1/SynthesisInput.php @@ -18,6 +18,21 @@ */ class SynthesisInput extends \Google\Protobuf\Internal\Message { + /** + * Optional. The pronunciation customizations to be applied to the input. If + * this is set, the input will be synthesized using the given pronunciation + * customizations. + * The initial support will be for EFIGS (English, French, + * Italian, German, Spanish) languages, as provided in + * VoiceSelectionParams. Journey and Instant Clone voices are + * not supported yet. + * In order to customize the pronunciation of a phrase, there must be an exact + * match of the phrase in the input types. If using SSML, the phrase must not + * be inside a phoneme tag (entirely or partially). + * + * Generated from protobuf field .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $custom_pronunciations = null; protected $input_source; /** @@ -34,6 +49,17 @@ class SynthesisInput extends \Google\Protobuf\Internal\Message * [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For * more information, see * [SSML](https://cloud.google.com/text-to-speech/docs/ssml). + * @type \Google\Cloud\TextToSpeech\V1\CustomPronunciations $custom_pronunciations + * Optional. The pronunciation customizations to be applied to the input. If + * this is set, the input will be synthesized using the given pronunciation + * customizations. + * The initial support will be for EFIGS (English, French, + * Italian, German, Spanish) languages, as provided in + * VoiceSelectionParams. Journey and Instant Clone voices are + * not supported yet. + * In order to customize the pronunciation of a phrase, there must be an exact + * match of the phrase in the input types. If using SSML, the phrase must not + * be inside a phoneme tag (entirely or partially). * } */ public function __construct($data = NULL) { @@ -111,6 +137,60 @@ public function setSsml($var) return $this; } + /** + * Optional. The pronunciation customizations to be applied to the input. If + * this is set, the input will be synthesized using the given pronunciation + * customizations. + * The initial support will be for EFIGS (English, French, + * Italian, German, Spanish) languages, as provided in + * VoiceSelectionParams. Journey and Instant Clone voices are + * not supported yet. + * In order to customize the pronunciation of a phrase, there must be an exact + * match of the phrase in the input types. If using SSML, the phrase must not + * be inside a phoneme tag (entirely or partially). + * + * Generated from protobuf field .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\TextToSpeech\V1\CustomPronunciations|null + */ + public function getCustomPronunciations() + { + return $this->custom_pronunciations; + } + + public function hasCustomPronunciations() + { + return isset($this->custom_pronunciations); + } + + public function clearCustomPronunciations() + { + unset($this->custom_pronunciations); + } + + /** + * Optional. The pronunciation customizations to be applied to the input. If + * this is set, the input will be synthesized using the given pronunciation + * customizations. + * The initial support will be for EFIGS (English, French, + * Italian, German, Spanish) languages, as provided in + * VoiceSelectionParams. Journey and Instant Clone voices are + * not supported yet. + * In order to customize the pronunciation of a phrase, there must be an exact + * match of the phrase in the input types. If using SSML, the phrase must not + * be inside a phoneme tag (entirely or partially). + * + * Generated from protobuf field .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\TextToSpeech\V1\CustomPronunciations $var + * @return $this + */ + public function setCustomPronunciations($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\TextToSpeech\V1\CustomPronunciations::class); + $this->custom_pronunciations = $var; + + return $this; + } + /** * @return string */ diff --git a/TextToSpeech/src/V1/SynthesizeSpeechRequest.php b/TextToSpeech/src/V1/SynthesizeSpeechRequest.php index b9e1a310aea4..706d3b0e9cb4 100644 --- a/TextToSpeech/src/V1/SynthesizeSpeechRequest.php +++ b/TextToSpeech/src/V1/SynthesizeSpeechRequest.php @@ -33,6 +33,12 @@ class SynthesizeSpeechRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED]; */ private $audio_config = null; + /** + * Advanced voice options. + * + * Generated from protobuf field optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8; + */ + private $advanced_voice_options = null; /** * @param \Google\Cloud\TextToSpeech\V1\SynthesisInput $input Required. The Synthesizer requires either plain text or SSML as input. @@ -63,6 +69,8 @@ public static function build(\Google\Cloud\TextToSpeech\V1\SynthesisInput $input * Required. The desired voice of the synthesized audio. * @type \Google\Cloud\TextToSpeech\V1\AudioConfig $audio_config * Required. The configuration of the synthesized audio. + * @type \Google\Cloud\TextToSpeech\V1\AdvancedVoiceOptions $advanced_voice_options + * Advanced voice options. * } */ public function __construct($data = NULL) { @@ -178,5 +186,41 @@ public function setAudioConfig($var) return $this; } + /** + * Advanced voice options. + * + * Generated from protobuf field optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8; + * @return \Google\Cloud\TextToSpeech\V1\AdvancedVoiceOptions|null + */ + public function getAdvancedVoiceOptions() + { + return $this->advanced_voice_options; + } + + public function hasAdvancedVoiceOptions() + { + return isset($this->advanced_voice_options); + } + + public function clearAdvancedVoiceOptions() + { + unset($this->advanced_voice_options); + } + + /** + * Advanced voice options. + * + * Generated from protobuf field optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8; + * @param \Google\Cloud\TextToSpeech\V1\AdvancedVoiceOptions $var + * @return $this + */ + public function setAdvancedVoiceOptions($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\TextToSpeech\V1\AdvancedVoiceOptions::class); + $this->advanced_voice_options = $var; + + return $this; + } + } From 438b3e8a540f8b95e24eb10abcb061c90b5dec48 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:17:32 -0700 Subject: [PATCH 016/157] feat: Add IngestionFailureEvent to the external proto (#7738) PiperOrigin-RevId: 684152766 Source-Link: https://github.com/googleapis/googleapis/commit/d992b0619ee79a2d32f6954cc29351ed8f15f560 Source-Link: https://github.com/googleapis/googleapis-gen/commit/f7405e1dc75cddd10a6aca96211318586fb61fc0 Copy-Tag: eyJwIjoiUHViU3ViLy5Pd2xCb3QueWFtbCIsImgiOiJmNzQwNWUxZGM3NWNkZGQxMGE2YWNhOTYyMTEzMTg1ODZmYjYxZmMwIn0= --- PubSub/metadata/V1/Pubsub.php | Bin 17089 -> 17622 bytes PubSub/src/V1/IngestionFailureEvent.php | 148 ++++++++++++ .../ApiViolationReason.php | 41 ++++ .../AvroFailureReason.php | 35 +++ .../CloudStorageFailure.php | 222 ++++++++++++++++++ 5 files changed, 446 insertions(+) create mode 100644 PubSub/src/V1/IngestionFailureEvent.php create mode 100644 PubSub/src/V1/IngestionFailureEvent/ApiViolationReason.php create mode 100644 PubSub/src/V1/IngestionFailureEvent/AvroFailureReason.php create mode 100644 PubSub/src/V1/IngestionFailureEvent/CloudStorageFailure.php diff --git a/PubSub/metadata/V1/Pubsub.php b/PubSub/metadata/V1/Pubsub.php index c4ea74873bcf3acd5b572450f5916b8e0ce46111..97038a175348fafc46d33a797451a9d8d62cd80c 100644 GIT binary patch delta 466 zcmX@u%6P4lal=_==B0B*ev9 zl3$RSEWxP2sKM#P{J@b(NQ#R$wWuh+C_Xo}xHvIARe}j2m&hfWoReRg5?@@BUj&qk zPlK2y!8}<|QeyH24$drO^YxrTii06)p%NfV7(E!IM7V?;3o^qp^K%kG&I(FREY8o9 z66O+gEGx=~s)Y)!W8xCVV$$RQd66haAqg(-{G_bZUgoogle.pubsub.v1.IngestionFailureEvent + */ +class IngestionFailureEvent extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the import topic. Format is: + * projects/{project_name}/topics/{topic_name}. + * + * Generated from protobuf field string topic = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $topic = ''; + /** + * Required. Error details explaining why ingestion to Pub/Sub has failed. + * + * Generated from protobuf field string error_message = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $error_message = ''; + protected $failure; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $topic + * Required. Name of the import topic. Format is: + * projects/{project_name}/topics/{topic_name}. + * @type string $error_message + * Required. Error details explaining why ingestion to Pub/Sub has failed. + * @type \Google\Cloud\PubSub\V1\IngestionFailureEvent\CloudStorageFailure $cloud_storage_failure + * Optional. Failure when ingesting from Cloud Storage. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Pubsub\V1\Pubsub::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the import topic. Format is: + * projects/{project_name}/topics/{topic_name}. + * + * Generated from protobuf field string topic = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getTopic() + { + return $this->topic; + } + + /** + * Required. Name of the import topic. Format is: + * projects/{project_name}/topics/{topic_name}. + * + * Generated from protobuf field string topic = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setTopic($var) + { + GPBUtil::checkString($var, True); + $this->topic = $var; + + return $this; + } + + /** + * Required. Error details explaining why ingestion to Pub/Sub has failed. + * + * Generated from protobuf field string error_message = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getErrorMessage() + { + return $this->error_message; + } + + /** + * Required. Error details explaining why ingestion to Pub/Sub has failed. + * + * Generated from protobuf field string error_message = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setErrorMessage($var) + { + GPBUtil::checkString($var, True); + $this->error_message = $var; + + return $this; + } + + /** + * Optional. Failure when ingesting from Cloud Storage. + * + * Generated from protobuf field .google.pubsub.v1.IngestionFailureEvent.CloudStorageFailure cloud_storage_failure = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\PubSub\V1\IngestionFailureEvent\CloudStorageFailure|null + */ + public function getCloudStorageFailure() + { + return $this->readOneof(3); + } + + public function hasCloudStorageFailure() + { + return $this->hasOneof(3); + } + + /** + * Optional. Failure when ingesting from Cloud Storage. + * + * Generated from protobuf field .google.pubsub.v1.IngestionFailureEvent.CloudStorageFailure cloud_storage_failure = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\PubSub\V1\IngestionFailureEvent\CloudStorageFailure $var + * @return $this + */ + public function setCloudStorageFailure($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\PubSub\V1\IngestionFailureEvent\CloudStorageFailure::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * @return string + */ + public function getFailure() + { + return $this->whichOneof("failure"); + } + +} + diff --git a/PubSub/src/V1/IngestionFailureEvent/ApiViolationReason.php b/PubSub/src/V1/IngestionFailureEvent/ApiViolationReason.php new file mode 100644 index 000000000000..d5a1b99f8ce9 --- /dev/null +++ b/PubSub/src/V1/IngestionFailureEvent/ApiViolationReason.php @@ -0,0 +1,41 @@ +google.pubsub.v1.IngestionFailureEvent.ApiViolationReason + */ +class ApiViolationReason extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Pubsub\V1\Pubsub::initOnce(); + parent::__construct($data); + } + +} + + diff --git a/PubSub/src/V1/IngestionFailureEvent/AvroFailureReason.php b/PubSub/src/V1/IngestionFailureEvent/AvroFailureReason.php new file mode 100644 index 000000000000..0a108a77ea73 --- /dev/null +++ b/PubSub/src/V1/IngestionFailureEvent/AvroFailureReason.php @@ -0,0 +1,35 @@ +google.pubsub.v1.IngestionFailureEvent.AvroFailureReason + */ +class AvroFailureReason extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Pubsub\V1\Pubsub::initOnce(); + parent::__construct($data); + } + +} + + diff --git a/PubSub/src/V1/IngestionFailureEvent/CloudStorageFailure.php b/PubSub/src/V1/IngestionFailureEvent/CloudStorageFailure.php new file mode 100644 index 000000000000..7eaece3abda3 --- /dev/null +++ b/PubSub/src/V1/IngestionFailureEvent/CloudStorageFailure.php @@ -0,0 +1,222 @@ +google.pubsub.v1.IngestionFailureEvent.CloudStorageFailure + */ +class CloudStorageFailure extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Name of the Cloud Storage bucket used for ingestion. + * + * Generated from protobuf field string bucket = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $bucket = ''; + /** + * Optional. Name of the Cloud Storage object which contained the section + * that couldn't be ingested. + * + * Generated from protobuf field string object_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $object_name = ''; + /** + * Optional. Generation of the Cloud Storage object which contained the + * section that couldn't be ingested. + * + * Generated from protobuf field int64 object_generation = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $object_generation = 0; + protected $reason; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $bucket + * Optional. Name of the Cloud Storage bucket used for ingestion. + * @type string $object_name + * Optional. Name of the Cloud Storage object which contained the section + * that couldn't be ingested. + * @type int|string $object_generation + * Optional. Generation of the Cloud Storage object which contained the + * section that couldn't be ingested. + * @type \Google\Cloud\PubSub\V1\IngestionFailureEvent\AvroFailureReason $avro_failure_reason + * Optional. Failure encountered when parsing an Avro file. + * @type \Google\Cloud\PubSub\V1\IngestionFailureEvent\ApiViolationReason $api_violation_reason + * Optional. The Pub/Sub API limits prevented the desired message from + * being published. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Pubsub\V1\Pubsub::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Name of the Cloud Storage bucket used for ingestion. + * + * Generated from protobuf field string bucket = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getBucket() + { + return $this->bucket; + } + + /** + * Optional. Name of the Cloud Storage bucket used for ingestion. + * + * Generated from protobuf field string bucket = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setBucket($var) + { + GPBUtil::checkString($var, True); + $this->bucket = $var; + + return $this; + } + + /** + * Optional. Name of the Cloud Storage object which contained the section + * that couldn't be ingested. + * + * Generated from protobuf field string object_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getObjectName() + { + return $this->object_name; + } + + /** + * Optional. Name of the Cloud Storage object which contained the section + * that couldn't be ingested. + * + * Generated from protobuf field string object_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setObjectName($var) + { + GPBUtil::checkString($var, True); + $this->object_name = $var; + + return $this; + } + + /** + * Optional. Generation of the Cloud Storage object which contained the + * section that couldn't be ingested. + * + * Generated from protobuf field int64 object_generation = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getObjectGeneration() + { + return $this->object_generation; + } + + /** + * Optional. Generation of the Cloud Storage object which contained the + * section that couldn't be ingested. + * + * Generated from protobuf field int64 object_generation = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setObjectGeneration($var) + { + GPBUtil::checkInt64($var); + $this->object_generation = $var; + + return $this; + } + + /** + * Optional. Failure encountered when parsing an Avro file. + * + * Generated from protobuf field .google.pubsub.v1.IngestionFailureEvent.AvroFailureReason avro_failure_reason = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\PubSub\V1\IngestionFailureEvent\AvroFailureReason|null + */ + public function getAvroFailureReason() + { + return $this->readOneof(5); + } + + public function hasAvroFailureReason() + { + return $this->hasOneof(5); + } + + /** + * Optional. Failure encountered when parsing an Avro file. + * + * Generated from protobuf field .google.pubsub.v1.IngestionFailureEvent.AvroFailureReason avro_failure_reason = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\PubSub\V1\IngestionFailureEvent\AvroFailureReason $var + * @return $this + */ + public function setAvroFailureReason($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\PubSub\V1\IngestionFailureEvent\AvroFailureReason::class); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * Optional. The Pub/Sub API limits prevented the desired message from + * being published. + * + * Generated from protobuf field .google.pubsub.v1.IngestionFailureEvent.ApiViolationReason api_violation_reason = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\PubSub\V1\IngestionFailureEvent\ApiViolationReason|null + */ + public function getApiViolationReason() + { + return $this->readOneof(6); + } + + public function hasApiViolationReason() + { + return $this->hasOneof(6); + } + + /** + * Optional. The Pub/Sub API limits prevented the desired message from + * being published. + * + * Generated from protobuf field .google.pubsub.v1.IngestionFailureEvent.ApiViolationReason api_violation_reason = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\PubSub\V1\IngestionFailureEvent\ApiViolationReason $var + * @return $this + */ + public function setApiViolationReason($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\PubSub\V1\IngestionFailureEvent\ApiViolationReason::class); + $this->writeOneof(6, $var); + + return $this; + } + + /** + * @return string + */ + public function getReason() + { + return $this->whichOneof("reason"); + } + +} + + From bb22cee327bb8a5a438bde0d39e6e48ae1d51b72 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:18:33 -0700 Subject: [PATCH 017/157] feat: add an effective_cgroup_mode field in node config (#7737) feat: add storage pools field to NodePool API feat: Add ControlPlaneEndpointsConfig message to consolidate control plane isolation options feat: Add DNSEndpointConfig for new DNS-based control plane access Moves control plane and node isolation fields to respective objects for better semantics, deprecating former locations. Introduces new DNS-based access to control plane, simplifying control plane access. feat: add API to enable/disable secret manager csi component on GKE clusters feat: Add CompliancePosture field for configuration of GKE Compliance Posture product feat: Add RBACBindingConfig to API feat: Add CompliancePosture field for configuration of GKE Compliance Posture product feat: Add KCP_SSHD and KCP_CONNECTION to the supported values for the --logging flag for the create and update cluster commands feat: surface upgrade_target_version in GetServerConfig for all supported release channels feat: added support for Parallelstore CSI Driver docs: Minor documentation updates PiperOrigin-RevId: 684119299 Source-Link: https://github.com/googleapis/googleapis/commit/1f77391203115a5740dd8815b13842f661f303df Source-Link: https://github.com/googleapis/googleapis-gen/commit/fa5cccba80771b6170d81522d48a6387c29c3c78 Copy-Tag: eyJwIjoiQ29udGFpbmVyLy5Pd2xCb3QueWFtbCIsImgiOiJmYTVjY2NiYTgwNzcxYjYxNzBkODE1MjJkNDhhNjM4N2MyOWMzYzc4In0= --- Container/metadata/V1/ClusterService.php | Bin 55136 -> 59093 bytes Container/src/V1/AddonsConfig.php | 44 ++ .../src/V1/Client/ClusterManagerClient.php | 49 +++ Container/src/V1/Cluster.php | 249 +++++++++++- Container/src/V1/ClusterUpdate.php | 363 ++++++++++++++++- Container/src/V1/CompliancePostureConfig.php | 112 ++++++ .../ComplianceStandard.php | 78 ++++ .../src/V1/CompliancePostureConfig/Mode.php | 62 +++ .../src/V1/ControlPlaneEndpointsConfig.php | 121 ++++++ .../DNSEndpointConfig.php | 132 ++++++ .../IPEndpointsConfig.php | 380 ++++++++++++++++++ Container/src/V1/EnterpriseConfig.php | 8 +- .../V1/LoggingComponentConfig/Component.php | 14 + Container/src/V1/MasterAuth.php | 12 +- .../src/V1/MasterAuthorizedNetworksConfig.php | 44 ++ Container/src/V1/NetworkConfig.php | 60 +++ Container/src/V1/NodeConfig.php | 80 ++++ .../src/V1/NodeConfig/EffectiveCgroupMode.php | 65 +++ Container/src/V1/NodeNetworkConfig.php | 8 +- .../src/V1/ParallelstoreCsiDriverConfig.php | 71 ++++ Container/src/V1/PrivateClusterConfig.php | 144 ++++++- Container/src/V1/RBACBindingConfig.php | 130 ++++++ Container/src/V1/SecretManagerConfig.php | 77 ++++ .../V1/ServerConfig/ReleaseChannelConfig.php | 34 ++ Container/src/V1/UpdateNodePoolRequest.php | 38 ++ Container/src/V1/UserManagedKeysConfig.php | 354 ++++++++++++++++ .../cluster_manager_descriptor_config.php | 2 + 27 files changed, 2689 insertions(+), 42 deletions(-) create mode 100644 Container/src/V1/CompliancePostureConfig.php create mode 100644 Container/src/V1/CompliancePostureConfig/ComplianceStandard.php create mode 100644 Container/src/V1/CompliancePostureConfig/Mode.php create mode 100644 Container/src/V1/ControlPlaneEndpointsConfig.php create mode 100644 Container/src/V1/ControlPlaneEndpointsConfig/DNSEndpointConfig.php create mode 100644 Container/src/V1/ControlPlaneEndpointsConfig/IPEndpointsConfig.php create mode 100644 Container/src/V1/NodeConfig/EffectiveCgroupMode.php create mode 100644 Container/src/V1/ParallelstoreCsiDriverConfig.php create mode 100644 Container/src/V1/RBACBindingConfig.php create mode 100644 Container/src/V1/SecretManagerConfig.php create mode 100644 Container/src/V1/UserManagedKeysConfig.php diff --git a/Container/metadata/V1/ClusterService.php b/Container/metadata/V1/ClusterService.php index 7d7df54cb9ba2ad98b57fb5e7cca9ed8fd5bce8b..8801f61a05bb02d1592b7b804691ce736ba2ff8a 100644 GIT binary patch delta 3831 zcmb7HZ)_W98RyPU?L1Di|k=Z|COe_4|{l~}rV?R<8!WN8v7p&g^$E|Hhz|e|>M72){Dh(L>f;OS?ymvl3 zf1J>MySwNA`#kUO_uTtG^1XM>R7VH zGw3ZSusp-{l52fYKYb)O`(p7ZG45#6!GjEQm;83ukFO|>AdOFB+t zr9H1Q( zw+MXE!WeEWMO;%aS8{!wA&FSWk<%!5!znW;bwf`1zQ!=zG_;s2k}R%hx}xb>FX9{I z`Dka$qL54puApq=CyyTgM@i^_c5%0$LK}p|8b0IyWT1J6NA4Jml!s5#@ziM5UM|*U z9MW~Ms7uAdd2F~QjA~k%p>tn=nCrFb6ah_JrOigU>$!1@=h8j8 zJ`RmiHfyR`*AtfezTB+?b$gh5t8 z(iO>6ES|;F4~?Cq`c=6LL1ot?)sRbNv&cAbJHK+R5cC{7{8B$f@39bqdeQq%Zr_OZ zHb5{vy_6JAO{9?}LlBslb6;2?0Cf&^+ar%0^0TiG*iR+@%Q6?p+4QOlxQ;sK5I&fDw5^zhV75e?~Aiv1^bgLy6-SI z44r$O2H)mPEM@n|9R{N0)7c*TrI&`8m=J}oJ%`=?*~>p~Wv{X1;`KG=d*mdwzK1?}ZG^|}*3tb-1mYzmiKH=;83h|r?whQAGPxotV~RsEIr@Hd_D+?AK1$OUNL83e(~i+~_V z_gnfK!1Y2KZsEqWqIwCJXq*DEU`ngVSUe3MbP=t+1P8?0YLPoEH19}(3q!!$Xr0a5 z#VHI{-f;58m7FG5YIZUzBU1$SXLH61W`e}5S{6+tgqg4u3!Z=o$)!6GUp`GdO#ao^ zP5#gqhJBTK$d&${69MNHAc+2*ty*Zu{A))RnxIkK63@Q%gX_%rL(ozKkZRW@Yzk#x zyz%N#;Hn=E;H@NyhA@fW{;+g6dG6djEJJzIxPZTP*65eYPaC5-!`&V5oA&@B1F#PS0^y~z5d`}L0_G934hgXb17->%le`imll%}tla>*ev!@cA z4FdKDvqd1S1G7#fQ2_zelb|IS0~`tzl2a9v&?N-~5+4c|lYv_o1{eY$0VoKQ{v{y+ z9g`p?83qI3K?4#TlR+jJ0RxjS04cZ0+V1^%K-zEELlGR1d}3KumwUQ3LsyTzEU5P!dt2YB5?{ClaN&!v+`WY z2LaQwykyk{v#4sy2Lkj0lXP.google.container.v1.StatefulHAConfig stateful_ha_config = 18 [(.google.api.field_behavior) = OPTIONAL]; */ protected $stateful_ha_config = null; + /** + * Configuration for the Cloud Storage Parallelstore CSI driver. + * + * Generated from protobuf field .google.container.v1.ParallelstoreCsiDriverConfig parallelstore_csi_driver_config = 19; + */ + protected $parallelstore_csi_driver_config = null; /** * Optional. Configuration for Ray Operator addon. * @@ -148,6 +154,8 @@ class AddonsConfig extends \Google\Protobuf\Internal\Message * Configuration for the Cloud Storage Fuse CSI driver. * @type \Google\Cloud\Container\V1\StatefulHAConfig $stateful_ha_config * Optional. Configuration for the StatefulHA add-on. + * @type \Google\Cloud\Container\V1\ParallelstoreCsiDriverConfig $parallelstore_csi_driver_config + * Configuration for the Cloud Storage Parallelstore CSI driver. * @type \Google\Cloud\Container\V1\RayOperatorConfig $ray_operator_config * Optional. Configuration for Ray Operator addon. * } @@ -617,6 +625,42 @@ public function setStatefulHaConfig($var) return $this; } + /** + * Configuration for the Cloud Storage Parallelstore CSI driver. + * + * Generated from protobuf field .google.container.v1.ParallelstoreCsiDriverConfig parallelstore_csi_driver_config = 19; + * @return \Google\Cloud\Container\V1\ParallelstoreCsiDriverConfig|null + */ + public function getParallelstoreCsiDriverConfig() + { + return $this->parallelstore_csi_driver_config; + } + + public function hasParallelstoreCsiDriverConfig() + { + return isset($this->parallelstore_csi_driver_config); + } + + public function clearParallelstoreCsiDriverConfig() + { + unset($this->parallelstore_csi_driver_config); + } + + /** + * Configuration for the Cloud Storage Parallelstore CSI driver. + * + * Generated from protobuf field .google.container.v1.ParallelstoreCsiDriverConfig parallelstore_csi_driver_config = 19; + * @param \Google\Cloud\Container\V1\ParallelstoreCsiDriverConfig $var + * @return $this + */ + public function setParallelstoreCsiDriverConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\ParallelstoreCsiDriverConfig::class); + $this->parallelstore_csi_driver_config = $var; + + return $this; + } + /** * Optional. Configuration for Ray Operator addon. * diff --git a/Container/src/V1/Client/ClusterManagerClient.php b/Container/src/V1/Client/ClusterManagerClient.php index 5208382934c3..1baf5f0edca0 100644 --- a/Container/src/V1/Client/ClusterManagerClient.php +++ b/Container/src/V1/Client/ClusterManagerClient.php @@ -170,6 +170,53 @@ private static function getClientDefaults() ]; } + /** + * Formats a string containing the fully-qualified path to represent a ca_pool + * resource. + * + * @param string $project + * @param string $location + * @param string $caPool + * + * @return string The formatted ca_pool resource. + */ + public static function caPoolName(string $project, string $location, string $caPool): string + { + return self::getPathTemplate('caPool')->render([ + 'project' => $project, + 'location' => $location, + 'ca_pool' => $caPool, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * crypto_key_version resource. + * + * @param string $project + * @param string $location + * @param string $keyRing + * @param string $cryptoKey + * @param string $cryptoKeyVersion + * + * @return string The formatted crypto_key_version resource. + */ + public static function cryptoKeyVersionName( + string $project, + string $location, + string $keyRing, + string $cryptoKey, + string $cryptoKeyVersion + ): string { + return self::getPathTemplate('cryptoKeyVersion')->render([ + 'project' => $project, + 'location' => $location, + 'key_ring' => $keyRing, + 'crypto_key' => $cryptoKey, + 'crypto_key_version' => $cryptoKeyVersion, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a topic * resource. @@ -191,6 +238,8 @@ public static function topicName(string $project, string $topic): string * Parses a formatted name string and returns an associative array of the components in the name. * The following name formats are supported: * Template: Pattern + * - caPool: projects/{project}/locations/{location}/caPools/{ca_pool} + * - cryptoKeyVersion: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} * - topic: projects/{project}/topics/{topic} * * The optional $template argument can be supplied to specify a particular pattern, diff --git a/Container/src/V1/Cluster.php b/Container/src/V1/Cluster.php index 2891e69914db..ef01339406ed 100644 --- a/Container/src/V1/Cluster.php +++ b/Container/src/V1/Cluster.php @@ -199,8 +199,12 @@ class Cluster extends \Google\Protobuf\Internal\Message protected $ip_allocation_policy = null; /** * The configuration options for master authorized networks feature. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config] + * instead. * - * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22; + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22 [deprecated = true]; + * @deprecated */ protected $master_authorized_networks_config = null; /** @@ -531,6 +535,12 @@ class Cluster extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.container.v1.SecurityPostureConfig security_posture_config = 145; */ protected $security_posture_config = null; + /** + * Configuration for all cluster's control plane endpoints. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig control_plane_endpoints_config = 146; + */ + protected $control_plane_endpoints_config = null; /** * Beta APIs Config * @@ -543,6 +553,18 @@ class Cluster extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.container.v1.EnterpriseConfig enterprise_config = 149; */ protected $enterprise_config = null; + /** + * Secret CSI driver configuration. + * + * Generated from protobuf field .google.container.v1.SecretManagerConfig secret_manager_config = 150; + */ + protected $secret_manager_config = null; + /** + * Enable/Disable Compliance Posture features for the cluster. + * + * Generated from protobuf field .google.container.v1.CompliancePostureConfig compliance_posture_config = 151; + */ + protected $compliance_posture_config = null; /** * Output only. Reserved for future use. * @@ -555,6 +577,19 @@ class Cluster extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional bool satisfies_pzi = 153 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $satisfies_pzi = null; + /** + * The Custom keys configuration for the cluster. + * + * Generated from protobuf field optional .google.container.v1.UserManagedKeysConfig user_managed_keys_config = 154; + */ + protected $user_managed_keys_config = null; + /** + * RBACBindingConfig allows user to restrict ClusterRoleBindings an + * RoleBindings that can be created. + * + * Generated from protobuf field optional .google.container.v1.RBACBindingConfig rbac_binding_config = 156; + */ + protected $rbac_binding_config = null; /** * Constructor. @@ -668,6 +703,9 @@ class Cluster extends \Google\Protobuf\Internal\Message * Configuration for cluster IP allocation. * @type \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig $master_authorized_networks_config * The configuration options for master authorized networks feature. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config] + * instead. * @type \Google\Cloud\Container\V1\MaintenancePolicy $maintenance_policy * Configure the maintenance policy for this cluster. * @type \Google\Cloud\Container\V1\BinaryAuthorization $binary_authorization @@ -811,14 +849,25 @@ class Cluster extends \Google\Protobuf\Internal\Message * Fleet information for the cluster. * @type \Google\Cloud\Container\V1\SecurityPostureConfig $security_posture_config * Enable/Disable Security Posture API features for the cluster. + * @type \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig $control_plane_endpoints_config + * Configuration for all cluster's control plane endpoints. * @type \Google\Cloud\Container\V1\K8sBetaAPIConfig $enable_k8s_beta_apis * Beta APIs Config * @type \Google\Cloud\Container\V1\EnterpriseConfig $enterprise_config * GKE Enterprise Configuration. + * @type \Google\Cloud\Container\V1\SecretManagerConfig $secret_manager_config + * Secret CSI driver configuration. + * @type \Google\Cloud\Container\V1\CompliancePostureConfig $compliance_posture_config + * Enable/Disable Compliance Posture features for the cluster. * @type bool $satisfies_pzs * Output only. Reserved for future use. * @type bool $satisfies_pzi * Output only. Reserved for future use. + * @type \Google\Cloud\Container\V1\UserManagedKeysConfig $user_managed_keys_config + * The Custom keys configuration for the cluster. + * @type \Google\Cloud\Container\V1\RBACBindingConfig $rbac_binding_config + * RBACBindingConfig allows user to restrict ClusterRoleBindings an + * RoleBindings that can be created. * } */ public function __construct($data = NULL) { @@ -1524,34 +1573,46 @@ public function setIpAllocationPolicy($var) /** * The configuration options for master authorized networks feature. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config] + * instead. * - * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22; + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22 [deprecated = true]; * @return \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig|null + * @deprecated */ public function getMasterAuthorizedNetworksConfig() { + @trigger_error('master_authorized_networks_config is deprecated.', E_USER_DEPRECATED); return $this->master_authorized_networks_config; } public function hasMasterAuthorizedNetworksConfig() { + @trigger_error('master_authorized_networks_config is deprecated.', E_USER_DEPRECATED); return isset($this->master_authorized_networks_config); } public function clearMasterAuthorizedNetworksConfig() { + @trigger_error('master_authorized_networks_config is deprecated.', E_USER_DEPRECATED); unset($this->master_authorized_networks_config); } /** * The configuration options for master authorized networks feature. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config] + * instead. * - * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22; + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22 [deprecated = true]; * @param \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig $var * @return $this + * @deprecated */ public function setMasterAuthorizedNetworksConfig($var) { + @trigger_error('master_authorized_networks_config is deprecated.', E_USER_DEPRECATED); GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig::class); $this->master_authorized_networks_config = $var; @@ -3104,6 +3165,42 @@ public function setSecurityPostureConfig($var) return $this; } + /** + * Configuration for all cluster's control plane endpoints. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig control_plane_endpoints_config = 146; + * @return \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig|null + */ + public function getControlPlaneEndpointsConfig() + { + return $this->control_plane_endpoints_config; + } + + public function hasControlPlaneEndpointsConfig() + { + return isset($this->control_plane_endpoints_config); + } + + public function clearControlPlaneEndpointsConfig() + { + unset($this->control_plane_endpoints_config); + } + + /** + * Configuration for all cluster's control plane endpoints. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig control_plane_endpoints_config = 146; + * @param \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig $var + * @return $this + */ + public function setControlPlaneEndpointsConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig::class); + $this->control_plane_endpoints_config = $var; + + return $this; + } + /** * Beta APIs Config * @@ -3176,6 +3273,78 @@ public function setEnterpriseConfig($var) return $this; } + /** + * Secret CSI driver configuration. + * + * Generated from protobuf field .google.container.v1.SecretManagerConfig secret_manager_config = 150; + * @return \Google\Cloud\Container\V1\SecretManagerConfig|null + */ + public function getSecretManagerConfig() + { + return $this->secret_manager_config; + } + + public function hasSecretManagerConfig() + { + return isset($this->secret_manager_config); + } + + public function clearSecretManagerConfig() + { + unset($this->secret_manager_config); + } + + /** + * Secret CSI driver configuration. + * + * Generated from protobuf field .google.container.v1.SecretManagerConfig secret_manager_config = 150; + * @param \Google\Cloud\Container\V1\SecretManagerConfig $var + * @return $this + */ + public function setSecretManagerConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\SecretManagerConfig::class); + $this->secret_manager_config = $var; + + return $this; + } + + /** + * Enable/Disable Compliance Posture features for the cluster. + * + * Generated from protobuf field .google.container.v1.CompliancePostureConfig compliance_posture_config = 151; + * @return \Google\Cloud\Container\V1\CompliancePostureConfig|null + */ + public function getCompliancePostureConfig() + { + return $this->compliance_posture_config; + } + + public function hasCompliancePostureConfig() + { + return isset($this->compliance_posture_config); + } + + public function clearCompliancePostureConfig() + { + unset($this->compliance_posture_config); + } + + /** + * Enable/Disable Compliance Posture features for the cluster. + * + * Generated from protobuf field .google.container.v1.CompliancePostureConfig compliance_posture_config = 151; + * @param \Google\Cloud\Container\V1\CompliancePostureConfig $var + * @return $this + */ + public function setCompliancePostureConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\CompliancePostureConfig::class); + $this->compliance_posture_config = $var; + + return $this; + } + /** * Output only. Reserved for future use. * @@ -3248,5 +3417,79 @@ public function setSatisfiesPzi($var) return $this; } + /** + * The Custom keys configuration for the cluster. + * + * Generated from protobuf field optional .google.container.v1.UserManagedKeysConfig user_managed_keys_config = 154; + * @return \Google\Cloud\Container\V1\UserManagedKeysConfig|null + */ + public function getUserManagedKeysConfig() + { + return $this->user_managed_keys_config; + } + + public function hasUserManagedKeysConfig() + { + return isset($this->user_managed_keys_config); + } + + public function clearUserManagedKeysConfig() + { + unset($this->user_managed_keys_config); + } + + /** + * The Custom keys configuration for the cluster. + * + * Generated from protobuf field optional .google.container.v1.UserManagedKeysConfig user_managed_keys_config = 154; + * @param \Google\Cloud\Container\V1\UserManagedKeysConfig $var + * @return $this + */ + public function setUserManagedKeysConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\UserManagedKeysConfig::class); + $this->user_managed_keys_config = $var; + + return $this; + } + + /** + * RBACBindingConfig allows user to restrict ClusterRoleBindings an + * RoleBindings that can be created. + * + * Generated from protobuf field optional .google.container.v1.RBACBindingConfig rbac_binding_config = 156; + * @return \Google\Cloud\Container\V1\RBACBindingConfig|null + */ + public function getRbacBindingConfig() + { + return $this->rbac_binding_config; + } + + public function hasRbacBindingConfig() + { + return isset($this->rbac_binding_config); + } + + public function clearRbacBindingConfig() + { + unset($this->rbac_binding_config); + } + + /** + * RBACBindingConfig allows user to restrict ClusterRoleBindings an + * RoleBindings that can be created. + * + * Generated from protobuf field optional .google.container.v1.RBACBindingConfig rbac_binding_config = 156; + * @param \Google\Cloud\Container\V1\RBACBindingConfig $var + * @return $this + */ + public function setRbacBindingConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\RBACBindingConfig::class); + $this->rbac_binding_config = $var; + + return $this; + } + } diff --git a/Container/src/V1/ClusterUpdate.php b/Container/src/V1/ClusterUpdate.php index 68b58c0027a3..6ce484dcd5c3 100644 --- a/Container/src/V1/ClusterUpdate.php +++ b/Container/src/V1/ClusterUpdate.php @@ -126,8 +126,12 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message private $desired_locations; /** * The desired configuration options for master authorized networks feature. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config + * instead. * - * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12; + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12 [deprecated = true]; + * @deprecated */ protected $desired_master_authorized_networks_config = null; /** @@ -175,8 +179,12 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message * [ClusterUpdate.desired_enable_private_endpoint][google.container.v1.ClusterUpdate.desired_enable_private_endpoint] * for modifying other fields within * [PrivateClusterConfig][google.container.v1.PrivateClusterConfig]. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.global_access + * instead. * - * Generated from protobuf field .google.container.v1.PrivateClusterConfig desired_private_cluster_config = 25; + * Generated from protobuf field .google.container.v1.PrivateClusterConfig desired_private_cluster_config = 25 [deprecated = true]; + * @deprecated */ protected $desired_private_cluster_config = null; /** @@ -254,10 +262,31 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message protected $desired_service_external_ips_config = null; /** * Enable/Disable private endpoint for the cluster's master. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint + * instead. Note that the value of enable_public_endpoint is reversed: if + * enable_private_endpoint is false, then enable_public_endpoint will be true. * - * Generated from protobuf field optional bool desired_enable_private_endpoint = 71; + * Generated from protobuf field optional bool desired_enable_private_endpoint = 71 [deprecated = true]; + * @deprecated */ protected $desired_enable_private_endpoint = null; + /** + * Override the default setting of whether future created + * nodes have private IP addresses only, namely + * [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] + * + * Generated from protobuf field optional bool desired_default_enable_private_nodes = 72; + */ + protected $desired_default_enable_private_nodes = null; + /** + * [Control plane + * endpoints][google.container.v1.Cluster.control_plane_endpoints_config] + * configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig desired_control_plane_endpoints_config = 73; + */ + protected $desired_control_plane_endpoints_config = null; /** * The Kubernetes version to change the master to. * Users may specify either explicit versions offered by @@ -400,6 +429,18 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional bool desired_enable_cilium_clusterwide_network_policy = 138; */ protected $desired_enable_cilium_clusterwide_network_policy = null; + /** + * Enable/Disable Secret Manager Config. + * + * Generated from protobuf field optional .google.container.v1.SecretManagerConfig desired_secret_manager_config = 139; + */ + protected $desired_secret_manager_config = null; + /** + * Enable/Disable Compliance Posture features for the cluster. + * + * Generated from protobuf field optional .google.container.v1.CompliancePostureConfig desired_compliance_posture_config = 140; + */ + protected $desired_compliance_posture_config = null; /** * The desired node kubelet config for the cluster. * @@ -413,6 +454,19 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.container.v1.NodeKubeletConfig desired_node_pool_auto_config_kubelet_config = 142; */ protected $desired_node_pool_auto_config_kubelet_config = null; + /** + * The Custom keys configuration for the cluster. + * + * Generated from protobuf field .google.container.v1.UserManagedKeysConfig user_managed_keys_config = 143; + */ + protected $user_managed_keys_config = null; + /** + * RBACBindingConfig allows user to restrict ClusterRoleBindings an + * RoleBindings that can be created. + * + * Generated from protobuf field optional .google.container.v1.RBACBindingConfig desired_rbac_binding_config = 144; + */ + protected $desired_rbac_binding_config = null; /** * Constructor. @@ -477,6 +531,9 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message * pools and will result in nodes being added and/or removed. * @type \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig $desired_master_authorized_networks_config * The desired configuration options for master authorized networks feature. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config + * instead. * @type \Google\Cloud\Container\V1\ClusterAutoscaling $desired_cluster_autoscaling * Cluster-level autoscaling configuration. * @type \Google\Cloud\Container\V1\BinaryAuthorization $desired_binary_authorization @@ -502,6 +559,9 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message * [ClusterUpdate.desired_enable_private_endpoint][google.container.v1.ClusterUpdate.desired_enable_private_endpoint] * for modifying other fields within * [PrivateClusterConfig][google.container.v1.PrivateClusterConfig]. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.global_access + * instead. * @type \Google\Cloud\Container\V1\IntraNodeVisibilityConfig $desired_intra_node_visibility_config * The desired config of Intra-node visibility. * @type \Google\Cloud\Container\V1\DefaultSnatStatus $desired_default_snat_status @@ -529,6 +589,18 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message * ExternalIPs field. * @type bool $desired_enable_private_endpoint * Enable/Disable private endpoint for the cluster's master. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint + * instead. Note that the value of enable_public_endpoint is reversed: if + * enable_private_endpoint is false, then enable_public_endpoint will be true. + * @type bool $desired_default_enable_private_nodes + * Override the default setting of whether future created + * nodes have private IP addresses only, namely + * [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] + * @type \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig $desired_control_plane_endpoints_config + * [Control plane + * endpoints][google.container.v1.Cluster.control_plane_endpoints_config] + * configuration. * @type string $desired_master_version * The Kubernetes version to change the master to. * Users may specify either explicit versions offered by @@ -587,11 +659,20 @@ class ClusterUpdate extends \Google\Protobuf\Internal\Message * Specify the details of in-transit encryption. * @type bool $desired_enable_cilium_clusterwide_network_policy * Enable/Disable Cilium Clusterwide Network Policy for the cluster. + * @type \Google\Cloud\Container\V1\SecretManagerConfig $desired_secret_manager_config + * Enable/Disable Secret Manager Config. + * @type \Google\Cloud\Container\V1\CompliancePostureConfig $desired_compliance_posture_config + * Enable/Disable Compliance Posture features for the cluster. * @type \Google\Cloud\Container\V1\NodeKubeletConfig $desired_node_kubelet_config * The desired node kubelet config for the cluster. * @type \Google\Cloud\Container\V1\NodeKubeletConfig $desired_node_pool_auto_config_kubelet_config * The desired node kubelet config for all auto-provisioned node pools * in autopilot clusters and node auto-provisioning enabled clusters. + * @type \Google\Cloud\Container\V1\UserManagedKeysConfig $user_managed_keys_config + * The Custom keys configuration for the cluster. + * @type \Google\Cloud\Container\V1\RBACBindingConfig $desired_rbac_binding_config + * RBACBindingConfig allows user to restrict ClusterRoleBindings an + * RoleBindings that can be created. * } */ public function __construct($data = NULL) { @@ -1077,34 +1158,46 @@ public function setDesiredLocations($var) /** * The desired configuration options for master authorized networks feature. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config + * instead. * - * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12; + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12 [deprecated = true]; * @return \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig|null + * @deprecated */ public function getDesiredMasterAuthorizedNetworksConfig() { + @trigger_error('desired_master_authorized_networks_config is deprecated.', E_USER_DEPRECATED); return $this->desired_master_authorized_networks_config; } public function hasDesiredMasterAuthorizedNetworksConfig() { + @trigger_error('desired_master_authorized_networks_config is deprecated.', E_USER_DEPRECATED); return isset($this->desired_master_authorized_networks_config); } public function clearDesiredMasterAuthorizedNetworksConfig() { + @trigger_error('desired_master_authorized_networks_config is deprecated.', E_USER_DEPRECATED); unset($this->desired_master_authorized_networks_config); } /** * The desired configuration options for master authorized networks feature. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config + * instead. * - * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12; + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12 [deprecated = true]; * @param \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig $var * @return $this + * @deprecated */ public function setDesiredMasterAuthorizedNetworksConfig($var) { + @trigger_error('desired_master_authorized_networks_config is deprecated.', E_USER_DEPRECATED); GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig::class); $this->desired_master_authorized_networks_config = $var; @@ -1304,22 +1397,29 @@ public function setDesiredVerticalPodAutoscaling($var) * [ClusterUpdate.desired_enable_private_endpoint][google.container.v1.ClusterUpdate.desired_enable_private_endpoint] * for modifying other fields within * [PrivateClusterConfig][google.container.v1.PrivateClusterConfig]. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.global_access + * instead. * - * Generated from protobuf field .google.container.v1.PrivateClusterConfig desired_private_cluster_config = 25; + * Generated from protobuf field .google.container.v1.PrivateClusterConfig desired_private_cluster_config = 25 [deprecated = true]; * @return \Google\Cloud\Container\V1\PrivateClusterConfig|null + * @deprecated */ public function getDesiredPrivateClusterConfig() { + @trigger_error('desired_private_cluster_config is deprecated.', E_USER_DEPRECATED); return $this->desired_private_cluster_config; } public function hasDesiredPrivateClusterConfig() { + @trigger_error('desired_private_cluster_config is deprecated.', E_USER_DEPRECATED); return isset($this->desired_private_cluster_config); } public function clearDesiredPrivateClusterConfig() { + @trigger_error('desired_private_cluster_config is deprecated.', E_USER_DEPRECATED); unset($this->desired_private_cluster_config); } @@ -1330,13 +1430,18 @@ public function clearDesiredPrivateClusterConfig() * [ClusterUpdate.desired_enable_private_endpoint][google.container.v1.ClusterUpdate.desired_enable_private_endpoint] * for modifying other fields within * [PrivateClusterConfig][google.container.v1.PrivateClusterConfig]. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.global_access + * instead. * - * Generated from protobuf field .google.container.v1.PrivateClusterConfig desired_private_cluster_config = 25; + * Generated from protobuf field .google.container.v1.PrivateClusterConfig desired_private_cluster_config = 25 [deprecated = true]; * @param \Google\Cloud\Container\V1\PrivateClusterConfig $var * @return $this + * @deprecated */ public function setDesiredPrivateClusterConfig($var) { + @trigger_error('desired_private_cluster_config is deprecated.', E_USER_DEPRECATED); GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\PrivateClusterConfig::class); $this->desired_private_cluster_config = $var; @@ -1759,40 +1864,134 @@ public function setDesiredServiceExternalIpsConfig($var) /** * Enable/Disable private endpoint for the cluster's master. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint + * instead. Note that the value of enable_public_endpoint is reversed: if + * enable_private_endpoint is false, then enable_public_endpoint will be true. * - * Generated from protobuf field optional bool desired_enable_private_endpoint = 71; + * Generated from protobuf field optional bool desired_enable_private_endpoint = 71 [deprecated = true]; * @return bool + * @deprecated */ public function getDesiredEnablePrivateEndpoint() { + @trigger_error('desired_enable_private_endpoint is deprecated.', E_USER_DEPRECATED); return isset($this->desired_enable_private_endpoint) ? $this->desired_enable_private_endpoint : false; } public function hasDesiredEnablePrivateEndpoint() { + @trigger_error('desired_enable_private_endpoint is deprecated.', E_USER_DEPRECATED); return isset($this->desired_enable_private_endpoint); } public function clearDesiredEnablePrivateEndpoint() { + @trigger_error('desired_enable_private_endpoint is deprecated.', E_USER_DEPRECATED); unset($this->desired_enable_private_endpoint); } /** * Enable/Disable private endpoint for the cluster's master. + * Deprecated: Use + * desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint + * instead. Note that the value of enable_public_endpoint is reversed: if + * enable_private_endpoint is false, then enable_public_endpoint will be true. * - * Generated from protobuf field optional bool desired_enable_private_endpoint = 71; + * Generated from protobuf field optional bool desired_enable_private_endpoint = 71 [deprecated = true]; * @param bool $var * @return $this + * @deprecated */ public function setDesiredEnablePrivateEndpoint($var) { + @trigger_error('desired_enable_private_endpoint is deprecated.', E_USER_DEPRECATED); GPBUtil::checkBool($var); $this->desired_enable_private_endpoint = $var; return $this; } + /** + * Override the default setting of whether future created + * nodes have private IP addresses only, namely + * [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] + * + * Generated from protobuf field optional bool desired_default_enable_private_nodes = 72; + * @return bool + */ + public function getDesiredDefaultEnablePrivateNodes() + { + return isset($this->desired_default_enable_private_nodes) ? $this->desired_default_enable_private_nodes : false; + } + + public function hasDesiredDefaultEnablePrivateNodes() + { + return isset($this->desired_default_enable_private_nodes); + } + + public function clearDesiredDefaultEnablePrivateNodes() + { + unset($this->desired_default_enable_private_nodes); + } + + /** + * Override the default setting of whether future created + * nodes have private IP addresses only, namely + * [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] + * + * Generated from protobuf field optional bool desired_default_enable_private_nodes = 72; + * @param bool $var + * @return $this + */ + public function setDesiredDefaultEnablePrivateNodes($var) + { + GPBUtil::checkBool($var); + $this->desired_default_enable_private_nodes = $var; + + return $this; + } + + /** + * [Control plane + * endpoints][google.container.v1.Cluster.control_plane_endpoints_config] + * configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig desired_control_plane_endpoints_config = 73; + * @return \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig|null + */ + public function getDesiredControlPlaneEndpointsConfig() + { + return $this->desired_control_plane_endpoints_config; + } + + public function hasDesiredControlPlaneEndpointsConfig() + { + return isset($this->desired_control_plane_endpoints_config); + } + + public function clearDesiredControlPlaneEndpointsConfig() + { + unset($this->desired_control_plane_endpoints_config); + } + + /** + * [Control plane + * endpoints][google.container.v1.Cluster.control_plane_endpoints_config] + * configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig desired_control_plane_endpoints_config = 73; + * @param \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig $var + * @return $this + */ + public function setDesiredControlPlaneEndpointsConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig::class); + $this->desired_control_plane_endpoints_config = $var; + + return $this; + } + /** * The Kubernetes version to change the master to. * Users may specify either explicit versions offered by @@ -2551,6 +2750,78 @@ public function setDesiredEnableCiliumClusterwideNetworkPolicy($var) return $this; } + /** + * Enable/Disable Secret Manager Config. + * + * Generated from protobuf field optional .google.container.v1.SecretManagerConfig desired_secret_manager_config = 139; + * @return \Google\Cloud\Container\V1\SecretManagerConfig|null + */ + public function getDesiredSecretManagerConfig() + { + return $this->desired_secret_manager_config; + } + + public function hasDesiredSecretManagerConfig() + { + return isset($this->desired_secret_manager_config); + } + + public function clearDesiredSecretManagerConfig() + { + unset($this->desired_secret_manager_config); + } + + /** + * Enable/Disable Secret Manager Config. + * + * Generated from protobuf field optional .google.container.v1.SecretManagerConfig desired_secret_manager_config = 139; + * @param \Google\Cloud\Container\V1\SecretManagerConfig $var + * @return $this + */ + public function setDesiredSecretManagerConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\SecretManagerConfig::class); + $this->desired_secret_manager_config = $var; + + return $this; + } + + /** + * Enable/Disable Compliance Posture features for the cluster. + * + * Generated from protobuf field optional .google.container.v1.CompliancePostureConfig desired_compliance_posture_config = 140; + * @return \Google\Cloud\Container\V1\CompliancePostureConfig|null + */ + public function getDesiredCompliancePostureConfig() + { + return $this->desired_compliance_posture_config; + } + + public function hasDesiredCompliancePostureConfig() + { + return isset($this->desired_compliance_posture_config); + } + + public function clearDesiredCompliancePostureConfig() + { + unset($this->desired_compliance_posture_config); + } + + /** + * Enable/Disable Compliance Posture features for the cluster. + * + * Generated from protobuf field optional .google.container.v1.CompliancePostureConfig desired_compliance_posture_config = 140; + * @param \Google\Cloud\Container\V1\CompliancePostureConfig $var + * @return $this + */ + public function setDesiredCompliancePostureConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\CompliancePostureConfig::class); + $this->desired_compliance_posture_config = $var; + + return $this; + } + /** * The desired node kubelet config for the cluster. * @@ -2625,5 +2896,79 @@ public function setDesiredNodePoolAutoConfigKubeletConfig($var) return $this; } + /** + * The Custom keys configuration for the cluster. + * + * Generated from protobuf field .google.container.v1.UserManagedKeysConfig user_managed_keys_config = 143; + * @return \Google\Cloud\Container\V1\UserManagedKeysConfig|null + */ + public function getUserManagedKeysConfig() + { + return $this->user_managed_keys_config; + } + + public function hasUserManagedKeysConfig() + { + return isset($this->user_managed_keys_config); + } + + public function clearUserManagedKeysConfig() + { + unset($this->user_managed_keys_config); + } + + /** + * The Custom keys configuration for the cluster. + * + * Generated from protobuf field .google.container.v1.UserManagedKeysConfig user_managed_keys_config = 143; + * @param \Google\Cloud\Container\V1\UserManagedKeysConfig $var + * @return $this + */ + public function setUserManagedKeysConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\UserManagedKeysConfig::class); + $this->user_managed_keys_config = $var; + + return $this; + } + + /** + * RBACBindingConfig allows user to restrict ClusterRoleBindings an + * RoleBindings that can be created. + * + * Generated from protobuf field optional .google.container.v1.RBACBindingConfig desired_rbac_binding_config = 144; + * @return \Google\Cloud\Container\V1\RBACBindingConfig|null + */ + public function getDesiredRbacBindingConfig() + { + return $this->desired_rbac_binding_config; + } + + public function hasDesiredRbacBindingConfig() + { + return isset($this->desired_rbac_binding_config); + } + + public function clearDesiredRbacBindingConfig() + { + unset($this->desired_rbac_binding_config); + } + + /** + * RBACBindingConfig allows user to restrict ClusterRoleBindings an + * RoleBindings that can be created. + * + * Generated from protobuf field optional .google.container.v1.RBACBindingConfig desired_rbac_binding_config = 144; + * @param \Google\Cloud\Container\V1\RBACBindingConfig $var + * @return $this + */ + public function setDesiredRbacBindingConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\RBACBindingConfig::class); + $this->desired_rbac_binding_config = $var; + + return $this; + } + } diff --git a/Container/src/V1/CompliancePostureConfig.php b/Container/src/V1/CompliancePostureConfig.php new file mode 100644 index 000000000000..f0ba2f3a20b9 --- /dev/null +++ b/Container/src/V1/CompliancePostureConfig.php @@ -0,0 +1,112 @@ +google.container.v1.CompliancePostureConfig + */ +class CompliancePostureConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Defines the enablement mode for Compliance Posture. + * + * Generated from protobuf field optional .google.container.v1.CompliancePostureConfig.Mode mode = 1; + */ + protected $mode = null; + /** + * List of enabled compliance standards. + * + * Generated from protobuf field repeated .google.container.v1.CompliancePostureConfig.ComplianceStandard compliance_standards = 2; + */ + private $compliance_standards; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $mode + * Defines the enablement mode for Compliance Posture. + * @type array<\Google\Cloud\Container\V1\CompliancePostureConfig\ComplianceStandard>|\Google\Protobuf\Internal\RepeatedField $compliance_standards + * List of enabled compliance standards. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * Defines the enablement mode for Compliance Posture. + * + * Generated from protobuf field optional .google.container.v1.CompliancePostureConfig.Mode mode = 1; + * @return int + */ + public function getMode() + { + return isset($this->mode) ? $this->mode : 0; + } + + public function hasMode() + { + return isset($this->mode); + } + + public function clearMode() + { + unset($this->mode); + } + + /** + * Defines the enablement mode for Compliance Posture. + * + * Generated from protobuf field optional .google.container.v1.CompliancePostureConfig.Mode mode = 1; + * @param int $var + * @return $this + */ + public function setMode($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Container\V1\CompliancePostureConfig\Mode::class); + $this->mode = $var; + + return $this; + } + + /** + * List of enabled compliance standards. + * + * Generated from protobuf field repeated .google.container.v1.CompliancePostureConfig.ComplianceStandard compliance_standards = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getComplianceStandards() + { + return $this->compliance_standards; + } + + /** + * List of enabled compliance standards. + * + * Generated from protobuf field repeated .google.container.v1.CompliancePostureConfig.ComplianceStandard compliance_standards = 2; + * @param array<\Google\Cloud\Container\V1\CompliancePostureConfig\ComplianceStandard>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setComplianceStandards($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Container\V1\CompliancePostureConfig\ComplianceStandard::class); + $this->compliance_standards = $arr; + + return $this; + } + +} + diff --git a/Container/src/V1/CompliancePostureConfig/ComplianceStandard.php b/Container/src/V1/CompliancePostureConfig/ComplianceStandard.php new file mode 100644 index 000000000000..4657961a0143 --- /dev/null +++ b/Container/src/V1/CompliancePostureConfig/ComplianceStandard.php @@ -0,0 +1,78 @@ +google.container.v1.CompliancePostureConfig.ComplianceStandard + */ +class ComplianceStandard extends \Google\Protobuf\Internal\Message +{ + /** + * Name of the compliance standard. + * + * Generated from protobuf field optional string standard = 1; + */ + protected $standard = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $standard + * Name of the compliance standard. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * Name of the compliance standard. + * + * Generated from protobuf field optional string standard = 1; + * @return string + */ + public function getStandard() + { + return isset($this->standard) ? $this->standard : ''; + } + + public function hasStandard() + { + return isset($this->standard); + } + + public function clearStandard() + { + unset($this->standard); + } + + /** + * Name of the compliance standard. + * + * Generated from protobuf field optional string standard = 1; + * @param string $var + * @return $this + */ + public function setStandard($var) + { + GPBUtil::checkString($var, True); + $this->standard = $var; + + return $this; + } + +} + + diff --git a/Container/src/V1/CompliancePostureConfig/Mode.php b/Container/src/V1/CompliancePostureConfig/Mode.php new file mode 100644 index 000000000000..e5ad0c416219 --- /dev/null +++ b/Container/src/V1/CompliancePostureConfig/Mode.php @@ -0,0 +1,62 @@ +google.container.v1.CompliancePostureConfig.Mode + */ +class Mode +{ + /** + * Default value not specified. + * + * Generated from protobuf enum MODE_UNSPECIFIED = 0; + */ + const MODE_UNSPECIFIED = 0; + /** + * Disables Compliance Posture features on the cluster. + * + * Generated from protobuf enum DISABLED = 1; + */ + const DISABLED = 1; + /** + * Enables Compliance Posture features on the cluster. + * + * Generated from protobuf enum ENABLED = 2; + */ + const ENABLED = 2; + + private static $valueToName = [ + self::MODE_UNSPECIFIED => 'MODE_UNSPECIFIED', + self::DISABLED => 'DISABLED', + self::ENABLED => 'ENABLED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Container/src/V1/ControlPlaneEndpointsConfig.php b/Container/src/V1/ControlPlaneEndpointsConfig.php new file mode 100644 index 000000000000..fccd4802d779 --- /dev/null +++ b/Container/src/V1/ControlPlaneEndpointsConfig.php @@ -0,0 +1,121 @@ +google.container.v1.ControlPlaneEndpointsConfig + */ +class ControlPlaneEndpointsConfig extends \Google\Protobuf\Internal\Message +{ + /** + * DNS endpoint configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig dns_endpoint_config = 1; + */ + protected $dns_endpoint_config = null; + /** + * IP endpoints configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig ip_endpoints_config = 3; + */ + protected $ip_endpoints_config = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig\DNSEndpointConfig $dns_endpoint_config + * DNS endpoint configuration. + * @type \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig\IPEndpointsConfig $ip_endpoints_config + * IP endpoints configuration. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * DNS endpoint configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig dns_endpoint_config = 1; + * @return \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig\DNSEndpointConfig|null + */ + public function getDnsEndpointConfig() + { + return $this->dns_endpoint_config; + } + + public function hasDnsEndpointConfig() + { + return isset($this->dns_endpoint_config); + } + + public function clearDnsEndpointConfig() + { + unset($this->dns_endpoint_config); + } + + /** + * DNS endpoint configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig dns_endpoint_config = 1; + * @param \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig\DNSEndpointConfig $var + * @return $this + */ + public function setDnsEndpointConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig\DNSEndpointConfig::class); + $this->dns_endpoint_config = $var; + + return $this; + } + + /** + * IP endpoints configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig ip_endpoints_config = 3; + * @return \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig\IPEndpointsConfig|null + */ + public function getIpEndpointsConfig() + { + return $this->ip_endpoints_config; + } + + public function hasIpEndpointsConfig() + { + return isset($this->ip_endpoints_config); + } + + public function clearIpEndpointsConfig() + { + unset($this->ip_endpoints_config); + } + + /** + * IP endpoints configuration. + * + * Generated from protobuf field .google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig ip_endpoints_config = 3; + * @param \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig\IPEndpointsConfig $var + * @return $this + */ + public function setIpEndpointsConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\ControlPlaneEndpointsConfig\IPEndpointsConfig::class); + $this->ip_endpoints_config = $var; + + return $this; + } + +} + diff --git a/Container/src/V1/ControlPlaneEndpointsConfig/DNSEndpointConfig.php b/Container/src/V1/ControlPlaneEndpointsConfig/DNSEndpointConfig.php new file mode 100644 index 000000000000..ac13124bb104 --- /dev/null +++ b/Container/src/V1/ControlPlaneEndpointsConfig/DNSEndpointConfig.php @@ -0,0 +1,132 @@ +google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig + */ +class DNSEndpointConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The cluster's DNS endpoint configuration. + * A DNS format address. This is accessible from the public internet. + * Ex: uid.us-central1.gke.goog. + * Always present, but the behavior may change according to the value of + * [DNSEndpointConfig.allow_external_traffic][google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig.allow_external_traffic]. + * + * Generated from protobuf field string endpoint = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $endpoint = ''; + /** + * Controls whether user traffic is allowed over this endpoint. Note that + * GCP-managed services may still use the endpoint even if this is false. + * + * Generated from protobuf field optional bool allow_external_traffic = 3; + */ + protected $allow_external_traffic = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $endpoint + * Output only. The cluster's DNS endpoint configuration. + * A DNS format address. This is accessible from the public internet. + * Ex: uid.us-central1.gke.goog. + * Always present, but the behavior may change according to the value of + * [DNSEndpointConfig.allow_external_traffic][google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig.allow_external_traffic]. + * @type bool $allow_external_traffic + * Controls whether user traffic is allowed over this endpoint. Note that + * GCP-managed services may still use the endpoint even if this is false. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The cluster's DNS endpoint configuration. + * A DNS format address. This is accessible from the public internet. + * Ex: uid.us-central1.gke.goog. + * Always present, but the behavior may change according to the value of + * [DNSEndpointConfig.allow_external_traffic][google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig.allow_external_traffic]. + * + * Generated from protobuf field string endpoint = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getEndpoint() + { + return $this->endpoint; + } + + /** + * Output only. The cluster's DNS endpoint configuration. + * A DNS format address. This is accessible from the public internet. + * Ex: uid.us-central1.gke.goog. + * Always present, but the behavior may change according to the value of + * [DNSEndpointConfig.allow_external_traffic][google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig.allow_external_traffic]. + * + * Generated from protobuf field string endpoint = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setEndpoint($var) + { + GPBUtil::checkString($var, True); + $this->endpoint = $var; + + return $this; + } + + /** + * Controls whether user traffic is allowed over this endpoint. Note that + * GCP-managed services may still use the endpoint even if this is false. + * + * Generated from protobuf field optional bool allow_external_traffic = 3; + * @return bool + */ + public function getAllowExternalTraffic() + { + return isset($this->allow_external_traffic) ? $this->allow_external_traffic : false; + } + + public function hasAllowExternalTraffic() + { + return isset($this->allow_external_traffic); + } + + public function clearAllowExternalTraffic() + { + unset($this->allow_external_traffic); + } + + /** + * Controls whether user traffic is allowed over this endpoint. Note that + * GCP-managed services may still use the endpoint even if this is false. + * + * Generated from protobuf field optional bool allow_external_traffic = 3; + * @param bool $var + * @return $this + */ + public function setAllowExternalTraffic($var) + { + GPBUtil::checkBool($var); + $this->allow_external_traffic = $var; + + return $this; + } + +} + + diff --git a/Container/src/V1/ControlPlaneEndpointsConfig/IPEndpointsConfig.php b/Container/src/V1/ControlPlaneEndpointsConfig/IPEndpointsConfig.php new file mode 100644 index 000000000000..aef655946583 --- /dev/null +++ b/Container/src/V1/ControlPlaneEndpointsConfig/IPEndpointsConfig.php @@ -0,0 +1,380 @@ +google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig + */ +class IPEndpointsConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Controls whether to allow direct IP access. + * + * Generated from protobuf field optional bool enabled = 1; + */ + protected $enabled = null; + /** + * Controls whether the control plane allows access through a public IP. + * It is invalid to specify both + * [PrivateClusterConfig.enablePrivateEndpoint][] and this field at the same + * time. + * + * Generated from protobuf field optional bool enable_public_endpoint = 2; + */ + protected $enable_public_endpoint = null; + /** + * Controls whether the control plane's private endpoint is accessible from + * sources in other regions. + * It is invalid to specify both + * [PrivateClusterMasterGlobalAccessConfig.enabled][google.container.v1.PrivateClusterMasterGlobalAccessConfig.enabled] + * and this field at the same time. + * + * Generated from protobuf field optional bool global_access = 3; + */ + protected $global_access = null; + /** + * Configuration of authorized networks. If enabled, restricts access to the + * control plane based on source IP. + * It is invalid to specify both + * [Cluster.masterAuthorizedNetworksConfig][] and this field at the same + * time. + * + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig authorized_networks_config = 4; + */ + protected $authorized_networks_config = null; + /** + * Output only. The external IP address of this cluster's control plane. + * Only populated if enabled. + * + * Generated from protobuf field string public_endpoint = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $public_endpoint = ''; + /** + * Output only. The internal IP address of this cluster's control plane. + * Only populated if enabled. + * + * Generated from protobuf field string private_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $private_endpoint = ''; + /** + * Subnet to provision the master's private endpoint during cluster + * creation. Specified in projects/*/regions/*/subnetworks/* format. It is + * invalid to specify both + * [PrivateClusterConfig.privateEndpointSubnetwork][] and this field at the + * same time. + * + * Generated from protobuf field string private_endpoint_subnetwork = 7; + */ + protected $private_endpoint_subnetwork = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enabled + * Controls whether to allow direct IP access. + * @type bool $enable_public_endpoint + * Controls whether the control plane allows access through a public IP. + * It is invalid to specify both + * [PrivateClusterConfig.enablePrivateEndpoint][] and this field at the same + * time. + * @type bool $global_access + * Controls whether the control plane's private endpoint is accessible from + * sources in other regions. + * It is invalid to specify both + * [PrivateClusterMasterGlobalAccessConfig.enabled][google.container.v1.PrivateClusterMasterGlobalAccessConfig.enabled] + * and this field at the same time. + * @type \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig $authorized_networks_config + * Configuration of authorized networks. If enabled, restricts access to the + * control plane based on source IP. + * It is invalid to specify both + * [Cluster.masterAuthorizedNetworksConfig][] and this field at the same + * time. + * @type string $public_endpoint + * Output only. The external IP address of this cluster's control plane. + * Only populated if enabled. + * @type string $private_endpoint + * Output only. The internal IP address of this cluster's control plane. + * Only populated if enabled. + * @type string $private_endpoint_subnetwork + * Subnet to provision the master's private endpoint during cluster + * creation. Specified in projects/*/regions/*/subnetworks/* format. It is + * invalid to specify both + * [PrivateClusterConfig.privateEndpointSubnetwork][] and this field at the + * same time. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * Controls whether to allow direct IP access. + * + * Generated from protobuf field optional bool enabled = 1; + * @return bool + */ + public function getEnabled() + { + return isset($this->enabled) ? $this->enabled : false; + } + + public function hasEnabled() + { + return isset($this->enabled); + } + + public function clearEnabled() + { + unset($this->enabled); + } + + /** + * Controls whether to allow direct IP access. + * + * Generated from protobuf field optional bool enabled = 1; + * @param bool $var + * @return $this + */ + public function setEnabled($var) + { + GPBUtil::checkBool($var); + $this->enabled = $var; + + return $this; + } + + /** + * Controls whether the control plane allows access through a public IP. + * It is invalid to specify both + * [PrivateClusterConfig.enablePrivateEndpoint][] and this field at the same + * time. + * + * Generated from protobuf field optional bool enable_public_endpoint = 2; + * @return bool + */ + public function getEnablePublicEndpoint() + { + return isset($this->enable_public_endpoint) ? $this->enable_public_endpoint : false; + } + + public function hasEnablePublicEndpoint() + { + return isset($this->enable_public_endpoint); + } + + public function clearEnablePublicEndpoint() + { + unset($this->enable_public_endpoint); + } + + /** + * Controls whether the control plane allows access through a public IP. + * It is invalid to specify both + * [PrivateClusterConfig.enablePrivateEndpoint][] and this field at the same + * time. + * + * Generated from protobuf field optional bool enable_public_endpoint = 2; + * @param bool $var + * @return $this + */ + public function setEnablePublicEndpoint($var) + { + GPBUtil::checkBool($var); + $this->enable_public_endpoint = $var; + + return $this; + } + + /** + * Controls whether the control plane's private endpoint is accessible from + * sources in other regions. + * It is invalid to specify both + * [PrivateClusterMasterGlobalAccessConfig.enabled][google.container.v1.PrivateClusterMasterGlobalAccessConfig.enabled] + * and this field at the same time. + * + * Generated from protobuf field optional bool global_access = 3; + * @return bool + */ + public function getGlobalAccess() + { + return isset($this->global_access) ? $this->global_access : false; + } + + public function hasGlobalAccess() + { + return isset($this->global_access); + } + + public function clearGlobalAccess() + { + unset($this->global_access); + } + + /** + * Controls whether the control plane's private endpoint is accessible from + * sources in other regions. + * It is invalid to specify both + * [PrivateClusterMasterGlobalAccessConfig.enabled][google.container.v1.PrivateClusterMasterGlobalAccessConfig.enabled] + * and this field at the same time. + * + * Generated from protobuf field optional bool global_access = 3; + * @param bool $var + * @return $this + */ + public function setGlobalAccess($var) + { + GPBUtil::checkBool($var); + $this->global_access = $var; + + return $this; + } + + /** + * Configuration of authorized networks. If enabled, restricts access to the + * control plane based on source IP. + * It is invalid to specify both + * [Cluster.masterAuthorizedNetworksConfig][] and this field at the same + * time. + * + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig authorized_networks_config = 4; + * @return \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig|null + */ + public function getAuthorizedNetworksConfig() + { + return $this->authorized_networks_config; + } + + public function hasAuthorizedNetworksConfig() + { + return isset($this->authorized_networks_config); + } + + public function clearAuthorizedNetworksConfig() + { + unset($this->authorized_networks_config); + } + + /** + * Configuration of authorized networks. If enabled, restricts access to the + * control plane based on source IP. + * It is invalid to specify both + * [Cluster.masterAuthorizedNetworksConfig][] and this field at the same + * time. + * + * Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig authorized_networks_config = 4; + * @param \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig $var + * @return $this + */ + public function setAuthorizedNetworksConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig::class); + $this->authorized_networks_config = $var; + + return $this; + } + + /** + * Output only. The external IP address of this cluster's control plane. + * Only populated if enabled. + * + * Generated from protobuf field string public_endpoint = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getPublicEndpoint() + { + return $this->public_endpoint; + } + + /** + * Output only. The external IP address of this cluster's control plane. + * Only populated if enabled. + * + * Generated from protobuf field string public_endpoint = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setPublicEndpoint($var) + { + GPBUtil::checkString($var, True); + $this->public_endpoint = $var; + + return $this; + } + + /** + * Output only. The internal IP address of this cluster's control plane. + * Only populated if enabled. + * + * Generated from protobuf field string private_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getPrivateEndpoint() + { + return $this->private_endpoint; + } + + /** + * Output only. The internal IP address of this cluster's control plane. + * Only populated if enabled. + * + * Generated from protobuf field string private_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setPrivateEndpoint($var) + { + GPBUtil::checkString($var, True); + $this->private_endpoint = $var; + + return $this; + } + + /** + * Subnet to provision the master's private endpoint during cluster + * creation. Specified in projects/*/regions/*/subnetworks/* format. It is + * invalid to specify both + * [PrivateClusterConfig.privateEndpointSubnetwork][] and this field at the + * same time. + * + * Generated from protobuf field string private_endpoint_subnetwork = 7; + * @return string + */ + public function getPrivateEndpointSubnetwork() + { + return $this->private_endpoint_subnetwork; + } + + /** + * Subnet to provision the master's private endpoint during cluster + * creation. Specified in projects/*/regions/*/subnetworks/* format. It is + * invalid to specify both + * [PrivateClusterConfig.privateEndpointSubnetwork][] and this field at the + * same time. + * + * Generated from protobuf field string private_endpoint_subnetwork = 7; + * @param string $var + * @return $this + */ + public function setPrivateEndpointSubnetwork($var) + { + GPBUtil::checkString($var, True); + $this->private_endpoint_subnetwork = $var; + + return $this; + } + +} + + diff --git a/Container/src/V1/EnterpriseConfig.php b/Container/src/V1/EnterpriseConfig.php index 87d37561f0e8..8f53cca0b529 100644 --- a/Container/src/V1/EnterpriseConfig.php +++ b/Container/src/V1/EnterpriseConfig.php @@ -16,7 +16,7 @@ class EnterpriseConfig extends \Google\Protobuf\Internal\Message { /** - * Output only. cluster_tier specifies the premium tier of the cluster. + * Output only. cluster_tier indicates the effective tier of the cluster. * * Generated from protobuf field .google.container.v1.EnterpriseConfig.ClusterTier cluster_tier = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -29,7 +29,7 @@ class EnterpriseConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $cluster_tier - * Output only. cluster_tier specifies the premium tier of the cluster. + * Output only. cluster_tier indicates the effective tier of the cluster. * } */ public function __construct($data = NULL) { @@ -38,7 +38,7 @@ public function __construct($data = NULL) { } /** - * Output only. cluster_tier specifies the premium tier of the cluster. + * Output only. cluster_tier indicates the effective tier of the cluster. * * Generated from protobuf field .google.container.v1.EnterpriseConfig.ClusterTier cluster_tier = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int @@ -49,7 +49,7 @@ public function getClusterTier() } /** - * Output only. cluster_tier specifies the premium tier of the cluster. + * Output only. cluster_tier indicates the effective tier of the cluster. * * Generated from protobuf field .google.container.v1.EnterpriseConfig.ClusterTier cluster_tier = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int $var diff --git a/Container/src/V1/LoggingComponentConfig/Component.php b/Container/src/V1/LoggingComponentConfig/Component.php index 2e72c43ef696..20604f85a96c 100644 --- a/Container/src/V1/LoggingComponentConfig/Component.php +++ b/Container/src/V1/LoggingComponentConfig/Component.php @@ -49,6 +49,18 @@ class Component * Generated from protobuf enum CONTROLLER_MANAGER = 5; */ const CONTROLLER_MANAGER = 5; + /** + * kcp-sshd + * + * Generated from protobuf enum KCP_SSHD = 7; + */ + const KCP_SSHD = 7; + /** + * kcp connection logs + * + * Generated from protobuf enum KCP_CONNECTION = 8; + */ + const KCP_CONNECTION = 8; private static $valueToName = [ self::COMPONENT_UNSPECIFIED => 'COMPONENT_UNSPECIFIED', @@ -57,6 +69,8 @@ class Component self::APISERVER => 'APISERVER', self::SCHEDULER => 'SCHEDULER', self::CONTROLLER_MANAGER => 'CONTROLLER_MANAGER', + self::KCP_SSHD => 'KCP_SSHD', + self::KCP_CONNECTION => 'KCP_CONNECTION', ]; public static function name($value) diff --git a/Container/src/V1/MasterAuth.php b/Container/src/V1/MasterAuth.php index 0637bf5ebdb2..86f08f6ce5dd 100644 --- a/Container/src/V1/MasterAuth.php +++ b/Container/src/V1/MasterAuth.php @@ -61,7 +61,8 @@ class MasterAuth extends \Google\Protobuf\Internal\Message protected $cluster_ca_certificate = ''; /** * Output only. Base64-encoded public certificate used by clients to - * authenticate to the cluster endpoint. + * authenticate to the cluster endpoint. Issued only if + * client_certificate_config is set. * * Generated from protobuf field string client_certificate = 101 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -106,7 +107,8 @@ class MasterAuth extends \Google\Protobuf\Internal\Message * trust for the cluster. * @type string $client_certificate * Output only. Base64-encoded public certificate used by clients to - * authenticate to the cluster endpoint. + * authenticate to the cluster endpoint. Issued only if + * client_certificate_config is set. * @type string $client_key * Output only. Base64-encoded private key used by clients to authenticate * to the cluster endpoint. @@ -273,7 +275,8 @@ public function setClusterCaCertificate($var) /** * Output only. Base64-encoded public certificate used by clients to - * authenticate to the cluster endpoint. + * authenticate to the cluster endpoint. Issued only if + * client_certificate_config is set. * * Generated from protobuf field string client_certificate = 101 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -285,7 +288,8 @@ public function getClientCertificate() /** * Output only. Base64-encoded public certificate used by clients to - * authenticate to the cluster endpoint. + * authenticate to the cluster endpoint. Issued only if + * client_certificate_config is set. * * Generated from protobuf field string client_certificate = 101 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var diff --git a/Container/src/V1/MasterAuthorizedNetworksConfig.php b/Container/src/V1/MasterAuthorizedNetworksConfig.php index f2d4ee45311c..f136b3f0d8b6 100644 --- a/Container/src/V1/MasterAuthorizedNetworksConfig.php +++ b/Container/src/V1/MasterAuthorizedNetworksConfig.php @@ -37,6 +37,12 @@ class MasterAuthorizedNetworksConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional bool gcp_public_cidrs_access_enabled = 3; */ protected $gcp_public_cidrs_access_enabled = null; + /** + * Whether master authorized networks is enforced on private endpoint or not. + * + * Generated from protobuf field optional bool private_endpoint_enforcement_enabled = 5; + */ + protected $private_endpoint_enforcement_enabled = null; /** * Constructor. @@ -51,6 +57,8 @@ class MasterAuthorizedNetworksConfig extends \Google\Protobuf\Internal\Message * Kubernetes master through HTTPS. * @type bool $gcp_public_cidrs_access_enabled * Whether master is accessbile via Google Compute Engine Public IP addresses. + * @type bool $private_endpoint_enforcement_enabled + * Whether master authorized networks is enforced on private endpoint or not. * } */ public function __construct($data = NULL) { @@ -148,5 +156,41 @@ public function setGcpPublicCidrsAccessEnabled($var) return $this; } + /** + * Whether master authorized networks is enforced on private endpoint or not. + * + * Generated from protobuf field optional bool private_endpoint_enforcement_enabled = 5; + * @return bool + */ + public function getPrivateEndpointEnforcementEnabled() + { + return isset($this->private_endpoint_enforcement_enabled) ? $this->private_endpoint_enforcement_enabled : false; + } + + public function hasPrivateEndpointEnforcementEnabled() + { + return isset($this->private_endpoint_enforcement_enabled); + } + + public function clearPrivateEndpointEnforcementEnabled() + { + unset($this->private_endpoint_enforcement_enabled); + } + + /** + * Whether master authorized networks is enforced on private endpoint or not. + * + * Generated from protobuf field optional bool private_endpoint_enforcement_enabled = 5; + * @param bool $var + * @return $this + */ + public function setPrivateEndpointEnforcementEnabled($var) + { + GPBUtil::checkBool($var); + $this->private_endpoint_enforcement_enabled = $var; + + return $this; + } + } diff --git a/Container/src/V1/NetworkConfig.php b/Container/src/V1/NetworkConfig.php index c10adc09c0bc..033e3ca44126 100644 --- a/Container/src/V1/NetworkConfig.php +++ b/Container/src/V1/NetworkConfig.php @@ -121,6 +121,16 @@ class NetworkConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional bool enable_cilium_clusterwide_network_policy = 21; */ protected $enable_cilium_clusterwide_network_policy = null; + /** + * Controls whether by default nodes have private IP addresses only. + * It is invalid to specify both [PrivateClusterConfig.enablePrivateNodes][] + * and this field at the same time. + * To update the default setting, use + * [ClusterUpdate.desired_default_enable_private_nodes][google.container.v1.ClusterUpdate.desired_default_enable_private_nodes] + * + * Generated from protobuf field optional bool default_enable_private_nodes = 22; + */ + protected $default_enable_private_nodes = null; /** * Constructor. @@ -174,6 +184,12 @@ class NetworkConfig extends \Google\Protobuf\Internal\Message * Now named inter-node transparent encryption. * @type bool $enable_cilium_clusterwide_network_policy * Whether CiliumClusterwideNetworkPolicy is enabled on this cluster. + * @type bool $default_enable_private_nodes + * Controls whether by default nodes have private IP addresses only. + * It is invalid to specify both [PrivateClusterConfig.enablePrivateNodes][] + * and this field at the same time. + * To update the default setting, use + * [ClusterUpdate.desired_default_enable_private_nodes][google.container.v1.ClusterUpdate.desired_default_enable_private_nodes] * } */ public function __construct($data = NULL) { @@ -683,5 +699,49 @@ public function setEnableCiliumClusterwideNetworkPolicy($var) return $this; } + /** + * Controls whether by default nodes have private IP addresses only. + * It is invalid to specify both [PrivateClusterConfig.enablePrivateNodes][] + * and this field at the same time. + * To update the default setting, use + * [ClusterUpdate.desired_default_enable_private_nodes][google.container.v1.ClusterUpdate.desired_default_enable_private_nodes] + * + * Generated from protobuf field optional bool default_enable_private_nodes = 22; + * @return bool + */ + public function getDefaultEnablePrivateNodes() + { + return isset($this->default_enable_private_nodes) ? $this->default_enable_private_nodes : false; + } + + public function hasDefaultEnablePrivateNodes() + { + return isset($this->default_enable_private_nodes); + } + + public function clearDefaultEnablePrivateNodes() + { + unset($this->default_enable_private_nodes); + } + + /** + * Controls whether by default nodes have private IP addresses only. + * It is invalid to specify both [PrivateClusterConfig.enablePrivateNodes][] + * and this field at the same time. + * To update the default setting, use + * [ClusterUpdate.desired_default_enable_private_nodes][google.container.v1.ClusterUpdate.desired_default_enable_private_nodes] + * + * Generated from protobuf field optional bool default_enable_private_nodes = 22; + * @param bool $var + * @return $this + */ + public function setDefaultEnablePrivateNodes($var) + { + GPBUtil::checkBool($var); + $this->default_enable_private_nodes = $var; + + return $this; + } + } diff --git a/Container/src/V1/NodeConfig.php b/Container/src/V1/NodeConfig.php index e3168f9ed1d5..57436b5cb6c3 100644 --- a/Container/src/V1/NodeConfig.php +++ b/Container/src/V1/NodeConfig.php @@ -337,12 +337,27 @@ class NodeConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.container.v1.SecondaryBootDisk secondary_boot_disks = 48; */ private $secondary_boot_disks; + /** + * List of Storage Pools where boot disks are provisioned. + * + * Generated from protobuf field repeated string storage_pools = 49; + */ + private $storage_pools; /** * Secondary boot disk update strategy. * * Generated from protobuf field optional .google.container.v1.SecondaryBootDiskUpdateStrategy secondary_boot_disk_update_strategy = 50; */ protected $secondary_boot_disk_update_strategy = null; + /** + * Output only. effective_cgroup_mode is the cgroup mode actually used by the + * node pool. It is determined by the cgroup mode specified in the + * LinuxNodeConfig or the default cgroup mode based on the cluster creation + * version. + * + * Generated from protobuf field .google.container.v1.NodeConfig.EffectiveCgroupMode effective_cgroup_mode = 55 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $effective_cgroup_mode = 0; /** * Constructor. @@ -516,8 +531,15 @@ class NodeConfig extends \Google\Protobuf\Internal\Message * Optional. Reserved for future use. * @type array<\Google\Cloud\Container\V1\SecondaryBootDisk>|\Google\Protobuf\Internal\RepeatedField $secondary_boot_disks * List of secondary boot disks attached to the nodes. + * @type array|\Google\Protobuf\Internal\RepeatedField $storage_pools + * List of Storage Pools where boot disks are provisioned. * @type \Google\Cloud\Container\V1\SecondaryBootDiskUpdateStrategy $secondary_boot_disk_update_strategy * Secondary boot disk update strategy. + * @type int $effective_cgroup_mode + * Output only. effective_cgroup_mode is the cgroup mode actually used by the + * node pool. It is determined by the cgroup mode specified in the + * LinuxNodeConfig or the default cgroup mode based on the cluster creation + * version. * } */ public function __construct($data = NULL) { @@ -1873,6 +1895,32 @@ public function setSecondaryBootDisks($var) return $this; } + /** + * List of Storage Pools where boot disks are provisioned. + * + * Generated from protobuf field repeated string storage_pools = 49; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getStoragePools() + { + return $this->storage_pools; + } + + /** + * List of Storage Pools where boot disks are provisioned. + * + * Generated from protobuf field repeated string storage_pools = 49; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setStoragePools($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->storage_pools = $arr; + + return $this; + } + /** * Secondary boot disk update strategy. * @@ -1909,5 +1957,37 @@ public function setSecondaryBootDiskUpdateStrategy($var) return $this; } + /** + * Output only. effective_cgroup_mode is the cgroup mode actually used by the + * node pool. It is determined by the cgroup mode specified in the + * LinuxNodeConfig or the default cgroup mode based on the cluster creation + * version. + * + * Generated from protobuf field .google.container.v1.NodeConfig.EffectiveCgroupMode effective_cgroup_mode = 55 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getEffectiveCgroupMode() + { + return $this->effective_cgroup_mode; + } + + /** + * Output only. effective_cgroup_mode is the cgroup mode actually used by the + * node pool. It is determined by the cgroup mode specified in the + * LinuxNodeConfig or the default cgroup mode based on the cluster creation + * version. + * + * Generated from protobuf field .google.container.v1.NodeConfig.EffectiveCgroupMode effective_cgroup_mode = 55 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setEffectiveCgroupMode($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Container\V1\NodeConfig\EffectiveCgroupMode::class); + $this->effective_cgroup_mode = $var; + + return $this; + } + } diff --git a/Container/src/V1/NodeConfig/EffectiveCgroupMode.php b/Container/src/V1/NodeConfig/EffectiveCgroupMode.php new file mode 100644 index 000000000000..aafc283b18a3 --- /dev/null +++ b/Container/src/V1/NodeConfig/EffectiveCgroupMode.php @@ -0,0 +1,65 @@ +google.container.v1.NodeConfig.EffectiveCgroupMode + */ +class EffectiveCgroupMode +{ + /** + * EFFECTIVE_CGROUP_MODE_UNSPECIFIED means the cgroup configuration for the + * node pool is unspecified, i.e. the node pool is a Windows node pool. + * + * Generated from protobuf enum EFFECTIVE_CGROUP_MODE_UNSPECIFIED = 0; + */ + const EFFECTIVE_CGROUP_MODE_UNSPECIFIED = 0; + /** + * CGROUP_MODE_V1 means the node pool is configured to use cgroupv1 for the + * cgroup configuration. + * + * Generated from protobuf enum EFFECTIVE_CGROUP_MODE_V1 = 1; + */ + const EFFECTIVE_CGROUP_MODE_V1 = 1; + /** + * CGROUP_MODE_V2 means the node pool is configured to use cgroupv2 for the + * cgroup configuration. + * + * Generated from protobuf enum EFFECTIVE_CGROUP_MODE_V2 = 2; + */ + const EFFECTIVE_CGROUP_MODE_V2 = 2; + + private static $valueToName = [ + self::EFFECTIVE_CGROUP_MODE_UNSPECIFIED => 'EFFECTIVE_CGROUP_MODE_UNSPECIFIED', + self::EFFECTIVE_CGROUP_MODE_V1 => 'EFFECTIVE_CGROUP_MODE_V1', + self::EFFECTIVE_CGROUP_MODE_V2 => 'EFFECTIVE_CGROUP_MODE_V2', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Container/src/V1/NodeNetworkConfig.php b/Container/src/V1/NodeNetworkConfig.php index 834f9cc666dd..b038dcc5e28d 100644 --- a/Container/src/V1/NodeNetworkConfig.php +++ b/Container/src/V1/NodeNetworkConfig.php @@ -57,7 +57,7 @@ class NodeNetworkConfig extends \Google\Protobuf\Internal\Message /** * Whether nodes have internal IP addresses only. * If enable_private_nodes is not specified, then the value is derived from - * [cluster.privateClusterConfig.enablePrivateNodes][google.container.v1beta1.PrivateClusterConfig.enablePrivateNodes] + * [Cluster.NetworkConfig.default_enable_private_nodes][] * * Generated from protobuf field optional bool enable_private_nodes = 9; */ @@ -142,7 +142,7 @@ class NodeNetworkConfig extends \Google\Protobuf\Internal\Message * @type bool $enable_private_nodes * Whether nodes have internal IP addresses only. * If enable_private_nodes is not specified, then the value is derived from - * [cluster.privateClusterConfig.enablePrivateNodes][google.container.v1beta1.PrivateClusterConfig.enablePrivateNodes] + * [Cluster.NetworkConfig.default_enable_private_nodes][] * @type \Google\Cloud\Container\V1\NodeNetworkConfig\NetworkPerformanceConfig $network_performance_config * Network bandwidth tier configuration. * @type \Google\Cloud\Container\V1\PodCIDROverprovisionConfig $pod_cidr_overprovision_config @@ -296,7 +296,7 @@ public function setPodIpv4CidrBlock($var) /** * Whether nodes have internal IP addresses only. * If enable_private_nodes is not specified, then the value is derived from - * [cluster.privateClusterConfig.enablePrivateNodes][google.container.v1beta1.PrivateClusterConfig.enablePrivateNodes] + * [Cluster.NetworkConfig.default_enable_private_nodes][] * * Generated from protobuf field optional bool enable_private_nodes = 9; * @return bool @@ -319,7 +319,7 @@ public function clearEnablePrivateNodes() /** * Whether nodes have internal IP addresses only. * If enable_private_nodes is not specified, then the value is derived from - * [cluster.privateClusterConfig.enablePrivateNodes][google.container.v1beta1.PrivateClusterConfig.enablePrivateNodes] + * [Cluster.NetworkConfig.default_enable_private_nodes][] * * Generated from protobuf field optional bool enable_private_nodes = 9; * @param bool $var diff --git a/Container/src/V1/ParallelstoreCsiDriverConfig.php b/Container/src/V1/ParallelstoreCsiDriverConfig.php new file mode 100644 index 000000000000..b793bd25dcb2 --- /dev/null +++ b/Container/src/V1/ParallelstoreCsiDriverConfig.php @@ -0,0 +1,71 @@ +google.container.v1.ParallelstoreCsiDriverConfig + */ +class ParallelstoreCsiDriverConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Whether the Cloud Storage Parallelstore CSI driver is enabled for this + * cluster. + * + * Generated from protobuf field bool enabled = 1; + */ + protected $enabled = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enabled + * Whether the Cloud Storage Parallelstore CSI driver is enabled for this + * cluster. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * Whether the Cloud Storage Parallelstore CSI driver is enabled for this + * cluster. + * + * Generated from protobuf field bool enabled = 1; + * @return bool + */ + public function getEnabled() + { + return $this->enabled; + } + + /** + * Whether the Cloud Storage Parallelstore CSI driver is enabled for this + * cluster. + * + * Generated from protobuf field bool enabled = 1; + * @param bool $var + * @return $this + */ + public function setEnabled($var) + { + GPBUtil::checkBool($var); + $this->enabled = $var; + + return $this; + } + +} + diff --git a/Container/src/V1/PrivateClusterConfig.php b/Container/src/V1/PrivateClusterConfig.php index 77b0254d7b4a..a6c52fc08e08 100644 --- a/Container/src/V1/PrivateClusterConfig.php +++ b/Container/src/V1/PrivateClusterConfig.php @@ -19,14 +19,23 @@ class PrivateClusterConfig extends \Google\Protobuf\Internal\Message * Whether nodes have internal IP addresses only. If enabled, all nodes are * given only RFC 1918 private addresses and communicate with the master via * private networking. + * Deprecated: Use + * [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] + * instead. * - * Generated from protobuf field bool enable_private_nodes = 1; + * Generated from protobuf field bool enable_private_nodes = 1 [deprecated = true]; + * @deprecated */ protected $enable_private_nodes = false; /** * Whether the master's internal IP address is used as the cluster endpoint. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint] + * instead. Note that the value of enable_public_endpoint is reversed: if + * enable_private_endpoint is false, then enable_public_endpoint will be true. * - * Generated from protobuf field bool enable_private_endpoint = 2; + * Generated from protobuf field bool enable_private_endpoint = 2 [deprecated = true]; + * @deprecated */ protected $enable_private_endpoint = false; /** @@ -40,14 +49,22 @@ class PrivateClusterConfig extends \Google\Protobuf\Internal\Message protected $master_ipv4_cidr_block = ''; /** * Output only. The internal IP address of this cluster's master endpoint. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint] + * instead. * - * Generated from protobuf field string private_endpoint = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string private_endpoint = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @deprecated */ protected $private_endpoint = ''; /** * Output only. The external IP address of this cluster's master endpoint. + * Deprecated:Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint] + * instead. * - * Generated from protobuf field string public_endpoint = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string public_endpoint = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @deprecated */ protected $public_endpoint = ''; /** @@ -58,15 +75,23 @@ class PrivateClusterConfig extends \Google\Protobuf\Internal\Message protected $peering_name = ''; /** * Controls master global access settings. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access][] + * instead. * - * Generated from protobuf field .google.container.v1.PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8; + * Generated from protobuf field .google.container.v1.PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8 [deprecated = true]; + * @deprecated */ protected $master_global_access_config = null; /** * Subnet to provision the master's private endpoint during cluster creation. * Specified in projects/*/regions/*/subnetworks/* format. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork] + * instead. * - * Generated from protobuf field string private_endpoint_subnetwork = 10; + * Generated from protobuf field string private_endpoint_subnetwork = 10 [deprecated = true]; + * @deprecated */ protected $private_endpoint_subnetwork = ''; @@ -80,8 +105,15 @@ class PrivateClusterConfig extends \Google\Protobuf\Internal\Message * Whether nodes have internal IP addresses only. If enabled, all nodes are * given only RFC 1918 private addresses and communicate with the master via * private networking. + * Deprecated: Use + * [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] + * instead. * @type bool $enable_private_endpoint * Whether the master's internal IP address is used as the cluster endpoint. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint] + * instead. Note that the value of enable_public_endpoint is reversed: if + * enable_private_endpoint is false, then enable_public_endpoint will be true. * @type string $master_ipv4_cidr_block * The IP range in CIDR notation to use for the hosted master network. This * range will be used for assigning internal IP addresses to the master or @@ -89,15 +121,27 @@ class PrivateClusterConfig extends \Google\Protobuf\Internal\Message * any other ranges in use within the cluster's network. * @type string $private_endpoint * Output only. The internal IP address of this cluster's master endpoint. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint] + * instead. * @type string $public_endpoint * Output only. The external IP address of this cluster's master endpoint. + * Deprecated:Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint] + * instead. * @type string $peering_name * Output only. The peering name in the customer VPC used by this cluster. * @type \Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig $master_global_access_config * Controls master global access settings. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access][] + * instead. * @type string $private_endpoint_subnetwork * Subnet to provision the master's private endpoint during cluster creation. * Specified in projects/*/regions/*/subnetworks/* format. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork] + * instead. * } */ public function __construct($data = NULL) { @@ -109,12 +153,17 @@ public function __construct($data = NULL) { * Whether nodes have internal IP addresses only. If enabled, all nodes are * given only RFC 1918 private addresses and communicate with the master via * private networking. + * Deprecated: Use + * [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] + * instead. * - * Generated from protobuf field bool enable_private_nodes = 1; + * Generated from protobuf field bool enable_private_nodes = 1 [deprecated = true]; * @return bool + * @deprecated */ public function getEnablePrivateNodes() { + @trigger_error('enable_private_nodes is deprecated.', E_USER_DEPRECATED); return $this->enable_private_nodes; } @@ -122,13 +171,18 @@ public function getEnablePrivateNodes() * Whether nodes have internal IP addresses only. If enabled, all nodes are * given only RFC 1918 private addresses and communicate with the master via * private networking. + * Deprecated: Use + * [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] + * instead. * - * Generated from protobuf field bool enable_private_nodes = 1; + * Generated from protobuf field bool enable_private_nodes = 1 [deprecated = true]; * @param bool $var * @return $this + * @deprecated */ public function setEnablePrivateNodes($var) { + @trigger_error('enable_private_nodes is deprecated.', E_USER_DEPRECATED); GPBUtil::checkBool($var); $this->enable_private_nodes = $var; @@ -137,24 +191,36 @@ public function setEnablePrivateNodes($var) /** * Whether the master's internal IP address is used as the cluster endpoint. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint] + * instead. Note that the value of enable_public_endpoint is reversed: if + * enable_private_endpoint is false, then enable_public_endpoint will be true. * - * Generated from protobuf field bool enable_private_endpoint = 2; + * Generated from protobuf field bool enable_private_endpoint = 2 [deprecated = true]; * @return bool + * @deprecated */ public function getEnablePrivateEndpoint() { + @trigger_error('enable_private_endpoint is deprecated.', E_USER_DEPRECATED); return $this->enable_private_endpoint; } /** * Whether the master's internal IP address is used as the cluster endpoint. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint] + * instead. Note that the value of enable_public_endpoint is reversed: if + * enable_private_endpoint is false, then enable_public_endpoint will be true. * - * Generated from protobuf field bool enable_private_endpoint = 2; + * Generated from protobuf field bool enable_private_endpoint = 2 [deprecated = true]; * @param bool $var * @return $this + * @deprecated */ public function setEnablePrivateEndpoint($var) { + @trigger_error('enable_private_endpoint is deprecated.', E_USER_DEPRECATED); GPBUtil::checkBool($var); $this->enable_private_endpoint = $var; @@ -195,24 +261,34 @@ public function setMasterIpv4CidrBlock($var) /** * Output only. The internal IP address of this cluster's master endpoint. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint] + * instead. * - * Generated from protobuf field string private_endpoint = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string private_endpoint = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; * @return string + * @deprecated */ public function getPrivateEndpoint() { + @trigger_error('private_endpoint is deprecated.', E_USER_DEPRECATED); return $this->private_endpoint; } /** * Output only. The internal IP address of this cluster's master endpoint. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint] + * instead. * - * Generated from protobuf field string private_endpoint = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string private_endpoint = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var * @return $this + * @deprecated */ public function setPrivateEndpoint($var) { + @trigger_error('private_endpoint is deprecated.', E_USER_DEPRECATED); GPBUtil::checkString($var, True); $this->private_endpoint = $var; @@ -221,24 +297,34 @@ public function setPrivateEndpoint($var) /** * Output only. The external IP address of this cluster's master endpoint. + * Deprecated:Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint] + * instead. * - * Generated from protobuf field string public_endpoint = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string public_endpoint = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; * @return string + * @deprecated */ public function getPublicEndpoint() { + @trigger_error('public_endpoint is deprecated.', E_USER_DEPRECATED); return $this->public_endpoint; } /** * Output only. The external IP address of this cluster's master endpoint. + * Deprecated:Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint] + * instead. * - * Generated from protobuf field string public_endpoint = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string public_endpoint = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var * @return $this + * @deprecated */ public function setPublicEndpoint($var) { + @trigger_error('public_endpoint is deprecated.', E_USER_DEPRECATED); GPBUtil::checkString($var, True); $this->public_endpoint = $var; @@ -273,34 +359,46 @@ public function setPeeringName($var) /** * Controls master global access settings. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access][] + * instead. * - * Generated from protobuf field .google.container.v1.PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8; + * Generated from protobuf field .google.container.v1.PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8 [deprecated = true]; * @return \Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig|null + * @deprecated */ public function getMasterGlobalAccessConfig() { + @trigger_error('master_global_access_config is deprecated.', E_USER_DEPRECATED); return $this->master_global_access_config; } public function hasMasterGlobalAccessConfig() { + @trigger_error('master_global_access_config is deprecated.', E_USER_DEPRECATED); return isset($this->master_global_access_config); } public function clearMasterGlobalAccessConfig() { + @trigger_error('master_global_access_config is deprecated.', E_USER_DEPRECATED); unset($this->master_global_access_config); } /** * Controls master global access settings. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access][] + * instead. * - * Generated from protobuf field .google.container.v1.PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8; + * Generated from protobuf field .google.container.v1.PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8 [deprecated = true]; * @param \Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig $var * @return $this + * @deprecated */ public function setMasterGlobalAccessConfig($var) { + @trigger_error('master_global_access_config is deprecated.', E_USER_DEPRECATED); GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig::class); $this->master_global_access_config = $var; @@ -310,25 +408,35 @@ public function setMasterGlobalAccessConfig($var) /** * Subnet to provision the master's private endpoint during cluster creation. * Specified in projects/*/regions/*/subnetworks/* format. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork] + * instead. * - * Generated from protobuf field string private_endpoint_subnetwork = 10; + * Generated from protobuf field string private_endpoint_subnetwork = 10 [deprecated = true]; * @return string + * @deprecated */ public function getPrivateEndpointSubnetwork() { + @trigger_error('private_endpoint_subnetwork is deprecated.', E_USER_DEPRECATED); return $this->private_endpoint_subnetwork; } /** * Subnet to provision the master's private endpoint during cluster creation. * Specified in projects/*/regions/*/subnetworks/* format. + * Deprecated: Use + * [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork] + * instead. * - * Generated from protobuf field string private_endpoint_subnetwork = 10; + * Generated from protobuf field string private_endpoint_subnetwork = 10 [deprecated = true]; * @param string $var * @return $this + * @deprecated */ public function setPrivateEndpointSubnetwork($var) { + @trigger_error('private_endpoint_subnetwork is deprecated.', E_USER_DEPRECATED); GPBUtil::checkString($var, True); $this->private_endpoint_subnetwork = $var; diff --git a/Container/src/V1/RBACBindingConfig.php b/Container/src/V1/RBACBindingConfig.php new file mode 100644 index 000000000000..27a645f8e165 --- /dev/null +++ b/Container/src/V1/RBACBindingConfig.php @@ -0,0 +1,130 @@ +google.container.v1.RBACBindingConfig + */ +class RBACBindingConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Setting this to true will allow any ClusterRoleBinding and RoleBinding + * with subjets system:anonymous or system:unauthenticated. + * + * Generated from protobuf field optional bool enable_insecure_binding_system_unauthenticated = 1; + */ + protected $enable_insecure_binding_system_unauthenticated = null; + /** + * Setting this to true will allow any ClusterRoleBinding and RoleBinding + * with subjects system:authenticated. + * + * Generated from protobuf field optional bool enable_insecure_binding_system_authenticated = 2; + */ + protected $enable_insecure_binding_system_authenticated = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enable_insecure_binding_system_unauthenticated + * Setting this to true will allow any ClusterRoleBinding and RoleBinding + * with subjets system:anonymous or system:unauthenticated. + * @type bool $enable_insecure_binding_system_authenticated + * Setting this to true will allow any ClusterRoleBinding and RoleBinding + * with subjects system:authenticated. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * Setting this to true will allow any ClusterRoleBinding and RoleBinding + * with subjets system:anonymous or system:unauthenticated. + * + * Generated from protobuf field optional bool enable_insecure_binding_system_unauthenticated = 1; + * @return bool + */ + public function getEnableInsecureBindingSystemUnauthenticated() + { + return isset($this->enable_insecure_binding_system_unauthenticated) ? $this->enable_insecure_binding_system_unauthenticated : false; + } + + public function hasEnableInsecureBindingSystemUnauthenticated() + { + return isset($this->enable_insecure_binding_system_unauthenticated); + } + + public function clearEnableInsecureBindingSystemUnauthenticated() + { + unset($this->enable_insecure_binding_system_unauthenticated); + } + + /** + * Setting this to true will allow any ClusterRoleBinding and RoleBinding + * with subjets system:anonymous or system:unauthenticated. + * + * Generated from protobuf field optional bool enable_insecure_binding_system_unauthenticated = 1; + * @param bool $var + * @return $this + */ + public function setEnableInsecureBindingSystemUnauthenticated($var) + { + GPBUtil::checkBool($var); + $this->enable_insecure_binding_system_unauthenticated = $var; + + return $this; + } + + /** + * Setting this to true will allow any ClusterRoleBinding and RoleBinding + * with subjects system:authenticated. + * + * Generated from protobuf field optional bool enable_insecure_binding_system_authenticated = 2; + * @return bool + */ + public function getEnableInsecureBindingSystemAuthenticated() + { + return isset($this->enable_insecure_binding_system_authenticated) ? $this->enable_insecure_binding_system_authenticated : false; + } + + public function hasEnableInsecureBindingSystemAuthenticated() + { + return isset($this->enable_insecure_binding_system_authenticated); + } + + public function clearEnableInsecureBindingSystemAuthenticated() + { + unset($this->enable_insecure_binding_system_authenticated); + } + + /** + * Setting this to true will allow any ClusterRoleBinding and RoleBinding + * with subjects system:authenticated. + * + * Generated from protobuf field optional bool enable_insecure_binding_system_authenticated = 2; + * @param bool $var + * @return $this + */ + public function setEnableInsecureBindingSystemAuthenticated($var) + { + GPBUtil::checkBool($var); + $this->enable_insecure_binding_system_authenticated = $var; + + return $this; + } + +} + diff --git a/Container/src/V1/SecretManagerConfig.php b/Container/src/V1/SecretManagerConfig.php new file mode 100644 index 000000000000..413ae666b79b --- /dev/null +++ b/Container/src/V1/SecretManagerConfig.php @@ -0,0 +1,77 @@ +google.container.v1.SecretManagerConfig + */ +class SecretManagerConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Enable/Disable Secret Manager Config. + * + * Generated from protobuf field optional bool enabled = 1; + */ + protected $enabled = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enabled + * Enable/Disable Secret Manager Config. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * Enable/Disable Secret Manager Config. + * + * Generated from protobuf field optional bool enabled = 1; + * @return bool + */ + public function getEnabled() + { + return isset($this->enabled) ? $this->enabled : false; + } + + public function hasEnabled() + { + return isset($this->enabled); + } + + public function clearEnabled() + { + unset($this->enabled); + } + + /** + * Enable/Disable Secret Manager Config. + * + * Generated from protobuf field optional bool enabled = 1; + * @param bool $var + * @return $this + */ + public function setEnabled($var) + { + GPBUtil::checkBool($var); + $this->enabled = $var; + + return $this; + } + +} + diff --git a/Container/src/V1/ServerConfig/ReleaseChannelConfig.php b/Container/src/V1/ServerConfig/ReleaseChannelConfig.php index 1f57633a601e..ba13f0b6f1d2 100644 --- a/Container/src/V1/ServerConfig/ReleaseChannelConfig.php +++ b/Container/src/V1/ServerConfig/ReleaseChannelConfig.php @@ -33,6 +33,12 @@ class ReleaseChannelConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated string valid_versions = 4; */ private $valid_versions; + /** + * The auto upgrade target version for clusters on the channel. + * + * Generated from protobuf field string upgrade_target_version = 5; + */ + protected $upgrade_target_version = ''; /** * Constructor. @@ -46,6 +52,8 @@ class ReleaseChannelConfig extends \Google\Protobuf\Internal\Message * The default version for newly created clusters on the channel. * @type array|\Google\Protobuf\Internal\RepeatedField $valid_versions * List of valid versions for the channel. + * @type string $upgrade_target_version + * The auto upgrade target version for clusters on the channel. * } */ public function __construct($data = NULL) { @@ -131,6 +139,32 @@ public function setValidVersions($var) return $this; } + /** + * The auto upgrade target version for clusters on the channel. + * + * Generated from protobuf field string upgrade_target_version = 5; + * @return string + */ + public function getUpgradeTargetVersion() + { + return $this->upgrade_target_version; + } + + /** + * The auto upgrade target version for clusters on the channel. + * + * Generated from protobuf field string upgrade_target_version = 5; + * @param string $var + * @return $this + */ + public function setUpgradeTargetVersion($var) + { + GPBUtil::checkString($var, True); + $this->upgrade_target_version = $var; + + return $this; + } + } diff --git a/Container/src/V1/UpdateNodePoolRequest.php b/Container/src/V1/UpdateNodePoolRequest.php index f87357ecffba..819f61b0d04a 100644 --- a/Container/src/V1/UpdateNodePoolRequest.php +++ b/Container/src/V1/UpdateNodePoolRequest.php @@ -253,6 +253,13 @@ class UpdateNodePoolRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.container.v1.NodePool.QueuedProvisioning queued_provisioning = 42; */ protected $queued_provisioning = null; + /** + * List of Storage Pools where boot disks are provisioned. + * Existing Storage Pools will be replaced with storage-pools. + * + * Generated from protobuf field repeated string storage_pools = 43; + */ + private $storage_pools; /** * Constructor. @@ -370,6 +377,9 @@ class UpdateNodePoolRequest extends \Google\Protobuf\Internal\Message * config. * @type \Google\Cloud\Container\V1\NodePool\QueuedProvisioning $queued_provisioning * Specifies the configuration of queued provisioning. + * @type array|\Google\Protobuf\Internal\RepeatedField $storage_pools + * List of Storage Pools where boot disks are provisioned. + * Existing Storage Pools will be replaced with storage-pools. * } */ public function __construct($data = NULL) { @@ -1475,5 +1485,33 @@ public function setQueuedProvisioning($var) return $this; } + /** + * List of Storage Pools where boot disks are provisioned. + * Existing Storage Pools will be replaced with storage-pools. + * + * Generated from protobuf field repeated string storage_pools = 43; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getStoragePools() + { + return $this->storage_pools; + } + + /** + * List of Storage Pools where boot disks are provisioned. + * Existing Storage Pools will be replaced with storage-pools. + * + * Generated from protobuf field repeated string storage_pools = 43; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setStoragePools($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->storage_pools = $arr; + + return $this; + } + } diff --git a/Container/src/V1/UserManagedKeysConfig.php b/Container/src/V1/UserManagedKeysConfig.php new file mode 100644 index 000000000000..60c2e5353c30 --- /dev/null +++ b/Container/src/V1/UserManagedKeysConfig.php @@ -0,0 +1,354 @@ +google.container.v1.UserManagedKeysConfig + */ +class UserManagedKeysConfig extends \Google\Protobuf\Internal\Message +{ + /** + * The Certificate Authority Service caPool to use for the cluster CA in this + * cluster. + * + * Generated from protobuf field string cluster_ca = 10 [(.google.api.resource_reference) = { + */ + protected $cluster_ca = ''; + /** + * Resource path of the Certificate Authority Service caPool to use for the + * etcd API CA in this cluster. + * + * Generated from protobuf field string etcd_api_ca = 11 [(.google.api.resource_reference) = { + */ + protected $etcd_api_ca = ''; + /** + * Resource path of the Certificate Authority Service caPool to use for the + * etcd peer CA in this cluster. + * + * Generated from protobuf field string etcd_peer_ca = 12 [(.google.api.resource_reference) = { + */ + protected $etcd_peer_ca = ''; + /** + * The Cloud KMS cryptoKeyVersions to use for signing service account JWTs + * issued by this cluster. + * Format: + * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + * + * Generated from protobuf field repeated string service_account_signing_keys = 13 [(.google.api.resource_reference) = { + */ + private $service_account_signing_keys; + /** + * The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs + * issued by this cluster. + * Format: + * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + * + * Generated from protobuf field repeated string service_account_verification_keys = 14 [(.google.api.resource_reference) = { + */ + private $service_account_verification_keys; + /** + * The Certificate Authority Service caPool to use for the aggregation CA in + * this cluster. + * + * Generated from protobuf field string aggregation_ca = 15 [(.google.api.resource_reference) = { + */ + protected $aggregation_ca = ''; + /** + * The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control + * plane nodes. + * + * Generated from protobuf field string control_plane_disk_encryption_key = 16 [(.google.api.resource_reference) = { + */ + protected $control_plane_disk_encryption_key = ''; + /** + * Resource path of the Cloud KMS cryptoKey to use for encryption of internal + * etcd backups. + * + * Generated from protobuf field string gkeops_etcd_backup_encryption_key = 17 [(.google.api.resource_reference) = { + */ + protected $gkeops_etcd_backup_encryption_key = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $cluster_ca + * The Certificate Authority Service caPool to use for the cluster CA in this + * cluster. + * @type string $etcd_api_ca + * Resource path of the Certificate Authority Service caPool to use for the + * etcd API CA in this cluster. + * @type string $etcd_peer_ca + * Resource path of the Certificate Authority Service caPool to use for the + * etcd peer CA in this cluster. + * @type array|\Google\Protobuf\Internal\RepeatedField $service_account_signing_keys + * The Cloud KMS cryptoKeyVersions to use for signing service account JWTs + * issued by this cluster. + * Format: + * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + * @type array|\Google\Protobuf\Internal\RepeatedField $service_account_verification_keys + * The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs + * issued by this cluster. + * Format: + * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + * @type string $aggregation_ca + * The Certificate Authority Service caPool to use for the aggregation CA in + * this cluster. + * @type string $control_plane_disk_encryption_key + * The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control + * plane nodes. + * @type string $gkeops_etcd_backup_encryption_key + * Resource path of the Cloud KMS cryptoKey to use for encryption of internal + * etcd backups. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Container\V1\ClusterService::initOnce(); + parent::__construct($data); + } + + /** + * The Certificate Authority Service caPool to use for the cluster CA in this + * cluster. + * + * Generated from protobuf field string cluster_ca = 10 [(.google.api.resource_reference) = { + * @return string + */ + public function getClusterCa() + { + return $this->cluster_ca; + } + + /** + * The Certificate Authority Service caPool to use for the cluster CA in this + * cluster. + * + * Generated from protobuf field string cluster_ca = 10 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setClusterCa($var) + { + GPBUtil::checkString($var, True); + $this->cluster_ca = $var; + + return $this; + } + + /** + * Resource path of the Certificate Authority Service caPool to use for the + * etcd API CA in this cluster. + * + * Generated from protobuf field string etcd_api_ca = 11 [(.google.api.resource_reference) = { + * @return string + */ + public function getEtcdApiCa() + { + return $this->etcd_api_ca; + } + + /** + * Resource path of the Certificate Authority Service caPool to use for the + * etcd API CA in this cluster. + * + * Generated from protobuf field string etcd_api_ca = 11 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setEtcdApiCa($var) + { + GPBUtil::checkString($var, True); + $this->etcd_api_ca = $var; + + return $this; + } + + /** + * Resource path of the Certificate Authority Service caPool to use for the + * etcd peer CA in this cluster. + * + * Generated from protobuf field string etcd_peer_ca = 12 [(.google.api.resource_reference) = { + * @return string + */ + public function getEtcdPeerCa() + { + return $this->etcd_peer_ca; + } + + /** + * Resource path of the Certificate Authority Service caPool to use for the + * etcd peer CA in this cluster. + * + * Generated from protobuf field string etcd_peer_ca = 12 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setEtcdPeerCa($var) + { + GPBUtil::checkString($var, True); + $this->etcd_peer_ca = $var; + + return $this; + } + + /** + * The Cloud KMS cryptoKeyVersions to use for signing service account JWTs + * issued by this cluster. + * Format: + * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + * + * Generated from protobuf field repeated string service_account_signing_keys = 13 [(.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getServiceAccountSigningKeys() + { + return $this->service_account_signing_keys; + } + + /** + * The Cloud KMS cryptoKeyVersions to use for signing service account JWTs + * issued by this cluster. + * Format: + * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + * + * Generated from protobuf field repeated string service_account_signing_keys = 13 [(.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setServiceAccountSigningKeys($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->service_account_signing_keys = $arr; + + return $this; + } + + /** + * The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs + * issued by this cluster. + * Format: + * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + * + * Generated from protobuf field repeated string service_account_verification_keys = 14 [(.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getServiceAccountVerificationKeys() + { + return $this->service_account_verification_keys; + } + + /** + * The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs + * issued by this cluster. + * Format: + * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + * + * Generated from protobuf field repeated string service_account_verification_keys = 14 [(.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setServiceAccountVerificationKeys($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->service_account_verification_keys = $arr; + + return $this; + } + + /** + * The Certificate Authority Service caPool to use for the aggregation CA in + * this cluster. + * + * Generated from protobuf field string aggregation_ca = 15 [(.google.api.resource_reference) = { + * @return string + */ + public function getAggregationCa() + { + return $this->aggregation_ca; + } + + /** + * The Certificate Authority Service caPool to use for the aggregation CA in + * this cluster. + * + * Generated from protobuf field string aggregation_ca = 15 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setAggregationCa($var) + { + GPBUtil::checkString($var, True); + $this->aggregation_ca = $var; + + return $this; + } + + /** + * The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control + * plane nodes. + * + * Generated from protobuf field string control_plane_disk_encryption_key = 16 [(.google.api.resource_reference) = { + * @return string + */ + public function getControlPlaneDiskEncryptionKey() + { + return $this->control_plane_disk_encryption_key; + } + + /** + * The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control + * plane nodes. + * + * Generated from protobuf field string control_plane_disk_encryption_key = 16 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setControlPlaneDiskEncryptionKey($var) + { + GPBUtil::checkString($var, True); + $this->control_plane_disk_encryption_key = $var; + + return $this; + } + + /** + * Resource path of the Cloud KMS cryptoKey to use for encryption of internal + * etcd backups. + * + * Generated from protobuf field string gkeops_etcd_backup_encryption_key = 17 [(.google.api.resource_reference) = { + * @return string + */ + public function getGkeopsEtcdBackupEncryptionKey() + { + return $this->gkeops_etcd_backup_encryption_key; + } + + /** + * Resource path of the Cloud KMS cryptoKey to use for encryption of internal + * etcd backups. + * + * Generated from protobuf field string gkeops_etcd_backup_encryption_key = 17 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setGkeopsEtcdBackupEncryptionKey($var) + { + GPBUtil::checkString($var, True); + $this->gkeops_etcd_backup_encryption_key = $var; + + return $this; + } + +} + diff --git a/Container/src/V1/resources/cluster_manager_descriptor_config.php b/Container/src/V1/resources/cluster_manager_descriptor_config.php index 1b330b402c69..3d5643144725 100644 --- a/Container/src/V1/resources/cluster_manager_descriptor_config.php +++ b/Container/src/V1/resources/cluster_manager_descriptor_config.php @@ -998,6 +998,8 @@ ], ], 'templateMap' => [ + 'caPool' => 'projects/{project}/locations/{location}/caPools/{ca_pool}', + 'cryptoKeyVersion' => 'projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}', 'topic' => 'projects/{project}/topics/{topic}', ], ], From dd48f72f8ca75bb3d038fc717338a5a39d24c977 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:20:33 -0700 Subject: [PATCH 018/157] feat: protos for R/W transaction support on multiplexed sessions (#7736) PiperOrigin-RevId: 683879049 Source-Link: https://github.com/googleapis/googleapis/commit/2b6b93bc89ecf122e1bd230e6d07312b0185cbe5 Source-Link: https://github.com/googleapis/googleapis-gen/commit/2f0c933b003164d5cd120505a98c87c95888d98f Copy-Tag: eyJwIjoiU3Bhbm5lci8uT3dsQm90LnlhbWwiLCJoIjoiMmYwYzkzM2IwMDMxNjRkNWNkMTIwNTA1YTk4Yzg3Yzk1ODg4ZDk4ZiJ9 --- Spanner/metadata/V1/CommitResponse.php | Bin 1043 -> 1251 bytes Spanner/metadata/V1/ResultSet.php | Bin 1875 -> 2130 bytes Spanner/metadata/V1/Spanner.php | Bin 11742 -> 11965 bytes Spanner/metadata/V1/Transaction.php | Bin 1977 -> 2283 bytes Spanner/src/V1/BeginTransactionRequest.php | 64 ++++++++++ Spanner/src/V1/CommitRequest.php | 64 ++++++++++ Spanner/src/V1/CommitResponse.php | 45 +++++++ Spanner/src/V1/ExecuteBatchDmlResponse.php | 68 +++++++++++ Spanner/src/V1/Gapic/SpannerGapicClient.php | 23 ++++ .../V1/MultiplexedSessionPrecommitToken.php | 112 ++++++++++++++++++ Spanner/src/V1/PartialResultSet.php | 68 +++++++++++ Spanner/src/V1/ResultSet.php | 68 +++++++++++ Spanner/src/V1/Transaction.php | 76 ++++++++++++ .../src/V1/TransactionOptions/ReadWrite.php | 50 ++++++++ 14 files changed, 638 insertions(+) create mode 100644 Spanner/src/V1/MultiplexedSessionPrecommitToken.php diff --git a/Spanner/metadata/V1/CommitResponse.php b/Spanner/metadata/V1/CommitResponse.php index 46823eb678dc24db91fcbc2c3b4b5eafd7d7e340..b5451ada8ff4d3bfe0d4b58d7492dfdfb04719dd 100644 GIT binary patch delta 198 zcmbQt@tAYNb4JFPiFL9(F(E~XdBuszC7JnolP@y5G96->EWu=}A*Gz2pP!zSs$X1? zn3tDYq+e#JUxHAoS5TB+lCLzEX>tTpcYu%|7k@!fYI1&VZe~e*Nq%-}o&<{mqXxH; zu^z-2J*Y8yWrljbr8y;;1v#k|sVTv!#l=9217LbXKw3Q*CO>A+? delta 35 rcmaFNIhkX_bH>T)O!`clm?uXt*)l6_Vw}8}seAGaW{u6anK>8%+BOT3 diff --git a/Spanner/metadata/V1/ResultSet.php b/Spanner/metadata/V1/ResultSet.php index 2f63b0c51704ac35eabe39b9dac1ce59ebb6d5c1..f702c5d7c9b996b7be3244ba42e87fc6bc90906b 100644 GIT binary patch delta 245 zcmcc2cS&HwRz^X`g3K7V%+#C|r__wZvdsLV$wwHqHg9F*W@PE*;!>LEtu*-=lZdQL zdVYR-PO5%EQGQ8&QfZogaY<2Wa)}<8Klvw92FoW#F3!n(EKZY`Ge=7c1#N7W9I^u<{Q|Q( L9c}@$`yRp%5P%aD diff --git a/Spanner/metadata/V1/Transaction.php b/Spanner/metadata/V1/Transaction.php index be467b14b3f65800f51d924335d6c3558e7c7cf9..d7fd2b4b2856ca6c6f997e98272764124bdcd02f 100644 GIT binary patch delta 327 zcmdnV|5|Xv4n{%8g3K7V%+#C|r__wZvdsLV$tM|&Cm&?&WSY%0*@wweUM@X9KRqW^ zzo00;BtNM%O+TfyD6u3nKTi)VGP#9GiSgX#.google.spanner.v1.RequestOptions request_options = 3; */ private $request_options = null; + /** + * Optional. Required for read-write transactions on a multiplexed session + * that commit mutations but do not perform any reads or queries. Clients + * should randomly select one of the mutations from the mutation set and send + * it as a part of this request. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $mutation_key = null; /** * @param string $session Required. The session in which the transaction runs. Please see @@ -71,6 +82,13 @@ public static function build(string $session, \Google\Cloud\Spanner\V1\Transacti * request_options struct will not do anything. To set the priority for a * transaction, set it on the reads and writes that are part of this * transaction instead. + * @type \Google\Cloud\Spanner\V1\Mutation $mutation_key + * Optional. Required for read-write transactions on a multiplexed session + * that commit mutations but do not perform any reads or queries. Clients + * should randomly select one of the mutations from the mutation set and send + * it as a part of this request. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * } */ public function __construct($data = NULL) { @@ -184,5 +202,51 @@ public function setRequestOptions($var) return $this; } + /** + * Optional. Required for read-write transactions on a multiplexed session + * that commit mutations but do not perform any reads or queries. Clients + * should randomly select one of the mutations from the mutation set and send + * it as a part of this request. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Spanner\V1\Mutation|null + */ + public function getMutationKey() + { + return $this->mutation_key; + } + + public function hasMutationKey() + { + return isset($this->mutation_key); + } + + public function clearMutationKey() + { + unset($this->mutation_key); + } + + /** + * Optional. Required for read-write transactions on a multiplexed session + * that commit mutations but do not perform any reads or queries. Clients + * should randomly select one of the mutations from the mutation set and send + * it as a part of this request. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Spanner\V1\Mutation $var + * @return $this + */ + public function setMutationKey($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\Mutation::class); + $this->mutation_key = $var; + + return $this; + } + } diff --git a/Spanner/src/V1/CommitRequest.php b/Spanner/src/V1/CommitRequest.php index b1e61d74be46..7c3e8d1a8e5e 100644 --- a/Spanner/src/V1/CommitRequest.php +++ b/Spanner/src/V1/CommitRequest.php @@ -53,6 +53,17 @@ class CommitRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 6; */ private $request_options = null; + /** + * Optional. If the read-write transaction was executed on a multiplexed + * session, the precommit token with the highest sequence number received in + * this transaction attempt, should be included here. Failing to do so will + * result in a FailedPrecondition error. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $precommit_token = null; protected $transaction; /** @@ -139,6 +150,13 @@ public static function buildFromSessionSingleUseTransactionMutations(string $ses * and 500 ms. * @type \Google\Cloud\Spanner\V1\RequestOptions $request_options * Common options for this request. + * @type \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $precommit_token + * Optional. If the read-write transaction was executed on a multiplexed + * session, the precommit token with the highest sequence number received in + * this transaction attempt, should be included here. Failing to do so will + * result in a FailedPrecondition error. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * } */ public function __construct($data = NULL) { @@ -390,6 +408,52 @@ public function setRequestOptions($var) return $this; } + /** + * Optional. If the read-write transaction was executed on a multiplexed + * session, the precommit token with the highest sequence number received in + * this transaction attempt, should be included here. Failing to do so will + * result in a FailedPrecondition error. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null + */ + public function getPrecommitToken() + { + return $this->precommit_token; + } + + public function hasPrecommitToken() + { + return isset($this->precommit_token); + } + + public function clearPrecommitToken() + { + unset($this->precommit_token); + } + + /** + * Optional. If the read-write transaction was executed on a multiplexed + * session, the precommit token with the highest sequence number received in + * this transaction attempt, should be included here. Failing to do so will + * result in a FailedPrecondition error. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $var + * @return $this + */ + public function setPrecommitToken($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken::class); + $this->precommit_token = $var; + + return $this; + } + /** * @return string */ diff --git a/Spanner/src/V1/CommitResponse.php b/Spanner/src/V1/CommitResponse.php index fd2bb2d3d365..a6d684a73fbe 100644 --- a/Spanner/src/V1/CommitResponse.php +++ b/Spanner/src/V1/CommitResponse.php @@ -29,6 +29,7 @@ class CommitResponse extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2; */ private $commit_stats = null; + protected $MultiplexedSessionRetry; /** * Constructor. @@ -42,6 +43,9 @@ class CommitResponse extends \Google\Protobuf\Internal\Message * The statistics about this Commit. Not returned by default. * For more information, see * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats]. + * @type \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $precommit_token + * If specified, transaction has not committed yet. + * Clients must retry the commit with the new precommit token. * } */ public function __construct($data = NULL) { @@ -125,5 +129,46 @@ public function setCommitStats($var) return $this; } + /** + * If specified, transaction has not committed yet. + * Clients must retry the commit with the new precommit token. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 4; + * @return \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null + */ + public function getPrecommitToken() + { + return $this->readOneof(4); + } + + public function hasPrecommitToken() + { + return $this->hasOneof(4); + } + + /** + * If specified, transaction has not committed yet. + * Clients must retry the commit with the new precommit token. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 4; + * @param \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $var + * @return $this + */ + public function setPrecommitToken($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * @return string + */ + public function getMultiplexedSessionRetry() + { + return $this->whichOneof("MultiplexedSessionRetry"); + } + } diff --git a/Spanner/src/V1/ExecuteBatchDmlResponse.php b/Spanner/src/V1/ExecuteBatchDmlResponse.php index d6ca0ae8042f..e1564ca76883 100644 --- a/Spanner/src/V1/ExecuteBatchDmlResponse.php +++ b/Spanner/src/V1/ExecuteBatchDmlResponse.php @@ -59,6 +59,18 @@ class ExecuteBatchDmlResponse extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.rpc.Status status = 2; */ private $status = null; + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $precommit_token = null; /** * Constructor. @@ -78,6 +90,14 @@ class ExecuteBatchDmlResponse extends \Google\Protobuf\Internal\Message * @type \Google\Rpc\Status $status * If all DML statements are executed successfully, the status is `OK`. * Otherwise, the error status of the first failed statement. + * @type \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $precommit_token + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * } */ public function __construct($data = NULL) { @@ -163,5 +183,53 @@ public function setStatus($var) return $this; } + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null + */ + public function getPrecommitToken() + { + return $this->precommit_token; + } + + public function hasPrecommitToken() + { + return isset($this->precommit_token); + } + + public function clearPrecommitToken() + { + unset($this->precommit_token); + } + + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $var + * @return $this + */ + public function setPrecommitToken($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken::class); + $this->precommit_token = $var; + + return $this; + } + } diff --git a/Spanner/src/V1/Gapic/SpannerGapicClient.php b/Spanner/src/V1/Gapic/SpannerGapicClient.php index 7b28cd26a3f0..fc2159eb9d3e 100644 --- a/Spanner/src/V1/Gapic/SpannerGapicClient.php +++ b/Spanner/src/V1/Gapic/SpannerGapicClient.php @@ -55,6 +55,7 @@ use Google\Cloud\Spanner\V1\KeySet; use Google\Cloud\Spanner\V1\ListSessionsRequest; use Google\Cloud\Spanner\V1\ListSessionsResponse; +use Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken; use Google\Cloud\Spanner\V1\Mutation; use Google\Cloud\Spanner\V1\PartialResultSet; use Google\Cloud\Spanner\V1\PartitionOptions; @@ -534,6 +535,13 @@ public function batchWrite( * request_options struct will not do anything. To set the priority for a * transaction, set it on the reads and writes that are part of this * transaction instead. + * @type Mutation $mutationKey + * Optional. Required for read-write transactions on a multiplexed session + * that commit mutations but do not perform any reads or queries. Clients + * should randomly select one of the mutations from the mutation set and send + * it as a part of this request. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -558,6 +566,10 @@ public function beginTransaction( $request->setRequestOptions($optionalArgs['requestOptions']); } + if (isset($optionalArgs['mutationKey'])) { + $request->setMutationKey($optionalArgs['mutationKey']); + } + $requestParams = new RequestParamsHeaderDescriptor( $requestParamHeaders ); @@ -631,6 +643,13 @@ public function beginTransaction( * and 500 ms. * @type RequestOptions $requestOptions * Common options for this request. + * @type MultiplexedSessionPrecommitToken $precommitToken + * Optional. If the read-write transaction was executed on a multiplexed + * session, the precommit token with the highest sequence number received in + * this transaction attempt, should be included here. Failing to do so will + * result in a FailedPrecondition error. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -670,6 +689,10 @@ public function commit($session, $mutations, array $optionalArgs = []) $request->setRequestOptions($optionalArgs['requestOptions']); } + if (isset($optionalArgs['precommitToken'])) { + $request->setPrecommitToken($optionalArgs['precommitToken']); + } + $requestParams = new RequestParamsHeaderDescriptor( $requestParamHeaders ); diff --git a/Spanner/src/V1/MultiplexedSessionPrecommitToken.php b/Spanner/src/V1/MultiplexedSessionPrecommitToken.php new file mode 100644 index 000000000000..120fb93f232b --- /dev/null +++ b/Spanner/src/V1/MultiplexedSessionPrecommitToken.php @@ -0,0 +1,112 @@ +google.spanner.v1.MultiplexedSessionPrecommitToken + */ +class MultiplexedSessionPrecommitToken extends \Google\Protobuf\Internal\Message +{ + /** + * Opaque precommit token. + * + * Generated from protobuf field bytes precommit_token = 1; + */ + private $precommit_token = ''; + /** + * An incrementing seq number is generated on every precommit token + * that is returned. Clients should remember the precommit token with the + * highest sequence number from the current transaction attempt. + * + * Generated from protobuf field int32 seq_num = 2; + */ + private $seq_num = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $precommit_token + * Opaque precommit token. + * @type int $seq_num + * An incrementing seq number is generated on every precommit token + * that is returned. Clients should remember the precommit token with the + * highest sequence number from the current transaction attempt. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Spanner\V1\Transaction::initOnce(); + parent::__construct($data); + } + + /** + * Opaque precommit token. + * + * Generated from protobuf field bytes precommit_token = 1; + * @return string + */ + public function getPrecommitToken() + { + return $this->precommit_token; + } + + /** + * Opaque precommit token. + * + * Generated from protobuf field bytes precommit_token = 1; + * @param string $var + * @return $this + */ + public function setPrecommitToken($var) + { + GPBUtil::checkString($var, False); + $this->precommit_token = $var; + + return $this; + } + + /** + * An incrementing seq number is generated on every precommit token + * that is returned. Clients should remember the precommit token with the + * highest sequence number from the current transaction attempt. + * + * Generated from protobuf field int32 seq_num = 2; + * @return int + */ + public function getSeqNum() + { + return $this->seq_num; + } + + /** + * An incrementing seq number is generated on every precommit token + * that is returned. Clients should remember the precommit token with the + * highest sequence number from the current transaction attempt. + * + * Generated from protobuf field int32 seq_num = 2; + * @param int $var + * @return $this + */ + public function setSeqNum($var) + { + GPBUtil::checkInt32($var); + $this->seq_num = $var; + + return $this; + } + +} + diff --git a/Spanner/src/V1/PartialResultSet.php b/Spanner/src/V1/PartialResultSet.php index e85ac14eb057..f82b53a2f1a8 100644 --- a/Spanner/src/V1/PartialResultSet.php +++ b/Spanner/src/V1/PartialResultSet.php @@ -117,6 +117,18 @@ class PartialResultSet extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.spanner.v1.ResultSetStats stats = 5; */ private $stats = null; + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $precommit_token = null; /** * Constructor. @@ -204,6 +216,14 @@ class PartialResultSet extends \Google\Protobuf\Internal\Message * only once with the last response in the stream. * This field will also be present in the last response for DML * statements. + * @type \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $precommit_token + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * } */ public function __construct($data = NULL) { @@ -501,5 +521,53 @@ public function setStats($var) return $this; } + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null + */ + public function getPrecommitToken() + { + return $this->precommit_token; + } + + public function hasPrecommitToken() + { + return isset($this->precommit_token); + } + + public function clearPrecommitToken() + { + unset($this->precommit_token); + } + + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $var + * @return $this + */ + public function setPrecommitToken($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken::class); + $this->precommit_token = $var; + + return $this; + } + } diff --git a/Spanner/src/V1/ResultSet.php b/Spanner/src/V1/ResultSet.php index dd8bce450a52..995b37ac22ea 100644 --- a/Spanner/src/V1/ResultSet.php +++ b/Spanner/src/V1/ResultSet.php @@ -46,6 +46,18 @@ class ResultSet extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.spanner.v1.ResultSetStats stats = 3; */ private $stats = null; + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $precommit_token = null; /** * Constructor. @@ -71,6 +83,14 @@ class ResultSet extends \Google\Protobuf\Internal\Message * [ExecuteSqlRequest.QueryMode.PLAN][google.spanner.v1.ExecuteSqlRequest.QueryMode.PLAN] [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode]. * Other fields may or may not be populated, based on the * [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode]. + * @type \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $precommit_token + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * } */ public function __construct($data = NULL) { @@ -200,5 +220,53 @@ public function setStats($var) return $this; } + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null + */ + public function getPrecommitToken() + { + return $this->precommit_token; + } + + public function hasPrecommitToken() + { + return isset($this->precommit_token); + } + + public function clearPrecommitToken() + { + unset($this->precommit_token); + } + + /** + * Optional. A precommit token will be included if the read-write transaction + * is on a multiplexed session. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the + * [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $var + * @return $this + */ + public function setPrecommitToken($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken::class); + $this->precommit_token = $var; + + return $this; + } + } diff --git a/Spanner/src/V1/Transaction.php b/Spanner/src/V1/Transaction.php index 7907d4aa6d78..52a69eaaf99e 100644 --- a/Spanner/src/V1/Transaction.php +++ b/Spanner/src/V1/Transaction.php @@ -37,6 +37,20 @@ class Transaction extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Timestamp read_timestamp = 2; */ private $read_timestamp = null; + /** + * A precommit token will be included in the response of a BeginTransaction + * request if the read-write transaction is on a multiplexed session and + * a mutation_key was specified in the + * [BeginTransaction][google.spanner.v1.BeginTransactionRequest]. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit] + * request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3; + */ + private $precommit_token = null; /** * Constructor. @@ -58,6 +72,16 @@ class Transaction extends \Google\Protobuf\Internal\Message * [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp]. * A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. * Example: `"2014-10-02T15:01:23.045123456Z"`. + * @type \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $precommit_token + * A precommit token will be included in the response of a BeginTransaction + * request if the read-write transaction is on a multiplexed session and + * a mutation_key was specified in the + * [BeginTransaction][google.spanner.v1.BeginTransactionRequest]. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit] + * request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * } */ public function __construct($data = NULL) { @@ -147,5 +171,57 @@ public function setReadTimestamp($var) return $this; } + /** + * A precommit token will be included in the response of a BeginTransaction + * request if the read-write transaction is on a multiplexed session and + * a mutation_key was specified in the + * [BeginTransaction][google.spanner.v1.BeginTransactionRequest]. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit] + * request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3; + * @return \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null + */ + public function getPrecommitToken() + { + return $this->precommit_token; + } + + public function hasPrecommitToken() + { + return isset($this->precommit_token); + } + + public function clearPrecommitToken() + { + unset($this->precommit_token); + } + + /** + * A precommit token will be included in the response of a BeginTransaction + * request if the read-write transaction is on a multiplexed session and + * a mutation_key was specified in the + * [BeginTransaction][google.spanner.v1.BeginTransactionRequest]. + * The precommit token with the highest sequence number from this transaction + * attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit] + * request for this transaction. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3; + * @param \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $var + * @return $this + */ + public function setPrecommitToken($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken::class); + $this->precommit_token = $var; + + return $this; + } + } diff --git a/Spanner/src/V1/TransactionOptions/ReadWrite.php b/Spanner/src/V1/TransactionOptions/ReadWrite.php index debc2477f577..cec00ef88464 100644 --- a/Spanner/src/V1/TransactionOptions/ReadWrite.php +++ b/Spanner/src/V1/TransactionOptions/ReadWrite.php @@ -22,6 +22,16 @@ class ReadWrite extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode read_lock_mode = 1; */ private $read_lock_mode = 0; + /** + * Optional. Clients should pass the transaction ID of the previous + * transaction attempt that was aborted if this transaction is being + * executed on a multiplexed session. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field bytes multiplexed_session_previous_transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $multiplexed_session_previous_transaction_id = ''; /** * Constructor. @@ -31,6 +41,12 @@ class ReadWrite extends \Google\Protobuf\Internal\Message * * @type int $read_lock_mode * Read lock mode for the transaction. + * @type string $multiplexed_session_previous_transaction_id + * Optional. Clients should pass the transaction ID of the previous + * transaction attempt that was aborted if this transaction is being + * executed on a multiplexed session. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. * } */ public function __construct($data = NULL) { @@ -64,6 +80,40 @@ public function setReadLockMode($var) return $this; } + /** + * Optional. Clients should pass the transaction ID of the previous + * transaction attempt that was aborted if this transaction is being + * executed on a multiplexed session. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field bytes multiplexed_session_previous_transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getMultiplexedSessionPreviousTransactionId() + { + return $this->multiplexed_session_previous_transaction_id; + } + + /** + * Optional. Clients should pass the transaction ID of the previous + * transaction attempt that was aborted if this transaction is being + * executed on a multiplexed session. + * This feature is not yet supported and will result in an UNIMPLEMENTED + * error. + * + * Generated from protobuf field bytes multiplexed_session_previous_transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setMultiplexedSessionPreviousTransactionId($var) + { + GPBUtil::checkString($var, False); + $this->multiplexed_session_previous_transaction_id = $var; + + return $this; + } + } // Adding a class alias for backwards compatibility with the previous class name. From 7c553c279fdd3eee3eb07c062007f9b4f1aa6e20 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:21:07 -0700 Subject: [PATCH 019/157] feat: add conversational search (#7734) feat: add tile navigation docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 683821686 Source-Link: https://github.com/googleapis/googleapis/commit/d01eb4689472766df6822cdfcdb4412bfb4c2789 Source-Link: https://github.com/googleapis/googleapis-gen/commit/1db3459f3dfa9347a5811d72b12e1714da75ed93 Copy-Tag: eyJwIjoiUmV0YWlsLy5Pd2xCb3QueWFtbCIsImgiOiIxZGIzNDU5ZjNkZmE5MzQ3YTU4MTFkNzJiMTJlMTcxNGRhNzVlZDkzIn0= --- Retail/metadata/V2/CompletionService.php | 14 +- Retail/metadata/V2/GenerativeQuestion.php | 40 ++ .../metadata/V2/GenerativeQuestionService.php | 59 +++ Retail/metadata/V2/SearchService.php | Bin 6303 -> 8443 bytes ...tch_update_generative_question_configs.php | 86 ++++ ...et_generative_questions_feature_config.php | 77 +++ .../list_generative_question_configs.php | 76 +++ .../update_generative_question_config.php | 81 +++ ...te_generative_questions_feature_config.php | 75 +++ ...UpdateGenerativeQuestionConfigsRequest.php | 121 +++++ ...pdateGenerativeQuestionConfigsResponse.php | 67 +++ .../GenerativeQuestionServiceClient.php | 373 ++++++++++++++ Retail/src/V2/CompleteQueryRequest.php | 16 +- Retail/src/V2/CompleteQueryResponse.php | 50 ++ .../CompleteQueryResponse/AttributeResult.php | 62 +++ Retail/src/V2/GenerativeQuestionConfig.php | 283 +++++++++++ .../V2/GenerativeQuestionsFeatureConfig.php | 151 ++++++ ...enerativeQuestionsFeatureConfigRequest.php | 86 ++++ .../ListGenerativeQuestionConfigsRequest.php | 86 ++++ .../ListGenerativeQuestionConfigsResponse.php | 67 +++ Retail/src/V2/Product.php | 36 +- Retail/src/V2/ProductAttributeInterval.php | 111 ++++ Retail/src/V2/ProductAttributeValue.php | 103 ++++ Retail/src/V2/Rule/ForceReturnFacetAction.php | 8 +- Retail/src/V2/SearchRequest.php | 92 ++++ .../ConversationalSearchSpec.php | 179 +++++++ .../ConversationalSearchSpec/UserAnswer.php | 120 +++++ .../UserAnswer/SelectedAnswer.php | 122 +++++ .../V2/SearchRequest/TileNavigationSpec.php | 118 +++++ Retail/src/V2/SearchResponse.php | 96 ++++ .../ConversationalSearchResult.php | 322 ++++++++++++ .../AdditionalFilter.php | 82 +++ .../SuggestedAnswer.php | 82 +++ .../SearchResponse/TileNavigationResult.php | 73 +++ Retail/src/V2/Tile.php | 144 ++++++ .../UpdateGenerativeQuestionConfigRequest.php | 158 ++++++ ...enerativeQuestionsFeatureConfigRequest.php | 146 ++++++ Retail/src/V2/gapic_metadata.json | 34 ++ ...rative_question_service_client_config.json | 47 ++ ...ive_question_service_descriptor_config.php | 93 ++++ ...ve_question_service_rest_client_config.php | 137 +++++ .../GenerativeQuestionServiceClientTest.php | 474 ++++++++++++++++++ 42 files changed, 4623 insertions(+), 24 deletions(-) create mode 100644 Retail/metadata/V2/GenerativeQuestion.php create mode 100644 Retail/metadata/V2/GenerativeQuestionService.php create mode 100644 Retail/samples/V2/GenerativeQuestionServiceClient/batch_update_generative_question_configs.php create mode 100644 Retail/samples/V2/GenerativeQuestionServiceClient/get_generative_questions_feature_config.php create mode 100644 Retail/samples/V2/GenerativeQuestionServiceClient/list_generative_question_configs.php create mode 100644 Retail/samples/V2/GenerativeQuestionServiceClient/update_generative_question_config.php create mode 100644 Retail/samples/V2/GenerativeQuestionServiceClient/update_generative_questions_feature_config.php create mode 100644 Retail/src/V2/BatchUpdateGenerativeQuestionConfigsRequest.php create mode 100644 Retail/src/V2/BatchUpdateGenerativeQuestionConfigsResponse.php create mode 100644 Retail/src/V2/Client/GenerativeQuestionServiceClient.php create mode 100644 Retail/src/V2/CompleteQueryResponse/AttributeResult.php create mode 100644 Retail/src/V2/GenerativeQuestionConfig.php create mode 100644 Retail/src/V2/GenerativeQuestionsFeatureConfig.php create mode 100644 Retail/src/V2/GetGenerativeQuestionsFeatureConfigRequest.php create mode 100644 Retail/src/V2/ListGenerativeQuestionConfigsRequest.php create mode 100644 Retail/src/V2/ListGenerativeQuestionConfigsResponse.php create mode 100644 Retail/src/V2/ProductAttributeInterval.php create mode 100644 Retail/src/V2/ProductAttributeValue.php create mode 100644 Retail/src/V2/SearchRequest/ConversationalSearchSpec.php create mode 100644 Retail/src/V2/SearchRequest/ConversationalSearchSpec/UserAnswer.php create mode 100644 Retail/src/V2/SearchRequest/ConversationalSearchSpec/UserAnswer/SelectedAnswer.php create mode 100644 Retail/src/V2/SearchRequest/TileNavigationSpec.php create mode 100644 Retail/src/V2/SearchResponse/ConversationalSearchResult.php create mode 100644 Retail/src/V2/SearchResponse/ConversationalSearchResult/AdditionalFilter.php create mode 100644 Retail/src/V2/SearchResponse/ConversationalSearchResult/SuggestedAnswer.php create mode 100644 Retail/src/V2/SearchResponse/TileNavigationResult.php create mode 100644 Retail/src/V2/Tile.php create mode 100644 Retail/src/V2/UpdateGenerativeQuestionConfigRequest.php create mode 100644 Retail/src/V2/UpdateGenerativeQuestionsFeatureConfigRequest.php create mode 100644 Retail/src/V2/resources/generative_question_service_client_config.json create mode 100644 Retail/src/V2/resources/generative_question_service_descriptor_config.php create mode 100644 Retail/src/V2/resources/generative_question_service_rest_client_config.php create mode 100644 Retail/tests/Unit/V2/Client/GenerativeQuestionServiceClientTest.php diff --git a/Retail/metadata/V2/CompletionService.php b/Retail/metadata/V2/CompletionService.php index 4cce3456ec40..182f6b8d5551 100644 --- a/Retail/metadata/V2/CompletionService.php +++ b/Retail/metadata/V2/CompletionService.php @@ -23,7 +23,7 @@ public static function initOnce() { \GPBMetadata\Google\Longrunning\Operations::initOnce(); $pool->internalAddGeneratedFile( ' -« +« /google/cloud/retail/v2/completion_service.protogoogle.cloud.retail.v2google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto#google/cloud/retail/v2/common.proto*google/cloud/retail/v2/import_config.proto#google/longrunning/operations.proto"ƒ CompleteQueryRequest6 catalog ( B%àAúA @@ -37,11 +37,12 @@ public static function initOnce() { max_suggestions ($ enable_attribute_suggestions ( entity - ( " + ( " CompleteQueryResponseZ completion_results ( 2>.google.cloud.retail.v2.CompleteQueryResponse.CompletionResult attribution_token ( c -recent_search_results ( 2@.google.cloud.retail.v2.CompleteQueryResponse.RecentSearchResultBæ +recent_search_results ( 2@.google.cloud.retail.v2.CompleteQueryResponse.RecentSearchResultB^ +attribute_results ( 2C.google.cloud.retail.v2.CompleteQueryResponse.AttributeResultsEntryæ CompletionResult suggestion ( b @@ -51,7 +52,12 @@ public static function initOnce() { key ( 6 value ( 2\'.google.cloud.retail.v2.CustomAttribute:8/ RecentSearchResult - recent_search ( :2² + recent_search ( :& +AttributeResult + suggestions ( v +AttributeResultsEntry +key ( L +value ( 2=.google.cloud.retail.v2.CompleteQueryResponse.AttributeResult:82² CompletionService³ CompleteQuery,.google.cloud.retail.v2.CompleteQueryRequest-.google.cloud.retail.v2.CompleteQueryResponse"E‚Óä“?=/v2/{catalog=projects/*/locations/*/catalogs/*}:completeQuery› ImportCompletionData3.google.cloud.retail.v2.ImportCompletionDataRequest.google.longrunning.Operation"®ÊA\\ diff --git a/Retail/metadata/V2/GenerativeQuestion.php b/Retail/metadata/V2/GenerativeQuestion.php new file mode 100644 index 000000000000..6eae16d42959 --- /dev/null +++ b/Retail/metadata/V2/GenerativeQuestion.php @@ -0,0 +1,40 @@ +internalAddGeneratedFile( + ' +î +0google/cloud/retail/v2/generative_question.protogoogle.cloud.retail.v2"u + GenerativeQuestionsFeatureConfig +catalog ( BàA +feature_enabled (BàA +minimum_products (BàA"Ý +GenerativeQuestionConfig +catalog ( BàA +facet ( BàA +generated_question ( BàA +final_question ( BàA +example_values ( BàA + frequency (BàA$ +allowed_in_conversation (BàAB +com.google.cloud.retail.v2BGenerativeQuestionProtoPZ2cloud.google.com/go/retail/apiv2/retailpb;retailpb¢RETAILªGoogle.Cloud.Retail.V2ÊGoogle\\Cloud\\Retail\\V2êGoogle::Cloud::Retail::V2bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/Retail/metadata/V2/GenerativeQuestionService.php b/Retail/metadata/V2/GenerativeQuestionService.php new file mode 100644 index 000000000000..a3d9d98c38ed --- /dev/null +++ b/Retail/metadata/V2/GenerativeQuestionService.php @@ -0,0 +1,59 @@ +internalAddGeneratedFile( + ' +ª +8google/cloud/retail/v2/generative_question_service.protogoogle.cloud.retail.v2google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto0google/cloud/retail/v2/generative_question.proto google/protobuf/field_mask.proto"Ñ +-UpdateGenerativeQuestionsFeatureConfigRequestj +#generative_questions_feature_config ( 28.google.cloud.retail.v2.GenerativeQuestionsFeatureConfigBàA4 + update_mask ( 2.google.protobuf.FieldMaskBàA"d +*GetGenerativeQuestionsFeatureConfigRequest6 +catalog ( B%àAúA +retail.googleapis.com/Catalog"] +$ListGenerativeQuestionConfigsRequest5 +parent ( B%àAúA +retail.googleapis.com/Catalog"~ +%ListGenerativeQuestionConfigsResponseU +generative_question_configs ( 20.google.cloud.retail.v2.GenerativeQuestionConfig"¸ +%UpdateGenerativeQuestionConfigRequestY +generative_question_config ( 20.google.cloud.retail.v2.GenerativeQuestionConfigBàA4 + update_mask ( 2.google.protobuf.FieldMaskBàA"º ++BatchUpdateGenerativeQuestionConfigsRequest5 +parent ( B%àAúA +retail.googleapis.com/CatalogT +requests ( 2=.google.cloud.retail.v2.UpdateGenerativeQuestionConfigRequestBàA"Š +,BatchUpdateGenerativeQuestionConfigsResponseZ +generative_question_configs ( 20.google.cloud.retail.v2.GenerativeQuestionConfigBàA2º +GenerativeQuestionServiceù +&UpdateGenerativeQuestionsFeatureConfigE.google.cloud.retail.v2.UpdateGenerativeQuestionsFeatureConfigRequest8.google.cloud.retail.v2.GenerativeQuestionsFeatureConfig"ÍÚA/generative_questions_feature_config,update_mask‚Óä“”2m/v2/{generative_questions_feature_config.catalog=projects/*/locations/*/catalogs/*}/generativeQuestionFeature:#generative_questions_feature_config€ +#GetGenerativeQuestionsFeatureConfigB.google.cloud.retail.v2.GetGenerativeQuestionsFeatureConfigRequest8.google.cloud.retail.v2.GenerativeQuestionsFeatureConfig"[ÚAcatalog‚Óä“KI/v2/{catalog=projects/*/locations/*/catalogs/*}/generativeQuestionFeatureñ +ListGenerativeQuestionConfigs<.google.cloud.retail.v2.ListGenerativeQuestionConfigsRequest=.google.cloud.retail.v2.ListGenerativeQuestionConfigsResponse"SÚAparent‚Óä“DB/v2/{parent=projects/*/locations/*/catalogs/*}/generativeQuestions¾ +UpdateGenerativeQuestionConfig=.google.cloud.retail.v2.UpdateGenerativeQuestionConfigRequest0.google.cloud.retail.v2.GenerativeQuestionConfig"ªÚA&generative_question_config,update_mask‚Óä“{2]/v2/{generative_question_config.catalog=projects/*/locations/*/catalogs/*}/generativeQuestion:generative_question_config +$BatchUpdateGenerativeQuestionConfigsC.google.cloud.retail.v2.BatchUpdateGenerativeQuestionConfigsRequestD.google.cloud.retail.v2.BatchUpdateGenerativeQuestionConfigsResponse"jÚAparent,requests‚Óä“R"M/v2/{parent=projects/*/locations/*/catalogs/*}/generativeQuestion:batchUpdate:*IÊAretail.googleapis.comÒA.https://www.googleapis.com/auth/cloud-platformBÉ +com.google.cloud.retail.v2BGenerativeQuestionServiceProtoPZ2cloud.google.com/go/retail/apiv2/retailpb;retailpb¢RETAILªGoogle.Cloud.Retail.V2ÊGoogle\\Cloud\\Retail\\V2êGoogle::Cloud::Retail::V2bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/Retail/metadata/V2/SearchService.php b/Retail/metadata/V2/SearchService.php index 68633c90cd26d70df2a8dc4965696dd1885676a9..4af2d655f344f299a75149ce9cf251fda8337465 100644 GIT binary patch delta 1712 zcma)6K~K|Q7-nmk@D4Wiu|a822M0xvMyCf2U@}MyL}QQ%F_GAm?qf8Tw)Xovc$D_Itf%L()h@{}2(T3X$xaiS1^ zEtsKnhq-WNJaFt$>w62^_%<-#|N6ZM(s>eS`zl=CwN2AL@ErAQx2lU@dYDjL<$e#K zamcoPXC?$T4x;Cf_6T-W%_0Zb<<6u_Yf8QcodY-wR&C=7ri5LGNq*R*tP-sbjNY{0Q?y zV9xXWEynZ1^S7Lo66n$S0S+7H1a^0V6o~ZD!LkXcbGJb<lO@aj$<0krJ$6s zT?I`~21mmW%s&}EN*~c?|%Hr>tR6;y#Wri;L#j(_q(#_`$UdsYI z*4Z6r8RaYs5lca7pDn~UzK%G;zWi4Nxra!XG=~3?0t~x&*Ra^&EWhqyGo&scty(pj zcerbq>?cH6Rs&NuqK5W*jHQ%Y@cSIimplQv*7fjnVRtTx{47k!5wBL`C)7+Tk@~sd z<4AC|mtZAAhdD+2kn0#hN^whD6YTUNj87nIkd2G$GdM$d auRGxihKg#Q{7n1>*7Bgoi~~Q delta 54 zcmV-60LlORL7y?OwgUv7DGDo*ODmJ*1Nj2J6SH6j?E|wD3oQkc$r7dlnhUdW6Dk6; MVHR)$vzQ!X1UX?7SpWb4 diff --git a/Retail/samples/V2/GenerativeQuestionServiceClient/batch_update_generative_question_configs.php b/Retail/samples/V2/GenerativeQuestionServiceClient/batch_update_generative_question_configs.php new file mode 100644 index 000000000000..80df18e6762d --- /dev/null +++ b/Retail/samples/V2/GenerativeQuestionServiceClient/batch_update_generative_question_configs.php @@ -0,0 +1,86 @@ +setCatalog($requestsGenerativeQuestionConfigCatalog) + ->setFacet($requestsGenerativeQuestionConfigFacet); + $updateGenerativeQuestionConfigRequest = (new UpdateGenerativeQuestionConfigRequest()) + ->setGenerativeQuestionConfig($requestsGenerativeQuestionConfig); + $requests = [$updateGenerativeQuestionConfigRequest,]; + $request = (new BatchUpdateGenerativeQuestionConfigsRequest()) + ->setRequests($requests); + + // Call the API and handle any network failures. + try { + /** @var BatchUpdateGenerativeQuestionConfigsResponse $response */ + $response = $generativeQuestionServiceClient->batchUpdateGenerativeQuestionConfigs($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $requestsGenerativeQuestionConfigCatalog = '[CATALOG]'; + $requestsGenerativeQuestionConfigFacet = '[FACET]'; + + batch_update_generative_question_configs_sample( + $requestsGenerativeQuestionConfigCatalog, + $requestsGenerativeQuestionConfigFacet + ); +} +// [END retail_v2_generated_GenerativeQuestionService_BatchUpdateGenerativeQuestionConfigs_sync] diff --git a/Retail/samples/V2/GenerativeQuestionServiceClient/get_generative_questions_feature_config.php b/Retail/samples/V2/GenerativeQuestionServiceClient/get_generative_questions_feature_config.php new file mode 100644 index 000000000000..a2c319426e89 --- /dev/null +++ b/Retail/samples/V2/GenerativeQuestionServiceClient/get_generative_questions_feature_config.php @@ -0,0 +1,77 @@ +setCatalog($formattedCatalog); + + // Call the API and handle any network failures. + try { + /** @var GenerativeQuestionsFeatureConfig $response */ + $response = $generativeQuestionServiceClient->getGenerativeQuestionsFeatureConfig($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedCatalog = GenerativeQuestionServiceClient::catalogName( + '[PROJECT]', + '[LOCATION]', + '[CATALOG]' + ); + + get_generative_questions_feature_config_sample($formattedCatalog); +} +// [END retail_v2_generated_GenerativeQuestionService_GetGenerativeQuestionsFeatureConfig_sync] diff --git a/Retail/samples/V2/GenerativeQuestionServiceClient/list_generative_question_configs.php b/Retail/samples/V2/GenerativeQuestionServiceClient/list_generative_question_configs.php new file mode 100644 index 000000000000..75edd24a1c46 --- /dev/null +++ b/Retail/samples/V2/GenerativeQuestionServiceClient/list_generative_question_configs.php @@ -0,0 +1,76 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var ListGenerativeQuestionConfigsResponse $response */ + $response = $generativeQuestionServiceClient->listGenerativeQuestionConfigs($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedParent = GenerativeQuestionServiceClient::catalogName( + '[PROJECT]', + '[LOCATION]', + '[CATALOG]' + ); + + list_generative_question_configs_sample($formattedParent); +} +// [END retail_v2_generated_GenerativeQuestionService_ListGenerativeQuestionConfigs_sync] diff --git a/Retail/samples/V2/GenerativeQuestionServiceClient/update_generative_question_config.php b/Retail/samples/V2/GenerativeQuestionServiceClient/update_generative_question_config.php new file mode 100644 index 000000000000..238fd35b1e25 --- /dev/null +++ b/Retail/samples/V2/GenerativeQuestionServiceClient/update_generative_question_config.php @@ -0,0 +1,81 @@ +setCatalog($generativeQuestionConfigCatalog) + ->setFacet($generativeQuestionConfigFacet); + $request = (new UpdateGenerativeQuestionConfigRequest()) + ->setGenerativeQuestionConfig($generativeQuestionConfig); + + // Call the API and handle any network failures. + try { + /** @var GenerativeQuestionConfig $response */ + $response = $generativeQuestionServiceClient->updateGenerativeQuestionConfig($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $generativeQuestionConfigCatalog = '[CATALOG]'; + $generativeQuestionConfigFacet = '[FACET]'; + + update_generative_question_config_sample( + $generativeQuestionConfigCatalog, + $generativeQuestionConfigFacet + ); +} +// [END retail_v2_generated_GenerativeQuestionService_UpdateGenerativeQuestionConfig_sync] diff --git a/Retail/samples/V2/GenerativeQuestionServiceClient/update_generative_questions_feature_config.php b/Retail/samples/V2/GenerativeQuestionServiceClient/update_generative_questions_feature_config.php new file mode 100644 index 000000000000..3bca45526e4d --- /dev/null +++ b/Retail/samples/V2/GenerativeQuestionServiceClient/update_generative_questions_feature_config.php @@ -0,0 +1,75 @@ +setCatalog($generativeQuestionsFeatureConfigCatalog); + $request = (new UpdateGenerativeQuestionsFeatureConfigRequest()) + ->setGenerativeQuestionsFeatureConfig($generativeQuestionsFeatureConfig); + + // Call the API and handle any network failures. + try { + /** @var GenerativeQuestionsFeatureConfig $response */ + $response = $generativeQuestionServiceClient->updateGenerativeQuestionsFeatureConfig($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $generativeQuestionsFeatureConfigCatalog = '[CATALOG]'; + + update_generative_questions_feature_config_sample($generativeQuestionsFeatureConfigCatalog); +} +// [END retail_v2_generated_GenerativeQuestionService_UpdateGenerativeQuestionsFeatureConfig_sync] diff --git a/Retail/src/V2/BatchUpdateGenerativeQuestionConfigsRequest.php b/Retail/src/V2/BatchUpdateGenerativeQuestionConfigsRequest.php new file mode 100644 index 000000000000..a45ef2bbec39 --- /dev/null +++ b/Retail/src/V2/BatchUpdateGenerativeQuestionConfigsRequest.php @@ -0,0 +1,121 @@ +google.cloud.retail.v2.BatchUpdateGenerativeQuestionConfigsRequest + */ +class BatchUpdateGenerativeQuestionConfigsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The updates question configs. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.UpdateGenerativeQuestionConfigRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $requests; + + /** + * @param string $parent Optional. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * @param \Google\Cloud\Retail\V2\UpdateGenerativeQuestionConfigRequest[] $requests Required. The updates question configs. + * + * @return \Google\Cloud\Retail\V2\BatchUpdateGenerativeQuestionConfigsRequest + * + * @experimental + */ + public static function build(string $parent, array $requests): self + { + return (new self()) + ->setParent($parent) + ->setRequests($requests); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Optional. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * @type array<\Google\Cloud\Retail\V2\UpdateGenerativeQuestionConfigRequest>|\Google\Protobuf\Internal\RepeatedField $requests + * Required. The updates question configs. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestionService::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Optional. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The updates question configs. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.UpdateGenerativeQuestionConfigRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRequests() + { + return $this->requests; + } + + /** + * Required. The updates question configs. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.UpdateGenerativeQuestionConfigRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Cloud\Retail\V2\UpdateGenerativeQuestionConfigRequest>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRequests($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\UpdateGenerativeQuestionConfigRequest::class); + $this->requests = $arr; + + return $this; + } + +} + diff --git a/Retail/src/V2/BatchUpdateGenerativeQuestionConfigsResponse.php b/Retail/src/V2/BatchUpdateGenerativeQuestionConfigsResponse.php new file mode 100644 index 000000000000..3fe2b844ef85 --- /dev/null +++ b/Retail/src/V2/BatchUpdateGenerativeQuestionConfigsResponse.php @@ -0,0 +1,67 @@ +google.cloud.retail.v2.BatchUpdateGenerativeQuestionConfigsResponse + */ +class BatchUpdateGenerativeQuestionConfigsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The updates question configs. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_configs = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $generative_question_configs; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Retail\V2\GenerativeQuestionConfig>|\Google\Protobuf\Internal\RepeatedField $generative_question_configs + * Optional. The updates question configs. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestionService::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The updates question configs. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_configs = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGenerativeQuestionConfigs() + { + return $this->generative_question_configs; + } + + /** + * Optional. The updates question configs. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_configs = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Retail\V2\GenerativeQuestionConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGenerativeQuestionConfigs($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\GenerativeQuestionConfig::class); + $this->generative_question_configs = $arr; + + return $this; + } + +} + diff --git a/Retail/src/V2/Client/GenerativeQuestionServiceClient.php b/Retail/src/V2/Client/GenerativeQuestionServiceClient.php new file mode 100644 index 000000000000..d7023d8f0d52 --- /dev/null +++ b/Retail/src/V2/Client/GenerativeQuestionServiceClient.php @@ -0,0 +1,373 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/generative_question_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/generative_question_service_descriptor_config.php', + 'gcpApiConfigPath' => __DIR__ . '/../resources/generative_question_service_grpc_config.json', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => + __DIR__ . '/../resources/generative_question_service_rest_client_config.php', + ], + ], + ]; + } + + /** + * Formats a string containing the fully-qualified path to represent a catalog + * resource. + * + * @param string $project + * @param string $location + * @param string $catalog + * + * @return string The formatted catalog resource. + */ + public static function catalogName(string $project, string $location, string $catalog): string + { + return self::getPathTemplate('catalog')->render([ + 'project' => $project, + 'location' => $location, + 'catalog' => $catalog, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - catalog: projects/{project}/locations/{location}/catalogs/{catalog} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'retail.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. May be either the string + * `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. + * *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'grpc' => [...], + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and + * {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * Allows management of multiple questions. + * + * The async variant is + * {@see GenerativeQuestionServiceClient::batchUpdateGenerativeQuestionConfigsAsync()} + * . + * + * @example samples/V2/GenerativeQuestionServiceClient/batch_update_generative_question_configs.php + * + * @param BatchUpdateGenerativeQuestionConfigsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return BatchUpdateGenerativeQuestionConfigsResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function batchUpdateGenerativeQuestionConfigs( + BatchUpdateGenerativeQuestionConfigsRequest $request, + array $callOptions = [] + ): BatchUpdateGenerativeQuestionConfigsResponse { + return $this->startApiCall('BatchUpdateGenerativeQuestionConfigs', $request, $callOptions)->wait(); + } + + /** + * Manages overal generative question feature state -- enables toggling + * feature on and off. + * + * The async variant is + * {@see GenerativeQuestionServiceClient::getGenerativeQuestionsFeatureConfigAsync()} + * . + * + * @example samples/V2/GenerativeQuestionServiceClient/get_generative_questions_feature_config.php + * + * @param GetGenerativeQuestionsFeatureConfigRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return GenerativeQuestionsFeatureConfig + * + * @throws ApiException Thrown if the API call fails. + */ + public function getGenerativeQuestionsFeatureConfig( + GetGenerativeQuestionsFeatureConfigRequest $request, + array $callOptions = [] + ): GenerativeQuestionsFeatureConfig { + return $this->startApiCall('GetGenerativeQuestionsFeatureConfig', $request, $callOptions)->wait(); + } + + /** + * Returns all questions for a given catalog. + * + * The async variant is + * {@see GenerativeQuestionServiceClient::listGenerativeQuestionConfigsAsync()} . + * + * @example samples/V2/GenerativeQuestionServiceClient/list_generative_question_configs.php + * + * @param ListGenerativeQuestionConfigsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return ListGenerativeQuestionConfigsResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listGenerativeQuestionConfigs( + ListGenerativeQuestionConfigsRequest $request, + array $callOptions = [] + ): ListGenerativeQuestionConfigsResponse { + return $this->startApiCall('ListGenerativeQuestionConfigs', $request, $callOptions)->wait(); + } + + /** + * Allows management of individual questions. + * + * The async variant is + * {@see GenerativeQuestionServiceClient::updateGenerativeQuestionConfigAsync()} . + * + * @example samples/V2/GenerativeQuestionServiceClient/update_generative_question_config.php + * + * @param UpdateGenerativeQuestionConfigRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return GenerativeQuestionConfig + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateGenerativeQuestionConfig( + UpdateGenerativeQuestionConfigRequest $request, + array $callOptions = [] + ): GenerativeQuestionConfig { + return $this->startApiCall('UpdateGenerativeQuestionConfig', $request, $callOptions)->wait(); + } + + /** + * Manages overal generative question feature state -- enables toggling + * feature on and off. + * + * The async variant is + * {@see GenerativeQuestionServiceClient::updateGenerativeQuestionsFeatureConfigAsync()} + * . + * + * @example samples/V2/GenerativeQuestionServiceClient/update_generative_questions_feature_config.php + * + * @param UpdateGenerativeQuestionsFeatureConfigRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return GenerativeQuestionsFeatureConfig + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateGenerativeQuestionsFeatureConfig( + UpdateGenerativeQuestionsFeatureConfigRequest $request, + array $callOptions = [] + ): GenerativeQuestionsFeatureConfig { + return $this->startApiCall('UpdateGenerativeQuestionsFeatureConfig', $request, $callOptions)->wait(); + } +} diff --git a/Retail/src/V2/CompleteQueryRequest.php b/Retail/src/V2/CompleteQueryRequest.php index 8e57791a191c..2118cf1f06f7 100644 --- a/Retail/src/V2/CompleteQueryRequest.php +++ b/Retail/src/V2/CompleteQueryRequest.php @@ -95,8 +95,8 @@ class CompleteQueryRequest extends \Google\Protobuf\Internal\Message */ protected $max_suggestions = 0; /** - * If true, attribute suggestions are enabled and provided in response. - * This field is only available for "cloud-retail" dataset. + * If true, attribute suggestions are enabled and provided in the response. + * This field is only available for the "cloud-retail" dataset. * * Generated from protobuf field bool enable_attribute_suggestions = 9; */ @@ -171,8 +171,8 @@ class CompleteQueryRequest extends \Google\Protobuf\Internal\Message * The maximum allowed max suggestions is 20. If it is set higher, it will be * capped by 20. * @type bool $enable_attribute_suggestions - * If true, attribute suggestions are enabled and provided in response. - * This field is only available for "cloud-retail" dataset. + * If true, attribute suggestions are enabled and provided in the response. + * This field is only available for the "cloud-retail" dataset. * @type string $entity * The entity for customers who run multiple entities, domains, sites, or * regions, for example, `Google US`, `Google Ads`, `Waymo`, @@ -444,8 +444,8 @@ public function setMaxSuggestions($var) } /** - * If true, attribute suggestions are enabled and provided in response. - * This field is only available for "cloud-retail" dataset. + * If true, attribute suggestions are enabled and provided in the response. + * This field is only available for the "cloud-retail" dataset. * * Generated from protobuf field bool enable_attribute_suggestions = 9; * @return bool @@ -456,8 +456,8 @@ public function getEnableAttributeSuggestions() } /** - * If true, attribute suggestions are enabled and provided in response. - * This field is only available for "cloud-retail" dataset. + * If true, attribute suggestions are enabled and provided in the response. + * This field is only available for the "cloud-retail" dataset. * * Generated from protobuf field bool enable_attribute_suggestions = 9; * @param bool $var diff --git a/Retail/src/V2/CompleteQueryResponse.php b/Retail/src/V2/CompleteQueryResponse.php index f4b5b4c2bdd5..2aa2c0bf0cd8 100644 --- a/Retail/src/V2/CompleteQueryResponse.php +++ b/Retail/src/V2/CompleteQueryResponse.php @@ -52,6 +52,16 @@ class CompleteQueryResponse extends \Google\Protobuf\Internal\Message * @deprecated */ private $recent_search_results; + /** + * A map of matched attribute suggestions. This field is only available for + * "cloud-retail" dataset. + * Current supported keys: + * * `brands` + * * `categories` + * + * Generated from protobuf field map attribute_results = 4; + */ + private $attribute_results; /** * Constructor. @@ -83,6 +93,12 @@ class CompleteQueryResponse extends \Google\Protobuf\Internal\Message * * They are UTF-8 safe. * Recent searches are deduplicated. More recent searches will be reserved * when duplication happens. + * @type array|\Google\Protobuf\Internal\MapField $attribute_results + * A map of matched attribute suggestions. This field is only available for + * "cloud-retail" dataset. + * Current supported keys: + * * `brands` + * * `categories` * } */ public function __construct($data = NULL) { @@ -208,5 +224,39 @@ public function setRecentSearchResults($var) return $this; } + /** + * A map of matched attribute suggestions. This field is only available for + * "cloud-retail" dataset. + * Current supported keys: + * * `brands` + * * `categories` + * + * Generated from protobuf field map attribute_results = 4; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAttributeResults() + { + return $this->attribute_results; + } + + /** + * A map of matched attribute suggestions. This field is only available for + * "cloud-retail" dataset. + * Current supported keys: + * * `brands` + * * `categories` + * + * Generated from protobuf field map attribute_results = 4; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAttributeResults($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\CompleteQueryResponse\AttributeResult::class); + $this->attribute_results = $arr; + + return $this; + } + } diff --git a/Retail/src/V2/CompleteQueryResponse/AttributeResult.php b/Retail/src/V2/CompleteQueryResponse/AttributeResult.php new file mode 100644 index 000000000000..fd1625f7a852 --- /dev/null +++ b/Retail/src/V2/CompleteQueryResponse/AttributeResult.php @@ -0,0 +1,62 @@ +google.cloud.retail.v2.CompleteQueryResponse.AttributeResult + */ +class AttributeResult extends \Google\Protobuf\Internal\Message +{ + /** + * Generated from protobuf field repeated string suggestions = 1; + */ + private $suggestions; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $suggestions + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\CompletionService::initOnce(); + parent::__construct($data); + } + + /** + * Generated from protobuf field repeated string suggestions = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSuggestions() + { + return $this->suggestions; + } + + /** + * Generated from protobuf field repeated string suggestions = 1; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSuggestions($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->suggestions = $arr; + + return $this; + } + +} + + diff --git a/Retail/src/V2/GenerativeQuestionConfig.php b/Retail/src/V2/GenerativeQuestionConfig.php new file mode 100644 index 000000000000..3735bded7aae --- /dev/null +++ b/Retail/src/V2/GenerativeQuestionConfig.php @@ -0,0 +1,283 @@ +google.cloud.retail.v2.GenerativeQuestionConfig + */ +class GenerativeQuestionConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Resource name of the catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $catalog = ''; + /** + * Required. The facet to which the question is associated. + * + * Generated from protobuf field string facet = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $facet = ''; + /** + * Output only. The LLM generated question. + * + * Generated from protobuf field string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $generated_question = ''; + /** + * Optional. The question that will be used at serving time. + * Question can have a max length of 300 bytes. + * When not populated, generated_question should be used. + * + * Generated from protobuf field string final_question = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $final_question = ''; + /** + * Output only. Values that can be used to answer the question. + * + * Generated from protobuf field repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $example_values; + /** + * Output only. The ratio of how often a question was asked. + * + * Generated from protobuf field float frequency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $frequency = 0.0; + /** + * Optional. Whether the question is asked at serving time. + * + * Generated from protobuf field bool allowed_in_conversation = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allowed_in_conversation = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $catalog + * Required. Resource name of the catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * @type string $facet + * Required. The facet to which the question is associated. + * @type string $generated_question + * Output only. The LLM generated question. + * @type string $final_question + * Optional. The question that will be used at serving time. + * Question can have a max length of 300 bytes. + * When not populated, generated_question should be used. + * @type array|\Google\Protobuf\Internal\RepeatedField $example_values + * Output only. Values that can be used to answer the question. + * @type float $frequency + * Output only. The ratio of how often a question was asked. + * @type bool $allowed_in_conversation + * Optional. Whether the question is asked at serving time. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestion::initOnce(); + parent::__construct($data); + } + + /** + * Required. Resource name of the catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getCatalog() + { + return $this->catalog; + } + + /** + * Required. Resource name of the catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setCatalog($var) + { + GPBUtil::checkString($var, True); + $this->catalog = $var; + + return $this; + } + + /** + * Required. The facet to which the question is associated. + * + * Generated from protobuf field string facet = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getFacet() + { + return $this->facet; + } + + /** + * Required. The facet to which the question is associated. + * + * Generated from protobuf field string facet = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setFacet($var) + { + GPBUtil::checkString($var, True); + $this->facet = $var; + + return $this; + } + + /** + * Output only. The LLM generated question. + * + * Generated from protobuf field string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getGeneratedQuestion() + { + return $this->generated_question; + } + + /** + * Output only. The LLM generated question. + * + * Generated from protobuf field string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setGeneratedQuestion($var) + { + GPBUtil::checkString($var, True); + $this->generated_question = $var; + + return $this; + } + + /** + * Optional. The question that will be used at serving time. + * Question can have a max length of 300 bytes. + * When not populated, generated_question should be used. + * + * Generated from protobuf field string final_question = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFinalQuestion() + { + return $this->final_question; + } + + /** + * Optional. The question that will be used at serving time. + * Question can have a max length of 300 bytes. + * When not populated, generated_question should be used. + * + * Generated from protobuf field string final_question = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFinalQuestion($var) + { + GPBUtil::checkString($var, True); + $this->final_question = $var; + + return $this; + } + + /** + * Output only. Values that can be used to answer the question. + * + * Generated from protobuf field repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getExampleValues() + { + return $this->example_values; + } + + /** + * Output only. Values that can be used to answer the question. + * + * Generated from protobuf field repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setExampleValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->example_values = $arr; + + return $this; + } + + /** + * Output only. The ratio of how often a question was asked. + * + * Generated from protobuf field float frequency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return float + */ + public function getFrequency() + { + return $this->frequency; + } + + /** + * Output only. The ratio of how often a question was asked. + * + * Generated from protobuf field float frequency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param float $var + * @return $this + */ + public function setFrequency($var) + { + GPBUtil::checkFloat($var); + $this->frequency = $var; + + return $this; + } + + /** + * Optional. Whether the question is asked at serving time. + * + * Generated from protobuf field bool allowed_in_conversation = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowedInConversation() + { + return $this->allowed_in_conversation; + } + + /** + * Optional. Whether the question is asked at serving time. + * + * Generated from protobuf field bool allowed_in_conversation = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowedInConversation($var) + { + GPBUtil::checkBool($var); + $this->allowed_in_conversation = $var; + + return $this; + } + +} + diff --git a/Retail/src/V2/GenerativeQuestionsFeatureConfig.php b/Retail/src/V2/GenerativeQuestionsFeatureConfig.php new file mode 100644 index 000000000000..a2efd07cd0b8 --- /dev/null +++ b/Retail/src/V2/GenerativeQuestionsFeatureConfig.php @@ -0,0 +1,151 @@ +google.cloud.retail.v2.GenerativeQuestionsFeatureConfig + */ +class GenerativeQuestionsFeatureConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Resource name of the affected catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $catalog = ''; + /** + * Optional. Determines whether questions will be used at serving time. + * Note: This feature cannot be enabled until initial data requirements are + * satisfied. + * + * Generated from protobuf field bool feature_enabled = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $feature_enabled = false; + /** + * Optional. Minimum number of products in the response to trigger follow-up + * questions. Value must be 0 or positive. + * + * Generated from protobuf field int32 minimum_products = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $minimum_products = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $catalog + * Required. Resource name of the affected catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * @type bool $feature_enabled + * Optional. Determines whether questions will be used at serving time. + * Note: This feature cannot be enabled until initial data requirements are + * satisfied. + * @type int $minimum_products + * Optional. Minimum number of products in the response to trigger follow-up + * questions. Value must be 0 or positive. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestion::initOnce(); + parent::__construct($data); + } + + /** + * Required. Resource name of the affected catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getCatalog() + { + return $this->catalog; + } + + /** + * Required. Resource name of the affected catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setCatalog($var) + { + GPBUtil::checkString($var, True); + $this->catalog = $var; + + return $this; + } + + /** + * Optional. Determines whether questions will be used at serving time. + * Note: This feature cannot be enabled until initial data requirements are + * satisfied. + * + * Generated from protobuf field bool feature_enabled = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getFeatureEnabled() + { + return $this->feature_enabled; + } + + /** + * Optional. Determines whether questions will be used at serving time. + * Note: This feature cannot be enabled until initial data requirements are + * satisfied. + * + * Generated from protobuf field bool feature_enabled = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setFeatureEnabled($var) + { + GPBUtil::checkBool($var); + $this->feature_enabled = $var; + + return $this; + } + + /** + * Optional. Minimum number of products in the response to trigger follow-up + * questions. Value must be 0 or positive. + * + * Generated from protobuf field int32 minimum_products = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getMinimumProducts() + { + return $this->minimum_products; + } + + /** + * Optional. Minimum number of products in the response to trigger follow-up + * questions. Value must be 0 or positive. + * + * Generated from protobuf field int32 minimum_products = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setMinimumProducts($var) + { + GPBUtil::checkInt32($var); + $this->minimum_products = $var; + + return $this; + } + +} + diff --git a/Retail/src/V2/GetGenerativeQuestionsFeatureConfigRequest.php b/Retail/src/V2/GetGenerativeQuestionsFeatureConfigRequest.php new file mode 100644 index 000000000000..3187270c7c16 --- /dev/null +++ b/Retail/src/V2/GetGenerativeQuestionsFeatureConfigRequest.php @@ -0,0 +1,86 @@ +google.cloud.retail.v2.GetGenerativeQuestionsFeatureConfigRequest + */ +class GetGenerativeQuestionsFeatureConfigRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $catalog = ''; + + /** + * @param string $catalog Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * Please see {@see GenerativeQuestionServiceClient::catalogName()} for help formatting this field. + * + * @return \Google\Cloud\Retail\V2\GetGenerativeQuestionsFeatureConfigRequest + * + * @experimental + */ + public static function build(string $catalog): self + { + return (new self()) + ->setCatalog($catalog); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $catalog + * Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestionService::initOnce(); + parent::__construct($data); + } + + /** + * Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getCatalog() + { + return $this->catalog; + } + + /** + * Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setCatalog($var) + { + GPBUtil::checkString($var, True); + $this->catalog = $var; + + return $this; + } + +} + diff --git a/Retail/src/V2/ListGenerativeQuestionConfigsRequest.php b/Retail/src/V2/ListGenerativeQuestionConfigsRequest.php new file mode 100644 index 000000000000..b68f5f75f2d9 --- /dev/null +++ b/Retail/src/V2/ListGenerativeQuestionConfigsRequest.php @@ -0,0 +1,86 @@ +google.cloud.retail.v2.ListGenerativeQuestionConfigsRequest + */ +class ListGenerativeQuestionConfigsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + + /** + * @param string $parent Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * Please see {@see GenerativeQuestionServiceClient::catalogName()} for help formatting this field. + * + * @return \Google\Cloud\Retail\V2\ListGenerativeQuestionConfigsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestionService::initOnce(); + parent::__construct($data); + } + + /** + * Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. Resource name of the parent catalog. + * Format: projects/{project}/locations/{location}/catalogs/{catalog} + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + +} + diff --git a/Retail/src/V2/ListGenerativeQuestionConfigsResponse.php b/Retail/src/V2/ListGenerativeQuestionConfigsResponse.php new file mode 100644 index 000000000000..cbec187cb9cd --- /dev/null +++ b/Retail/src/V2/ListGenerativeQuestionConfigsResponse.php @@ -0,0 +1,67 @@ +google.cloud.retail.v2.ListGenerativeQuestionConfigsResponse + */ +class ListGenerativeQuestionConfigsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * All the questions for a given catalog. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_configs = 1; + */ + private $generative_question_configs; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Retail\V2\GenerativeQuestionConfig>|\Google\Protobuf\Internal\RepeatedField $generative_question_configs + * All the questions for a given catalog. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestionService::initOnce(); + parent::__construct($data); + } + + /** + * All the questions for a given catalog. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_configs = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGenerativeQuestionConfigs() + { + return $this->generative_question_configs; + } + + /** + * All the questions for a given catalog. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_configs = 1; + * @param array<\Google\Cloud\Retail\V2\GenerativeQuestionConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGenerativeQuestionConfigs($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\GenerativeQuestionConfig::class); + $this->generative_question_configs = $arr; + + return $this; + } + +} + diff --git a/Retail/src/V2/Product.php b/Retail/src/V2/Product.php index 3f51475923ce..0d56e63f4e47 100644 --- a/Retail/src/V2/Product.php +++ b/Retail/src/V2/Product.php @@ -254,6 +254,13 @@ class Product extends \Google\Protobuf\Internal\Message * The online availability of the [Product][google.cloud.retail.v2.Product]. * Default to * [Availability.IN_STOCK][google.cloud.retail.v2.Product.Availability.IN_STOCK]. + * For primary products with variants set the availability of the primary as + * [Availability.OUT_OF_STOCK][google.cloud.retail.v2.Product.Availability.OUT_OF_STOCK] + * and set the true availability at the variant level. This way the primary + * product will be considered "in stock" as long as it has at least one + * variant in stock. + * For primary products with no variants set the true availability at the + * primary level. * Corresponding properties: Google Merchant Center property * [availability](https://support.google.com/merchants/answer/6324448). * Schema.org property [Offer.availability](https://schema.org/availability). @@ -438,8 +445,6 @@ class Product extends \Google\Protobuf\Internal\Message * following fields are always returned in by default: * * [name][google.cloud.retail.v2.Product.name] * * [color_info][google.cloud.retail.v2.Product.color_info] - * The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is - * returned. * Note: Returning more fields in * [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase * response payload size and serving latency. @@ -697,6 +702,13 @@ class Product extends \Google\Protobuf\Internal\Message * The online availability of the [Product][google.cloud.retail.v2.Product]. * Default to * [Availability.IN_STOCK][google.cloud.retail.v2.Product.Availability.IN_STOCK]. + * For primary products with variants set the availability of the primary as + * [Availability.OUT_OF_STOCK][google.cloud.retail.v2.Product.Availability.OUT_OF_STOCK] + * and set the true availability at the variant level. This way the primary + * product will be considered "in stock" as long as it has at least one + * variant in stock. + * For primary products with no variants set the true availability at the + * primary level. * Corresponding properties: Google Merchant Center property * [availability](https://support.google.com/merchants/answer/6324448). * Schema.org property [Offer.availability](https://schema.org/availability). @@ -829,8 +841,6 @@ class Product extends \Google\Protobuf\Internal\Message * following fields are always returned in by default: * * [name][google.cloud.retail.v2.Product.name] * * [color_info][google.cloud.retail.v2.Product.color_info] - * The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is - * returned. * Note: Returning more fields in * [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase * response payload size and serving latency. @@ -1721,6 +1731,13 @@ public function setAvailableTime($var) * The online availability of the [Product][google.cloud.retail.v2.Product]. * Default to * [Availability.IN_STOCK][google.cloud.retail.v2.Product.Availability.IN_STOCK]. + * For primary products with variants set the availability of the primary as + * [Availability.OUT_OF_STOCK][google.cloud.retail.v2.Product.Availability.OUT_OF_STOCK] + * and set the true availability at the variant level. This way the primary + * product will be considered "in stock" as long as it has at least one + * variant in stock. + * For primary products with no variants set the true availability at the + * primary level. * Corresponding properties: Google Merchant Center property * [availability](https://support.google.com/merchants/answer/6324448). * Schema.org property [Offer.availability](https://schema.org/availability). @@ -1737,6 +1754,13 @@ public function getAvailability() * The online availability of the [Product][google.cloud.retail.v2.Product]. * Default to * [Availability.IN_STOCK][google.cloud.retail.v2.Product.Availability.IN_STOCK]. + * For primary products with variants set the availability of the primary as + * [Availability.OUT_OF_STOCK][google.cloud.retail.v2.Product.Availability.OUT_OF_STOCK] + * and set the true availability at the variant level. This way the primary + * product will be considered "in stock" as long as it has at least one + * variant in stock. + * For primary products with no variants set the true availability at the + * primary level. * Corresponding properties: Google Merchant Center property * [availability](https://support.google.com/merchants/answer/6324448). * Schema.org property [Offer.availability](https://schema.org/availability). @@ -2302,8 +2326,6 @@ public function setPublishTime($var) * following fields are always returned in by default: * * [name][google.cloud.retail.v2.Product.name] * * [color_info][google.cloud.retail.v2.Product.color_info] - * The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is - * returned. * Note: Returning more fields in * [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase * response payload size and serving latency. @@ -2371,8 +2393,6 @@ public function clearRetrievableFields() * following fields are always returned in by default: * * [name][google.cloud.retail.v2.Product.name] * * [color_info][google.cloud.retail.v2.Product.color_info] - * The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is - * returned. * Note: Returning more fields in * [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase * response payload size and serving latency. diff --git a/Retail/src/V2/ProductAttributeInterval.php b/Retail/src/V2/ProductAttributeInterval.php new file mode 100644 index 000000000000..d077bbd3ea7d --- /dev/null +++ b/Retail/src/V2/ProductAttributeInterval.php @@ -0,0 +1,111 @@ +google.cloud.retail.v2.ProductAttributeInterval + */ +class ProductAttributeInterval extends \Google\Protobuf\Internal\Message +{ + /** + * The attribute name (e.g. "length") + * + * Generated from protobuf field string name = 1; + */ + protected $name = ''; + /** + * The numeric interval (e.g. [10, 20)) + * + * Generated from protobuf field .google.cloud.retail.v2.Interval interval = 2; + */ + protected $interval = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * The attribute name (e.g. "length") + * @type \Google\Cloud\Retail\V2\Interval $interval + * The numeric interval (e.g. [10, 20)) + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * The attribute name (e.g. "length") + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * The attribute name (e.g. "length") + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * The numeric interval (e.g. [10, 20)) + * + * Generated from protobuf field .google.cloud.retail.v2.Interval interval = 2; + * @return \Google\Cloud\Retail\V2\Interval|null + */ + public function getInterval() + { + return $this->interval; + } + + public function hasInterval() + { + return isset($this->interval); + } + + public function clearInterval() + { + unset($this->interval); + } + + /** + * The numeric interval (e.g. [10, 20)) + * + * Generated from protobuf field .google.cloud.retail.v2.Interval interval = 2; + * @param \Google\Cloud\Retail\V2\Interval $var + * @return $this + */ + public function setInterval($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\Interval::class); + $this->interval = $var; + + return $this; + } + +} + diff --git a/Retail/src/V2/ProductAttributeValue.php b/Retail/src/V2/ProductAttributeValue.php new file mode 100644 index 000000000000..0e258e59b22b --- /dev/null +++ b/Retail/src/V2/ProductAttributeValue.php @@ -0,0 +1,103 @@ +google.cloud.retail.v2.ProductAttributeValue + */ +class ProductAttributeValue extends \Google\Protobuf\Internal\Message +{ + /** + * The attribute name. + * + * Generated from protobuf field string name = 1; + */ + protected $name = ''; + /** + * The attribute value. + * + * Generated from protobuf field string value = 2; + */ + protected $value = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * The attribute name. + * @type string $value + * The attribute value. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * The attribute name. + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * The attribute name. + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * The attribute value. + * + * Generated from protobuf field string value = 2; + * @return string + */ + public function getValue() + { + return $this->value; + } + + /** + * The attribute value. + * + * Generated from protobuf field string value = 2; + * @param string $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkString($var, True); + $this->value = $var; + + return $this; + } + +} + diff --git a/Retail/src/V2/Rule/ForceReturnFacetAction.php b/Retail/src/V2/Rule/ForceReturnFacetAction.php index 24238cc30930..034e39e1d160 100644 --- a/Retail/src/V2/Rule/ForceReturnFacetAction.php +++ b/Retail/src/V2/Rule/ForceReturnFacetAction.php @@ -38,7 +38,7 @@ class ForceReturnFacetAction extends \Google\Protobuf\Internal\Message { /** * Each instance corresponds to a force return attribute for the given - * condition. There can't be more 3 instances here. + * condition. There can't be more 15 instances here. * * Generated from protobuf field repeated .google.cloud.retail.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1; */ @@ -52,7 +52,7 @@ class ForceReturnFacetAction extends \Google\Protobuf\Internal\Message * * @type array<\Google\Cloud\Retail\V2\Rule\ForceReturnFacetAction\FacetPositionAdjustment>|\Google\Protobuf\Internal\RepeatedField $facet_position_adjustments * Each instance corresponds to a force return attribute for the given - * condition. There can't be more 3 instances here. + * condition. There can't be more 15 instances here. * } */ public function __construct($data = NULL) { @@ -62,7 +62,7 @@ public function __construct($data = NULL) { /** * Each instance corresponds to a force return attribute for the given - * condition. There can't be more 3 instances here. + * condition. There can't be more 15 instances here. * * Generated from protobuf field repeated .google.cloud.retail.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -74,7 +74,7 @@ public function getFacetPositionAdjustments() /** * Each instance corresponds to a force return attribute for the given - * condition. There can't be more 3 instances here. + * condition. There can't be more 15 instances here. * * Generated from protobuf field repeated .google.cloud.retail.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1; * @param array<\Google\Cloud\Retail\V2\Rule\ForceReturnFacetAction\FacetPositionAdjustment>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Retail/src/V2/SearchRequest.php b/Retail/src/V2/SearchRequest.php index 54a05c2617d5..b948fc40243f 100644 --- a/Retail/src/V2/SearchRequest.php +++ b/Retail/src/V2/SearchRequest.php @@ -320,6 +320,19 @@ class SearchRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field string entity = 38; */ protected $entity = ''; + /** + * Optional. This field specifies all conversational related parameters + * addition to traditional retail search. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec conversational_search_spec = 40 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $conversational_search_spec = null; + /** + * Optional. This field specifies tile navigation related parameters. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.TileNavigationSpec tile_navigation_spec = 41 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $tile_navigation_spec = null; /** * Constructor. @@ -542,6 +555,11 @@ class SearchRequest extends \Google\Protobuf\Internal\Message * If this is set, it should be exactly matched with * [UserEvent.entity][google.cloud.retail.v2.UserEvent.entity] to get search * results boosted by entity. + * @type \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec $conversational_search_spec + * Optional. This field specifies all conversational related parameters + * addition to traditional retail search. + * @type \Google\Cloud\Retail\V2\SearchRequest\TileNavigationSpec $tile_navigation_spec + * Optional. This field specifies tile navigation related parameters. * } */ public function __construct($data = NULL) { @@ -1529,5 +1547,79 @@ public function setEntity($var) return $this; } + /** + * Optional. This field specifies all conversational related parameters + * addition to traditional retail search. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec conversational_search_spec = 40 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec|null + */ + public function getConversationalSearchSpec() + { + return $this->conversational_search_spec; + } + + public function hasConversationalSearchSpec() + { + return isset($this->conversational_search_spec); + } + + public function clearConversationalSearchSpec() + { + unset($this->conversational_search_spec); + } + + /** + * Optional. This field specifies all conversational related parameters + * addition to traditional retail search. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec conversational_search_spec = 40 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec $var + * @return $this + */ + public function setConversationalSearchSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec::class); + $this->conversational_search_spec = $var; + + return $this; + } + + /** + * Optional. This field specifies tile navigation related parameters. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.TileNavigationSpec tile_navigation_spec = 41 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Retail\V2\SearchRequest\TileNavigationSpec|null + */ + public function getTileNavigationSpec() + { + return $this->tile_navigation_spec; + } + + public function hasTileNavigationSpec() + { + return isset($this->tile_navigation_spec); + } + + public function clearTileNavigationSpec() + { + unset($this->tile_navigation_spec); + } + + /** + * Optional. This field specifies tile navigation related parameters. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.TileNavigationSpec tile_navigation_spec = 41 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Retail\V2\SearchRequest\TileNavigationSpec $var + * @return $this + */ + public function setTileNavigationSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\SearchRequest\TileNavigationSpec::class); + $this->tile_navigation_spec = $var; + + return $this; + } + } diff --git a/Retail/src/V2/SearchRequest/ConversationalSearchSpec.php b/Retail/src/V2/SearchRequest/ConversationalSearchSpec.php new file mode 100644 index 000000000000..5552df53e5a3 --- /dev/null +++ b/Retail/src/V2/SearchRequest/ConversationalSearchSpec.php @@ -0,0 +1,179 @@ +google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec + */ +class ConversationalSearchSpec extends \Google\Protobuf\Internal\Message +{ + /** + * This field specifies whether the customer would like to do conversational + * search. If this field is set to true, conversational related extra + * information will be returned from server side, including follow-up + * question, answer options, etc. + * + * Generated from protobuf field bool followup_conversation_requested = 1; + */ + protected $followup_conversation_requested = false; + /** + * This field specifies the conversation id, which maintains the state of + * the conversation between client side and server side. Use the value from + * the previous [ConversationalSearchResult.conversation_id][]. For the + * initial request, this should be empty. + * + * Generated from protobuf field string conversation_id = 2; + */ + protected $conversation_id = ''; + /** + * This field specifies the current user answer during the conversational + * search. This can be either user selected from suggested answers or user + * input plain text. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3; + */ + protected $user_answer = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $followup_conversation_requested + * This field specifies whether the customer would like to do conversational + * search. If this field is set to true, conversational related extra + * information will be returned from server side, including follow-up + * question, answer options, etc. + * @type string $conversation_id + * This field specifies the conversation id, which maintains the state of + * the conversation between client side and server side. Use the value from + * the previous [ConversationalSearchResult.conversation_id][]. For the + * initial request, this should be empty. + * @type \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec\UserAnswer $user_answer + * This field specifies the current user answer during the conversational + * search. This can be either user selected from suggested answers or user + * input plain text. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * This field specifies whether the customer would like to do conversational + * search. If this field is set to true, conversational related extra + * information will be returned from server side, including follow-up + * question, answer options, etc. + * + * Generated from protobuf field bool followup_conversation_requested = 1; + * @return bool + */ + public function getFollowupConversationRequested() + { + return $this->followup_conversation_requested; + } + + /** + * This field specifies whether the customer would like to do conversational + * search. If this field is set to true, conversational related extra + * information will be returned from server side, including follow-up + * question, answer options, etc. + * + * Generated from protobuf field bool followup_conversation_requested = 1; + * @param bool $var + * @return $this + */ + public function setFollowupConversationRequested($var) + { + GPBUtil::checkBool($var); + $this->followup_conversation_requested = $var; + + return $this; + } + + /** + * This field specifies the conversation id, which maintains the state of + * the conversation between client side and server side. Use the value from + * the previous [ConversationalSearchResult.conversation_id][]. For the + * initial request, this should be empty. + * + * Generated from protobuf field string conversation_id = 2; + * @return string + */ + public function getConversationId() + { + return $this->conversation_id; + } + + /** + * This field specifies the conversation id, which maintains the state of + * the conversation between client side and server side. Use the value from + * the previous [ConversationalSearchResult.conversation_id][]. For the + * initial request, this should be empty. + * + * Generated from protobuf field string conversation_id = 2; + * @param string $var + * @return $this + */ + public function setConversationId($var) + { + GPBUtil::checkString($var, True); + $this->conversation_id = $var; + + return $this; + } + + /** + * This field specifies the current user answer during the conversational + * search. This can be either user selected from suggested answers or user + * input plain text. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3; + * @return \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec\UserAnswer|null + */ + public function getUserAnswer() + { + return $this->user_answer; + } + + public function hasUserAnswer() + { + return isset($this->user_answer); + } + + public function clearUserAnswer() + { + unset($this->user_answer); + } + + /** + * This field specifies the current user answer during the conversational + * search. This can be either user selected from suggested answers or user + * input plain text. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3; + * @param \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec\UserAnswer $var + * @return $this + */ + public function setUserAnswer($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec\UserAnswer::class); + $this->user_answer = $var; + + return $this; + } + +} + + diff --git a/Retail/src/V2/SearchRequest/ConversationalSearchSpec/UserAnswer.php b/Retail/src/V2/SearchRequest/ConversationalSearchSpec/UserAnswer.php new file mode 100644 index 000000000000..5d651b48079c --- /dev/null +++ b/Retail/src/V2/SearchRequest/ConversationalSearchSpec/UserAnswer.php @@ -0,0 +1,120 @@ +google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer + */ +class UserAnswer extends \Google\Protobuf\Internal\Message +{ + protected $type; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $text_answer + * This field specifies the incremental input text from the user during + * the conversational search. + * @type \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec\UserAnswer\SelectedAnswer $selected_answer + * This field specifies the selected attributes during the + * conversational search. This should be a subset of + * [ConversationalSearchResult.suggested_answers][]. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * This field specifies the incremental input text from the user during + * the conversational search. + * + * Generated from protobuf field string text_answer = 1; + * @return string + */ + public function getTextAnswer() + { + return $this->readOneof(1); + } + + public function hasTextAnswer() + { + return $this->hasOneof(1); + } + + /** + * This field specifies the incremental input text from the user during + * the conversational search. + * + * Generated from protobuf field string text_answer = 1; + * @param string $var + * @return $this + */ + public function setTextAnswer($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * This field specifies the selected attributes during the + * conversational search. This should be a subset of + * [ConversationalSearchResult.suggested_answers][]. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer.SelectedAnswer selected_answer = 2; + * @return \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec\UserAnswer\SelectedAnswer|null + */ + public function getSelectedAnswer() + { + return $this->readOneof(2); + } + + public function hasSelectedAnswer() + { + return $this->hasOneof(2); + } + + /** + * This field specifies the selected attributes during the + * conversational search. This should be a subset of + * [ConversationalSearchResult.suggested_answers][]. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer.SelectedAnswer selected_answer = 2; + * @param \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec\UserAnswer\SelectedAnswer $var + * @return $this + */ + public function setSelectedAnswer($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\SearchRequest\ConversationalSearchSpec\UserAnswer\SelectedAnswer::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * @return string + */ + public function getType() + { + return $this->whichOneof("type"); + } + +} + + diff --git a/Retail/src/V2/SearchRequest/ConversationalSearchSpec/UserAnswer/SelectedAnswer.php b/Retail/src/V2/SearchRequest/ConversationalSearchSpec/UserAnswer/SelectedAnswer.php new file mode 100644 index 000000000000..75d013fe8008 --- /dev/null +++ b/Retail/src/V2/SearchRequest/ConversationalSearchSpec/UserAnswer/SelectedAnswer.php @@ -0,0 +1,122 @@ +google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer.SelectedAnswer + */ +class SelectedAnswer extends \Google\Protobuf\Internal\Message +{ + /** + * This field is deprecated and should not be set. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.ProductAttributeValue product_attribute_values = 1 [deprecated = true]; + * @deprecated + */ + private $product_attribute_values; + /** + * This field specifies the selected answer which is a attribute + * key-value. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 2; + */ + protected $product_attribute_value = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Retail\V2\ProductAttributeValue>|\Google\Protobuf\Internal\RepeatedField $product_attribute_values + * This field is deprecated and should not be set. + * @type \Google\Cloud\Retail\V2\ProductAttributeValue $product_attribute_value + * This field specifies the selected answer which is a attribute + * key-value. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * This field is deprecated and should not be set. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.ProductAttributeValue product_attribute_values = 1 [deprecated = true]; + * @return \Google\Protobuf\Internal\RepeatedField + * @deprecated + */ + public function getProductAttributeValues() + { + @trigger_error('product_attribute_values is deprecated.', E_USER_DEPRECATED); + return $this->product_attribute_values; + } + + /** + * This field is deprecated and should not be set. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.ProductAttributeValue product_attribute_values = 1 [deprecated = true]; + * @param array<\Google\Cloud\Retail\V2\ProductAttributeValue>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + * @deprecated + */ + public function setProductAttributeValues($var) + { + @trigger_error('product_attribute_values is deprecated.', E_USER_DEPRECATED); + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\ProductAttributeValue::class); + $this->product_attribute_values = $arr; + + return $this; + } + + /** + * This field specifies the selected answer which is a attribute + * key-value. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 2; + * @return \Google\Cloud\Retail\V2\ProductAttributeValue|null + */ + public function getProductAttributeValue() + { + return $this->product_attribute_value; + } + + public function hasProductAttributeValue() + { + return isset($this->product_attribute_value); + } + + public function clearProductAttributeValue() + { + unset($this->product_attribute_value); + } + + /** + * This field specifies the selected answer which is a attribute + * key-value. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 2; + * @param \Google\Cloud\Retail\V2\ProductAttributeValue $var + * @return $this + */ + public function setProductAttributeValue($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\ProductAttributeValue::class); + $this->product_attribute_value = $var; + + return $this; + } + +} + + diff --git a/Retail/src/V2/SearchRequest/TileNavigationSpec.php b/Retail/src/V2/SearchRequest/TileNavigationSpec.php new file mode 100644 index 000000000000..c2369b992a20 --- /dev/null +++ b/Retail/src/V2/SearchRequest/TileNavigationSpec.php @@ -0,0 +1,118 @@ +google.cloud.retail.v2.SearchRequest.TileNavigationSpec + */ +class TileNavigationSpec extends \Google\Protobuf\Internal\Message +{ + /** + * This field specifies whether the customer would like to request tile + * navigation. + * + * Generated from protobuf field bool tile_navigation_requested = 1; + */ + protected $tile_navigation_requested = false; + /** + * This field specifies the tiles which are already clicked in client side. + * NOTE: This field is not being used for filtering search products. Client + * side should also put all the applied tiles in + * [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.Tile applied_tiles = 2; + */ + private $applied_tiles; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $tile_navigation_requested + * This field specifies whether the customer would like to request tile + * navigation. + * @type array<\Google\Cloud\Retail\V2\Tile>|\Google\Protobuf\Internal\RepeatedField $applied_tiles + * This field specifies the tiles which are already clicked in client side. + * NOTE: This field is not being used for filtering search products. Client + * side should also put all the applied tiles in + * [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * This field specifies whether the customer would like to request tile + * navigation. + * + * Generated from protobuf field bool tile_navigation_requested = 1; + * @return bool + */ + public function getTileNavigationRequested() + { + return $this->tile_navigation_requested; + } + + /** + * This field specifies whether the customer would like to request tile + * navigation. + * + * Generated from protobuf field bool tile_navigation_requested = 1; + * @param bool $var + * @return $this + */ + public function setTileNavigationRequested($var) + { + GPBUtil::checkBool($var); + $this->tile_navigation_requested = $var; + + return $this; + } + + /** + * This field specifies the tiles which are already clicked in client side. + * NOTE: This field is not being used for filtering search products. Client + * side should also put all the applied tiles in + * [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.Tile applied_tiles = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAppliedTiles() + { + return $this->applied_tiles; + } + + /** + * This field specifies the tiles which are already clicked in client side. + * NOTE: This field is not being used for filtering search products. Client + * side should also put all the applied tiles in + * [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.Tile applied_tiles = 2; + * @param array<\Google\Cloud\Retail\V2\Tile>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAppliedTiles($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\Tile::class); + $this->applied_tiles = $arr; + + return $this; + } + +} + + diff --git a/Retail/src/V2/SearchResponse.php b/Retail/src/V2/SearchResponse.php index c87e0c07238c..f8508be2ccc4 100644 --- a/Retail/src/V2/SearchResponse.php +++ b/Retail/src/V2/SearchResponse.php @@ -101,6 +101,20 @@ class SearchResponse extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17; */ private $experiment_info; + /** + * This field specifies all related information that is needed on client + * side for UI rendering of conversational retail search. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18; + */ + protected $conversational_search_result = null; + /** + * This field specifies all related information for tile navigation that will + * be used in client side. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19; + */ + protected $tile_navigation_result = null; /** * Constructor. @@ -149,6 +163,12 @@ class SearchResponse extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\Retail\V2\ExperimentInfo>|\Google\Protobuf\Internal\RepeatedField $experiment_info * Metadata related to A/B testing [Experiment][] associated with this * response. Only exists when an experiment is triggered. + * @type \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult $conversational_search_result + * This field specifies all related information that is needed on client + * side for UI rendering of conversational retail search. + * @type \Google\Cloud\Retail\V2\SearchResponse\TileNavigationResult $tile_navigation_result + * This field specifies all related information for tile navigation that will + * be used in client side. * } */ public function __construct($data = NULL) { @@ -490,5 +510,81 @@ public function setExperimentInfo($var) return $this; } + /** + * This field specifies all related information that is needed on client + * side for UI rendering of conversational retail search. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18; + * @return \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult|null + */ + public function getConversationalSearchResult() + { + return $this->conversational_search_result; + } + + public function hasConversationalSearchResult() + { + return isset($this->conversational_search_result); + } + + public function clearConversationalSearchResult() + { + unset($this->conversational_search_result); + } + + /** + * This field specifies all related information that is needed on client + * side for UI rendering of conversational retail search. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18; + * @param \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult $var + * @return $this + */ + public function setConversationalSearchResult($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult::class); + $this->conversational_search_result = $var; + + return $this; + } + + /** + * This field specifies all related information for tile navigation that will + * be used in client side. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19; + * @return \Google\Cloud\Retail\V2\SearchResponse\TileNavigationResult|null + */ + public function getTileNavigationResult() + { + return $this->tile_navigation_result; + } + + public function hasTileNavigationResult() + { + return isset($this->tile_navigation_result); + } + + public function clearTileNavigationResult() + { + unset($this->tile_navigation_result); + } + + /** + * This field specifies all related information for tile navigation that will + * be used in client side. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19; + * @param \Google\Cloud\Retail\V2\SearchResponse\TileNavigationResult $var + * @return $this + */ + public function setTileNavigationResult($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\SearchResponse\TileNavigationResult::class); + $this->tile_navigation_result = $var; + + return $this; + } + } diff --git a/Retail/src/V2/SearchResponse/ConversationalSearchResult.php b/Retail/src/V2/SearchResponse/ConversationalSearchResult.php new file mode 100644 index 000000000000..a41fd134efd0 --- /dev/null +++ b/Retail/src/V2/SearchResponse/ConversationalSearchResult.php @@ -0,0 +1,322 @@ +google.cloud.retail.v2.SearchResponse.ConversationalSearchResult + */ +class ConversationalSearchResult extends \Google\Protobuf\Internal\Message +{ + /** + * Conversation UUID. This field will be stored in client side storage to + * maintain the conversation session with server and will be used for next + * search request's + * [SearchRequest.ConversationalSearchSpec.conversation_id][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id] + * to restore conversation state in server. + * + * Generated from protobuf field string conversation_id = 1; + */ + protected $conversation_id = ''; + /** + * The current refined query for the conversational search. This field + * will be used in customer UI that the query in the search bar should be + * replaced with the refined query. For example, if + * [SearchRequest.query][google.cloud.retail.v2.SearchRequest.query] is + * `dress` and next + * [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer] + * is `red color`, which does not match any product attribute value filters, + * the refined query will be `dress, red color`. + * + * Generated from protobuf field string refined_query = 2; + */ + protected $refined_query = ''; + /** + * This field is deprecated but will be kept for backward compatibility. + * There is expected to have only one additional filter and the value will + * be the same to the same as field `additional_filter`. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true]; + * @deprecated + */ + private $additional_filters; + /** + * The follow-up question. e.g., `What is the color?` + * + * Generated from protobuf field string followup_question = 4; + */ + protected $followup_question = ''; + /** + * The answer options provided to client for the follow-up question. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5; + */ + private $suggested_answers; + /** + * This is the incremental additional filters implied from the current + * user answer. User should add the suggested addition filters to the + * previous + * [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter], and + * use the merged filter in the follow up search request. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6; + */ + protected $additional_filter = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $conversation_id + * Conversation UUID. This field will be stored in client side storage to + * maintain the conversation session with server and will be used for next + * search request's + * [SearchRequest.ConversationalSearchSpec.conversation_id][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id] + * to restore conversation state in server. + * @type string $refined_query + * The current refined query for the conversational search. This field + * will be used in customer UI that the query in the search bar should be + * replaced with the refined query. For example, if + * [SearchRequest.query][google.cloud.retail.v2.SearchRequest.query] is + * `dress` and next + * [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer] + * is `red color`, which does not match any product attribute value filters, + * the refined query will be `dress, red color`. + * @type array<\Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\AdditionalFilter>|\Google\Protobuf\Internal\RepeatedField $additional_filters + * This field is deprecated but will be kept for backward compatibility. + * There is expected to have only one additional filter and the value will + * be the same to the same as field `additional_filter`. + * @type string $followup_question + * The follow-up question. e.g., `What is the color?` + * @type array<\Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\SuggestedAnswer>|\Google\Protobuf\Internal\RepeatedField $suggested_answers + * The answer options provided to client for the follow-up question. + * @type \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\AdditionalFilter $additional_filter + * This is the incremental additional filters implied from the current + * user answer. User should add the suggested addition filters to the + * previous + * [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter], and + * use the merged filter in the follow up search request. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * Conversation UUID. This field will be stored in client side storage to + * maintain the conversation session with server and will be used for next + * search request's + * [SearchRequest.ConversationalSearchSpec.conversation_id][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id] + * to restore conversation state in server. + * + * Generated from protobuf field string conversation_id = 1; + * @return string + */ + public function getConversationId() + { + return $this->conversation_id; + } + + /** + * Conversation UUID. This field will be stored in client side storage to + * maintain the conversation session with server and will be used for next + * search request's + * [SearchRequest.ConversationalSearchSpec.conversation_id][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id] + * to restore conversation state in server. + * + * Generated from protobuf field string conversation_id = 1; + * @param string $var + * @return $this + */ + public function setConversationId($var) + { + GPBUtil::checkString($var, True); + $this->conversation_id = $var; + + return $this; + } + + /** + * The current refined query for the conversational search. This field + * will be used in customer UI that the query in the search bar should be + * replaced with the refined query. For example, if + * [SearchRequest.query][google.cloud.retail.v2.SearchRequest.query] is + * `dress` and next + * [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer] + * is `red color`, which does not match any product attribute value filters, + * the refined query will be `dress, red color`. + * + * Generated from protobuf field string refined_query = 2; + * @return string + */ + public function getRefinedQuery() + { + return $this->refined_query; + } + + /** + * The current refined query for the conversational search. This field + * will be used in customer UI that the query in the search bar should be + * replaced with the refined query. For example, if + * [SearchRequest.query][google.cloud.retail.v2.SearchRequest.query] is + * `dress` and next + * [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer] + * is `red color`, which does not match any product attribute value filters, + * the refined query will be `dress, red color`. + * + * Generated from protobuf field string refined_query = 2; + * @param string $var + * @return $this + */ + public function setRefinedQuery($var) + { + GPBUtil::checkString($var, True); + $this->refined_query = $var; + + return $this; + } + + /** + * This field is deprecated but will be kept for backward compatibility. + * There is expected to have only one additional filter and the value will + * be the same to the same as field `additional_filter`. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true]; + * @return \Google\Protobuf\Internal\RepeatedField + * @deprecated + */ + public function getAdditionalFilters() + { + @trigger_error('additional_filters is deprecated.', E_USER_DEPRECATED); + return $this->additional_filters; + } + + /** + * This field is deprecated but will be kept for backward compatibility. + * There is expected to have only one additional filter and the value will + * be the same to the same as field `additional_filter`. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true]; + * @param array<\Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\AdditionalFilter>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + * @deprecated + */ + public function setAdditionalFilters($var) + { + @trigger_error('additional_filters is deprecated.', E_USER_DEPRECATED); + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\AdditionalFilter::class); + $this->additional_filters = $arr; + + return $this; + } + + /** + * The follow-up question. e.g., `What is the color?` + * + * Generated from protobuf field string followup_question = 4; + * @return string + */ + public function getFollowupQuestion() + { + return $this->followup_question; + } + + /** + * The follow-up question. e.g., `What is the color?` + * + * Generated from protobuf field string followup_question = 4; + * @param string $var + * @return $this + */ + public function setFollowupQuestion($var) + { + GPBUtil::checkString($var, True); + $this->followup_question = $var; + + return $this; + } + + /** + * The answer options provided to client for the follow-up question. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSuggestedAnswers() + { + return $this->suggested_answers; + } + + /** + * The answer options provided to client for the follow-up question. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5; + * @param array<\Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\SuggestedAnswer>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSuggestedAnswers($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\SuggestedAnswer::class); + $this->suggested_answers = $arr; + + return $this; + } + + /** + * This is the incremental additional filters implied from the current + * user answer. User should add the suggested addition filters to the + * previous + * [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter], and + * use the merged filter in the follow up search request. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6; + * @return \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\AdditionalFilter|null + */ + public function getAdditionalFilter() + { + return $this->additional_filter; + } + + public function hasAdditionalFilter() + { + return isset($this->additional_filter); + } + + public function clearAdditionalFilter() + { + unset($this->additional_filter); + } + + /** + * This is the incremental additional filters implied from the current + * user answer. User should add the suggested addition filters to the + * previous + * [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter], and + * use the merged filter in the follow up search request. + * + * Generated from protobuf field .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6; + * @param \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\AdditionalFilter $var + * @return $this + */ + public function setAdditionalFilter($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\SearchResponse\ConversationalSearchResult\AdditionalFilter::class); + $this->additional_filter = $var; + + return $this; + } + +} + + diff --git a/Retail/src/V2/SearchResponse/ConversationalSearchResult/AdditionalFilter.php b/Retail/src/V2/SearchResponse/ConversationalSearchResult/AdditionalFilter.php new file mode 100644 index 000000000000..a68e9cc7d57a --- /dev/null +++ b/Retail/src/V2/SearchResponse/ConversationalSearchResult/AdditionalFilter.php @@ -0,0 +1,82 @@ +google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter + */ +class AdditionalFilter extends \Google\Protobuf\Internal\Message +{ + /** + * Product attribute value, including an attribute key and an + * attribute value. Other types can be added here in the future. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 1; + */ + protected $product_attribute_value = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Retail\V2\ProductAttributeValue $product_attribute_value + * Product attribute value, including an attribute key and an + * attribute value. Other types can be added here in the future. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * Product attribute value, including an attribute key and an + * attribute value. Other types can be added here in the future. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 1; + * @return \Google\Cloud\Retail\V2\ProductAttributeValue|null + */ + public function getProductAttributeValue() + { + return $this->product_attribute_value; + } + + public function hasProductAttributeValue() + { + return isset($this->product_attribute_value); + } + + public function clearProductAttributeValue() + { + unset($this->product_attribute_value); + } + + /** + * Product attribute value, including an attribute key and an + * attribute value. Other types can be added here in the future. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 1; + * @param \Google\Cloud\Retail\V2\ProductAttributeValue $var + * @return $this + */ + public function setProductAttributeValue($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\ProductAttributeValue::class); + $this->product_attribute_value = $var; + + return $this; + } + +} + + diff --git a/Retail/src/V2/SearchResponse/ConversationalSearchResult/SuggestedAnswer.php b/Retail/src/V2/SearchResponse/ConversationalSearchResult/SuggestedAnswer.php new file mode 100644 index 000000000000..8f92198beec5 --- /dev/null +++ b/Retail/src/V2/SearchResponse/ConversationalSearchResult/SuggestedAnswer.php @@ -0,0 +1,82 @@ +google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer + */ +class SuggestedAnswer extends \Google\Protobuf\Internal\Message +{ + /** + * Product attribute value, including an attribute key and an + * attribute value. Other types can be added here in the future. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 1; + */ + protected $product_attribute_value = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Retail\V2\ProductAttributeValue $product_attribute_value + * Product attribute value, including an attribute key and an + * attribute value. Other types can be added here in the future. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * Product attribute value, including an attribute key and an + * attribute value. Other types can be added here in the future. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 1; + * @return \Google\Cloud\Retail\V2\ProductAttributeValue|null + */ + public function getProductAttributeValue() + { + return $this->product_attribute_value; + } + + public function hasProductAttributeValue() + { + return isset($this->product_attribute_value); + } + + public function clearProductAttributeValue() + { + unset($this->product_attribute_value); + } + + /** + * Product attribute value, including an attribute key and an + * attribute value. Other types can be added here in the future. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 1; + * @param \Google\Cloud\Retail\V2\ProductAttributeValue $var + * @return $this + */ + public function setProductAttributeValue($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\ProductAttributeValue::class); + $this->product_attribute_value = $var; + + return $this; + } + +} + + diff --git a/Retail/src/V2/SearchResponse/TileNavigationResult.php b/Retail/src/V2/SearchResponse/TileNavigationResult.php new file mode 100644 index 000000000000..585a811d5a81 --- /dev/null +++ b/Retail/src/V2/SearchResponse/TileNavigationResult.php @@ -0,0 +1,73 @@ +google.cloud.retail.v2.SearchResponse.TileNavigationResult + */ +class TileNavigationResult extends \Google\Protobuf\Internal\Message +{ + /** + * The current tiles that are used for tile navigation, sorted by + * engagement. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.Tile tiles = 1; + */ + private $tiles; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Retail\V2\Tile>|\Google\Protobuf\Internal\RepeatedField $tiles + * The current tiles that are used for tile navigation, sorted by + * engagement. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * The current tiles that are used for tile navigation, sorted by + * engagement. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.Tile tiles = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTiles() + { + return $this->tiles; + } + + /** + * The current tiles that are used for tile navigation, sorted by + * engagement. + * + * Generated from protobuf field repeated .google.cloud.retail.v2.Tile tiles = 1; + * @param array<\Google\Cloud\Retail\V2\Tile>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTiles($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\Tile::class); + $this->tiles = $arr; + + return $this; + } + +} + + diff --git a/Retail/src/V2/Tile.php b/Retail/src/V2/Tile.php new file mode 100644 index 000000000000..cd96719b01d0 --- /dev/null +++ b/Retail/src/V2/Tile.php @@ -0,0 +1,144 @@ +google.cloud.retail.v2.Tile + */ +class Tile extends \Google\Protobuf\Internal\Message +{ + /** + * The representative product id for this tile. + * + * Generated from protobuf field string representative_product_id = 3; + */ + protected $representative_product_id = ''; + protected $product_attribute; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Retail\V2\ProductAttributeValue $product_attribute_value + * The product attribute key-value. + * @type \Google\Cloud\Retail\V2\ProductAttributeInterval $product_attribute_interval + * The product attribute key-numeric interval. + * @type string $representative_product_id + * The representative product id for this tile. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * The product attribute key-value. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 1; + * @return \Google\Cloud\Retail\V2\ProductAttributeValue|null + */ + public function getProductAttributeValue() + { + return $this->readOneof(1); + } + + public function hasProductAttributeValue() + { + return $this->hasOneof(1); + } + + /** + * The product attribute key-value. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeValue product_attribute_value = 1; + * @param \Google\Cloud\Retail\V2\ProductAttributeValue $var + * @return $this + */ + public function setProductAttributeValue($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\ProductAttributeValue::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * The product attribute key-numeric interval. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeInterval product_attribute_interval = 2; + * @return \Google\Cloud\Retail\V2\ProductAttributeInterval|null + */ + public function getProductAttributeInterval() + { + return $this->readOneof(2); + } + + public function hasProductAttributeInterval() + { + return $this->hasOneof(2); + } + + /** + * The product attribute key-numeric interval. + * + * Generated from protobuf field .google.cloud.retail.v2.ProductAttributeInterval product_attribute_interval = 2; + * @param \Google\Cloud\Retail\V2\ProductAttributeInterval $var + * @return $this + */ + public function setProductAttributeInterval($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\ProductAttributeInterval::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * The representative product id for this tile. + * + * Generated from protobuf field string representative_product_id = 3; + * @return string + */ + public function getRepresentativeProductId() + { + return $this->representative_product_id; + } + + /** + * The representative product id for this tile. + * + * Generated from protobuf field string representative_product_id = 3; + * @param string $var + * @return $this + */ + public function setRepresentativeProductId($var) + { + GPBUtil::checkString($var, True); + $this->representative_product_id = $var; + + return $this; + } + + /** + * @return string + */ + public function getProductAttribute() + { + return $this->whichOneof("product_attribute"); + } + +} + diff --git a/Retail/src/V2/UpdateGenerativeQuestionConfigRequest.php b/Retail/src/V2/UpdateGenerativeQuestionConfigRequest.php new file mode 100644 index 000000000000..63d052fd0322 --- /dev/null +++ b/Retail/src/V2/UpdateGenerativeQuestionConfigRequest.php @@ -0,0 +1,158 @@ +google.cloud.retail.v2.UpdateGenerativeQuestionConfigRequest + */ +class UpdateGenerativeQuestionConfigRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The question to update. + * + * Generated from protobuf field .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_config = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $generative_question_config = null; + /** + * Optional. Indicates which fields in the provided + * [GenerativeQuestionConfig][google.cloud.retail.v2.GenerativeQuestionConfig] + * to update. The following are NOT supported: + * * [GenerativeQuestionConfig.frequency][google.cloud.retail.v2.GenerativeQuestionConfig.frequency] + * If not set or empty, all supported fields are updated. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $update_mask = null; + + /** + * @param \Google\Cloud\Retail\V2\GenerativeQuestionConfig $generativeQuestionConfig Required. The question to update. + * @param \Google\Protobuf\FieldMask $updateMask Optional. Indicates which fields in the provided + * [GenerativeQuestionConfig][google.cloud.retail.v2.GenerativeQuestionConfig] + * to update. The following are NOT supported: + * + * * [GenerativeQuestionConfig.frequency][google.cloud.retail.v2.GenerativeQuestionConfig.frequency] + * + * If not set or empty, all supported fields are updated. + * + * @return \Google\Cloud\Retail\V2\UpdateGenerativeQuestionConfigRequest + * + * @experimental + */ + public static function build(\Google\Cloud\Retail\V2\GenerativeQuestionConfig $generativeQuestionConfig, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setGenerativeQuestionConfig($generativeQuestionConfig) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Retail\V2\GenerativeQuestionConfig $generative_question_config + * Required. The question to update. + * @type \Google\Protobuf\FieldMask $update_mask + * Optional. Indicates which fields in the provided + * [GenerativeQuestionConfig][google.cloud.retail.v2.GenerativeQuestionConfig] + * to update. The following are NOT supported: + * * [GenerativeQuestionConfig.frequency][google.cloud.retail.v2.GenerativeQuestionConfig.frequency] + * If not set or empty, all supported fields are updated. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestionService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The question to update. + * + * Generated from protobuf field .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_config = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Retail\V2\GenerativeQuestionConfig|null + */ + public function getGenerativeQuestionConfig() + { + return $this->generative_question_config; + } + + public function hasGenerativeQuestionConfig() + { + return isset($this->generative_question_config); + } + + public function clearGenerativeQuestionConfig() + { + unset($this->generative_question_config); + } + + /** + * Required. The question to update. + * + * Generated from protobuf field .google.cloud.retail.v2.GenerativeQuestionConfig generative_question_config = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Retail\V2\GenerativeQuestionConfig $var + * @return $this + */ + public function setGenerativeQuestionConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\GenerativeQuestionConfig::class); + $this->generative_question_config = $var; + + return $this; + } + + /** + * Optional. Indicates which fields in the provided + * [GenerativeQuestionConfig][google.cloud.retail.v2.GenerativeQuestionConfig] + * to update. The following are NOT supported: + * * [GenerativeQuestionConfig.frequency][google.cloud.retail.v2.GenerativeQuestionConfig.frequency] + * If not set or empty, all supported fields are updated. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Optional. Indicates which fields in the provided + * [GenerativeQuestionConfig][google.cloud.retail.v2.GenerativeQuestionConfig] + * to update. The following are NOT supported: + * * [GenerativeQuestionConfig.frequency][google.cloud.retail.v2.GenerativeQuestionConfig.frequency] + * If not set or empty, all supported fields are updated. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/Retail/src/V2/UpdateGenerativeQuestionsFeatureConfigRequest.php b/Retail/src/V2/UpdateGenerativeQuestionsFeatureConfigRequest.php new file mode 100644 index 000000000000..29dfb439aa90 --- /dev/null +++ b/Retail/src/V2/UpdateGenerativeQuestionsFeatureConfigRequest.php @@ -0,0 +1,146 @@ +google.cloud.retail.v2.UpdateGenerativeQuestionsFeatureConfigRequest + */ +class UpdateGenerativeQuestionsFeatureConfigRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The configuration managing the feature state. + * + * Generated from protobuf field .google.cloud.retail.v2.GenerativeQuestionsFeatureConfig generative_questions_feature_config = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $generative_questions_feature_config = null; + /** + * Optional. Indicates which fields in the provided + * [GenerativeQuestionsFeatureConfig][google.cloud.retail.v2.GenerativeQuestionsFeatureConfig] + * to update. If not set or empty, all supported fields are updated. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $update_mask = null; + + /** + * @param \Google\Cloud\Retail\V2\GenerativeQuestionsFeatureConfig $generativeQuestionsFeatureConfig Required. The configuration managing the feature state. + * @param \Google\Protobuf\FieldMask $updateMask Optional. Indicates which fields in the provided + * [GenerativeQuestionsFeatureConfig][google.cloud.retail.v2.GenerativeQuestionsFeatureConfig] + * to update. If not set or empty, all supported fields are updated. + * + * @return \Google\Cloud\Retail\V2\UpdateGenerativeQuestionsFeatureConfigRequest + * + * @experimental + */ + public static function build(\Google\Cloud\Retail\V2\GenerativeQuestionsFeatureConfig $generativeQuestionsFeatureConfig, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setGenerativeQuestionsFeatureConfig($generativeQuestionsFeatureConfig) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Retail\V2\GenerativeQuestionsFeatureConfig $generative_questions_feature_config + * Required. The configuration managing the feature state. + * @type \Google\Protobuf\FieldMask $update_mask + * Optional. Indicates which fields in the provided + * [GenerativeQuestionsFeatureConfig][google.cloud.retail.v2.GenerativeQuestionsFeatureConfig] + * to update. If not set or empty, all supported fields are updated. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Retail\V2\GenerativeQuestionService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The configuration managing the feature state. + * + * Generated from protobuf field .google.cloud.retail.v2.GenerativeQuestionsFeatureConfig generative_questions_feature_config = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Retail\V2\GenerativeQuestionsFeatureConfig|null + */ + public function getGenerativeQuestionsFeatureConfig() + { + return $this->generative_questions_feature_config; + } + + public function hasGenerativeQuestionsFeatureConfig() + { + return isset($this->generative_questions_feature_config); + } + + public function clearGenerativeQuestionsFeatureConfig() + { + unset($this->generative_questions_feature_config); + } + + /** + * Required. The configuration managing the feature state. + * + * Generated from protobuf field .google.cloud.retail.v2.GenerativeQuestionsFeatureConfig generative_questions_feature_config = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Retail\V2\GenerativeQuestionsFeatureConfig $var + * @return $this + */ + public function setGenerativeQuestionsFeatureConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\GenerativeQuestionsFeatureConfig::class); + $this->generative_questions_feature_config = $var; + + return $this; + } + + /** + * Optional. Indicates which fields in the provided + * [GenerativeQuestionsFeatureConfig][google.cloud.retail.v2.GenerativeQuestionsFeatureConfig] + * to update. If not set or empty, all supported fields are updated. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Optional. Indicates which fields in the provided + * [GenerativeQuestionsFeatureConfig][google.cloud.retail.v2.GenerativeQuestionsFeatureConfig] + * to update. If not set or empty, all supported fields are updated. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/Retail/src/V2/gapic_metadata.json b/Retail/src/V2/gapic_metadata.json index 7c30c861c0d5..a4ab5df79825 100644 --- a/Retail/src/V2/gapic_metadata.json +++ b/Retail/src/V2/gapic_metadata.json @@ -136,6 +136,40 @@ } } }, + "GenerativeQuestionService": { + "clients": { + "grpc": { + "libraryClient": "GenerativeQuestionServiceGapicClient", + "rpcs": { + "BatchUpdateGenerativeQuestionConfigs": { + "methods": [ + "batchUpdateGenerativeQuestionConfigs" + ] + }, + "GetGenerativeQuestionsFeatureConfig": { + "methods": [ + "getGenerativeQuestionsFeatureConfig" + ] + }, + "ListGenerativeQuestionConfigs": { + "methods": [ + "listGenerativeQuestionConfigs" + ] + }, + "UpdateGenerativeQuestionConfig": { + "methods": [ + "updateGenerativeQuestionConfig" + ] + }, + "UpdateGenerativeQuestionsFeatureConfig": { + "methods": [ + "updateGenerativeQuestionsFeatureConfig" + ] + } + } + } + } + }, "ModelService": { "clients": { "grpc": { diff --git a/Retail/src/V2/resources/generative_question_service_client_config.json b/Retail/src/V2/resources/generative_question_service_client_config.json new file mode 100644 index 000000000000..a22e14095f73 --- /dev/null +++ b/Retail/src/V2/resources/generative_question_service_client_config.json @@ -0,0 +1,47 @@ +{ + "interfaces": { + "google.cloud.retail.v2.GenerativeQuestionService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "BatchUpdateGenerativeQuestionConfigs": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "GetGenerativeQuestionsFeatureConfig": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListGenerativeQuestionConfigs": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "UpdateGenerativeQuestionConfig": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "UpdateGenerativeQuestionsFeatureConfig": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/Retail/src/V2/resources/generative_question_service_descriptor_config.php b/Retail/src/V2/resources/generative_question_service_descriptor_config.php new file mode 100644 index 000000000000..56b813c71536 --- /dev/null +++ b/Retail/src/V2/resources/generative_question_service_descriptor_config.php @@ -0,0 +1,93 @@ + [ + 'google.cloud.retail.v2.GenerativeQuestionService' => [ + 'BatchUpdateGenerativeQuestionConfigs' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Retail\V2\BatchUpdateGenerativeQuestionConfigsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'GetGenerativeQuestionsFeatureConfig' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Retail\V2\GenerativeQuestionsFeatureConfig', + 'headerParams' => [ + [ + 'keyName' => 'catalog', + 'fieldAccessors' => [ + 'getCatalog', + ], + ], + ], + ], + 'ListGenerativeQuestionConfigs' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Retail\V2\ListGenerativeQuestionConfigsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'UpdateGenerativeQuestionConfig' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Retail\V2\GenerativeQuestionConfig', + 'headerParams' => [ + [ + 'keyName' => 'generative_question_config.catalog', + 'fieldAccessors' => [ + 'getGenerativeQuestionConfig', + 'getCatalog', + ], + ], + ], + ], + 'UpdateGenerativeQuestionsFeatureConfig' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Retail\V2\GenerativeQuestionsFeatureConfig', + 'headerParams' => [ + [ + 'keyName' => 'generative_questions_feature_config.catalog', + 'fieldAccessors' => [ + 'getGenerativeQuestionsFeatureConfig', + 'getCatalog', + ], + ], + ], + ], + 'templateMap' => [ + 'catalog' => 'projects/{project}/locations/{location}/catalogs/{catalog}', + ], + ], + ], +]; diff --git a/Retail/src/V2/resources/generative_question_service_rest_client_config.php b/Retail/src/V2/resources/generative_question_service_rest_client_config.php new file mode 100644 index 000000000000..eef5c95d149f --- /dev/null +++ b/Retail/src/V2/resources/generative_question_service_rest_client_config.php @@ -0,0 +1,137 @@ + [ + 'google.cloud.retail.v2.GenerativeQuestionService' => [ + 'BatchUpdateGenerativeQuestionConfigs' => [ + 'method' => 'post', + 'uriTemplate' => '/v2/{parent=projects/*/locations/*/catalogs/*}/generativeQuestion:batchUpdate', + 'body' => '*', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'GetGenerativeQuestionsFeatureConfig' => [ + 'method' => 'get', + 'uriTemplate' => '/v2/{catalog=projects/*/locations/*/catalogs/*}/generativeQuestionFeature', + 'placeholders' => [ + 'catalog' => [ + 'getters' => [ + 'getCatalog', + ], + ], + ], + ], + 'ListGenerativeQuestionConfigs' => [ + 'method' => 'get', + 'uriTemplate' => '/v2/{parent=projects/*/locations/*/catalogs/*}/generativeQuestions', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'UpdateGenerativeQuestionConfig' => [ + 'method' => 'patch', + 'uriTemplate' => '/v2/{generative_question_config.catalog=projects/*/locations/*/catalogs/*}/generativeQuestion', + 'body' => 'generative_question_config', + 'placeholders' => [ + 'generative_question_config.catalog' => [ + 'getters' => [ + 'getGenerativeQuestionConfig', + 'getCatalog', + ], + ], + ], + ], + 'UpdateGenerativeQuestionsFeatureConfig' => [ + 'method' => 'patch', + 'uriTemplate' => '/v2/{generative_questions_feature_config.catalog=projects/*/locations/*/catalogs/*}/generativeQuestionFeature', + 'body' => 'generative_questions_feature_config', + 'placeholders' => [ + 'generative_questions_feature_config.catalog' => [ + 'getters' => [ + 'getGenerativeQuestionsFeatureConfig', + 'getCatalog', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*/locations/*/catalogs/*/branches/*/operations/*}', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*/locations/*/catalogs/*/operations/*}', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*/operations/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListOperations' => [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*/locations/*}/operations', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*/locations/*/catalogs/*}/operations', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v2/{name=projects/*}/operations', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/Retail/tests/Unit/V2/Client/GenerativeQuestionServiceClientTest.php b/Retail/tests/Unit/V2/Client/GenerativeQuestionServiceClientTest.php new file mode 100644 index 000000000000..e4675523e6c3 --- /dev/null +++ b/Retail/tests/Unit/V2/Client/GenerativeQuestionServiceClientTest.php @@ -0,0 +1,474 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return GenerativeQuestionServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new GenerativeQuestionServiceClient($options); + } + + /** @test */ + public function batchUpdateGenerativeQuestionConfigsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new BatchUpdateGenerativeQuestionConfigsResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $requests = []; + $request = (new BatchUpdateGenerativeQuestionConfigsRequest())->setRequests($requests); + $response = $gapicClient->batchUpdateGenerativeQuestionConfigs($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.retail.v2.GenerativeQuestionService/BatchUpdateGenerativeQuestionConfigs', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getRequests(); + $this->assertProtobufEquals($requests, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function batchUpdateGenerativeQuestionConfigsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $requests = []; + $request = (new BatchUpdateGenerativeQuestionConfigsRequest())->setRequests($requests); + try { + $gapicClient->batchUpdateGenerativeQuestionConfigs($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getGenerativeQuestionsFeatureConfigTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $catalog2 = 'catalog21455933836'; + $featureEnabled = true; + $minimumProducts = 417095051; + $expectedResponse = new GenerativeQuestionsFeatureConfig(); + $expectedResponse->setCatalog($catalog2); + $expectedResponse->setFeatureEnabled($featureEnabled); + $expectedResponse->setMinimumProducts($minimumProducts); + $transport->addResponse($expectedResponse); + // Mock request + $formattedCatalog = $gapicClient->catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]'); + $request = (new GetGenerativeQuestionsFeatureConfigRequest())->setCatalog($formattedCatalog); + $response = $gapicClient->getGenerativeQuestionsFeatureConfig($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.retail.v2.GenerativeQuestionService/GetGenerativeQuestionsFeatureConfig', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getCatalog(); + $this->assertProtobufEquals($formattedCatalog, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getGenerativeQuestionsFeatureConfigExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedCatalog = $gapicClient->catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]'); + $request = (new GetGenerativeQuestionsFeatureConfigRequest())->setCatalog($formattedCatalog); + try { + $gapicClient->getGenerativeQuestionsFeatureConfig($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listGenerativeQuestionConfigsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new ListGenerativeQuestionConfigsResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]'); + $request = (new ListGenerativeQuestionConfigsRequest())->setParent($formattedParent); + $response = $gapicClient->listGenerativeQuestionConfigs($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.retail.v2.GenerativeQuestionService/ListGenerativeQuestionConfigs', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listGenerativeQuestionConfigsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]'); + $request = (new ListGenerativeQuestionConfigsRequest())->setParent($formattedParent); + try { + $gapicClient->listGenerativeQuestionConfigs($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateGenerativeQuestionConfigTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $catalog = 'catalog555704345'; + $facet = 'facet97187255'; + $generatedQuestion = 'generatedQuestion-1515248490'; + $finalQuestion = 'finalQuestion1509683343'; + $frequency = -7002384; + $allowedInConversation = true; + $expectedResponse = new GenerativeQuestionConfig(); + $expectedResponse->setCatalog($catalog); + $expectedResponse->setFacet($facet); + $expectedResponse->setGeneratedQuestion($generatedQuestion); + $expectedResponse->setFinalQuestion($finalQuestion); + $expectedResponse->setFrequency($frequency); + $expectedResponse->setAllowedInConversation($allowedInConversation); + $transport->addResponse($expectedResponse); + // Mock request + $generativeQuestionConfig = new GenerativeQuestionConfig(); + $generativeQuestionConfigCatalog = 'generativeQuestionConfigCatalog-1000208599'; + $generativeQuestionConfig->setCatalog($generativeQuestionConfigCatalog); + $generativeQuestionConfigFacet = 'generativeQuestionConfigFacet-592699193'; + $generativeQuestionConfig->setFacet($generativeQuestionConfigFacet); + $request = (new UpdateGenerativeQuestionConfigRequest())->setGenerativeQuestionConfig( + $generativeQuestionConfig + ); + $response = $gapicClient->updateGenerativeQuestionConfig($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.retail.v2.GenerativeQuestionService/UpdateGenerativeQuestionConfig', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getGenerativeQuestionConfig(); + $this->assertProtobufEquals($generativeQuestionConfig, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateGenerativeQuestionConfigExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $generativeQuestionConfig = new GenerativeQuestionConfig(); + $generativeQuestionConfigCatalog = 'generativeQuestionConfigCatalog-1000208599'; + $generativeQuestionConfig->setCatalog($generativeQuestionConfigCatalog); + $generativeQuestionConfigFacet = 'generativeQuestionConfigFacet-592699193'; + $generativeQuestionConfig->setFacet($generativeQuestionConfigFacet); + $request = (new UpdateGenerativeQuestionConfigRequest())->setGenerativeQuestionConfig( + $generativeQuestionConfig + ); + try { + $gapicClient->updateGenerativeQuestionConfig($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateGenerativeQuestionsFeatureConfigTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $catalog = 'catalog555704345'; + $featureEnabled = true; + $minimumProducts = 417095051; + $expectedResponse = new GenerativeQuestionsFeatureConfig(); + $expectedResponse->setCatalog($catalog); + $expectedResponse->setFeatureEnabled($featureEnabled); + $expectedResponse->setMinimumProducts($minimumProducts); + $transport->addResponse($expectedResponse); + // Mock request + $generativeQuestionsFeatureConfig = new GenerativeQuestionsFeatureConfig(); + $generativeQuestionsFeatureConfigCatalog = 'generativeQuestionsFeatureConfigCatalog-1230760186'; + $generativeQuestionsFeatureConfig->setCatalog($generativeQuestionsFeatureConfigCatalog); + $request = (new UpdateGenerativeQuestionsFeatureConfigRequest())->setGenerativeQuestionsFeatureConfig( + $generativeQuestionsFeatureConfig + ); + $response = $gapicClient->updateGenerativeQuestionsFeatureConfig($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.retail.v2.GenerativeQuestionService/UpdateGenerativeQuestionsFeatureConfig', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getGenerativeQuestionsFeatureConfig(); + $this->assertProtobufEquals($generativeQuestionsFeatureConfig, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateGenerativeQuestionsFeatureConfigExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $generativeQuestionsFeatureConfig = new GenerativeQuestionsFeatureConfig(); + $generativeQuestionsFeatureConfigCatalog = 'generativeQuestionsFeatureConfigCatalog-1230760186'; + $generativeQuestionsFeatureConfig->setCatalog($generativeQuestionsFeatureConfigCatalog); + $request = (new UpdateGenerativeQuestionsFeatureConfigRequest())->setGenerativeQuestionsFeatureConfig( + $generativeQuestionsFeatureConfig + ); + try { + $gapicClient->updateGenerativeQuestionsFeatureConfig($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function batchUpdateGenerativeQuestionConfigsAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new BatchUpdateGenerativeQuestionConfigsResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $requests = []; + $request = (new BatchUpdateGenerativeQuestionConfigsRequest())->setRequests($requests); + $response = $gapicClient->batchUpdateGenerativeQuestionConfigsAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.retail.v2.GenerativeQuestionService/BatchUpdateGenerativeQuestionConfigs', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getRequests(); + $this->assertProtobufEquals($requests, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} From c4a0d8d12ac9210d8b6a767133edb5bce1a0e20a Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:21:26 -0700 Subject: [PATCH 020/157] feat: Support for field update operators in the Datastore API and resolution strategies when there is a conflict at write time (#7733) PiperOrigin-RevId: 683253625 Source-Link: https://github.com/googleapis/googleapis/commit/3effbf23b1a1d1fe1306356e94397e20d01d31a0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/5dd983c76417f2ad88f9d47438c48c27d5ac0e27 Copy-Tag: eyJwIjoiRGF0YXN0b3JlLy5Pd2xCb3QueWFtbCIsImgiOiI1ZGQ5ODNjNzY0MTdmMmFkODhmOWQ0NzQzOGM0OGMyN2Q1YWMwZTI3In0= --- Datastore/metadata/V1/Datastore.php | Bin 7423 -> 8218 bytes Datastore/src/V1/Mutation.php | 88 ++++ .../Mutation/ConflictResolutionStrategy.php | 64 +++ Datastore/src/V1/MutationResult.php | 42 ++ Datastore/src/V1/PropertyTransform.php | 432 ++++++++++++++++++ .../src/V1/PropertyTransform/ServerValue.php | 59 +++ .../V1/resources/datastore_client_config.json | 12 +- 7 files changed, 696 insertions(+), 1 deletion(-) create mode 100644 Datastore/src/V1/Mutation/ConflictResolutionStrategy.php create mode 100644 Datastore/src/V1/PropertyTransform.php create mode 100644 Datastore/src/V1/PropertyTransform/ServerValue.php diff --git a/Datastore/metadata/V1/Datastore.php b/Datastore/metadata/V1/Datastore.php index b06ea5d20319711fd1059809e592d3e73774c20a..5fd0a98c20b1eccf60b4003d2554ea7d8db9aa71 100644 GIT binary patch delta 672 zcmZ{iUu)A)7{-?+TeG*NP0m_&*dI2k=nz_=ApQYi?aa2~lr2dM-gt=hbOiE`b54r| zZ^REEk~=@epw}Ya_!Ybr`~u>&ph;-Dig^8d-sgSJbKc+gKO9{Ckd?1@;aYsDRNs@z zbVF&DmVYYKW33|Hd=A@#Fc^C7KoCZG=#7LM280Xd2zoKWuqW-8TleBOP>V}tb*p(e zQ=4nbj&(I{Kf^yXEo@#RZPH#N^E`xqH zi!)z|YM|yBv6MV;EenCpVVzS!L`XPgW6H?b@kSIcXBD*a=-1~yO)Hc2Q`N~5x(#b? zFksZDfrvj9cB(mOK*4ujx&FwB%e8eTCzJFQ{s3Y8M4qPPReoNYJx0I)E`1|;RR?L@M4$$Hft|6n2}5v~7hgPKyp+gPjIYe2e6suUdbX)-=f#>2V=d@ AssI20 delta 51 zcmV-30L=fIK>s.google.datastore.v1.Mutation.ConflictResolutionStrategy conflict_resolution_strategy = 10; + */ + private $conflict_resolution_strategy = 0; /** * The properties to write in this mutation. * None of the properties in the mask may have a reserved name, except for @@ -27,6 +35,15 @@ class Mutation extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.datastore.v1.PropertyMask property_mask = 9; */ private $property_mask = null; + /** + * Optional. The transforms to perform on the entity. + * This field can be set only when the operation is `insert`, `update`, + * or `upsert`. If present, the transforms are be applied to the entity + * regardless of the property mask, in order, after the operation. + * + * Generated from protobuf field repeated .google.datastore.v1.PropertyTransform property_transforms = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $property_transforms; protected $operation; protected $conflict_detection_strategy; @@ -56,6 +73,10 @@ class Mutation extends \Google\Protobuf\Internal\Message * The update time of the entity that this mutation is being applied * to. If this does not match the current update time on the server, the * mutation conflicts. + * @type int $conflict_resolution_strategy + * The strategy to use when a conflict is detected. Defaults to + * `SERVER_VALUE`. + * If this is set, then `conflict_detection_strategy` must also be set. * @type \Google\Cloud\Datastore\V1\PropertyMask $property_mask * The properties to write in this mutation. * None of the properties in the mask may have a reserved name, except for @@ -64,6 +85,11 @@ class Mutation extends \Google\Protobuf\Internal\Message * If the entity already exists, only properties referenced in the mask are * updated, others are left untouched. * Properties referenced in the mask but not in the entity are deleted. + * @type array<\Google\Cloud\Datastore\V1\PropertyTransform>|\Google\Protobuf\Internal\RepeatedField $property_transforms + * Optional. The transforms to perform on the entity. + * This field can be set only when the operation is `insert`, `update`, + * or `upsert`. If present, the transforms are be applied to the entity + * regardless of the property mask, in order, after the operation. * } */ public function __construct($data = NULL) { @@ -273,6 +299,36 @@ public function setUpdateTime($var) return $this; } + /** + * The strategy to use when a conflict is detected. Defaults to + * `SERVER_VALUE`. + * If this is set, then `conflict_detection_strategy` must also be set. + * + * Generated from protobuf field .google.datastore.v1.Mutation.ConflictResolutionStrategy conflict_resolution_strategy = 10; + * @return int + */ + public function getConflictResolutionStrategy() + { + return $this->conflict_resolution_strategy; + } + + /** + * The strategy to use when a conflict is detected. Defaults to + * `SERVER_VALUE`. + * If this is set, then `conflict_detection_strategy` must also be set. + * + * Generated from protobuf field .google.datastore.v1.Mutation.ConflictResolutionStrategy conflict_resolution_strategy = 10; + * @param int $var + * @return $this + */ + public function setConflictResolutionStrategy($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Datastore\V1\Mutation\ConflictResolutionStrategy::class); + $this->conflict_resolution_strategy = $var; + + return $this; + } + /** * The properties to write in this mutation. * None of the properties in the mask may have a reserved name, except for @@ -321,6 +377,38 @@ public function setPropertyMask($var) return $this; } + /** + * Optional. The transforms to perform on the entity. + * This field can be set only when the operation is `insert`, `update`, + * or `upsert`. If present, the transforms are be applied to the entity + * regardless of the property mask, in order, after the operation. + * + * Generated from protobuf field repeated .google.datastore.v1.PropertyTransform property_transforms = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPropertyTransforms() + { + return $this->property_transforms; + } + + /** + * Optional. The transforms to perform on the entity. + * This field can be set only when the operation is `insert`, `update`, + * or `upsert`. If present, the transforms are be applied to the entity + * regardless of the property mask, in order, after the operation. + * + * Generated from protobuf field repeated .google.datastore.v1.PropertyTransform property_transforms = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Datastore\V1\PropertyTransform>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPropertyTransforms($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Datastore\V1\PropertyTransform::class); + $this->property_transforms = $arr; + + return $this; + } + /** * @return string */ diff --git a/Datastore/src/V1/Mutation/ConflictResolutionStrategy.php b/Datastore/src/V1/Mutation/ConflictResolutionStrategy.php new file mode 100644 index 000000000000..f2809890ebe1 --- /dev/null +++ b/Datastore/src/V1/Mutation/ConflictResolutionStrategy.php @@ -0,0 +1,64 @@ +google.datastore.v1.Mutation.ConflictResolutionStrategy + */ +class ConflictResolutionStrategy +{ + /** + * Unspecified. Defaults to `SERVER_VALUE`. + * + * Generated from protobuf enum STRATEGY_UNSPECIFIED = 0; + */ + const STRATEGY_UNSPECIFIED = 0; + /** + * The server entity is kept. + * + * Generated from protobuf enum SERVER_VALUE = 1; + */ + const SERVER_VALUE = 1; + /** + * The whole commit request fails. + * + * Generated from protobuf enum FAIL = 3; + */ + const FAIL = 3; + + private static $valueToName = [ + self::STRATEGY_UNSPECIFIED => 'STRATEGY_UNSPECIFIED', + self::SERVER_VALUE => 'SERVER_VALUE', + self::FAIL => 'FAIL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(ConflictResolutionStrategy::class, \Google\Cloud\Datastore\V1\Mutation_ConflictResolutionStrategy::class); + diff --git a/Datastore/src/V1/MutationResult.php b/Datastore/src/V1/MutationResult.php index a5a507fbbd95..388e3aae280f 100644 --- a/Datastore/src/V1/MutationResult.php +++ b/Datastore/src/V1/MutationResult.php @@ -54,6 +54,14 @@ class MutationResult extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool conflict_detected = 5; */ private $conflict_detected = false; + /** + * The results of applying each + * [PropertyTransform][google.datastore.v1.PropertyTransform], in the same + * order of the request. + * + * Generated from protobuf field repeated .google.datastore.v1.Value transform_results = 8; + */ + private $transform_results; /** * Constructor. @@ -80,6 +88,10 @@ class MutationResult extends \Google\Protobuf\Internal\Message * @type bool $conflict_detected * Whether a conflict was detected for this mutation. Always false when a * conflict detection strategy field is not set in the mutation. + * @type array<\Google\Cloud\Datastore\V1\Value>|\Google\Protobuf\Internal\RepeatedField $transform_results + * The results of applying each + * [PropertyTransform][google.datastore.v1.PropertyTransform], in the same + * order of the request. * } */ public function __construct($data = NULL) { @@ -265,5 +277,35 @@ public function setConflictDetected($var) return $this; } + /** + * The results of applying each + * [PropertyTransform][google.datastore.v1.PropertyTransform], in the same + * order of the request. + * + * Generated from protobuf field repeated .google.datastore.v1.Value transform_results = 8; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTransformResults() + { + return $this->transform_results; + } + + /** + * The results of applying each + * [PropertyTransform][google.datastore.v1.PropertyTransform], in the same + * order of the request. + * + * Generated from protobuf field repeated .google.datastore.v1.Value transform_results = 8; + * @param array<\Google\Cloud\Datastore\V1\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTransformResults($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Datastore\V1\Value::class); + $this->transform_results = $arr; + + return $this; + } + } diff --git a/Datastore/src/V1/PropertyTransform.php b/Datastore/src/V1/PropertyTransform.php new file mode 100644 index 000000000000..5be9066dcaa6 --- /dev/null +++ b/Datastore/src/V1/PropertyTransform.php @@ -0,0 +1,432 @@ +google.datastore.v1.PropertyTransform + */ +class PropertyTransform extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The name of the property. + * Property paths (a list of property names separated by dots (`.`)) may be + * used to refer to properties inside entity values. For example `foo.bar` + * means the property `bar` inside the entity property `foo`. + * If a property name contains a dot `.` or a backlslash `\`, then that name + * must be escaped. + * + * Generated from protobuf field string property = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $property = ''; + protected $transform_type; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $property + * Optional. The name of the property. + * Property paths (a list of property names separated by dots (`.`)) may be + * used to refer to properties inside entity values. For example `foo.bar` + * means the property `bar` inside the entity property `foo`. + * If a property name contains a dot `.` or a backlslash `\`, then that name + * must be escaped. + * @type int $set_to_server_value + * Sets the property to the given server value. + * @type \Google\Cloud\Datastore\V1\Value $increment + * Adds the given value to the property's current value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the given value. + * If either of the given value or the current property value are doubles, + * both values will be interpreted as doubles. Double arithmetic and + * representation of double values follows IEEE 754 semantics. + * If there is positive/negative integer overflow, the property is resolved + * to the largest magnitude positive/negative integer. + * @type \Google\Cloud\Datastore\V1\Value $maximum + * Sets the property to the maximum of its current value and the given + * value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the given value. + * If a maximum operation is applied where the property and the input value + * are of mixed types (that is - one is an integer and one is a double) + * the property takes on the type of the larger operand. If the operands are + * equivalent (e.g. 3 and 3.0), the property does not change. + * 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and + * zero input value is always the stored value. + * The maximum of any numeric value x and NaN is NaN. + * @type \Google\Cloud\Datastore\V1\Value $minimum + * Sets the property to the minimum of its current value and the given + * value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the input value. + * If a minimum operation is applied where the property and the input value + * are of mixed types (that is - one is an integer and one is a double) + * the property takes on the type of the smaller operand. If the operands + * are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, + * and -0.0 are all zero. The minimum of a zero stored value and zero input + * value is always the stored value. The minimum of any numeric value x and + * NaN is NaN. + * @type \Google\Cloud\Datastore\V1\ArrayValue $append_missing_elements + * Appends the given elements in order if they are not already present in + * the current property value. + * If the property is not an array, or if the property does not yet exist, + * it is first set to the empty array. + * Equivalent numbers of different types (e.g. 3L and 3.0) are + * considered equal when checking if a value is missing. + * NaN is equal to NaN, and the null value is equal to the null value. + * If the input contains multiple equivalent values, only the first will + * be considered. + * The corresponding transform result will be the null value. + * @type \Google\Cloud\Datastore\V1\ArrayValue $remove_all_from_array + * Removes all of the given elements from the array in the property. + * If the property is not an array, or if the property does not yet exist, + * it is set to the empty array. + * Equivalent numbers of different types (e.g. 3L and 3.0) are + * considered equal when deciding whether an element should be removed. + * NaN is equal to NaN, and the null value is equal to the null value. + * This will remove all equivalent values if there are duplicates. + * The corresponding transform result will be the null value. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Datastore\V1\Datastore::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The name of the property. + * Property paths (a list of property names separated by dots (`.`)) may be + * used to refer to properties inside entity values. For example `foo.bar` + * means the property `bar` inside the entity property `foo`. + * If a property name contains a dot `.` or a backlslash `\`, then that name + * must be escaped. + * + * Generated from protobuf field string property = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getProperty() + { + return $this->property; + } + + /** + * Optional. The name of the property. + * Property paths (a list of property names separated by dots (`.`)) may be + * used to refer to properties inside entity values. For example `foo.bar` + * means the property `bar` inside the entity property `foo`. + * If a property name contains a dot `.` or a backlslash `\`, then that name + * must be escaped. + * + * Generated from protobuf field string property = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setProperty($var) + { + GPBUtil::checkString($var, True); + $this->property = $var; + + return $this; + } + + /** + * Sets the property to the given server value. + * + * Generated from protobuf field .google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2; + * @return int + */ + public function getSetToServerValue() + { + return $this->readOneof(2); + } + + public function hasSetToServerValue() + { + return $this->hasOneof(2); + } + + /** + * Sets the property to the given server value. + * + * Generated from protobuf field .google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2; + * @param int $var + * @return $this + */ + public function setSetToServerValue($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Datastore\V1\PropertyTransform\ServerValue::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Adds the given value to the property's current value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the given value. + * If either of the given value or the current property value are doubles, + * both values will be interpreted as doubles. Double arithmetic and + * representation of double values follows IEEE 754 semantics. + * If there is positive/negative integer overflow, the property is resolved + * to the largest magnitude positive/negative integer. + * + * Generated from protobuf field .google.datastore.v1.Value increment = 3; + * @return \Google\Cloud\Datastore\V1\Value|null + */ + public function getIncrement() + { + return $this->readOneof(3); + } + + public function hasIncrement() + { + return $this->hasOneof(3); + } + + /** + * Adds the given value to the property's current value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the given value. + * If either of the given value or the current property value are doubles, + * both values will be interpreted as doubles. Double arithmetic and + * representation of double values follows IEEE 754 semantics. + * If there is positive/negative integer overflow, the property is resolved + * to the largest magnitude positive/negative integer. + * + * Generated from protobuf field .google.datastore.v1.Value increment = 3; + * @param \Google\Cloud\Datastore\V1\Value $var + * @return $this + */ + public function setIncrement($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Datastore\V1\Value::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Sets the property to the maximum of its current value and the given + * value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the given value. + * If a maximum operation is applied where the property and the input value + * are of mixed types (that is - one is an integer and one is a double) + * the property takes on the type of the larger operand. If the operands are + * equivalent (e.g. 3 and 3.0), the property does not change. + * 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and + * zero input value is always the stored value. + * The maximum of any numeric value x and NaN is NaN. + * + * Generated from protobuf field .google.datastore.v1.Value maximum = 4; + * @return \Google\Cloud\Datastore\V1\Value|null + */ + public function getMaximum() + { + return $this->readOneof(4); + } + + public function hasMaximum() + { + return $this->hasOneof(4); + } + + /** + * Sets the property to the maximum of its current value and the given + * value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the given value. + * If a maximum operation is applied where the property and the input value + * are of mixed types (that is - one is an integer and one is a double) + * the property takes on the type of the larger operand. If the operands are + * equivalent (e.g. 3 and 3.0), the property does not change. + * 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and + * zero input value is always the stored value. + * The maximum of any numeric value x and NaN is NaN. + * + * Generated from protobuf field .google.datastore.v1.Value maximum = 4; + * @param \Google\Cloud\Datastore\V1\Value $var + * @return $this + */ + public function setMaximum($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Datastore\V1\Value::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * Sets the property to the minimum of its current value and the given + * value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the input value. + * If a minimum operation is applied where the property and the input value + * are of mixed types (that is - one is an integer and one is a double) + * the property takes on the type of the smaller operand. If the operands + * are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, + * and -0.0 are all zero. The minimum of a zero stored value and zero input + * value is always the stored value. The minimum of any numeric value x and + * NaN is NaN. + * + * Generated from protobuf field .google.datastore.v1.Value minimum = 5; + * @return \Google\Cloud\Datastore\V1\Value|null + */ + public function getMinimum() + { + return $this->readOneof(5); + } + + public function hasMinimum() + { + return $this->hasOneof(5); + } + + /** + * Sets the property to the minimum of its current value and the given + * value. + * This must be an integer or a double value. + * If the property is not an integer or double, or if the property does not + * yet exist, the transformation will set the property to the input value. + * If a minimum operation is applied where the property and the input value + * are of mixed types (that is - one is an integer and one is a double) + * the property takes on the type of the smaller operand. If the operands + * are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, + * and -0.0 are all zero. The minimum of a zero stored value and zero input + * value is always the stored value. The minimum of any numeric value x and + * NaN is NaN. + * + * Generated from protobuf field .google.datastore.v1.Value minimum = 5; + * @param \Google\Cloud\Datastore\V1\Value $var + * @return $this + */ + public function setMinimum($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Datastore\V1\Value::class); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * Appends the given elements in order if they are not already present in + * the current property value. + * If the property is not an array, or if the property does not yet exist, + * it is first set to the empty array. + * Equivalent numbers of different types (e.g. 3L and 3.0) are + * considered equal when checking if a value is missing. + * NaN is equal to NaN, and the null value is equal to the null value. + * If the input contains multiple equivalent values, only the first will + * be considered. + * The corresponding transform result will be the null value. + * + * Generated from protobuf field .google.datastore.v1.ArrayValue append_missing_elements = 6; + * @return \Google\Cloud\Datastore\V1\ArrayValue|null + */ + public function getAppendMissingElements() + { + return $this->readOneof(6); + } + + public function hasAppendMissingElements() + { + return $this->hasOneof(6); + } + + /** + * Appends the given elements in order if they are not already present in + * the current property value. + * If the property is not an array, or if the property does not yet exist, + * it is first set to the empty array. + * Equivalent numbers of different types (e.g. 3L and 3.0) are + * considered equal when checking if a value is missing. + * NaN is equal to NaN, and the null value is equal to the null value. + * If the input contains multiple equivalent values, only the first will + * be considered. + * The corresponding transform result will be the null value. + * + * Generated from protobuf field .google.datastore.v1.ArrayValue append_missing_elements = 6; + * @param \Google\Cloud\Datastore\V1\ArrayValue $var + * @return $this + */ + public function setAppendMissingElements($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Datastore\V1\ArrayValue::class); + $this->writeOneof(6, $var); + + return $this; + } + + /** + * Removes all of the given elements from the array in the property. + * If the property is not an array, or if the property does not yet exist, + * it is set to the empty array. + * Equivalent numbers of different types (e.g. 3L and 3.0) are + * considered equal when deciding whether an element should be removed. + * NaN is equal to NaN, and the null value is equal to the null value. + * This will remove all equivalent values if there are duplicates. + * The corresponding transform result will be the null value. + * + * Generated from protobuf field .google.datastore.v1.ArrayValue remove_all_from_array = 7; + * @return \Google\Cloud\Datastore\V1\ArrayValue|null + */ + public function getRemoveAllFromArray() + { + return $this->readOneof(7); + } + + public function hasRemoveAllFromArray() + { + return $this->hasOneof(7); + } + + /** + * Removes all of the given elements from the array in the property. + * If the property is not an array, or if the property does not yet exist, + * it is set to the empty array. + * Equivalent numbers of different types (e.g. 3L and 3.0) are + * considered equal when deciding whether an element should be removed. + * NaN is equal to NaN, and the null value is equal to the null value. + * This will remove all equivalent values if there are duplicates. + * The corresponding transform result will be the null value. + * + * Generated from protobuf field .google.datastore.v1.ArrayValue remove_all_from_array = 7; + * @param \Google\Cloud\Datastore\V1\ArrayValue $var + * @return $this + */ + public function setRemoveAllFromArray($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Datastore\V1\ArrayValue::class); + $this->writeOneof(7, $var); + + return $this; + } + + /** + * @return string + */ + public function getTransformType() + { + return $this->whichOneof("transform_type"); + } + +} + diff --git a/Datastore/src/V1/PropertyTransform/ServerValue.php b/Datastore/src/V1/PropertyTransform/ServerValue.php new file mode 100644 index 000000000000..6162f10f4c4d --- /dev/null +++ b/Datastore/src/V1/PropertyTransform/ServerValue.php @@ -0,0 +1,59 @@ +google.datastore.v1.PropertyTransform.ServerValue + */ +class ServerValue +{ + /** + * Unspecified. This value must not be used. + * + * Generated from protobuf enum SERVER_VALUE_UNSPECIFIED = 0; + */ + const SERVER_VALUE_UNSPECIFIED = 0; + /** + * The time at which the server processed the request, with millisecond + * precision. If used on multiple properties (same or different entities) + * in a transaction, all the properties will get the same server timestamp. + * + * Generated from protobuf enum REQUEST_TIME = 1; + */ + const REQUEST_TIME = 1; + + private static $valueToName = [ + self::SERVER_VALUE_UNSPECIFIED => 'SERVER_VALUE_UNSPECIFIED', + self::REQUEST_TIME => 'REQUEST_TIME', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(ServerValue::class, \Google\Cloud\Datastore\V1\PropertyTransform_ServerValue::class); + diff --git a/Datastore/src/V1/resources/datastore_client_config.json b/Datastore/src/V1/resources/datastore_client_config.json index 135281a0a986..081d5f9f6b62 100644 --- a/Datastore/src/V1/resources/datastore_client_config.json +++ b/Datastore/src/V1/resources/datastore_client_config.json @@ -7,7 +7,8 @@ "UNAVAILABLE", "DEADLINE_EXCEEDED" ], - "no_retry_1_codes": [] + "no_retry_1_codes": [], + "no_retry_2_codes": [] }, "retry_params": { "no_retry_params": { @@ -36,6 +37,15 @@ "rpc_timeout_multiplier": 1.0, "max_rpc_timeout_millis": 60000, "total_timeout_millis": 60000 + }, + "no_retry_2_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 } }, "methods": { From 3252d24783823082ea5e0af837be3cbd84854639 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 18:23:13 +0000 Subject: [PATCH 021/157] feat: add Order modification RPCs and License Management Service (#7729) docs: A comment for enum value `LINE_ITEM_CHANGE_STATE_PENDING_APPROVAL` in enum `LineItemChangeState` is changed docs: A comment for enum value `LINE_ITEM_CHANGE_STATE_APPROVED` in enum `LineItemChangeState` is changed docs: A comment for enum value `LINE_ITEM_CHANGE_STATE_COMPLETED` in enum `LineItemChangeState` is changed docs: A comment for enum value `LINE_ITEM_CHANGE_STATE_REJECTED` in enum `LineItemChangeState` is changed docs: A comment for enum value `LINE_ITEM_CHANGE_STATE_ABANDONED` in enum `LineItemChangeState` is changed docs: A comment for enum value `LINE_ITEM_CHANGE_STATE_ACTIVATING` in enum `LineItemChangeState` is changed docs: A comment for field `request_id` in message `.google.cloud.commerce.consumer.procurement.v1.PlaceOrderRequest` is changed docs: A comment for field `filter` in message `.google.cloud.commerce.consumer.procurement.v1.ListOrdersRequest` is changed PiperOrigin-RevId: 682457622 Source-Link: https://github.com/googleapis/googleapis/commit/1f8352cf46df74d7db6fd544181655c590689b8c Source-Link: https://github.com/googleapis/googleapis-gen/commit/172720068f2259b365a56a22a0c7c2a6d446c732 Copy-Tag: eyJwIjoiQ29tbWVyY2VDb25zdW1lclByb2N1cmVtZW50Ly5Pd2xCb3QueWFtbCIsImgiOiIxNzI3MjAwNjhmMjI1OWIzNjVhNTZhMjJhMGM3YzJhNmQ0NDZjNzMyIn0= --- .../metadata/V1/LicenseManagementService.php | Bin 0 -> 4558 bytes .../metadata/V1/ProcurementService.php | Bin 2812 -> 4255 bytes .../cancel_order.php | 84 ++++ .../modify_order.php | 83 +++ .../LicenseManagementServiceClient/assign.php | 75 +++ .../enumerate_licensed_users.php | 75 +++ .../get_license_pool.php | 71 +++ .../unassign.php | 75 +++ .../update_license_pool.php | 65 +++ .../src/V1/AssignRequest.php | 122 +++++ .../src/V1/AssignResponse.php | 34 ++ .../src/V1/AssignmentProtocol.php | 108 ++++ .../AssignmentProtocol/AutoAssignmentType.php | 86 ++++ .../ManualAssignmentType.php | 34 ++ .../src/V1/AutoRenewalBehavior.php | 61 +++ .../src/V1/CancelOrderMetadata.php | 34 ++ .../src/V1/CancelOrderRequest.php | 144 ++++++ .../CancelOrderRequest/CancellationPolicy.php | 68 +++ .../ConsumerProcurementServiceClient.php | 61 +++ .../Client/LicenseManagementServiceClient.php | 357 +++++++++++++ .../src/V1/EnumerateLicensedUsersRequest.php | 157 ++++++ .../src/V1/EnumerateLicensedUsersResponse.php | 106 ++++ .../src/V1/GetLicensePoolRequest.php | 85 ++++ .../src/V1/LicensePool.php | 183 +++++++ .../src/V1/LicensedUser.php | 167 +++++++ .../src/V1/LineItemChangeState.php | 24 +- .../src/V1/ModifyOrderMetadata.php | 34 ++ .../src/V1/ModifyOrderRequest.php | 190 +++++++ .../V1/ModifyOrderRequest/Modification.php | 216 ++++++++ .../src/V1/PlaceOrderRequest.php | 8 +- .../src/V1/UnassignRequest.php | 122 +++++ .../src/V1/UnassignResponse.php | 34 ++ .../src/V1/UpdateLicensePoolRequest.php | 152 ++++++ .../src/V1/gapic_metadata.json | 44 ++ ...mer_procurement_service_client_config.json | 10 + ..._procurement_service_descriptor_config.php | 38 ++ ...procurement_service_rest_client_config.php | 24 + ...ense_management_service_client_config.json | 47 ++ ...e_management_service_descriptor_config.php | 100 ++++ ..._management_service_rest_client_config.php | 104 ++++ .../ConsumerProcurementServiceClientTest.php | 329 +++++++++++- .../LicenseManagementServiceClientTest.php | 472 ++++++++++++++++++ 42 files changed, 4255 insertions(+), 28 deletions(-) create mode 100644 CommerceConsumerProcurement/metadata/V1/LicenseManagementService.php create mode 100644 CommerceConsumerProcurement/samples/V1/ConsumerProcurementServiceClient/cancel_order.php create mode 100644 CommerceConsumerProcurement/samples/V1/ConsumerProcurementServiceClient/modify_order.php create mode 100644 CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/assign.php create mode 100644 CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/enumerate_licensed_users.php create mode 100644 CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/get_license_pool.php create mode 100644 CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/unassign.php create mode 100644 CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/update_license_pool.php create mode 100644 CommerceConsumerProcurement/src/V1/AssignRequest.php create mode 100644 CommerceConsumerProcurement/src/V1/AssignResponse.php create mode 100644 CommerceConsumerProcurement/src/V1/AssignmentProtocol.php create mode 100644 CommerceConsumerProcurement/src/V1/AssignmentProtocol/AutoAssignmentType.php create mode 100644 CommerceConsumerProcurement/src/V1/AssignmentProtocol/ManualAssignmentType.php create mode 100644 CommerceConsumerProcurement/src/V1/AutoRenewalBehavior.php create mode 100644 CommerceConsumerProcurement/src/V1/CancelOrderMetadata.php create mode 100644 CommerceConsumerProcurement/src/V1/CancelOrderRequest.php create mode 100644 CommerceConsumerProcurement/src/V1/CancelOrderRequest/CancellationPolicy.php create mode 100644 CommerceConsumerProcurement/src/V1/Client/LicenseManagementServiceClient.php create mode 100644 CommerceConsumerProcurement/src/V1/EnumerateLicensedUsersRequest.php create mode 100644 CommerceConsumerProcurement/src/V1/EnumerateLicensedUsersResponse.php create mode 100644 CommerceConsumerProcurement/src/V1/GetLicensePoolRequest.php create mode 100644 CommerceConsumerProcurement/src/V1/LicensePool.php create mode 100644 CommerceConsumerProcurement/src/V1/LicensedUser.php create mode 100644 CommerceConsumerProcurement/src/V1/ModifyOrderMetadata.php create mode 100644 CommerceConsumerProcurement/src/V1/ModifyOrderRequest.php create mode 100644 CommerceConsumerProcurement/src/V1/ModifyOrderRequest/Modification.php create mode 100644 CommerceConsumerProcurement/src/V1/UnassignRequest.php create mode 100644 CommerceConsumerProcurement/src/V1/UnassignResponse.php create mode 100644 CommerceConsumerProcurement/src/V1/UpdateLicensePoolRequest.php create mode 100644 CommerceConsumerProcurement/src/V1/resources/license_management_service_client_config.json create mode 100644 CommerceConsumerProcurement/src/V1/resources/license_management_service_descriptor_config.php create mode 100644 CommerceConsumerProcurement/src/V1/resources/license_management_service_rest_client_config.php create mode 100644 CommerceConsumerProcurement/tests/Unit/V1/Client/LicenseManagementServiceClientTest.php diff --git a/CommerceConsumerProcurement/metadata/V1/LicenseManagementService.php b/CommerceConsumerProcurement/metadata/V1/LicenseManagementService.php new file mode 100644 index 0000000000000000000000000000000000000000..35aced28e7f0829a92dadae768219623ba3feed1 GIT binary patch literal 4558 zcmb_gPjAy^7@t#y;4OpJu(kxjybOs_QAa5|xh>$f&@oYnpsgkr$$I0wNv%4zv0oP$ z%4IuF+JQ+s>V9-rt(k1~d?^Vja=aL{HP8$cf#qT-^iTB{H z$)OPnaGN9%c8RfGUD+TMH!#Jub&gV7Whk{(i2@e_rB>~t)V3>&2)RB^662mg+sMEk z2`uyi8SodSb@0bXD5mi5vX?ks;873z-ZzkuWuuAxgn+Sr*=8EJ)C&WHDLe>VGJDk! zHks_@D1;0y8_H|&j)suX+TDPXIKX~wjU;aDMKp}7AZl4HLbFn^JF{0MEHmddjalKN zW%W6^Y|uC*d33{w2~Fc*k^9XIbh4}3fSlTqSF?j4WLbcGT2?ovu8G4GSA7pEJDScN zkNAxhvV-@$Fdj|yA(3r2w3Aux*HUP72yl47OqDylfs@@M=x%z@&J?$!!MeOv=5Khi zG3-Vo>w`Nmce7dLSRJpRR~OLz_d9Uu=$DL#bk^vUZ>=$sc|V7fixDCVZrpV7FF z=ar8t>86^om9c+pZDkUjIgr%Sn*th_q|9hepG3zP-*bZ}nbrw?7hO!ML=i|EHjnEC#fX=Wwe8{B6bOW8GK#zWw10iuNldyi)UfVxu zXpy_4W=M??_?}IW=q4DRgpFD`pNpls=lfpJvR!UIDZh|694zj1%3<6fF+AY^JL+Z1 zGC6ljCXM|_7RGbGN^|JrbwYDc56P1hNU1;jh0-q?n%Rorl}iT5Zy|-^L;xe(z#6d@ zIm4m|pQG`VL&8>&?8*ukmDQ}dG8X1qr6u%{=x!CwS#&(YF${ONn+p0AI+?PwphUA!HzHK?1<#um7fybU3O<;Y23 z4dL0~ZK&zf2=V(g+$90;Pacd`da0pPGOOIYK7mfCs6{e#$gzmcVZ?Z7jZA$ti0cZ1>aS0)Zs`XNT{fV4Oh@U~zRl_J+du#Pv2b0l zum$=BYvtvGR57QhVJ=S!9sTh+}&Q=rI#6K8Sxh}x1CzS_4Z1XW#AW18@gZaDU>ysABZB*%7X*AkY6`|p6zDal~+o>CQll=M-APxhMvO)IBj@cSP&qV w#Zlm&gke_#$Fg!jmbG1}9|uQic>PNDfp<-O$mhQM5B=unlH%LEgE|QP4=IX5a{vGU literal 0 HcmV?d00001 diff --git a/CommerceConsumerProcurement/metadata/V1/ProcurementService.php b/CommerceConsumerProcurement/metadata/V1/ProcurementService.php index 7be6cab52a7b1bd3c08f5b7f793e1d2d4c09608b..f71ca250fd217982a381b89c4289a0f7a74c6879 100644 GIT binary patch delta 1033 zcmaiz!Ee$~9LH@7+jwjQA0cCk5m=^#EF|k?37#J18Jm$pIfA91C_WS$3*I(K9#Sd=<{?pcMB0LnN z(j*38)9ISMackJ6!w!9MK}RmU4Pv(5r#Y^`l@oR08u9Qs*y#J9Y3Q!$*rVJ^K`19h zbvj8@ud0h4!DvqV7989H>s@m+u=Fuu?(xu_^FK&k{VW%|8QuBDgLP&*_wePGX;Wgl zv`@@#B-|!E0ZHRrx6deX#{-({A~MG#S_V%Mq+^God+A8o&spomn33p_ne&I zX_Mk3Upsvj&lGwft6#Vd8B!0{E%J<>>zAf8WLZ;UJtzQqNGBlbbAT;f%7RR!oTj&B zS9kT&XC6RFw+(9julTSUegJ~^x7i6&ESf(*%(Nm%pBwBQ@2BSdKW|AP| zJ1z_pJ%iiezJyc>D+iDt?L-LhASlI+9zRzw#D9 z{txa3!z!vP*b7+%_m&e4`G6t3c)d3JxMK1Ue&Ikea=nl}xz+jaFul9FTR!@V@*vJG z87_MXZ@&MW@_VJ->E7B-zSd{|VvVaX=g9t{b1+(Tj-X*xQD;yy*n{z$XWNM%+;2=H BIL`n8 delta 29 lcmbQQ_(ya@A2ZVezReSu)tQ-%&aiGi$(6~p`550#MgX7<3X1>$ diff --git a/CommerceConsumerProcurement/samples/V1/ConsumerProcurementServiceClient/cancel_order.php b/CommerceConsumerProcurement/samples/V1/ConsumerProcurementServiceClient/cancel_order.php new file mode 100644 index 000000000000..34945b1ab793 --- /dev/null +++ b/CommerceConsumerProcurement/samples/V1/ConsumerProcurementServiceClient/cancel_order.php @@ -0,0 +1,84 @@ +setName($name); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $consumerProcurementServiceClient->cancelOrder($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Order $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]'; + + cancel_order_sample($name); +} +// [END cloudcommerceconsumerprocurement_v1_generated_ConsumerProcurementService_CancelOrder_sync] diff --git a/CommerceConsumerProcurement/samples/V1/ConsumerProcurementServiceClient/modify_order.php b/CommerceConsumerProcurement/samples/V1/ConsumerProcurementServiceClient/modify_order.php new file mode 100644 index 000000000000..2ea79ce79c8f --- /dev/null +++ b/CommerceConsumerProcurement/samples/V1/ConsumerProcurementServiceClient/modify_order.php @@ -0,0 +1,83 @@ +setName($name); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $consumerProcurementServiceClient->modifyOrder($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Order $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]'; + + modify_order_sample($name); +} +// [END cloudcommerceconsumerprocurement_v1_generated_ConsumerProcurementService_ModifyOrder_sync] diff --git a/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/assign.php b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/assign.php new file mode 100644 index 000000000000..c33ec70102dc --- /dev/null +++ b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/assign.php @@ -0,0 +1,75 @@ +setParent($parent) + ->setUsernames($usernames); + + // Call the API and handle any network failures. + try { + /** @var AssignResponse $response */ + $response = $licenseManagementServiceClient->assign($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $parent = '[PARENT]'; + $usernamesElement = '[USERNAMES]'; + + assign_sample($parent, $usernamesElement); +} +// [END cloudcommerceconsumerprocurement_v1_generated_LicenseManagementService_Assign_sync] diff --git a/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/enumerate_licensed_users.php b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/enumerate_licensed_users.php new file mode 100644 index 000000000000..c5a983d791d4 --- /dev/null +++ b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/enumerate_licensed_users.php @@ -0,0 +1,75 @@ +setParent($parent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $licenseManagementServiceClient->enumerateLicensedUsers($request); + + /** @var LicensedUser $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $parent = '[PARENT]'; + + enumerate_licensed_users_sample($parent); +} +// [END cloudcommerceconsumerprocurement_v1_generated_LicenseManagementService_EnumerateLicensedUsers_sync] diff --git a/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/get_license_pool.php b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/get_license_pool.php new file mode 100644 index 000000000000..623e2151ab21 --- /dev/null +++ b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/get_license_pool.php @@ -0,0 +1,71 @@ +setName($name); + + // Call the API and handle any network failures. + try { + /** @var LicensePool $response */ + $response = $licenseManagementServiceClient->getLicensePool($request); + printf('Response data: %s' . PHP_EOL, $response->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]'; + + get_license_pool_sample($name); +} +// [END cloudcommerceconsumerprocurement_v1_generated_LicenseManagementService_GetLicensePool_sync] diff --git a/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/unassign.php b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/unassign.php new file mode 100644 index 000000000000..2843103ad5d2 --- /dev/null +++ b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/unassign.php @@ -0,0 +1,75 @@ +setParent($parent) + ->setUsernames($usernames); + + // Call the API and handle any network failures. + try { + /** @var UnassignResponse $response */ + $response = $licenseManagementServiceClient->unassign($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $parent = '[PARENT]'; + $usernamesElement = '[USERNAMES]'; + + unassign_sample($parent, $usernamesElement); +} +// [END cloudcommerceconsumerprocurement_v1_generated_LicenseManagementService_Unassign_sync] diff --git a/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/update_license_pool.php b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/update_license_pool.php new file mode 100644 index 000000000000..29d7325e6ec6 --- /dev/null +++ b/CommerceConsumerProcurement/samples/V1/LicenseManagementServiceClient/update_license_pool.php @@ -0,0 +1,65 @@ +setLicenseAssignmentProtocol($licensePoolLicenseAssignmentProtocol); + $updateMask = new FieldMask(); + $request = (new UpdateLicensePoolRequest()) + ->setLicensePool($licensePool) + ->setUpdateMask($updateMask); + + // Call the API and handle any network failures. + try { + /** @var LicensePool $response */ + $response = $licenseManagementServiceClient->updateLicensePool($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END cloudcommerceconsumerprocurement_v1_generated_LicenseManagementService_UpdateLicensePool_sync] diff --git a/CommerceConsumerProcurement/src/V1/AssignRequest.php b/CommerceConsumerProcurement/src/V1/AssignRequest.php new file mode 100644 index 000000000000..7cad3988cfd4 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/AssignRequest.php @@ -0,0 +1,122 @@ +google.cloud.commerce.consumer.procurement.v1.AssignRequest + */ +class AssignRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $parent = ''; + /** + * Required. Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field repeated string usernames = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $usernames; + + /** + * @param string $parent Required. License pool name. + * @param string[] $usernames Required. Username. + * Format: `name@domain.com`. + * + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignRequest + * + * @experimental + */ + public static function build(string $parent, array $usernames): self + { + return (new self()) + ->setParent($parent) + ->setUsernames($usernames); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. License pool name. + * @type array|\Google\Protobuf\Internal\RepeatedField $usernames + * Required. Username. + * Format: `name@domain.com`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field repeated string usernames = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUsernames() + { + return $this->usernames; + } + + /** + * Required. Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field repeated string usernames = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUsernames($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->usernames = $arr; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/AssignResponse.php b/CommerceConsumerProcurement/src/V1/AssignResponse.php new file mode 100644 index 000000000000..8dc2ea6b662b --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/AssignResponse.php @@ -0,0 +1,34 @@ +google.cloud.commerce.consumer.procurement.v1.AssignResponse + */ +class AssignResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/AssignmentProtocol.php b/CommerceConsumerProcurement/src/V1/AssignmentProtocol.php new file mode 100644 index 000000000000..1d068020ee10 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/AssignmentProtocol.php @@ -0,0 +1,108 @@ +google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol + */ +class AssignmentProtocol extends \Google\Protobuf\Internal\Message +{ + protected $assignment_type; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol\ManualAssignmentType $manual_assignment_type + * Allow manual assignments triggered by administrative operations only. + * @type \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol\AutoAssignmentType $auto_assignment_type + * Allow automatic assignments triggered by data plane operations. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Allow manual assignments triggered by administrative operations only. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol.ManualAssignmentType manual_assignment_type = 2; + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol\ManualAssignmentType|null + */ + public function getManualAssignmentType() + { + return $this->readOneof(2); + } + + public function hasManualAssignmentType() + { + return $this->hasOneof(2); + } + + /** + * Allow manual assignments triggered by administrative operations only. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol.ManualAssignmentType manual_assignment_type = 2; + * @param \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol\ManualAssignmentType $var + * @return $this + */ + public function setManualAssignmentType($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol\ManualAssignmentType::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Allow automatic assignments triggered by data plane operations. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol.AutoAssignmentType auto_assignment_type = 3; + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol\AutoAssignmentType|null + */ + public function getAutoAssignmentType() + { + return $this->readOneof(3); + } + + public function hasAutoAssignmentType() + { + return $this->hasOneof(3); + } + + /** + * Allow automatic assignments triggered by data plane operations. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol.AutoAssignmentType auto_assignment_type = 3; + * @param \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol\AutoAssignmentType $var + * @return $this + */ + public function setAutoAssignmentType($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol\AutoAssignmentType::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * @return string + */ + public function getAssignmentType() + { + return $this->whichOneof("assignment_type"); + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/AssignmentProtocol/AutoAssignmentType.php b/CommerceConsumerProcurement/src/V1/AssignmentProtocol/AutoAssignmentType.php new file mode 100644 index 000000000000..14e80415f81d --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/AssignmentProtocol/AutoAssignmentType.php @@ -0,0 +1,86 @@ +google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol.AutoAssignmentType + */ +class AutoAssignmentType extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The time to live for an inactive license. After this time has + * passed, the license will be automatically unassigned from the user. Must + * be at least 7 days, if set. If unset, the license will never expire. + * + * Generated from protobuf field .google.protobuf.Duration inactive_license_ttl = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $inactive_license_ttl = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Duration $inactive_license_ttl + * Optional. The time to live for an inactive license. After this time has + * passed, the license will be automatically unassigned from the user. Must + * be at least 7 days, if set. If unset, the license will never expire. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The time to live for an inactive license. After this time has + * passed, the license will be automatically unassigned from the user. Must + * be at least 7 days, if set. If unset, the license will never expire. + * + * Generated from protobuf field .google.protobuf.Duration inactive_license_ttl = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Duration|null + */ + public function getInactiveLicenseTtl() + { + return $this->inactive_license_ttl; + } + + public function hasInactiveLicenseTtl() + { + return isset($this->inactive_license_ttl); + } + + public function clearInactiveLicenseTtl() + { + unset($this->inactive_license_ttl); + } + + /** + * Optional. The time to live for an inactive license. After this time has + * passed, the license will be automatically unassigned from the user. Must + * be at least 7 days, if set. If unset, the license will never expire. + * + * Generated from protobuf field .google.protobuf.Duration inactive_license_ttl = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setInactiveLicenseTtl($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->inactive_license_ttl = $var; + + return $this; + } + +} + + diff --git a/CommerceConsumerProcurement/src/V1/AssignmentProtocol/ManualAssignmentType.php b/CommerceConsumerProcurement/src/V1/AssignmentProtocol/ManualAssignmentType.php new file mode 100644 index 000000000000..25d147e3b0ab --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/AssignmentProtocol/ManualAssignmentType.php @@ -0,0 +1,34 @@ +google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol.ManualAssignmentType + */ +class ManualAssignmentType extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + +} + + diff --git a/CommerceConsumerProcurement/src/V1/AutoRenewalBehavior.php b/CommerceConsumerProcurement/src/V1/AutoRenewalBehavior.php new file mode 100644 index 000000000000..ac3e70593302 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/AutoRenewalBehavior.php @@ -0,0 +1,61 @@ +google.cloud.commerce.consumer.procurement.v1.AutoRenewalBehavior + */ +class AutoRenewalBehavior +{ + /** + * If unspecified, the auto renewal behavior will follow the default config. + * + * Generated from protobuf enum AUTO_RENEWAL_BEHAVIOR_UNSPECIFIED = 0; + */ + const AUTO_RENEWAL_BEHAVIOR_UNSPECIFIED = 0; + /** + * Auto Renewal will be enabled on subscription. + * + * Generated from protobuf enum AUTO_RENEWAL_BEHAVIOR_ENABLE = 1; + */ + const AUTO_RENEWAL_BEHAVIOR_ENABLE = 1; + /** + * Auto Renewal will be disabled on subscription. + * + * Generated from protobuf enum AUTO_RENEWAL_BEHAVIOR_DISABLE = 2; + */ + const AUTO_RENEWAL_BEHAVIOR_DISABLE = 2; + + private static $valueToName = [ + self::AUTO_RENEWAL_BEHAVIOR_UNSPECIFIED => 'AUTO_RENEWAL_BEHAVIOR_UNSPECIFIED', + self::AUTO_RENEWAL_BEHAVIOR_ENABLE => 'AUTO_RENEWAL_BEHAVIOR_ENABLE', + self::AUTO_RENEWAL_BEHAVIOR_DISABLE => 'AUTO_RENEWAL_BEHAVIOR_DISABLE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/CommerceConsumerProcurement/src/V1/CancelOrderMetadata.php b/CommerceConsumerProcurement/src/V1/CancelOrderMetadata.php new file mode 100644 index 000000000000..58e2200fed76 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/CancelOrderMetadata.php @@ -0,0 +1,34 @@ +google.cloud.commerce.consumer.procurement.v1.CancelOrderMetadata + */ +class CancelOrderMetadata extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\ProcurementService::initOnce(); + parent::__construct($data); + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/CancelOrderRequest.php b/CommerceConsumerProcurement/src/V1/CancelOrderRequest.php new file mode 100644 index 000000000000..bf6be9598319 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/CancelOrderRequest.php @@ -0,0 +1,144 @@ +google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest + */ +class CancelOrderRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the order. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $name = ''; + /** + * Optional. The weak etag, which can be optionally populated, of the order + * that this cancel request is based on. Validation checking will only happen + * if the invoker supplies this field. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = ''; + /** + * Optional. Cancellation policy of this request. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy cancellation_policy = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $cancellation_policy = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the order. + * @type string $etag + * Optional. The weak etag, which can be optionally populated, of the order + * that this cancel request is based on. Validation checking will only happen + * if the invoker supplies this field. + * @type int $cancellation_policy + * Optional. Cancellation policy of this request. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\ProcurementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the order. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the order. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. The weak etag, which can be optionally populated, of the order + * that this cancel request is based on. Validation checking will only happen + * if the invoker supplies this field. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Optional. The weak etag, which can be optionally populated, of the order + * that this cancel request is based on. Validation checking will only happen + * if the invoker supplies this field. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Optional. Cancellation policy of this request. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy cancellation_policy = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getCancellationPolicy() + { + return $this->cancellation_policy; + } + + /** + * Optional. Cancellation policy of this request. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy cancellation_policy = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setCancellationPolicy($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Commerce\Consumer\Procurement\V1\CancelOrderRequest\CancellationPolicy::class); + $this->cancellation_policy = $var; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/CancelOrderRequest/CancellationPolicy.php b/CommerceConsumerProcurement/src/V1/CancelOrderRequest/CancellationPolicy.php new file mode 100644 index 000000000000..3044ad0c4f8f --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/CancelOrderRequest/CancellationPolicy.php @@ -0,0 +1,68 @@ +google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy + */ +class CancellationPolicy +{ + /** + * If unspecified, cancellation will try to cancel the order, if order + * cannot be immediately cancelled, auto renewal will be turned off. + * However, caller should avoid using the value as it will yield a + * non-deterministic result. This is still supported mainly to maintain + * existing integrated usages and ensure backwards compatibility. + * + * Generated from protobuf enum CANCELLATION_POLICY_UNSPECIFIED = 0; + */ + const CANCELLATION_POLICY_UNSPECIFIED = 0; + /** + * Request will cancel the whole order immediately, if order cannot be + * immediately cancelled, the request will fail. + * + * Generated from protobuf enum CANCELLATION_POLICY_CANCEL_IMMEDIATELY = 1; + */ + const CANCELLATION_POLICY_CANCEL_IMMEDIATELY = 1; + /** + * Request will cancel the auto renewal, if order is not subscription based, + * the request will fail. + * + * Generated from protobuf enum CANCELLATION_POLICY_CANCEL_AT_TERM_END = 2; + */ + const CANCELLATION_POLICY_CANCEL_AT_TERM_END = 2; + + private static $valueToName = [ + self::CANCELLATION_POLICY_UNSPECIFIED => 'CANCELLATION_POLICY_UNSPECIFIED', + self::CANCELLATION_POLICY_CANCEL_IMMEDIATELY => 'CANCELLATION_POLICY_CANCEL_IMMEDIATELY', + self::CANCELLATION_POLICY_CANCEL_AT_TERM_END => 'CANCELLATION_POLICY_CANCEL_AT_TERM_END', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/CommerceConsumerProcurement/src/V1/Client/ConsumerProcurementServiceClient.php b/CommerceConsumerProcurement/src/V1/Client/ConsumerProcurementServiceClient.php index 2130ace770de..201f8e45d39b 100644 --- a/CommerceConsumerProcurement/src/V1/Client/ConsumerProcurementServiceClient.php +++ b/CommerceConsumerProcurement/src/V1/Client/ConsumerProcurementServiceClient.php @@ -34,8 +34,10 @@ use Google\ApiCore\Transport\TransportInterface; use Google\ApiCore\ValidationException; use Google\Auth\FetchAuthTokenInterface; +use Google\Cloud\Commerce\Consumer\Procurement\V1\CancelOrderRequest; use Google\Cloud\Commerce\Consumer\Procurement\V1\GetOrderRequest; use Google\Cloud\Commerce\Consumer\Procurement\V1\ListOrdersRequest; +use Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest; use Google\Cloud\Commerce\Consumer\Procurement\V1\Order; use Google\Cloud\Commerce\Consumer\Procurement\V1\PlaceOrderRequest; use Google\LongRunning\Client\OperationsClient; @@ -62,8 +64,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * + * @method PromiseInterface cancelOrderAsync(CancelOrderRequest $request, array $optionalArgs = []) * @method PromiseInterface getOrderAsync(GetOrderRequest $request, array $optionalArgs = []) * @method PromiseInterface listOrdersAsync(ListOrdersRequest $request, array $optionalArgs = []) + * @method PromiseInterface modifyOrderAsync(ModifyOrderRequest $request, array $optionalArgs = []) * @method PromiseInterface placeOrderAsync(PlaceOrderRequest $request, array $optionalArgs = []) */ final class ConsumerProcurementServiceClient @@ -331,6 +335,35 @@ public function __call($method, $args) return call_user_func_array([$this, 'startAsyncCall'], $args); } + /** + * Cancels an existing + * [Order][google.cloud.commerce.consumer.procurement.v1.Order]. Every product + * procured in the Order will be cancelled. + * + * The async variant is {@see ConsumerProcurementServiceClient::cancelOrderAsync()} + * . + * + * @example samples/V1/ConsumerProcurementServiceClient/cancel_order.php + * + * @param CancelOrderRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function cancelOrder(CancelOrderRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CancelOrder', $request, $callOptions)->wait(); + } + /** * Returns the requested * [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource. @@ -387,6 +420,34 @@ public function listOrders(ListOrdersRequest $request, array $callOptions = []): return $this->startApiCall('ListOrders', $request, $callOptions); } + /** + * Modifies an existing + * [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource. + * + * The async variant is {@see ConsumerProcurementServiceClient::modifyOrderAsync()} + * . + * + * @example samples/V1/ConsumerProcurementServiceClient/modify_order.php + * + * @param ModifyOrderRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function modifyOrder(ModifyOrderRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('ModifyOrder', $request, $callOptions)->wait(); + } + /** * Creates a new [Order][google.cloud.commerce.consumer.procurement.v1.Order]. * diff --git a/CommerceConsumerProcurement/src/V1/Client/LicenseManagementServiceClient.php b/CommerceConsumerProcurement/src/V1/Client/LicenseManagementServiceClient.php new file mode 100644 index 000000000000..e0e8cf45cd8a --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/Client/LicenseManagementServiceClient.php @@ -0,0 +1,357 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/license_management_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/license_management_service_descriptor_config.php', + 'gcpApiConfigPath' => __DIR__ . '/../resources/license_management_service_grpc_config.json', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => + __DIR__ . '/../resources/license_management_service_rest_client_config.php', + ], + ], + ]; + } + + /** + * Formats a string containing the fully-qualified path to represent a license_pool + * resource. + * + * @param string $billingAccount + * @param string $order + * + * @return string The formatted license_pool resource. + */ + public static function licensePoolName(string $billingAccount, string $order): string + { + return self::getPathTemplate('licensePool')->render([ + 'billing_account' => $billingAccount, + 'order' => $order, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - licensePool: billingAccounts/{billing_account}/orders/{order}/licensePool + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default + * 'cloudcommerceconsumerprocurement.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. May be either the string + * `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. + * *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'grpc' => [...], + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and + * {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * Assigns a license to a user. + * + * The async variant is {@see LicenseManagementServiceClient::assignAsync()} . + * + * @example samples/V1/LicenseManagementServiceClient/assign.php + * + * @param AssignRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return AssignResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function assign(AssignRequest $request, array $callOptions = []): AssignResponse + { + return $this->startApiCall('Assign', $request, $callOptions)->wait(); + } + + /** + * Enumerates all users assigned a license. + * + * The async variant is + * {@see LicenseManagementServiceClient::enumerateLicensedUsersAsync()} . + * + * @example samples/V1/LicenseManagementServiceClient/enumerate_licensed_users.php + * + * @param EnumerateLicensedUsersRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function enumerateLicensedUsers( + EnumerateLicensedUsersRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('EnumerateLicensedUsers', $request, $callOptions); + } + + /** + * Gets the license pool. + * + * The async variant is + * {@see LicenseManagementServiceClient::getLicensePoolAsync()} . + * + * @example samples/V1/LicenseManagementServiceClient/get_license_pool.php + * + * @param GetLicensePoolRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return LicensePool + * + * @throws ApiException Thrown if the API call fails. + */ + public function getLicensePool(GetLicensePoolRequest $request, array $callOptions = []): LicensePool + { + return $this->startApiCall('GetLicensePool', $request, $callOptions)->wait(); + } + + /** + * Unassigns a license from a user. + * + * The async variant is {@see LicenseManagementServiceClient::unassignAsync()} . + * + * @example samples/V1/LicenseManagementServiceClient/unassign.php + * + * @param UnassignRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return UnassignResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function unassign(UnassignRequest $request, array $callOptions = []): UnassignResponse + { + return $this->startApiCall('Unassign', $request, $callOptions)->wait(); + } + + /** + * Updates the license pool if one exists for this Order. + * + * The async variant is + * {@see LicenseManagementServiceClient::updateLicensePoolAsync()} . + * + * @example samples/V1/LicenseManagementServiceClient/update_license_pool.php + * + * @param UpdateLicensePoolRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return LicensePool + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateLicensePool(UpdateLicensePoolRequest $request, array $callOptions = []): LicensePool + { + return $this->startApiCall('UpdateLicensePool', $request, $callOptions)->wait(); + } +} diff --git a/CommerceConsumerProcurement/src/V1/EnumerateLicensedUsersRequest.php b/CommerceConsumerProcurement/src/V1/EnumerateLicensedUsersRequest.php new file mode 100644 index 000000000000..37bb56e1839a --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/EnumerateLicensedUsersRequest.php @@ -0,0 +1,157 @@ +google.cloud.commerce.consumer.procurement.v1.EnumerateLicensedUsersRequest + */ +class EnumerateLicensedUsersRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $parent = ''; + /** + * Optional. The maximum number of users to return. The service may return + * fewer than this value. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `EnumerateLicensedUsers` + * call. Provide this to retrieve the subsequent page. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + + /** + * @param string $parent Required. License pool name. + * + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\EnumerateLicensedUsersRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. License pool name. + * @type int $page_size + * Optional. The maximum number of users to return. The service may return + * fewer than this value. + * @type string $page_token + * Optional. A page token, received from a previous `EnumerateLicensedUsers` + * call. Provide this to retrieve the subsequent page. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of users to return. The service may return + * fewer than this value. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of users to return. The service may return + * fewer than this value. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `EnumerateLicensedUsers` + * call. Provide this to retrieve the subsequent page. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `EnumerateLicensedUsers` + * call. Provide this to retrieve the subsequent page. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/EnumerateLicensedUsersResponse.php b/CommerceConsumerProcurement/src/V1/EnumerateLicensedUsersResponse.php new file mode 100644 index 000000000000..ad994465605b --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/EnumerateLicensedUsersResponse.php @@ -0,0 +1,106 @@ +google.cloud.commerce.consumer.procurement.v1.EnumerateLicensedUsersResponse + */ +class EnumerateLicensedUsersResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of licensed users. + * + * Generated from protobuf field repeated .google.cloud.commerce.consumer.procurement.v1.LicensedUser licensed_users = 1; + */ + private $licensed_users; + /** + * A token that can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Commerce\Consumer\Procurement\V1\LicensedUser>|\Google\Protobuf\Internal\RepeatedField $licensed_users + * The list of licensed users. + * @type string $next_page_token + * A token that can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * The list of licensed users. + * + * Generated from protobuf field repeated .google.cloud.commerce.consumer.procurement.v1.LicensedUser licensed_users = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getLicensedUsers() + { + return $this->licensed_users; + } + + /** + * The list of licensed users. + * + * Generated from protobuf field repeated .google.cloud.commerce.consumer.procurement.v1.LicensedUser licensed_users = 1; + * @param array<\Google\Cloud\Commerce\Consumer\Procurement\V1\LicensedUser>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setLicensedUsers($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Commerce\Consumer\Procurement\V1\LicensedUser::class); + $this->licensed_users = $arr; + + return $this; + } + + /** + * A token that can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token that can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/GetLicensePoolRequest.php b/CommerceConsumerProcurement/src/V1/GetLicensePoolRequest.php new file mode 100644 index 000000000000..23e2d4af8b0e --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/GetLicensePoolRequest.php @@ -0,0 +1,85 @@ +google.cloud.commerce.consumer.procurement.v1.GetLicensePoolRequest + */ +class GetLicensePoolRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the license pool to get. + * Format: `billingAccounts/{billing_account}/orders/{order}/licensePool` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the license pool to get. + * Format: `billingAccounts/{billing_account}/orders/{order}/licensePool` + * + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\GetLicensePoolRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the license pool to get. + * Format: `billingAccounts/{billing_account}/orders/{order}/licensePool` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the license pool to get. + * Format: `billingAccounts/{billing_account}/orders/{order}/licensePool` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the license pool to get. + * Format: `billingAccounts/{billing_account}/orders/{order}/licensePool` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/LicensePool.php b/CommerceConsumerProcurement/src/V1/LicensePool.php new file mode 100644 index 000000000000..cc37fd0582f8 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/LicensePool.php @@ -0,0 +1,183 @@ +google.cloud.commerce.consumer.procurement.v1.LicensePool + */ +class LicensePool extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Required. Assignment protocol for the license pool. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol license_assignment_protocol = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $license_assignment_protocol = null; + /** + * Output only. Licenses count that are available to be assigned. + * + * Generated from protobuf field int32 available_license_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $available_license_count = 0; + /** + * Output only. Total number of licenses in the pool. + * + * Generated from protobuf field int32 total_license_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $total_license_count = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool` + * @type \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol $license_assignment_protocol + * Required. Assignment protocol for the license pool. + * @type int $available_license_count + * Output only. Licenses count that are available to be assigned. + * @type int $total_license_count + * Output only. Total number of licenses in the pool. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Required. Assignment protocol for the license pool. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol license_assignment_protocol = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol|null + */ + public function getLicenseAssignmentProtocol() + { + return $this->license_assignment_protocol; + } + + public function hasLicenseAssignmentProtocol() + { + return isset($this->license_assignment_protocol); + } + + public function clearLicenseAssignmentProtocol() + { + unset($this->license_assignment_protocol); + } + + /** + * Required. Assignment protocol for the license pool. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AssignmentProtocol license_assignment_protocol = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol $var + * @return $this + */ + public function setLicenseAssignmentProtocol($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Commerce\Consumer\Procurement\V1\AssignmentProtocol::class); + $this->license_assignment_protocol = $var; + + return $this; + } + + /** + * Output only. Licenses count that are available to be assigned. + * + * Generated from protobuf field int32 available_license_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getAvailableLicenseCount() + { + return $this->available_license_count; + } + + /** + * Output only. Licenses count that are available to be assigned. + * + * Generated from protobuf field int32 available_license_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setAvailableLicenseCount($var) + { + GPBUtil::checkInt32($var); + $this->available_license_count = $var; + + return $this; + } + + /** + * Output only. Total number of licenses in the pool. + * + * Generated from protobuf field int32 total_license_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getTotalLicenseCount() + { + return $this->total_license_count; + } + + /** + * Output only. Total number of licenses in the pool. + * + * Generated from protobuf field int32 total_license_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setTotalLicenseCount($var) + { + GPBUtil::checkInt32($var); + $this->total_license_count = $var; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/LicensedUser.php b/CommerceConsumerProcurement/src/V1/LicensedUser.php new file mode 100644 index 000000000000..959c7b3cd26e --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/LicensedUser.php @@ -0,0 +1,167 @@ +google.cloud.commerce.consumer.procurement.v1.LicensedUser + */ +class LicensedUser extends \Google\Protobuf\Internal\Message +{ + /** + * Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field string username = 1; + */ + protected $username = ''; + /** + * Output only. Timestamp when the license was assigned. + * + * Generated from protobuf field .google.protobuf.Timestamp assign_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $assign_time = null; + /** + * Output only. Timestamp when the license was recently used. This may not be + * the most recent usage time, and will be updated regularly (within 24 + * hours). + * + * Generated from protobuf field .google.protobuf.Timestamp recent_usage_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $recent_usage_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $username + * Username. + * Format: `name@domain.com`. + * @type \Google\Protobuf\Timestamp $assign_time + * Output only. Timestamp when the license was assigned. + * @type \Google\Protobuf\Timestamp $recent_usage_time + * Output only. Timestamp when the license was recently used. This may not be + * the most recent usage time, and will be updated regularly (within 24 + * hours). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field string username = 1; + * @return string + */ + public function getUsername() + { + return $this->username; + } + + /** + * Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field string username = 1; + * @param string $var + * @return $this + */ + public function setUsername($var) + { + GPBUtil::checkString($var, True); + $this->username = $var; + + return $this; + } + + /** + * Output only. Timestamp when the license was assigned. + * + * Generated from protobuf field .google.protobuf.Timestamp assign_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getAssignTime() + { + return $this->assign_time; + } + + public function hasAssignTime() + { + return isset($this->assign_time); + } + + public function clearAssignTime() + { + unset($this->assign_time); + } + + /** + * Output only. Timestamp when the license was assigned. + * + * Generated from protobuf field .google.protobuf.Timestamp assign_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setAssignTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->assign_time = $var; + + return $this; + } + + /** + * Output only. Timestamp when the license was recently used. This may not be + * the most recent usage time, and will be updated regularly (within 24 + * hours). + * + * Generated from protobuf field .google.protobuf.Timestamp recent_usage_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getRecentUsageTime() + { + return $this->recent_usage_time; + } + + public function hasRecentUsageTime() + { + return isset($this->recent_usage_time); + } + + public function clearRecentUsageTime() + { + unset($this->recent_usage_time); + } + + /** + * Output only. Timestamp when the license was recently used. This may not be + * the most recent usage time, and will be updated regularly (within 24 + * hours). + * + * Generated from protobuf field .google.protobuf.Timestamp recent_usage_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setRecentUsageTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->recent_usage_time = $var; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/LineItemChangeState.php b/CommerceConsumerProcurement/src/V1/LineItemChangeState.php index 357ddcaba7c8..0f578e994c1a 100644 --- a/CommerceConsumerProcurement/src/V1/LineItemChangeState.php +++ b/CommerceConsumerProcurement/src/V1/LineItemChangeState.php @@ -20,43 +20,47 @@ class LineItemChangeState */ const LINE_ITEM_CHANGE_STATE_UNSPECIFIED = 0; /** - * Change is in this state when a change is initiated and waiting for - * partner approval. + * Change is in this state when a change is initiated and waiting for partner + * approval. This state is only applicable for pending change. * * Generated from protobuf enum LINE_ITEM_CHANGE_STATE_PENDING_APPROVAL = 1; */ const LINE_ITEM_CHANGE_STATE_PENDING_APPROVAL = 1; /** * Change is in this state after it's approved by the partner or auto-approved - * but before it takes effect. The change can be overwritten - * or cancelled depending on the new line item info property (pending Private - * Offer change cannot be cancelled and can only be overwritten by another - * Private Offer). + * but before it takes effect. The change can be overwritten or cancelled + * depending on the new line item info property (pending Private Offer change + * cannot be cancelled and can only be overwritten by another Private Offer). + * This state is only applicable for pending change. * * Generated from protobuf enum LINE_ITEM_CHANGE_STATE_APPROVED = 2; */ const LINE_ITEM_CHANGE_STATE_APPROVED = 2; /** - * Change is in this state after it's been activated. + * Change is in this state after it's been activated. This state is only + * applicable for change in history. * * Generated from protobuf enum LINE_ITEM_CHANGE_STATE_COMPLETED = 3; */ const LINE_ITEM_CHANGE_STATE_COMPLETED = 3; /** - * Change is in this state if it was rejected by the partner. + * Change is in this state if it was rejected by the partner. This state is + * only applicable for change in history. * * Generated from protobuf enum LINE_ITEM_CHANGE_STATE_REJECTED = 4; */ const LINE_ITEM_CHANGE_STATE_REJECTED = 4; /** - * Change is in this state if it was abandoned by the user. + * Change is in this state if it was abandoned by the user. This state is only + * applicable for change in history. * * Generated from protobuf enum LINE_ITEM_CHANGE_STATE_ABANDONED = 5; */ const LINE_ITEM_CHANGE_STATE_ABANDONED = 5; /** * Change is in this state if it's currently being provisioned downstream. The - * change can't be overwritten or cancelled when it's in this state. + * change can't be overwritten or cancelled when it's in this state. This + * state is only applicable for pending change. * * Generated from protobuf enum LINE_ITEM_CHANGE_STATE_ACTIVATING = 6; */ diff --git a/CommerceConsumerProcurement/src/V1/ModifyOrderMetadata.php b/CommerceConsumerProcurement/src/V1/ModifyOrderMetadata.php new file mode 100644 index 000000000000..e457f78bd1eb --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/ModifyOrderMetadata.php @@ -0,0 +1,34 @@ +google.cloud.commerce.consumer.procurement.v1.ModifyOrderMetadata + */ +class ModifyOrderMetadata extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\ProcurementService::initOnce(); + parent::__construct($data); + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/ModifyOrderRequest.php b/CommerceConsumerProcurement/src/V1/ModifyOrderRequest.php new file mode 100644 index 000000000000..f9638efd58e9 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/ModifyOrderRequest.php @@ -0,0 +1,190 @@ +google.cloud.commerce.consumer.procurement.v1.ModifyOrderRequest + */ +class ModifyOrderRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the order to update. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $name = ''; + /** + * Optional. Modifications for an existing Order created by an Offer. + * Required when Offer based Order is being modified, except for when going + * from an offer to a public plan. + * + * Generated from protobuf field repeated .google.cloud.commerce.consumer.procurement.v1.ModifyOrderRequest.Modification modifications = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $modifications; + /** + * Optional. Updated display name of the order, leave as empty if you do not + * want to update current display name. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Optional. The weak etag, which can be optionally populated, of the order + * that this modify request is based on. Validation checking will only happen + * if the invoker supplies this field. + * + * Generated from protobuf field string etag = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the order to update. + * @type array<\Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest\Modification>|\Google\Protobuf\Internal\RepeatedField $modifications + * Optional. Modifications for an existing Order created by an Offer. + * Required when Offer based Order is being modified, except for when going + * from an offer to a public plan. + * @type string $display_name + * Optional. Updated display name of the order, leave as empty if you do not + * want to update current display name. + * @type string $etag + * Optional. The weak etag, which can be optionally populated, of the order + * that this modify request is based on. Validation checking will only happen + * if the invoker supplies this field. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\ProcurementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the order to update. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the order to update. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. Modifications for an existing Order created by an Offer. + * Required when Offer based Order is being modified, except for when going + * from an offer to a public plan. + * + * Generated from protobuf field repeated .google.cloud.commerce.consumer.procurement.v1.ModifyOrderRequest.Modification modifications = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getModifications() + { + return $this->modifications; + } + + /** + * Optional. Modifications for an existing Order created by an Offer. + * Required when Offer based Order is being modified, except for when going + * from an offer to a public plan. + * + * Generated from protobuf field repeated .google.cloud.commerce.consumer.procurement.v1.ModifyOrderRequest.Modification modifications = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest\Modification>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setModifications($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest\Modification::class); + $this->modifications = $arr; + + return $this; + } + + /** + * Optional. Updated display name of the order, leave as empty if you do not + * want to update current display name. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Updated display name of the order, leave as empty if you do not + * want to update current display name. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Optional. The weak etag, which can be optionally populated, of the order + * that this modify request is based on. Validation checking will only happen + * if the invoker supplies this field. + * + * Generated from protobuf field string etag = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Optional. The weak etag, which can be optionally populated, of the order + * that this modify request is based on. Validation checking will only happen + * if the invoker supplies this field. + * + * Generated from protobuf field string etag = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/ModifyOrderRequest/Modification.php b/CommerceConsumerProcurement/src/V1/ModifyOrderRequest/Modification.php new file mode 100644 index 000000000000..51db5bb537e3 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/ModifyOrderRequest/Modification.php @@ -0,0 +1,216 @@ +google.cloud.commerce.consumer.procurement.v1.ModifyOrderRequest.Modification + */ +class Modification extends \Google\Protobuf\Internal\Message +{ + /** + * Required. ID of the existing line item to make change to. + * Required when change type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL]. + * + * Generated from protobuf field string line_item_id = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $line_item_id = ''; + /** + * Required. Type of change to make. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LineItemChangeType change_type = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $change_type = 0; + /** + * Optional. The line item to update to. + * Required when change_type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LineItemInfo new_line_item_info = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $new_line_item_info = null; + /** + * Optional. Auto renewal behavior of the subscription for the update. + * Applied when change_type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default + * config when this field is not specified. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AutoRenewalBehavior auto_renewal_behavior = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $auto_renewal_behavior = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $line_item_id + * Required. ID of the existing line item to make change to. + * Required when change type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL]. + * @type int $change_type + * Required. Type of change to make. + * @type \Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo $new_line_item_info + * Optional. The line item to update to. + * Required when change_type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. + * @type int $auto_renewal_behavior + * Optional. Auto renewal behavior of the subscription for the update. + * Applied when change_type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default + * config when this field is not specified. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\ProcurementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. ID of the existing line item to make change to. + * Required when change type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL]. + * + * Generated from protobuf field string line_item_id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getLineItemId() + { + return $this->line_item_id; + } + + /** + * Required. ID of the existing line item to make change to. + * Required when change type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL]. + * + * Generated from protobuf field string line_item_id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setLineItemId($var) + { + GPBUtil::checkString($var, True); + $this->line_item_id = $var; + + return $this; + } + + /** + * Required. Type of change to make. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LineItemChangeType change_type = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getChangeType() + { + return $this->change_type; + } + + /** + * Required. Type of change to make. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LineItemChangeType change_type = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setChangeType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemChangeType::class); + $this->change_type = $var; + + return $this; + } + + /** + * Optional. The line item to update to. + * Required when change_type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LineItemInfo new_line_item_info = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo|null + */ + public function getNewLineItemInfo() + { + return $this->new_line_item_info; + } + + public function hasNewLineItemInfo() + { + return isset($this->new_line_item_info); + } + + public function clearNewLineItemInfo() + { + unset($this->new_line_item_info); + } + + /** + * Optional. The line item to update to. + * Required when change_type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LineItemInfo new_line_item_info = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo $var + * @return $this + */ + public function setNewLineItemInfo($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo::class); + $this->new_line_item_info = $var; + + return $this; + } + + /** + * Optional. Auto renewal behavior of the subscription for the update. + * Applied when change_type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default + * config when this field is not specified. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AutoRenewalBehavior auto_renewal_behavior = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getAutoRenewalBehavior() + { + return $this->auto_renewal_behavior; + } + + /** + * Optional. Auto renewal behavior of the subscription for the update. + * Applied when change_type is + * [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default + * config when this field is not specified. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.AutoRenewalBehavior auto_renewal_behavior = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setAutoRenewalBehavior($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Commerce\Consumer\Procurement\V1\AutoRenewalBehavior::class); + $this->auto_renewal_behavior = $var; + + return $this; + } + +} + + diff --git a/CommerceConsumerProcurement/src/V1/PlaceOrderRequest.php b/CommerceConsumerProcurement/src/V1/PlaceOrderRequest.php index 1821ffd71844..38716b51963c 100644 --- a/CommerceConsumerProcurement/src/V1/PlaceOrderRequest.php +++ b/CommerceConsumerProcurement/src/V1/PlaceOrderRequest.php @@ -39,7 +39,7 @@ class PlaceOrderRequest extends \Google\Protobuf\Internal\Message /** * Optional. A unique identifier for this request. * The server will ignore subsequent requests that provide a duplicate request - * ID for at least 120 minutes after the first request. + * ID for at least 24 hours after the first request. * The request ID must be a valid * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). * @@ -64,7 +64,7 @@ class PlaceOrderRequest extends \Google\Protobuf\Internal\Message * @type string $request_id * Optional. A unique identifier for this request. * The server will ignore subsequent requests that provide a duplicate request - * ID for at least 120 minutes after the first request. + * ID for at least 24 hours after the first request. * The request ID must be a valid * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). * } @@ -159,7 +159,7 @@ public function setLineItemInfo($var) /** * Optional. A unique identifier for this request. * The server will ignore subsequent requests that provide a duplicate request - * ID for at least 120 minutes after the first request. + * ID for at least 24 hours after the first request. * The request ID must be a valid * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). * @@ -174,7 +174,7 @@ public function getRequestId() /** * Optional. A unique identifier for this request. * The server will ignore subsequent requests that provide a duplicate request - * ID for at least 120 minutes after the first request. + * ID for at least 24 hours after the first request. * The request ID must be a valid * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). * diff --git a/CommerceConsumerProcurement/src/V1/UnassignRequest.php b/CommerceConsumerProcurement/src/V1/UnassignRequest.php new file mode 100644 index 000000000000..b61d1f46d9bb --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/UnassignRequest.php @@ -0,0 +1,122 @@ +google.cloud.commerce.consumer.procurement.v1.UnassignRequest + */ +class UnassignRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $parent = ''; + /** + * Required. Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field repeated string usernames = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $usernames; + + /** + * @param string $parent Required. License pool name. + * @param string[] $usernames Required. Username. + * Format: `name@domain.com`. + * + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\UnassignRequest + * + * @experimental + */ + public static function build(string $parent, array $usernames): self + { + return (new self()) + ->setParent($parent) + ->setUsernames($usernames); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. License pool name. + * @type array|\Google\Protobuf\Internal\RepeatedField $usernames + * Required. Username. + * Format: `name@domain.com`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. License pool name. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field repeated string usernames = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUsernames() + { + return $this->usernames; + } + + /** + * Required. Username. + * Format: `name@domain.com`. + * + * Generated from protobuf field repeated string usernames = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUsernames($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->usernames = $arr; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/UnassignResponse.php b/CommerceConsumerProcurement/src/V1/UnassignResponse.php new file mode 100644 index 000000000000..80b8d97dccc0 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/UnassignResponse.php @@ -0,0 +1,34 @@ +google.cloud.commerce.consumer.procurement.v1.UnassignResponse + */ +class UnassignResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/UpdateLicensePoolRequest.php b/CommerceConsumerProcurement/src/V1/UpdateLicensePoolRequest.php new file mode 100644 index 000000000000..58377294310c --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/UpdateLicensePoolRequest.php @@ -0,0 +1,152 @@ +google.cloud.commerce.consumer.procurement.v1.UpdateLicensePoolRequest + */ +class UpdateLicensePoolRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The license pool to update. + * The license pool's name field is used to identify the license pool to + * update. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool`. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LicensePool license_pool = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $license_pool = null; + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + + /** + * @param \Google\Cloud\Commerce\Consumer\Procurement\V1\LicensePool $licensePool Required. The license pool to update. + * + * The license pool's name field is used to identify the license pool to + * update. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool`. + * @param \Google\Protobuf\FieldMask $updateMask Required. The list of fields to update. + * + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\UpdateLicensePoolRequest + * + * @experimental + */ + public static function build(\Google\Cloud\Commerce\Consumer\Procurement\V1\LicensePool $licensePool, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setLicensePool($licensePool) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Commerce\Consumer\Procurement\V1\LicensePool $license_pool + * Required. The license pool to update. + * The license pool's name field is used to identify the license pool to + * update. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool`. + * @type \Google\Protobuf\FieldMask $update_mask + * Required. The list of fields to update. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Commerce\Consumer\Procurement\V1\LicenseManagementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The license pool to update. + * The license pool's name field is used to identify the license pool to + * update. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool`. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LicensePool license_pool = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Commerce\Consumer\Procurement\V1\LicensePool|null + */ + public function getLicensePool() + { + return $this->license_pool; + } + + public function hasLicensePool() + { + return isset($this->license_pool); + } + + public function clearLicensePool() + { + unset($this->license_pool); + } + + /** + * Required. The license pool to update. + * The license pool's name field is used to identify the license pool to + * update. Format: + * `billingAccounts/{billing_account}/orders/{order}/licensePool`. + * + * Generated from protobuf field .google.cloud.commerce.consumer.procurement.v1.LicensePool license_pool = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Commerce\Consumer\Procurement\V1\LicensePool $var + * @return $this + */ + public function setLicensePool($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Commerce\Consumer\Procurement\V1\LicensePool::class); + $this->license_pool = $var; + + return $this; + } + + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/CommerceConsumerProcurement/src/V1/gapic_metadata.json b/CommerceConsumerProcurement/src/V1/gapic_metadata.json index cb38272d584e..eade9d314231 100644 --- a/CommerceConsumerProcurement/src/V1/gapic_metadata.json +++ b/CommerceConsumerProcurement/src/V1/gapic_metadata.json @@ -5,11 +5,50 @@ "protoPackage": "google.cloud.commerce.consumer.procurement.v1", "libraryPackage": "Google\\Cloud\\Commerce\\Consumer\\Procurement\\V1", "services": { + "LicenseManagementService": { + "clients": { + "grpc": { + "libraryClient": "LicenseManagementServiceGapicClient", + "rpcs": { + "Assign": { + "methods": [ + "assign" + ] + }, + "EnumerateLicensedUsers": { + "methods": [ + "enumerateLicensedUsers" + ] + }, + "GetLicensePool": { + "methods": [ + "getLicensePool" + ] + }, + "Unassign": { + "methods": [ + "unassign" + ] + }, + "UpdateLicensePool": { + "methods": [ + "updateLicensePool" + ] + } + } + } + } + }, "ConsumerProcurementService": { "clients": { "grpc": { "libraryClient": "ConsumerProcurementServiceGapicClient", "rpcs": { + "CancelOrder": { + "methods": [ + "cancelOrder" + ] + }, "GetOrder": { "methods": [ "getOrder" @@ -20,6 +59,11 @@ "listOrders" ] }, + "ModifyOrder": { + "methods": [ + "modifyOrder" + ] + }, "PlaceOrder": { "methods": [ "placeOrder" diff --git a/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_client_config.json b/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_client_config.json index 620c6d0fc1d4..e35a772bd53f 100644 --- a/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_client_config.json +++ b/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_client_config.json @@ -38,6 +38,11 @@ } }, "methods": { + "CancelOrder": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "GetOrder": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", @@ -48,6 +53,11 @@ "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "ModifyOrder": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "PlaceOrder": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", diff --git a/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_descriptor_config.php b/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_descriptor_config.php index c49b87798bc3..1c547a193562 100644 --- a/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_descriptor_config.php +++ b/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_descriptor_config.php @@ -23,6 +23,44 @@ return [ 'interfaces' => [ 'google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService' => [ + 'CancelOrder' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Commerce\Consumer\Procurement\V1\Order', + 'metadataReturnType' => '\Google\Cloud\Commerce\Consumer\Procurement\V1\CancelOrderMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ModifyOrder' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Commerce\Consumer\Procurement\V1\Order', + 'metadataReturnType' => '\Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'PlaceOrder' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\Commerce\Consumer\Procurement\V1\Order', diff --git a/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_rest_client_config.php b/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_rest_client_config.php index 940b479b9f04..b29e89ae9fbc 100644 --- a/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_rest_client_config.php +++ b/CommerceConsumerProcurement/src/V1/resources/consumer_procurement_service_rest_client_config.php @@ -23,6 +23,18 @@ return [ 'interfaces' => [ 'google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService' => [ + 'CancelOrder' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=billingAccounts/*/orders/*}:cancel', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetOrder' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=billingAccounts/*/orders/*}', @@ -45,6 +57,18 @@ ], ], ], + 'ModifyOrder' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=billingAccounts/*/orders/*}:modify', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'PlaceOrder' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=billingAccounts/*}/orders:place', diff --git a/CommerceConsumerProcurement/src/V1/resources/license_management_service_client_config.json b/CommerceConsumerProcurement/src/V1/resources/license_management_service_client_config.json new file mode 100644 index 000000000000..98dd2f4c2dd0 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/resources/license_management_service_client_config.json @@ -0,0 +1,47 @@ +{ + "interfaces": { + "google.cloud.commerce.consumer.procurement.v1.LicenseManagementService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "Assign": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "EnumerateLicensedUsers": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "GetLicensePool": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "Unassign": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "UpdateLicensePool": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/CommerceConsumerProcurement/src/V1/resources/license_management_service_descriptor_config.php b/CommerceConsumerProcurement/src/V1/resources/license_management_service_descriptor_config.php new file mode 100644 index 000000000000..6e93fa011f59 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/resources/license_management_service_descriptor_config.php @@ -0,0 +1,100 @@ + [ + 'google.cloud.commerce.consumer.procurement.v1.LicenseManagementService' => [ + 'Assign' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Commerce\Consumer\Procurement\V1\AssignResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'EnumerateLicensedUsers' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getLicensedUsers', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Commerce\Consumer\Procurement\V1\EnumerateLicensedUsersResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'GetLicensePool' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Commerce\Consumer\Procurement\V1\LicensePool', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'Unassign' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Commerce\Consumer\Procurement\V1\UnassignResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'UpdateLicensePool' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Commerce\Consumer\Procurement\V1\LicensePool', + 'headerParams' => [ + [ + 'keyName' => 'license_pool.name', + 'fieldAccessors' => [ + 'getLicensePool', + 'getName', + ], + ], + ], + ], + 'templateMap' => [ + 'licensePool' => 'billingAccounts/{billing_account}/orders/{order}/licensePool', + ], + ], + ], +]; diff --git a/CommerceConsumerProcurement/src/V1/resources/license_management_service_rest_client_config.php b/CommerceConsumerProcurement/src/V1/resources/license_management_service_rest_client_config.php new file mode 100644 index 000000000000..c8a2ad883774 --- /dev/null +++ b/CommerceConsumerProcurement/src/V1/resources/license_management_service_rest_client_config.php @@ -0,0 +1,104 @@ + [ + 'google.cloud.commerce.consumer.procurement.v1.LicenseManagementService' => [ + 'Assign' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=billingAccounts/*/orders/*/licensePool}:assign', + 'body' => '*', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'EnumerateLicensedUsers' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=billingAccounts/*/orders/*/licensePool}:enumerateLicensedUsers', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'GetLicensePool' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=billingAccounts/*/orders/*/licensePool}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'Unassign' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=billingAccounts/*/orders/*/licensePool}:unassign', + 'body' => '*', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'UpdateLicensePool' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{license_pool.name=billingAccounts/*/orders/*/licensePool/*}', + 'body' => 'license_pool', + 'placeholders' => [ + 'license_pool.name' => [ + 'getters' => [ + 'getLicensePool', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=billingAccounts/*/orders/*/operations/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/CommerceConsumerProcurement/tests/Unit/V1/Client/ConsumerProcurementServiceClientTest.php b/CommerceConsumerProcurement/tests/Unit/V1/Client/ConsumerProcurementServiceClientTest.php index 5832dc58b3ee..0b8e62ec30b5 100644 --- a/CommerceConsumerProcurement/tests/Unit/V1/Client/ConsumerProcurementServiceClientTest.php +++ b/CommerceConsumerProcurement/tests/Unit/V1/Client/ConsumerProcurementServiceClientTest.php @@ -26,10 +26,12 @@ use Google\ApiCore\CredentialsWrapper; use Google\ApiCore\Testing\GeneratedTest; use Google\ApiCore\Testing\MockTransport; +use Google\Cloud\Commerce\Consumer\Procurement\V1\CancelOrderRequest; use Google\Cloud\Commerce\Consumer\Procurement\V1\Client\ConsumerProcurementServiceClient; use Google\Cloud\Commerce\Consumer\Procurement\V1\GetOrderRequest; use Google\Cloud\Commerce\Consumer\Procurement\V1\ListOrdersRequest; use Google\Cloud\Commerce\Consumer\Procurement\V1\ListOrdersResponse; +use Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest; use Google\Cloud\Commerce\Consumer\Procurement\V1\Order; use Google\Cloud\Commerce\Consumer\Procurement\V1\PlaceOrderRequest; use Google\LongRunning\Client\OperationsClient; @@ -69,6 +71,137 @@ private function createClient(array $options = []) return new ConsumerProcurementServiceClient($options); } + /** @test */ + public function cancelOrderTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/cancelOrderTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $displayName = 'displayName1615086568'; + $etag2 = 'etag2-1293302904'; + $expectedResponse = new Order(); + $expectedResponse->setName($name2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setEtag($etag2); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/cancelOrderTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $name = 'name3373707'; + $request = (new CancelOrderRequest())->setName($name); + $response = $gapicClient->cancelOrder($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService/CancelOrder', + $actualApiFuncCall + ); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($name, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/cancelOrderTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function cancelOrderExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/cancelOrderTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $name = 'name3373707'; + $request = (new CancelOrderRequest())->setName($name); + $response = $gapicClient->cancelOrder($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/cancelOrderTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function getOrderTest() { @@ -215,6 +348,137 @@ public function listOrdersExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function modifyOrderTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/modifyOrderTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $displayName2 = 'displayName21615000987'; + $etag2 = 'etag2-1293302904'; + $expectedResponse = new Order(); + $expectedResponse->setName($name2); + $expectedResponse->setDisplayName($displayName2); + $expectedResponse->setEtag($etag2); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/modifyOrderTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $name = 'name3373707'; + $request = (new ModifyOrderRequest())->setName($name); + $response = $gapicClient->modifyOrder($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService/ModifyOrder', + $actualApiFuncCall + ); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($name, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/modifyOrderTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function modifyOrderExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/modifyOrderTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $name = 'name3373707'; + $request = (new ModifyOrderRequest())->setName($name); + $response = $gapicClient->modifyOrder($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/modifyOrderTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function placeOrderTest() { @@ -351,37 +615,74 @@ public function placeOrderExceptionTest() } /** @test */ - public function getOrderAsyncTest() + public function cancelOrderAsyncTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/cancelOrderTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); $name2 = 'name2-1052831874'; $displayName = 'displayName1615086568'; - $etag = 'etag3123477'; + $etag2 = 'etag2-1293302904'; $expectedResponse = new Order(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); - $expectedResponse->setEtag($etag); - $transport->addResponse($expectedResponse); + $expectedResponse->setEtag($etag2); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/cancelOrderTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); // Mock request $name = 'name3373707'; - $request = (new GetOrderRequest())->setName($name); - $response = $gapicClient->getOrderAsync($request)->wait(); - $this->assertEquals($expectedResponse, $response); - $actualRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($actualRequests)); - $actualFuncCall = $actualRequests[0]->getFuncCall(); - $actualRequestObject = $actualRequests[0]->getRequestObject(); + $request = (new CancelOrderRequest())->setName($name); + $response = $gapicClient->cancelOrderAsync($request)->wait(); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); $this->assertSame( - '/google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService/GetOrder', - $actualFuncCall + '/google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService/CancelOrder', + $actualApiFuncCall ); - $actualValue = $actualRequestObject->getName(); + $actualValue = $actualApiRequestObject->getName(); $this->assertProtobufEquals($name, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/cancelOrderTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } } diff --git a/CommerceConsumerProcurement/tests/Unit/V1/Client/LicenseManagementServiceClientTest.php b/CommerceConsumerProcurement/tests/Unit/V1/Client/LicenseManagementServiceClientTest.php new file mode 100644 index 000000000000..a0dcd999b2ea --- /dev/null +++ b/CommerceConsumerProcurement/tests/Unit/V1/Client/LicenseManagementServiceClientTest.php @@ -0,0 +1,472 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return LicenseManagementServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new LicenseManagementServiceClient($options); + } + + /** @test */ + public function assignTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new AssignResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $parent = 'parent-995424086'; + $usernames = []; + $request = (new AssignRequest())->setParent($parent)->setUsernames($usernames); + $response = $gapicClient->assign($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.commerce.consumer.procurement.v1.LicenseManagementService/Assign', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($parent, $actualValue); + $actualValue = $actualRequestObject->getUsernames(); + $this->assertProtobufEquals($usernames, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function assignExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $parent = 'parent-995424086'; + $usernames = []; + $request = (new AssignRequest())->setParent($parent)->setUsernames($usernames); + try { + $gapicClient->assign($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function enumerateLicensedUsersTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $licensedUsersElement = new LicensedUser(); + $licensedUsers = [$licensedUsersElement]; + $expectedResponse = new EnumerateLicensedUsersResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setLicensedUsers($licensedUsers); + $transport->addResponse($expectedResponse); + // Mock request + $parent = 'parent-995424086'; + $request = (new EnumerateLicensedUsersRequest())->setParent($parent); + $response = $gapicClient->enumerateLicensedUsers($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getLicensedUsers()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.commerce.consumer.procurement.v1.LicenseManagementService/EnumerateLicensedUsers', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($parent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function enumerateLicensedUsersExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $parent = 'parent-995424086'; + $request = (new EnumerateLicensedUsersRequest())->setParent($parent); + try { + $gapicClient->enumerateLicensedUsers($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getLicensePoolTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $availableLicenseCount = 387091611; + $totalLicenseCount = 834147882; + $expectedResponse = new LicensePool(); + $expectedResponse->setName($name2); + $expectedResponse->setAvailableLicenseCount($availableLicenseCount); + $expectedResponse->setTotalLicenseCount($totalLicenseCount); + $transport->addResponse($expectedResponse); + // Mock request + $name = 'name3373707'; + $request = (new GetLicensePoolRequest())->setName($name); + $response = $gapicClient->getLicensePool($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.commerce.consumer.procurement.v1.LicenseManagementService/GetLicensePool', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($name, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getLicensePoolExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $name = 'name3373707'; + $request = (new GetLicensePoolRequest())->setName($name); + try { + $gapicClient->getLicensePool($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function unassignTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new UnassignResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $parent = 'parent-995424086'; + $usernames = []; + $request = (new UnassignRequest())->setParent($parent)->setUsernames($usernames); + $response = $gapicClient->unassign($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.commerce.consumer.procurement.v1.LicenseManagementService/Unassign', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($parent, $actualValue); + $actualValue = $actualRequestObject->getUsernames(); + $this->assertProtobufEquals($usernames, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function unassignExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $parent = 'parent-995424086'; + $usernames = []; + $request = (new UnassignRequest())->setParent($parent)->setUsernames($usernames); + try { + $gapicClient->unassign($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateLicensePoolTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $availableLicenseCount = 387091611; + $totalLicenseCount = 834147882; + $expectedResponse = new LicensePool(); + $expectedResponse->setName($name); + $expectedResponse->setAvailableLicenseCount($availableLicenseCount); + $expectedResponse->setTotalLicenseCount($totalLicenseCount); + $transport->addResponse($expectedResponse); + // Mock request + $licensePool = new LicensePool(); + $licensePoolLicenseAssignmentProtocol = new AssignmentProtocol(); + $licensePool->setLicenseAssignmentProtocol($licensePoolLicenseAssignmentProtocol); + $updateMask = new FieldMask(); + $request = (new UpdateLicensePoolRequest())->setLicensePool($licensePool)->setUpdateMask($updateMask); + $response = $gapicClient->updateLicensePool($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.commerce.consumer.procurement.v1.LicenseManagementService/UpdateLicensePool', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getLicensePool(); + $this->assertProtobufEquals($licensePool, $actualValue); + $actualValue = $actualRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateLicensePoolExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $licensePool = new LicensePool(); + $licensePoolLicenseAssignmentProtocol = new AssignmentProtocol(); + $licensePool->setLicenseAssignmentProtocol($licensePoolLicenseAssignmentProtocol); + $updateMask = new FieldMask(); + $request = (new UpdateLicensePoolRequest())->setLicensePool($licensePool)->setUpdateMask($updateMask); + try { + $gapicClient->updateLicensePool($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function assignAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new AssignResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $parent = 'parent-995424086'; + $usernames = []; + $request = (new AssignRequest())->setParent($parent)->setUsernames($usernames); + $response = $gapicClient->assignAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.commerce.consumer.procurement.v1.LicenseManagementService/Assign', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($parent, $actualValue); + $actualValue = $actualRequestObject->getUsernames(); + $this->assertProtobufEquals($usernames, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} From a93ec74d89b046e5fd0f751c17eca18b840ac74a Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 18:29:18 +0000 Subject: [PATCH 022/157] fix: location type annotation (#7739) PiperOrigin-RevId: 684535402 Source-Link: https://github.com/googleapis/googleapis/commit/d544df712edd6fcb39970dff0dbda2123fe2589e Source-Link: https://github.com/googleapis/googleapis-gen/commit/8bdbcef851073f49cf96e45864c4eadb37cd7d69 Copy-Tag: eyJwIjoiRGlzY292ZXJ5RW5naW5lLy5Pd2xCb3QueWFtbCIsImgiOiI4YmRiY2VmODUxMDczZjQ5Y2Y5NmU0NTg2NGM0ZWFkYjM3Y2Q3ZDY5In0= feat: Add GroundedGenerationService API feat: Add BillingEstimation in data store feat: Support Google Workspace search feat: Support advanced boost search feat: Add one_box_page_size on search feat: Add site_credential for site search config docs: Update documentation PiperOrigin-RevId: 684224724 Source-Link: https://github.com/googleapis/googleapis/commit/72be1383924aa4c59828ffd1e716d8d528825983 Source-Link: https://github.com/googleapis/googleapis-gen/commit/eecf784b020fdac5e75884fd3634b1aa40022aca Copy-Tag: eyJwIjoiRGlzY292ZXJ5RW5naW5lLy5Pd2xCb3QueWFtbCIsImgiOiJlZWNmNzg0YjAyMGZkYWM1ZTc1ODg0ZmQzNjM0YjFhYTQwMDIyYWNhIn0= --- DiscoveryEngine/metadata/V1/Answer.php | Bin 5570 -> 5646 bytes DiscoveryEngine/metadata/V1/Common.php | Bin 2908 -> 3076 bytes .../V1/ConversationalSearchService.php | Bin 13815 -> 14097 bytes .../metadata/V1/CustomTuningModel.php | Bin 2137 -> 2160 bytes DiscoveryEngine/metadata/V1/DataStore.php | Bin 2405 -> 3260 bytes .../metadata/V1/DocumentService.php | Bin 6575 -> 6836 bytes DiscoveryEngine/metadata/V1/Engine.php | Bin 2637 -> 2669 bytes .../metadata/V1/GroundedGenerationService.php | Bin 2654 -> 7834 bytes DiscoveryEngine/metadata/V1/SearchService.php | Bin 9248 -> 10162 bytes .../metadata/V1/SiteSearchEngineService.php | Bin 10297 -> 10328 bytes .../ControlServiceClient/create_control.php | 4 +- .../ControlServiceClient/delete_control.php | 2 +- .../V1/ControlServiceClient/get_control.php | 2 +- .../V1/ControlServiceClient/list_controls.php | 4 +- .../converse_conversation.php | 4 +- .../create_conversation.php | 2 +- .../create_session.php | 2 +- .../delete_conversation.php | 2 +- .../delete_session.php | 2 +- .../get_answer.php | 2 +- .../get_conversation.php | 2 +- .../get_session.php | 2 +- .../list_conversations.php | 2 +- .../list_sessions.php | 2 +- .../generate_grounded_content.php | 73 ++++ .../stream_generate_grounded_content.php | 79 ++++ .../samples/V1/RankServiceClient/rank.php | 2 +- .../purge_user_events.php | 4 +- .../src/V1/Answer/AnswerSkippedReason.php | 11 +- .../QueryClassificationInfo/Type.php | 9 +- DiscoveryEngine/src/V1/AnswerQueryRequest.php | 19 +- .../AnswerGenerationSpec.php | 70 ++++ .../QueryClassificationSpec/Type.php | 9 +- .../SearchResult/ChunkInfo.php | 44 +++ .../ChunkInfo/DocumentMetadata.php | 103 +++++ .../SearchResult/UnstructuredDocumentInfo.php | 39 +- .../DocumentContext.php | 8 +- .../ExtractiveSegment.php | 2 + .../FhirMatcher.php | 77 ++++ .../Matcher.php | 33 ++ .../DocumentMetadata/MatcherValue.php | 36 ++ .../src/V1/Client/DocumentServiceClient.php | 32 ++ .../GroundedGenerationServiceClient.php | 182 +++++++++ .../src/V1/ConverseConversationRequest.php | 28 +- .../src/V1/CreateControlRequest.php | 20 +- .../src/V1/CreateConversationRequest.php | 10 +- .../src/V1/CreateSessionRequest.php | 10 +- DiscoveryEngine/src/V1/CustomTuningModel.php | 62 ++- DiscoveryEngine/src/V1/DataStore.php | 104 +++++ .../src/V1/DataStore/BillingEstimation.php | 268 +++++++++++++ .../src/V1/DataStore/ContentConfig.php | 9 + .../src/V1/DeleteControlRequest.php | 10 +- .../src/V1/DeleteConversationRequest.php | 10 +- .../src/V1/DeleteSessionRequest.php | 10 +- DiscoveryEngine/src/V1/DocumentInfo.php | 6 +- .../src/V1/DocumentProcessingConfig.php | 18 +- DiscoveryEngine/src/V1/Engine.php | 46 ++- .../src/V1/GenerateGroundedContentRequest.php | 352 +++++++++++++++++ .../DynamicRetrievalConfiguration.php | 78 ++++ .../DynamicRetrievalPredictor.php | 116 ++++++ .../DynamicRetrievalPredictor/Version.php | 55 +++ .../GenerationSpec.php | 370 ++++++++++++++++++ .../GroundingSource.php | 142 +++++++ .../GroundingSource/GoogleSearchSource.php | 82 ++++ .../GroundingSource/InlineSource.php | 110 ++++++ .../GroundingSource/SearchSource.php | 190 +++++++++ .../GroundingSpec.php | 68 ++++ .../V1/GenerateGroundedContentResponse.php | 65 +++ .../Candidate.php | 200 ++++++++++ .../Candidate/GroundingMetadata.php | 238 +++++++++++ .../DynamicRetrievalMetadata.php | 78 ++++ .../DynamicRetrievalPredictorMetadata.php | 128 ++++++ .../Version.php | 55 +++ .../GroundingMetadata/GroundingSupport.php | 170 ++++++++ .../GroundingMetadata/RetrievalMetadata.php | 112 ++++++ .../RetrievalMetadata/Source.php | 76 ++++ .../GroundingMetadata/SearchEntryPoint.php | 110 ++++++ DiscoveryEngine/src/V1/GetAnswerRequest.php | 10 +- DiscoveryEngine/src/V1/GetControlRequest.php | 10 +- .../src/V1/GetConversationRequest.php | 10 +- DiscoveryEngine/src/V1/GetSessionRequest.php | 10 +- .../src/V1/GroundedGenerationContent.php | 109 ++++++ .../src/V1/GroundedGenerationContent/Part.php | 76 ++++ .../src/V1/ListControlsRequest.php | 20 +- .../src/V1/ListConversationsRequest.php | 10 +- .../src/V1/ListSessionsRequest.php | 10 +- DiscoveryEngine/src/V1/Project.php | 8 +- .../src/V1/PurgeUserEventsRequest.php | 8 +- DiscoveryEngine/src/V1/RankRequest.php | 8 +- DiscoveryEngine/src/V1/RecrawlUrisRequest.php | 42 ++ DiscoveryEngine/src/V1/SearchRequest.php | 42 ++ .../BoostSpec/ConditionBoostSpec.php | 48 +++ .../ConditionBoostSpec/BoostControlSpec.php | 204 ++++++++++ .../BoostControlSpec/AttributeType.php | 71 ++++ .../BoostControlSpec/ControlPoint.php | 128 ++++++ .../BoostControlSpec/InterpolationType.php | 57 +++ .../ContentSearchSpec/SummarySpec.php | 70 ++++ .../src/V1/SearchRequest/DataStoreSpec.php | 42 ++ .../Summary/SummarySkippedReason.php | 12 + DiscoveryEngine/src/V1/WorkspaceConfig.php | 185 +++++++++ .../src/V1/WorkspaceConfig/Type.php | 97 +++++ DiscoveryEngine/src/V1/gapic_metadata.json | 10 + .../completion_service_rest_client_config.php | 4 +- .../control_service_rest_client_config.php | 4 +- ...onal_search_service_rest_client_config.php | 4 +- .../data_store_service_rest_client_config.php | 4 +- .../document_service_descriptor_config.php | 1 + .../document_service_rest_client_config.php | 4 +- .../engine_service_rest_client_config.php | 4 +- ...nded_generation_service_client_config.json | 8 + ...d_generation_service_descriptor_config.php | 32 ++ ..._generation_service_rest_client_config.php | 16 +- .../project_service_rest_client_config.php | 4 +- .../rank_service_rest_client_config.php | 4 +- ...ommendation_service_rest_client_config.php | 4 +- .../schema_service_rest_client_config.php | 4 +- .../search_service_rest_client_config.php | 4 +- ...arch_tuning_service_rest_client_config.php | 4 +- ...arch_engine_service_rest_client_config.php | 4 +- .../user_event_service_rest_client_config.php | 4 +- .../V1/Client/EngineServiceClientTest.php | 8 + .../GroundedGenerationServiceClientTest.php | 166 ++++++++ 122 files changed, 5664 insertions(+), 192 deletions(-) create mode 100644 DiscoveryEngine/samples/V1/GroundedGenerationServiceClient/generate_grounded_content.php create mode 100644 DiscoveryEngine/samples/V1/GroundedGenerationServiceClient/stream_generate_grounded_content.php create mode 100644 DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/ChunkInfo/DocumentMetadata.php create mode 100644 DiscoveryEngine/src/V1/BatchGetDocumentsMetadataRequest/FhirMatcher.php create mode 100644 DiscoveryEngine/src/V1/DataStore/BillingEstimation.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration/DynamicRetrievalPredictor.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration/DynamicRetrievalPredictor/Version.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GenerationSpec.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/GoogleSearchSource.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/InlineSource.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/SearchSource.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSpec.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalMetadata.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalPredictorMetadata.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalPredictorMetadata/Version.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/GroundingSupport.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/RetrievalMetadata.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/RetrievalMetadata/Source.php create mode 100644 DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/SearchEntryPoint.php create mode 100644 DiscoveryEngine/src/V1/GroundedGenerationContent.php create mode 100644 DiscoveryEngine/src/V1/GroundedGenerationContent/Part.php create mode 100644 DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec.php create mode 100644 DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/AttributeType.php create mode 100644 DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/ControlPoint.php create mode 100644 DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/InterpolationType.php create mode 100644 DiscoveryEngine/src/V1/WorkspaceConfig.php create mode 100644 DiscoveryEngine/src/V1/WorkspaceConfig/Type.php diff --git a/DiscoveryEngine/metadata/V1/Answer.php b/DiscoveryEngine/metadata/V1/Answer.php index e163c2d7c02d738c303067ed4e247d37dfdf2cd4..35be0444f496955fd25ebed50f673099e021e8f4 100644 GIT binary patch delta 93 zcmX@4-KVqRG!x_3$!C~WGaXRcT*;in!?KH+OKkEv0kO&d`D+-LOs)}_!PLz-SyV8K xMM$1Yda|yNBuki)0L$chL0`rro6ic$FtQ58sB`<=1egN~7L(2p7L)%Ed;x-!d=QucYLgZb UYLlT6O#z#;?-3jUvo#ah0_F4;n*aa+ diff --git a/DiscoveryEngine/metadata/V1/Common.php b/DiscoveryEngine/metadata/V1/Common.php index f32e9c49d835dee42e127027c98476bfad00512a..47891dd4cd599bfc0288882f53d70b5a3efd46e9 100644 GIT binary patch delta 97 zcmca3)*`V%nu%$y@Mc*i4`!y*Je$*5SFp0Za$Lg5r8ap6mmF76YH@yPQF5wK)#P;? n8k3)LX{qa{Wn>oVR~JEL;!7$EQfu|AL89?+!OWD&eB6EjF5Ds$ delta 27 jcmZpXxFfbfnu+PF;AUAS4`!yt+?&%`SFldr&g}~TdCCZ% diff --git a/DiscoveryEngine/metadata/V1/ConversationalSearchService.php b/DiscoveryEngine/metadata/V1/ConversationalSearchService.php index a908b1cf059a240816ee85832293c4c0554a63a9..2cd4e6bad36e1eabd9dd5c800c9a806d29cd6e90 100644 GIT binary patch delta 332 zcmeyKJuz>?3>KDUDO}Ez-?J)g-op~k!E{4$vncOLCPvxG_xUARoR}mSC;#Bz$+Vbd z^JanRjG96*>ReKp>3R7@sqtBfnK|)EMX8C|nR)5)g{7%Ql@c5Zj2awH%nuwVdkUp7 z-4NKkQOJ#nshwx?PmwOBKU|wzMYS0jmu=oCc9fBE`Q&nmB@ip5C3iE;W}19mGE7cr z5+j#jN`7)_Zfaghd~Rw%xB^fpL|wIVsf2y1yeWU BW)A=W delta 145 zcmV;C0B--0Zue`jm;?lkVhTf(?*$;UyaZPW0>2-#6%EM(0U49u4;hpE54i;T0}2$A zfDsh4%@BbBlXwzk0*()}-x5Xw0=){8Cl!hUvI(=Z6)OP&qO;!?#Q_1MlcgA>lT8`B z0alX=8dj4f8x;iL1PT_DFdP=MR2v2X1pNUD7n9K(7n5}yc>!vZ@EmHhdmWY;o=q`= diff --git a/DiscoveryEngine/metadata/V1/CustomTuningModel.php b/DiscoveryEngine/metadata/V1/CustomTuningModel.php index b1a833e457ea20e4ff21f7f8a2b8faad4782b88a..4a60172f88093a4b803fb1314e17ec35c0d130ad 100644 GIT binary patch delta 49 zcmca9@Ihe1DkjE1lUFm%Vm!Oqjd?DkxR59pZ)#Cdeo=gGYH@L5da4A60;2}!=Ep2$ F%mB~Q5X}Gp delta 25 hcmew$a8qEzDkjFKlUFm%V%)abjd?EP=3gvj%m9*23V{Fs diff --git a/DiscoveryEngine/metadata/V1/DataStore.php b/DiscoveryEngine/metadata/V1/DataStore.php index 37038364070b25bdfface4703ed715ec9bbf6bb1..878fa114d0ee1e299092250ede8de34da3748773 100644 GIT binary patch delta 784 zcmaKpPm9w)7{*PLrtYk6r{l7wT@?)?i-%Gc1i=N#rem$G+tOrRycp7CwhlIb$V^=H z(u3e#a`fg05MeJOegg3$co4ypU%`XZY?Zhx-iCR8&-3y=?|1aE{_dr${HTG}t6nSn zApb0V0*CLF7t%T!)9I9k6NfNP1DDe%)Xra)HkLQHvPY_Z%jK@cql7fKk2w4X+m^o? zGP(!gL6kgUvFj1Xi^6?6(dxOsm93PoRQG<1X0By7)i<-o+Y+dq$U_&vD&tA&@iZa6 zPPWPL(5E*xa7;ORVuhB)f`hT|)#QH4zqS7_A3Seh2 z==8C(HyHJ-pn{AcXT~3N<*$Gb7+2N30(vAB1r<5PKC=)2xECg zf}06Ye=PwepDXsU9}cmzyJHQp*}c=nZFmYnaAvV(d(?e^p@gbndGT}K==Nc$fLL7{ xTTn*lKy`tbMj!9AjS*A|KJ%_&!!oMr;OqkHj0U?y3#tXEhw%_r4r`}v=@;Fg?NI;# delta 47 zcmV+~0MP%u8RZhNh64nY3kooiOE8nV1N;Km2D7*Xg8`G~2A={VX_L4JX_Gez%(G|< FQ~|9p5sv@> diff --git a/DiscoveryEngine/metadata/V1/DocumentService.php b/DiscoveryEngine/metadata/V1/DocumentService.php index 06077227204995e4663ad835101a4328dc639e62..96eaaabe568a5eacb9bdb30782692fa0084470ea 100644 GIT binary patch delta 282 zcmZ2)yv20GMi!RM+FWK6z0EeiX6a>Nna#qbFj)YI=Wy%g8M9O)N>yNG%d_ zh;ecZSAm33Di;sfyj+O+5=;t=8r(*{lizbX$s*b7!QjNn#ST@Z zw1AaM5$Hha$=|sum^LwQF66dlWGtDyo=4V2$c2j+#erZGIi0jgaNOooJWqK55R+X$ delta 87 zcmV-d0I2`8HLo+Uu>=IJDGD}`OE$CX1dRj)+yV+9lhGF-lbi{^0eh3Q3UClY2?_^o tVRU0?WpX0g1PURO(H9$&FBk@sybE#y>;khe3_Sq>E|YEz9kbC5;|wgl9UuSz diff --git a/DiscoveryEngine/metadata/V1/Engine.php b/DiscoveryEngine/metadata/V1/Engine.php index dc42397e8e7ea4843f5c59771367f157e6b859be..227b9d7477417f014f77341e25457a058d835614 100644 GIT binary patch delta 59 zcmX>r@>XQSZ6?MOlkYI?W@_f%Jd=4VlY)>Omtaa}abi+VYJ6f|VoqgAW^%EFlmep$ PhZFMyN5;*5Z2y@7miZJ^ delta 26 icmaDWa#m!+Z6?MQlkYI?W_rxEc_#B#rp%WoV>8BdQrethHD8Tm_ zy4~H|4<{xHpcSA6fdoQGz)B!-0r3xT;D9)?Hy#q#Js^8ko(^?kqZQJ;O&-E-k3WtH00(*xR2>PJejM-|s|0>^MHr5-k$)Kd)Sz%?!Esfx0^ zscdZCRVvHXyD#EV-w8c~7L=Cbv@Du8EGKN_8>VkKhtxZwcFVMB{%|4R@|@6a(1z9$ zyiCW|eCi#V230vX09!wxzN;HlS=}n#p@H7e1HHD&3D?SuaBaDpaBX+t7Jy;tzOSrC z3?f~S{*E9I4?)2{ZdkWWL-7MWz<*vgea*DZz|<}CYpC~<($p=VBDMa#&CoUiq^Gb0 zo3=scuPcHk+xxQXpq-YKSkNtIIy76YY6sM_b*r{aeZw=|!11Y!&clhcXW^`l4MkBeP z6?FUg#H7r?*Wf2Np?GS4Cszdtm4}Sl6Ef=If_y3Bp}Qu=6*Ikv6gfJXXA4bcU#%V) zINETzf?TuK?4 z&n&*F4pC7ZNLbxMI`S15W&e_C7!BxyKyX<*QyPO&h7Gwtor5d!O~s@l$+qb`A@u`N zgbB+rxVMYrrTmA*)JMhZP`lP^b0IBS)mIVl^6Sw#vJ1pN@&kH+kl|wlax|Drqsp1Z z!qe+W)?vaBc8o1{8fq<=X?0+$OO3e^F5<>;5hMIR-iB&qVg{*5l~9;&aj-=v(R{{d zl=HcBYCbVl&ZYsG5Ho~k>2+%Pb7S14Hc!jr9+F(=6f1V%9m#)4!E}#)S(rF*8r0Iv z2DjiOxd3M^-EM_?i)scgp?@=XpMwlKh09WB=uvKk)Y_T%B#9762ac<`+(}YvQpdOb zxp6$4UQ4lWS75g3F;BIPBh96lErO%D30zODjj;6>AnRfP<1$T_C;9Sdbo@YnpgCdS zhJhA1`_%U5fRj(-dTAP_vZo`JM!mNUUKRm;-qfW)|DZ ztK^3gjAP;Aqu5-~>BVn+OoFPrLJV>dCWAe6f<4D-aK{rqmb(e#@s>+)Znv_%Q{CLq z?rrRBRm#( z!op1x2{^j4TJ5x^=wYN*ITyio?F{4VQ{6N6V!kZQGKn4B!!rVFk{zUs>OtzK-mSD>G?!5FtSgNxNA+4vyevA2qR!Eq&_3bKb2sr(?p~S z)4XB8q=Q)#;YFM+Eqqi|;gun|oc98DOW+a$cb4H8232SUNG-Gj9$9IuG{%~yg@t>B z{O2I!>rD& zCf0xG%OW5?_w-g3RMm1!QvTO8OeX(heraOY`hdGyn%stQbUjx1a(6jh_4mon_{M%2 zD+q=+Q3de;Nc*Y|qGmWMv`zzvy$VMqID&uNam#<6g4yIYkHh8`V@lqWx}sL7jsC|vtmi9A;siT_sr>5^ znC-ueZ%Z-a@GzNP448bF9Ut&qG{S1S>c)C?qoS2JH}0~UE=6V_ z6K%Uw+}g>G%D=;0G)NfobM)?{9@i2Bu^v9N`1R*{dA%|vb$M(l`4=g8ap*3B)j?04 z{vGM#6+EfeF9AfxWlaS0x>FYHXCcFSG1fjIMfnZL_F)7TG#Q?d`)-oQqmVpCM}0K3I_%!0k=g)WT6;RlKkL1Y@?^K85PQWmDQ zuEi38tk%wF{6KCUNO_MM`)z4hjdB%;VT$o&yG`N1BJtk3bOFw3{X25M9Dxhn`5~H9T?-@?PCIGx3Y9%8^l!;ixK&c5~R!Q7i-ONR*yx9>#z!hjdl3= z=RAyKH1e-3D$?-)s58h|t;a@4*~FLQ_+mn)$){kh!)sZbU{mo35LCoZ7Aip zhTh5m*0C4mHs1Z~KYpBA%az%K)5Cb|yM)h6Z&Pfa^EdMGH~jsmfTP^O`V^!a^U`Y) z`KJVz2JroVPuK<-Lf0JOkJ37hDp*PZfAi@gy(yJOb!puqR$M zUv(`#Xgc0O=|?Ge2_FcCX<51=@&=7xlQ4Tn@x&hqx1=xK5syD2-S9_;mecooin5?T z_bB1kZ}oloRcdCrx>Mf7I`WH^ja4iWf1A201{ErQ8dI0!_tOf0m{oTdK8SbJq9@k& z8>`q;!$;PCr*eW!p}^@B3O$4hh24ev7=Ooo{aW%`_KJ9}?0DTA__E1&iWkU7@Ce|4 DW(aYC delta 31 ncmbPbdrxG8IWyB;-pQ8CuQ%6;^)WLYW17q-C9|1FrjH2#wcQFn diff --git a/DiscoveryEngine/metadata/V1/SearchService.php b/DiscoveryEngine/metadata/V1/SearchService.php index 4a6c0325c9a1719c37bf404913e748615b7ce26e..84d04cc513f5e80902e7c79f85ba2a7f46902dcb 100644 GIT binary patch delta 731 zcmaKqF>ljA6o5H93FKn8&H=@>sy0MOq)RI@bU*^+1V^=$I>B)wkU%G=Tp|a@XB-Do z1_}%eEDZhuM63)TJXNZM#K_DJ5=e;Oz=E9+Q5uQy-Fxr5_r1IE_WRnqA1w2$68>ac zfcdf>%E?P$X&GjzLvWjpuxoY+9$1fvxEc0SuM(ga@R{aWbQ-2QmhBTyOy)o#U1Gn= zAZ%xz0Os&y@SPhmA5*~{eoI6nh}x76e7s8?-=j7jxMWvk1B$kSYy3)cqZDV$(_|yc zNiUO7IDUu_gdL06cd=vki3s95(K7%SOyBpc_RuHT-*bt`M2UrBF94~{n0|GRz9G*V zjHn*H01#PDq~TKA^eyU4G3*56{0E~RZJMB-M$^n3T^d0LVj{;DGDT~K*`J^0k9R$; zm##qWXpGLm#lLzFOnW#JKLfexPR%|YI{w6($?rh^U%6E%$%dh;rKX`^<5qoN!A-4E zSITNdRjvys5D(K@b4StDvRoBF99DFtv8^eMhQQ>@FgtIVhpVb)D0;nCl?}C~#oXgq z2vb#6Q)FEL(&uQwH-^O9Q$}t$<{tv)H5V=~K4-vTFwP#V-@XVXtLspY;GSvOxa|@1 zp5=7${kTbl(LPoPM!=K})kKeOorRsjO}BC|mSF#)rU2ATu`Rg)+SRkM-{fB^!p0h1IB zcmXz(jtw@m(GY|I0{IKGR}zK-0h5#76uGm(6=ehgkFzHls{;b*3$xT6uLJ?PvxFi# J0kh~M$^(t!C2Rly diff --git a/DiscoveryEngine/metadata/V1/SiteSearchEngineService.php b/DiscoveryEngine/metadata/V1/SiteSearchEngineService.php index 190cb1f40a19c06c94f907302f5a60d7ac04d310..9a1bc9de605154667014edc4df5c21e0c9e8d703 100644 GIT binary patch delta 83 zcmV-Z0IdJHP}oqg@&g2%ND4rct^_iXeGaoW1iJ|ingI$DQe|UuVRvj*a%q!+5@3^F p4iFv^910I}X>?^@V{&C=Wo~q7VQd%$AOR=|LIdDI0kdun%Nf3!8zcY# delta 51 zcmV-30L=f`P`OaB@&g3@M+!ibt^_iXeGaoW1iJ|hdsetLocation($formattedLocation); + + // Call the API and handle any network failures. + try { + /** @var GenerateGroundedContentResponse $response */ + $response = $groundedGenerationServiceClient->generateGroundedContent($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedLocation = GroundedGenerationServiceClient::locationName('[PROJECT]', '[LOCATION]'); + + generate_grounded_content_sample($formattedLocation); +} +// [END discoveryengine_v1_generated_GroundedGenerationService_GenerateGroundedContent_sync] diff --git a/DiscoveryEngine/samples/V1/GroundedGenerationServiceClient/stream_generate_grounded_content.php b/DiscoveryEngine/samples/V1/GroundedGenerationServiceClient/stream_generate_grounded_content.php new file mode 100644 index 000000000000..ea57f6a63064 --- /dev/null +++ b/DiscoveryEngine/samples/V1/GroundedGenerationServiceClient/stream_generate_grounded_content.php @@ -0,0 +1,79 @@ +setLocation($formattedLocation); + + // Call the API and handle any network failures. + try { + /** @var BidiStream $stream */ + $stream = $groundedGenerationServiceClient->streamGenerateGroundedContent(); + $stream->writeAll([$request,]); + + /** @var GenerateGroundedContentResponse $element */ + foreach ($stream->closeWriteAndReadAll() as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedLocation = GroundedGenerationServiceClient::locationName('[PROJECT]', '[LOCATION]'); + + stream_generate_grounded_content_sample($formattedLocation); +} +// [END discoveryengine_v1_generated_GroundedGenerationService_StreamGenerateGroundedContent_sync] diff --git a/DiscoveryEngine/samples/V1/RankServiceClient/rank.php b/DiscoveryEngine/samples/V1/RankServiceClient/rank.php index c827628b944d..41a011e4e30e 100644 --- a/DiscoveryEngine/samples/V1/RankServiceClient/rank.php +++ b/DiscoveryEngine/samples/V1/RankServiceClient/rank.php @@ -33,7 +33,7 @@ * Ranks a list of text records based on the given input query. * * @param string $formattedRankingConfig The resource name of the rank service config, such as - * `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. Please see + * `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. Please see * {@see RankServiceClient::rankingConfigName()} for help formatting this field. */ function rank_sample(string $formattedRankingConfig): void diff --git a/DiscoveryEngine/samples/V1/UserEventServiceClient/purge_user_events.php b/DiscoveryEngine/samples/V1/UserEventServiceClient/purge_user_events.php index d66083dd37ad..7e5de6f5ae7d 100644 --- a/DiscoveryEngine/samples/V1/UserEventServiceClient/purge_user_events.php +++ b/DiscoveryEngine/samples/V1/UserEventServiceClient/purge_user_events.php @@ -38,8 +38,8 @@ * * @param string $formattedParent The resource name of the catalog under which the events are * created. The format is - * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}` - * Please see {@see UserEventServiceClient::dataStoreName()} for help formatting this field. + * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. Please see + * {@see UserEventServiceClient::dataStoreName()} for help formatting this field. * @param string $filter The filter string to specify the events to be deleted with a * length limit of 5,000 characters. The eligible fields for filtering are: * diff --git a/DiscoveryEngine/src/V1/Answer/AnswerSkippedReason.php b/DiscoveryEngine/src/V1/Answer/AnswerSkippedReason.php index 4cf04de06fac..ef1da4f5f4bb 100644 --- a/DiscoveryEngine/src/V1/Answer/AnswerSkippedReason.php +++ b/DiscoveryEngine/src/V1/Answer/AnswerSkippedReason.php @@ -26,7 +26,8 @@ class AnswerSkippedReason */ const ADVERSARIAL_QUERY_IGNORED = 1; /** - * The non-answer seeking query ignored case. + * The non-answer seeking query ignored case + * Google skips the answer if the query is chit chat. * * Generated from protobuf enum NON_ANSWER_SEEKING_QUERY_IGNORED = 2; */ @@ -71,6 +72,13 @@ class AnswerSkippedReason * Generated from protobuf enum CUSTOMER_POLICY_VIOLATION = 7; */ const CUSTOMER_POLICY_VIOLATION = 7; + /** + * The non-answer seeking query ignored case. + * Google skips the answer if the query doesn't have clear intent. + * + * Generated from protobuf enum NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8; + */ + const NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8; private static $valueToName = [ self::ANSWER_SKIPPED_REASON_UNSPECIFIED => 'ANSWER_SKIPPED_REASON_UNSPECIFIED', @@ -81,6 +89,7 @@ class AnswerSkippedReason self::NO_RELEVANT_CONTENT => 'NO_RELEVANT_CONTENT', self::JAIL_BREAKING_QUERY_IGNORED => 'JAIL_BREAKING_QUERY_IGNORED', self::CUSTOMER_POLICY_VIOLATION => 'CUSTOMER_POLICY_VIOLATION', + self::NON_ANSWER_SEEKING_QUERY_IGNORED_V2 => 'NON_ANSWER_SEEKING_QUERY_IGNORED_V2', ]; public static function name($value) diff --git a/DiscoveryEngine/src/V1/Answer/QueryUnderstandingInfo/QueryClassificationInfo/Type.php b/DiscoveryEngine/src/V1/Answer/QueryUnderstandingInfo/QueryClassificationInfo/Type.php index 1e25779cc343..2359554eb2b2 100644 --- a/DiscoveryEngine/src/V1/Answer/QueryUnderstandingInfo/QueryClassificationInfo/Type.php +++ b/DiscoveryEngine/src/V1/Answer/QueryUnderstandingInfo/QueryClassificationInfo/Type.php @@ -26,7 +26,7 @@ class Type */ const ADVERSARIAL_QUERY = 1; /** - * Non-answer-seeking query classification type. + * Non-answer-seeking query classification type, for chit chat. * * Generated from protobuf enum NON_ANSWER_SEEKING_QUERY = 2; */ @@ -37,12 +37,19 @@ class Type * Generated from protobuf enum JAIL_BREAKING_QUERY = 3; */ const JAIL_BREAKING_QUERY = 3; + /** + * Non-answer-seeking query classification type, for no clear intent. + * + * Generated from protobuf enum NON_ANSWER_SEEKING_QUERY_V2 = 4; + */ + const NON_ANSWER_SEEKING_QUERY_V2 = 4; private static $valueToName = [ self::TYPE_UNSPECIFIED => 'TYPE_UNSPECIFIED', self::ADVERSARIAL_QUERY => 'ADVERSARIAL_QUERY', self::NON_ANSWER_SEEKING_QUERY => 'NON_ANSWER_SEEKING_QUERY', self::JAIL_BREAKING_QUERY => 'JAIL_BREAKING_QUERY', + self::NON_ANSWER_SEEKING_QUERY_V2 => 'NON_ANSWER_SEEKING_QUERY_V2', ]; public static function name($value) diff --git a/DiscoveryEngine/src/V1/AnswerQueryRequest.php b/DiscoveryEngine/src/V1/AnswerQueryRequest.php index 56bead21686c..9b11d0f2349c 100644 --- a/DiscoveryEngine/src/V1/AnswerQueryRequest.php +++ b/DiscoveryEngine/src/V1/AnswerQueryRequest.php @@ -74,6 +74,8 @@ class AnswerQueryRequest extends \Google\Protobuf\Internal\Message */ protected $query_understanding_spec = null; /** + * Deprecated: This field is deprecated. Streaming Answer API will be + * supported. * Asynchronous mode control. * If enabled, the response will be returned with answer/session resource * name without final answer. The API users need to do the polling to get @@ -83,7 +85,8 @@ class AnswerQueryRequest extends \Google\Protobuf\Internal\Message * [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession] * method. * - * Generated from protobuf field bool asynchronous_mode = 10; + * Generated from protobuf field bool asynchronous_mode = 10 [deprecated = true]; + * @deprecated */ protected $asynchronous_mode = false; /** @@ -150,6 +153,8 @@ class AnswerQueryRequest extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\QueryUnderstandingSpec $query_understanding_spec * Query understanding specification. * @type bool $asynchronous_mode + * Deprecated: This field is deprecated. Streaming Answer API will be + * supported. * Asynchronous mode control. * If enabled, the response will be returned with answer/session resource * name without final answer. The API users need to do the polling to get @@ -474,6 +479,8 @@ public function setQueryUnderstandingSpec($var) } /** + * Deprecated: This field is deprecated. Streaming Answer API will be + * supported. * Asynchronous mode control. * If enabled, the response will be returned with answer/session resource * name without final answer. The API users need to do the polling to get @@ -483,15 +490,19 @@ public function setQueryUnderstandingSpec($var) * [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession] * method. * - * Generated from protobuf field bool asynchronous_mode = 10; + * Generated from protobuf field bool asynchronous_mode = 10 [deprecated = true]; * @return bool + * @deprecated */ public function getAsynchronousMode() { + @trigger_error('asynchronous_mode is deprecated.', E_USER_DEPRECATED); return $this->asynchronous_mode; } /** + * Deprecated: This field is deprecated. Streaming Answer API will be + * supported. * Asynchronous mode control. * If enabled, the response will be returned with answer/session resource * name without final answer. The API users need to do the polling to get @@ -501,12 +512,14 @@ public function getAsynchronousMode() * [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession] * method. * - * Generated from protobuf field bool asynchronous_mode = 10; + * Generated from protobuf field bool asynchronous_mode = 10 [deprecated = true]; * @param bool $var * @return $this + * @deprecated */ public function setAsynchronousMode($var) { + @trigger_error('asynchronous_mode is deprecated.', E_USER_DEPRECATED); GPBUtil::checkBool($var); $this->asynchronous_mode = $var; diff --git a/DiscoveryEngine/src/V1/AnswerQueryRequest/AnswerGenerationSpec.php b/DiscoveryEngine/src/V1/AnswerQueryRequest/AnswerGenerationSpec.php index 0bd500071a5d..fbc6526be641 100644 --- a/DiscoveryEngine/src/V1/AnswerQueryRequest/AnswerGenerationSpec.php +++ b/DiscoveryEngine/src/V1/AnswerQueryRequest/AnswerGenerationSpec.php @@ -77,6 +77,21 @@ class AnswerGenerationSpec extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional bool ignore_low_relevant_content = 7; */ protected $ignore_low_relevant_content = null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The + * default value is `false`. + * Google employs search-query classification to detect jail-breaking + * queries. No summary is returned if the search query is classified as a + * jail-breaking query. A user might add instructions to the query to + * change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a + * competing company's CEO". If this field is set to `true`, we skip + * generating summaries for jail-breaking queries and return fallback + * messages instead. + * + * Generated from protobuf field bool ignore_jail_breaking_query = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $ignore_jail_breaking_query = false; /** * Constructor. @@ -118,6 +133,17 @@ class AnswerGenerationSpec extends \Google\Protobuf\Internal\Message * If this field is set to `false`, all search results are used regardless * of relevance to generate answers. If set to `true` or unset, the behavior * will be determined automatically by the service. + * @type bool $ignore_jail_breaking_query + * Optional. Specifies whether to filter out jail-breaking queries. The + * default value is `false`. + * Google employs search-query classification to detect jail-breaking + * queries. No summary is returned if the search query is classified as a + * jail-breaking query. A user might add instructions to the query to + * change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a + * competing company's CEO". If this field is set to `true`, we skip + * generating summaries for jail-breaking queries and return fallback + * messages instead. * } */ public function __construct($data = NULL) { @@ -377,6 +403,50 @@ public function setIgnoreLowRelevantContent($var) return $this; } + /** + * Optional. Specifies whether to filter out jail-breaking queries. The + * default value is `false`. + * Google employs search-query classification to detect jail-breaking + * queries. No summary is returned if the search query is classified as a + * jail-breaking query. A user might add instructions to the query to + * change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a + * competing company's CEO". If this field is set to `true`, we skip + * generating summaries for jail-breaking queries and return fallback + * messages instead. + * + * Generated from protobuf field bool ignore_jail_breaking_query = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getIgnoreJailBreakingQuery() + { + return $this->ignore_jail_breaking_query; + } + + /** + * Optional. Specifies whether to filter out jail-breaking queries. The + * default value is `false`. + * Google employs search-query classification to detect jail-breaking + * queries. No summary is returned if the search query is classified as a + * jail-breaking query. A user might add instructions to the query to + * change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a + * competing company's CEO". If this field is set to `true`, we skip + * generating summaries for jail-breaking queries and return fallback + * messages instead. + * + * Generated from protobuf field bool ignore_jail_breaking_query = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setIgnoreJailBreakingQuery($var) + { + GPBUtil::checkBool($var); + $this->ignore_jail_breaking_query = $var; + + return $this; + } + } diff --git a/DiscoveryEngine/src/V1/AnswerQueryRequest/QueryUnderstandingSpec/QueryClassificationSpec/Type.php b/DiscoveryEngine/src/V1/AnswerQueryRequest/QueryUnderstandingSpec/QueryClassificationSpec/Type.php index 145547c22087..3e762d2414b8 100644 --- a/DiscoveryEngine/src/V1/AnswerQueryRequest/QueryUnderstandingSpec/QueryClassificationSpec/Type.php +++ b/DiscoveryEngine/src/V1/AnswerQueryRequest/QueryUnderstandingSpec/QueryClassificationSpec/Type.php @@ -26,7 +26,7 @@ class Type */ const ADVERSARIAL_QUERY = 1; /** - * Non-answer-seeking query classification type. + * Non-answer-seeking query classification type, for chit chat. * * Generated from protobuf enum NON_ANSWER_SEEKING_QUERY = 2; */ @@ -37,12 +37,19 @@ class Type * Generated from protobuf enum JAIL_BREAKING_QUERY = 3; */ const JAIL_BREAKING_QUERY = 3; + /** + * Non-answer-seeking query classification type, for no clear intent. + * + * Generated from protobuf enum NON_ANSWER_SEEKING_QUERY_V2 = 4; + */ + const NON_ANSWER_SEEKING_QUERY_V2 = 4; private static $valueToName = [ self::TYPE_UNSPECIFIED => 'TYPE_UNSPECIFIED', self::ADVERSARIAL_QUERY => 'ADVERSARIAL_QUERY', self::NON_ANSWER_SEEKING_QUERY => 'NON_ANSWER_SEEKING_QUERY', self::JAIL_BREAKING_QUERY => 'JAIL_BREAKING_QUERY', + self::NON_ANSWER_SEEKING_QUERY_V2 => 'NON_ANSWER_SEEKING_QUERY_V2', ]; public static function name($value) diff --git a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/ChunkInfo.php b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/ChunkInfo.php index b35fda5b1b26..c26ca5b29b05 100644 --- a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/ChunkInfo.php +++ b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/ChunkInfo.php @@ -27,6 +27,12 @@ class ChunkInfo extends \Google\Protobuf\Internal\Message * Generated from protobuf field string content = 2; */ protected $content = ''; + /** + * Metadata of the document from the current chunk. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata document_metadata = 4; + */ + protected $document_metadata = null; /** * Constructor. @@ -38,6 +44,8 @@ class ChunkInfo extends \Google\Protobuf\Internal\Message * Chunk resource name. * @type string $content * Chunk textual content. + * @type \Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\ChunkInfo\DocumentMetadata $document_metadata + * Metadata of the document from the current chunk. * } */ public function __construct($data = NULL) { @@ -97,6 +105,42 @@ public function setContent($var) return $this; } + /** + * Metadata of the document from the current chunk. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata document_metadata = 4; + * @return \Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\ChunkInfo\DocumentMetadata|null + */ + public function getDocumentMetadata() + { + return $this->document_metadata; + } + + public function hasDocumentMetadata() + { + return isset($this->document_metadata); + } + + public function clearDocumentMetadata() + { + unset($this->document_metadata); + } + + /** + * Metadata of the document from the current chunk. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata document_metadata = 4; + * @param \Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\ChunkInfo\DocumentMetadata $var + * @return $this + */ + public function setDocumentMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\ChunkInfo\DocumentMetadata::class); + $this->document_metadata = $var; + + return $this; + } + } diff --git a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/ChunkInfo/DocumentMetadata.php b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/ChunkInfo/DocumentMetadata.php new file mode 100644 index 000000000000..0f7227b608b8 --- /dev/null +++ b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/ChunkInfo/DocumentMetadata.php @@ -0,0 +1,103 @@ +google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata + */ +class DocumentMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Uri of the document. + * + * Generated from protobuf field string uri = 1; + */ + protected $uri = ''; + /** + * Title of the document. + * + * Generated from protobuf field string title = 2; + */ + protected $title = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * Uri of the document. + * @type string $title + * Title of the document. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\ConversationalSearchService::initOnce(); + parent::__construct($data); + } + + /** + * Uri of the document. + * + * Generated from protobuf field string uri = 1; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * Uri of the document. + * + * Generated from protobuf field string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + + /** + * Title of the document. + * + * Generated from protobuf field string title = 2; + * @return string + */ + public function getTitle() + { + return $this->title; + } + + /** + * Title of the document. + * + * Generated from protobuf field string title = 2; + * @param string $var + * @return $this + */ + public function setTitle($var) + { + GPBUtil::checkString($var, True); + $this->title = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo.php b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo.php index 532d17bbfe72..e19d82364cfe 100644 --- a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo.php +++ b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo.php @@ -34,7 +34,9 @@ class UnstructuredDocumentInfo extends \Google\Protobuf\Internal\Message */ protected $title = ''; /** - * List of document contexts. + * List of document contexts. The content will be used for Answer + * Generation. This is supposed to be the main content of the document + * that can be long and comprehensive. * * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext document_contexts = 4; */ @@ -46,9 +48,13 @@ class UnstructuredDocumentInfo extends \Google\Protobuf\Internal\Message */ private $extractive_segments; /** + * Deprecated: This field is deprecated and will have no effect on + * the Answer generation. + * Please use document_contexts and extractive_segments fields. * List of extractive answers. * - * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6; + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6 [deprecated = true]; + * @deprecated */ private $extractive_answers; @@ -65,10 +71,15 @@ class UnstructuredDocumentInfo extends \Google\Protobuf\Internal\Message * @type string $title * Title. * @type array<\Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\DocumentContext>|\Google\Protobuf\Internal\RepeatedField $document_contexts - * List of document contexts. + * List of document contexts. The content will be used for Answer + * Generation. This is supposed to be the main content of the document + * that can be long and comprehensive. * @type array<\Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\ExtractiveSegment>|\Google\Protobuf\Internal\RepeatedField $extractive_segments * List of extractive segments. * @type array<\Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\ExtractiveAnswer>|\Google\Protobuf\Internal\RepeatedField $extractive_answers + * Deprecated: This field is deprecated and will have no effect on + * the Answer generation. + * Please use document_contexts and extractive_segments fields. * List of extractive answers. * } */ @@ -156,7 +167,9 @@ public function setTitle($var) } /** - * List of document contexts. + * List of document contexts. The content will be used for Answer + * Generation. This is supposed to be the main content of the document + * that can be long and comprehensive. * * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext document_contexts = 4; * @return \Google\Protobuf\Internal\RepeatedField @@ -167,7 +180,9 @@ public function getDocumentContexts() } /** - * List of document contexts. + * List of document contexts. The content will be used for Answer + * Generation. This is supposed to be the main content of the document + * that can be long and comprehensive. * * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext document_contexts = 4; * @param array<\Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\DocumentContext>|\Google\Protobuf\Internal\RepeatedField $var @@ -208,25 +223,35 @@ public function setExtractiveSegments($var) } /** + * Deprecated: This field is deprecated and will have no effect on + * the Answer generation. + * Please use document_contexts and extractive_segments fields. * List of extractive answers. * - * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6; + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6 [deprecated = true]; * @return \Google\Protobuf\Internal\RepeatedField + * @deprecated */ public function getExtractiveAnswers() { + @trigger_error('extractive_answers is deprecated.', E_USER_DEPRECATED); return $this->extractive_answers; } /** + * Deprecated: This field is deprecated and will have no effect on + * the Answer generation. + * Please use document_contexts and extractive_segments fields. * List of extractive answers. * - * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6; + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6 [deprecated = true]; * @param array<\Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\ExtractiveAnswer>|\Google\Protobuf\Internal\RepeatedField $var * @return $this + * @deprecated */ public function setExtractiveAnswers($var) { + @trigger_error('extractive_answers is deprecated.', E_USER_DEPRECATED); $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\ExtractiveAnswer::class); $this->extractive_answers = $arr; diff --git a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo/DocumentContext.php b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo/DocumentContext.php index 6c15269c9a25..36d3af1a6faa 100644 --- a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo/DocumentContext.php +++ b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo/DocumentContext.php @@ -22,7 +22,7 @@ class DocumentContext extends \Google\Protobuf\Internal\Message */ protected $page_identifier = ''; /** - * Document content. + * Document content to be used for answer generation. * * Generated from protobuf field string content = 2; */ @@ -37,7 +37,7 @@ class DocumentContext extends \Google\Protobuf\Internal\Message * @type string $page_identifier * Page identifier. * @type string $content - * Document content. + * Document content to be used for answer generation. * } */ public function __construct($data = NULL) { @@ -72,7 +72,7 @@ public function setPageIdentifier($var) } /** - * Document content. + * Document content to be used for answer generation. * * Generated from protobuf field string content = 2; * @return string @@ -83,7 +83,7 @@ public function getContent() } /** - * Document content. + * Document content to be used for answer generation. * * Generated from protobuf field string content = 2; * @param string $var diff --git a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo/ExtractiveSegment.php b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo/ExtractiveSegment.php index 4857b57330d6..5cd3964e36f9 100644 --- a/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo/ExtractiveSegment.php +++ b/DiscoveryEngine/src/V1/AnswerQueryRequest/SearchSpec/SearchResultList/SearchResult/UnstructuredDocumentInfo/ExtractiveSegment.php @@ -11,6 +11,8 @@ /** * Extractive segment. * [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + * Answer generation will only use it if document_contexts is empty. + * This is supposed to be shorter snippets. * * Generated from protobuf message google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment */ diff --git a/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataRequest/FhirMatcher.php b/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataRequest/FhirMatcher.php new file mode 100644 index 000000000000..6d5544b6fc57 --- /dev/null +++ b/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataRequest/FhirMatcher.php @@ -0,0 +1,77 @@ +google.cloud.discoveryengine.v1.BatchGetDocumentsMetadataRequest.FhirMatcher + */ +class FhirMatcher extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The FHIR resources to match by. + * Format: + * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + * + * Generated from protobuf field repeated string fhir_resources = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + private $fhir_resources; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $fhir_resources + * Required. The FHIR resources to match by. + * Format: + * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\DocumentService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The FHIR resources to match by. + * Format: + * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + * + * Generated from protobuf field repeated string fhir_resources = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getFhirResources() + { + return $this->fhir_resources; + } + + /** + * Required. The FHIR resources to match by. + * Format: + * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + * + * Generated from protobuf field repeated string fhir_resources = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setFhirResources($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->fhir_resources = $arr; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataRequest/Matcher.php b/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataRequest/Matcher.php index 4b2170341859..837f67795cc6 100644 --- a/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataRequest/Matcher.php +++ b/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataRequest/Matcher.php @@ -26,6 +26,8 @@ class Matcher extends \Google\Protobuf\Internal\Message * * @type \Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest\UrisMatcher $uris_matcher * Matcher by exact URIs. + * @type \Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest\FhirMatcher $fhir_matcher + * Matcher by FHIR resource names. * } */ public function __construct($data = NULL) { @@ -64,6 +66,37 @@ public function setUrisMatcher($var) return $this; } + /** + * Matcher by FHIR resource names. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.BatchGetDocumentsMetadataRequest.FhirMatcher fhir_matcher = 2; + * @return \Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest\FhirMatcher|null + */ + public function getFhirMatcher() + { + return $this->readOneof(2); + } + + public function hasFhirMatcher() + { + return $this->hasOneof(2); + } + + /** + * Matcher by FHIR resource names. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.BatchGetDocumentsMetadataRequest.FhirMatcher fhir_matcher = 2; + * @param \Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest\FhirMatcher $var + * @return $this + */ + public function setFhirMatcher($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest\FhirMatcher::class); + $this->writeOneof(2, $var); + + return $this; + } + /** * @return string */ diff --git a/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataResponse/DocumentMetadata/MatcherValue.php b/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataResponse/DocumentMetadata/MatcherValue.php index 4cdaea6507df..214dde886286 100644 --- a/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataResponse/DocumentMetadata/MatcherValue.php +++ b/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataResponse/DocumentMetadata/MatcherValue.php @@ -27,6 +27,9 @@ class MatcherValue extends \Google\Protobuf\Internal\Message * @type string $uri * If match by URI, the URI of the * [Document][google.cloud.discoveryengine.v1.Document]. + * @type string $fhir_resource + * Required. Format: + * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} * } */ public function __construct($data = NULL) { @@ -67,6 +70,39 @@ public function setUri($var) return $this; } + /** + * Required. Format: + * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + * + * Generated from protobuf field string fhir_resource = 2 [(.google.api.resource_reference) = { + * @return string + */ + public function getFhirResource() + { + return $this->readOneof(2); + } + + public function hasFhirResource() + { + return $this->hasOneof(2); + } + + /** + * Required. Format: + * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + * + * Generated from protobuf field string fhir_resource = 2 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setFhirResource($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(2, $var); + + return $this; + } + /** * @return string */ diff --git a/DiscoveryEngine/src/V1/Client/DocumentServiceClient.php b/DiscoveryEngine/src/V1/Client/DocumentServiceClient.php index fc2a8721ac4f..c51bd037fcde 100644 --- a/DiscoveryEngine/src/V1/Client/DocumentServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/DocumentServiceClient.php @@ -216,6 +216,37 @@ public static function documentName( ]); } + /** + * Formats a string containing the fully-qualified path to represent a + * fhir_resource resource. + * + * @param string $project + * @param string $location + * @param string $dataset + * @param string $fhirStore + * @param string $resourceType + * @param string $fhirResourceId + * + * @return string The formatted fhir_resource resource. + */ + public static function fhirResourceName( + string $project, + string $location, + string $dataset, + string $fhirStore, + string $resourceType, + string $fhirResourceId + ): string { + return self::getPathTemplate('fhirResource')->render([ + 'project' => $project, + 'location' => $location, + 'dataset' => $dataset, + 'fhir_store' => $fhirStore, + 'resource_type' => $resourceType, + 'fhir_resource_id' => $fhirResourceId, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a fhir_store * resource. @@ -355,6 +386,7 @@ public static function projectLocationDataStoreBranchDocumentName( * Template: Pattern * - branch: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch} * - document: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document} + * - fhirResource: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} * - fhirStore: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store} * - projectLocationCollectionDataStoreBranch: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch} * - projectLocationCollectionDataStoreBranchDocument: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document} diff --git a/DiscoveryEngine/src/V1/Client/GroundedGenerationServiceClient.php b/DiscoveryEngine/src/V1/Client/GroundedGenerationServiceClient.php index 85d09fe3c447..3db7e4412924 100644 --- a/DiscoveryEngine/src/V1/Client/GroundedGenerationServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/GroundedGenerationServiceClient.php @@ -25,6 +25,7 @@ namespace Google\Cloud\DiscoveryEngine\V1\Client; use Google\ApiCore\ApiException; +use Google\ApiCore\BidiStream; use Google\ApiCore\CredentialsWrapper; use Google\ApiCore\GapicClientTrait; use Google\ApiCore\ResourceHelperTrait; @@ -34,6 +35,8 @@ use Google\Auth\FetchAuthTokenInterface; use Google\Cloud\DiscoveryEngine\V1\CheckGroundingRequest; use Google\Cloud\DiscoveryEngine\V1\CheckGroundingResponse; +use Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest; +use Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse; use GuzzleHttp\Promise\PromiseInterface; /** @@ -48,6 +51,7 @@ * contained within formatted names that are returned by the API. * * @method PromiseInterface checkGroundingAsync(CheckGroundingRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateGroundedContentAsync(GenerateGroundedContentRequest $request, array $optionalArgs = []) */ final class GroundedGenerationServiceClient { @@ -115,11 +119,139 @@ public static function groundingConfigName(string $project, string $location, st ]); } + /** + * Formats a string containing the fully-qualified path to represent a location + * resource. + * + * @param string $project + * @param string $location + * + * @return string The formatted location resource. + */ + public static function locationName(string $project, string $location): string + { + return self::getPathTemplate('location')->render([ + 'project' => $project, + 'location' => $location, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * project_location_collection_data_store_serving_config resource. + * + * @param string $project + * @param string $location + * @param string $collection + * @param string $dataStore + * @param string $servingConfig + * + * @return string The formatted project_location_collection_data_store_serving_config resource. + */ + public static function projectLocationCollectionDataStoreServingConfigName( + string $project, + string $location, + string $collection, + string $dataStore, + string $servingConfig + ): string { + return self::getPathTemplate('projectLocationCollectionDataStoreServingConfig')->render([ + 'project' => $project, + 'location' => $location, + 'collection' => $collection, + 'data_store' => $dataStore, + 'serving_config' => $servingConfig, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * project_location_collection_engine_serving_config resource. + * + * @param string $project + * @param string $location + * @param string $collection + * @param string $engine + * @param string $servingConfig + * + * @return string The formatted project_location_collection_engine_serving_config resource. + */ + public static function projectLocationCollectionEngineServingConfigName( + string $project, + string $location, + string $collection, + string $engine, + string $servingConfig + ): string { + return self::getPathTemplate('projectLocationCollectionEngineServingConfig')->render([ + 'project' => $project, + 'location' => $location, + 'collection' => $collection, + 'engine' => $engine, + 'serving_config' => $servingConfig, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * project_location_data_store_serving_config resource. + * + * @param string $project + * @param string $location + * @param string $dataStore + * @param string $servingConfig + * + * @return string The formatted project_location_data_store_serving_config resource. + */ + public static function projectLocationDataStoreServingConfigName( + string $project, + string $location, + string $dataStore, + string $servingConfig + ): string { + return self::getPathTemplate('projectLocationDataStoreServingConfig')->render([ + 'project' => $project, + 'location' => $location, + 'data_store' => $dataStore, + 'serving_config' => $servingConfig, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * serving_config resource. + * + * @param string $project + * @param string $location + * @param string $dataStore + * @param string $servingConfig + * + * @return string The formatted serving_config resource. + */ + public static function servingConfigName( + string $project, + string $location, + string $dataStore, + string $servingConfig + ): string { + return self::getPathTemplate('servingConfig')->render([ + 'project' => $project, + 'location' => $location, + 'data_store' => $dataStore, + 'serving_config' => $servingConfig, + ]); + } + /** * Parses a formatted name string and returns an associative array of the components in the name. * The following name formats are supported: * Template: Pattern * - groundingConfig: projects/{project}/locations/{location}/groundingConfigs/{grounding_config} + * - location: projects/{project}/locations/{location} + * - projectLocationCollectionDataStoreServingConfig: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config} + * - projectLocationCollectionEngineServingConfig: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config} + * - projectLocationDataStoreServingConfig: projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config} + * - servingConfig: projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config} * * The optional $template argument can be supplied to specify a particular pattern, * and must match one of the templates listed above. If no $template argument is @@ -236,4 +368,54 @@ public function checkGrounding(CheckGroundingRequest $request, array $callOption { return $this->startApiCall('CheckGrounding', $request, $callOptions)->wait(); } + + /** + * Generates grounded content. + * + * The async variant is + * {@see GroundedGenerationServiceClient::generateGroundedContentAsync()} . + * + * @example samples/V1/GroundedGenerationServiceClient/generate_grounded_content.php + * + * @param GenerateGroundedContentRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return GenerateGroundedContentResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function generateGroundedContent( + GenerateGroundedContentRequest $request, + array $callOptions = [] + ): GenerateGroundedContentResponse { + return $this->startApiCall('GenerateGroundedContent', $request, $callOptions)->wait(); + } + + /** + * Generates grounded content in a streaming fashion. + * + * @example samples/V1/GroundedGenerationServiceClient/stream_generate_grounded_content.php + * + * @param array $callOptions { + * Optional. + * + * @type int $timeoutMillis + * Timeout to use for this call. + * } + * + * @return BidiStream + * + * @throws ApiException Thrown if the API call fails. + */ + public function streamGenerateGroundedContent(array $callOptions = []): BidiStream + { + return $this->startApiCall('StreamGenerateGroundedContent', null, $callOptions); + } } diff --git a/DiscoveryEngine/src/V1/ConverseConversationRequest.php b/DiscoveryEngine/src/V1/ConverseConversationRequest.php index 77e933fd05aa..46ba1bb88e60 100644 --- a/DiscoveryEngine/src/V1/ConverseConversationRequest.php +++ b/DiscoveryEngine/src/V1/ConverseConversationRequest.php @@ -19,9 +19,9 @@ class ConverseConversationRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. * Use - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` * to activate auto session mode, which automatically creates a new * conversation inside a ConverseConversation session. * @@ -36,7 +36,7 @@ class ConverseConversationRequest extends \Google\Protobuf\Internal\Message protected $query = null; /** * The resource name of the Serving Config to use. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` * If this is not set, the default serving config will be used. * * Generated from protobuf field string serving_config = 3 [(.google.api.resource_reference) = { @@ -111,9 +111,9 @@ class ConverseConversationRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. * Use - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` * to activate auto session mode, which automatically creates a new * conversation inside a ConverseConversation session. Please see * {@see ConversationalSearchServiceClient::conversationName()} for help formatting this field. @@ -138,16 +138,16 @@ public static function build(string $name, \Google\Cloud\DiscoveryEngine\V1\Text * * @type string $name * Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. * Use - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` * to activate auto session mode, which automatically creates a new * conversation inside a ConverseConversation session. * @type \Google\Cloud\DiscoveryEngine\V1\TextInput $query * Required. Current user input. * @type string $serving_config * The resource name of the Serving Config to use. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` * If this is not set, the default serving config will be used. * @type \Google\Cloud\DiscoveryEngine\V1\Conversation $conversation * The conversation to be used by auto session only. The name field will be @@ -200,9 +200,9 @@ public function __construct($data = NULL) { /** * Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. * Use - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` * to activate auto session mode, which automatically creates a new * conversation inside a ConverseConversation session. * @@ -216,9 +216,9 @@ public function getName() /** * Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. * Use - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` * to activate auto session mode, which automatically creates a new * conversation inside a ConverseConversation session. * @@ -272,7 +272,7 @@ public function setQuery($var) /** * The resource name of the Serving Config to use. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` * If this is not set, the default serving config will be used. * * Generated from protobuf field string serving_config = 3 [(.google.api.resource_reference) = { @@ -285,7 +285,7 @@ public function getServingConfig() /** * The resource name of the Serving Config to use. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` * If this is not set, the default serving config will be used. * * Generated from protobuf field string serving_config = 3 [(.google.api.resource_reference) = { diff --git a/DiscoveryEngine/src/V1/CreateControlRequest.php b/DiscoveryEngine/src/V1/CreateControlRequest.php index 98ecea4bb311..723fe141d957 100644 --- a/DiscoveryEngine/src/V1/CreateControlRequest.php +++ b/DiscoveryEngine/src/V1/CreateControlRequest.php @@ -17,9 +17,9 @@ class CreateControlRequest extends \Google\Protobuf\Internal\Message { /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -42,9 +42,9 @@ class CreateControlRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. Please see + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Please see * {@see ControlServiceClient::dataStoreName()} for help formatting this field. * @param \Google\Cloud\DiscoveryEngine\V1\Control $control Required. The Control to create. * @param string $controlId Required. The ID to use for the Control, which will become the final @@ -73,9 +73,9 @@ public static function build(string $parent, \Google\Cloud\DiscoveryEngine\V1\Co * * @type string $parent * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. * @type \Google\Cloud\DiscoveryEngine\V1\Control $control * Required. The Control to create. * @type string $control_id @@ -92,9 +92,9 @@ public function __construct($data = NULL) { /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -106,9 +106,9 @@ public function getParent() /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/CreateConversationRequest.php b/DiscoveryEngine/src/V1/CreateConversationRequest.php index b0fa4f4ed674..541c714940dd 100644 --- a/DiscoveryEngine/src/V1/CreateConversationRequest.php +++ b/DiscoveryEngine/src/V1/CreateConversationRequest.php @@ -17,7 +17,7 @@ class CreateConversationRequest extends \Google\Protobuf\Internal\Message { /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -31,7 +31,7 @@ class CreateConversationRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * Please see {@see ConversationalSearchServiceClient::dataStoreName()} for help formatting this field. * @param \Google\Cloud\DiscoveryEngine\V1\Conversation $conversation Required. The conversation to create. * @@ -54,7 +54,7 @@ public static function build(string $parent, \Google\Cloud\DiscoveryEngine\V1\Co * * @type string $parent * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * @type \Google\Cloud\DiscoveryEngine\V1\Conversation $conversation * Required. The conversation to create. * } @@ -66,7 +66,7 @@ public function __construct($data = NULL) { /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -78,7 +78,7 @@ public function getParent() /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/CreateSessionRequest.php b/DiscoveryEngine/src/V1/CreateSessionRequest.php index 068ad30fa60c..297971632e1f 100644 --- a/DiscoveryEngine/src/V1/CreateSessionRequest.php +++ b/DiscoveryEngine/src/V1/CreateSessionRequest.php @@ -17,7 +17,7 @@ class CreateSessionRequest extends \Google\Protobuf\Internal\Message { /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -31,7 +31,7 @@ class CreateSessionRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * Please see {@see ConversationalSearchServiceClient::dataStoreName()} for help formatting this field. * @param \Google\Cloud\DiscoveryEngine\V1\Session $session Required. The session to create. * @@ -54,7 +54,7 @@ public static function build(string $parent, \Google\Cloud\DiscoveryEngine\V1\Se * * @type string $parent * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * @type \Google\Cloud\DiscoveryEngine\V1\Session $session * Required. The session to create. * } @@ -66,7 +66,7 @@ public function __construct($data = NULL) { /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -78,7 +78,7 @@ public function getParent() /** * Required. Full resource name of parent data store. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/CustomTuningModel.php b/DiscoveryEngine/src/V1/CustomTuningModel.php index 2af5c01b2139..4f939490e339 100644 --- a/DiscoveryEngine/src/V1/CustomTuningModel.php +++ b/DiscoveryEngine/src/V1/CustomTuningModel.php @@ -18,8 +18,8 @@ class CustomTuningModel extends \Google\Protobuf\Internal\Message /** * Required. The fully qualified resource name of the model. * Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` - * model must be an alpha-numerical string with limit of 40 characters. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + * Model must be an alpha-numerical string with limit of 40 characters. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -43,7 +43,7 @@ class CustomTuningModel extends \Google\Protobuf\Internal\Message */ protected $model_state = 0; /** - * Deprecated: timestamp the Model was created at. + * Deprecated: Timestamp the Model was created at. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [deprecated = true]; * @deprecated @@ -61,6 +61,13 @@ class CustomTuningModel extends \Google\Protobuf\Internal\Message * Generated from protobuf field map metrics = 7; */ private $metrics; + /** + * Currently this is only populated if the model state is + * `INPUT_VALIDATION_FAILED`. + * + * Generated from protobuf field string error_message = 8; + */ + protected $error_message = ''; /** * Constructor. @@ -71,8 +78,8 @@ class CustomTuningModel extends \Google\Protobuf\Internal\Message * @type string $name * Required. The fully qualified resource name of the model. * Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` - * model must be an alpha-numerical string with limit of 40 characters. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + * Model must be an alpha-numerical string with limit of 40 characters. * @type string $display_name * The display name of the model. * @type int|string $model_version @@ -80,11 +87,14 @@ class CustomTuningModel extends \Google\Protobuf\Internal\Message * @type int $model_state * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). * @type \Google\Protobuf\Timestamp $create_time - * Deprecated: timestamp the Model was created at. + * Deprecated: Timestamp the Model was created at. * @type \Google\Protobuf\Timestamp $training_start_time * Timestamp the model training was initiated. * @type array|\Google\Protobuf\Internal\MapField $metrics * The metrics of the trained model. + * @type string $error_message + * Currently this is only populated if the model state is + * `INPUT_VALIDATION_FAILED`. * } */ public function __construct($data = NULL) { @@ -95,8 +105,8 @@ public function __construct($data = NULL) { /** * Required. The fully qualified resource name of the model. * Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` - * model must be an alpha-numerical string with limit of 40 characters. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + * Model must be an alpha-numerical string with limit of 40 characters. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -109,8 +119,8 @@ public function getName() /** * Required. The fully qualified resource name of the model. * Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` - * model must be an alpha-numerical string with limit of 40 characters. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + * Model must be an alpha-numerical string with limit of 40 characters. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -203,7 +213,7 @@ public function setModelState($var) } /** - * Deprecated: timestamp the Model was created at. + * Deprecated: Timestamp the Model was created at. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [deprecated = true]; * @return \Google\Protobuf\Timestamp|null @@ -228,7 +238,7 @@ public function clearCreateTime() } /** - * Deprecated: timestamp the Model was created at. + * Deprecated: Timestamp the Model was created at. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [deprecated = true]; * @param \Google\Protobuf\Timestamp $var @@ -306,5 +316,33 @@ public function setMetrics($var) return $this; } + /** + * Currently this is only populated if the model state is + * `INPUT_VALIDATION_FAILED`. + * + * Generated from protobuf field string error_message = 8; + * @return string + */ + public function getErrorMessage() + { + return $this->error_message; + } + + /** + * Currently this is only populated if the model state is + * `INPUT_VALIDATION_FAILED`. + * + * Generated from protobuf field string error_message = 8; + * @param string $var + * @return $this + */ + public function setErrorMessage($var) + { + GPBUtil::checkString($var, True); + $this->error_message = $var; + + return $this; + } + } diff --git a/DiscoveryEngine/src/V1/DataStore.php b/DiscoveryEngine/src/V1/DataStore.php index 73c19db07f00..464d6673ab2d 100644 --- a/DiscoveryEngine/src/V1/DataStore.php +++ b/DiscoveryEngine/src/V1/DataStore.php @@ -72,6 +72,22 @@ class DataStore extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $create_time = null; + /** + * Output only. Data size estimation for billing. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $billing_estimation = null; + /** + * Config to store data store type configuration for workspace data. This + * must be set when + * [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config] + * is set as + * [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE]. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25; + */ + protected $workspace_config = null; /** * Configuration for Document understanding and enrichment. * @@ -131,6 +147,14 @@ class DataStore extends \Google\Protobuf\Internal\Message * @type \Google\Protobuf\Timestamp $create_time * Output only. Timestamp the * [DataStore][google.cloud.discoveryengine.v1.DataStore] was created at. + * @type \Google\Cloud\DiscoveryEngine\V1\DataStore\BillingEstimation $billing_estimation + * Output only. Data size estimation for billing. + * @type \Google\Cloud\DiscoveryEngine\V1\WorkspaceConfig $workspace_config + * Config to store data store type configuration for workspace data. This + * must be set when + * [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config] + * is set as + * [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE]. * @type \Google\Cloud\DiscoveryEngine\V1\DocumentProcessingConfig $document_processing_config * Configuration for Document understanding and enrichment. * @type \Google\Cloud\DiscoveryEngine\V1\Schema $starting_schema @@ -375,6 +399,86 @@ public function setCreateTime($var) return $this; } + /** + * Output only. Data size estimation for billing. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\DiscoveryEngine\V1\DataStore\BillingEstimation|null + */ + public function getBillingEstimation() + { + return $this->billing_estimation; + } + + public function hasBillingEstimation() + { + return isset($this->billing_estimation); + } + + public function clearBillingEstimation() + { + unset($this->billing_estimation); + } + + /** + * Output only. Data size estimation for billing. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\DiscoveryEngine\V1\DataStore\BillingEstimation $var + * @return $this + */ + public function setBillingEstimation($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\DataStore\BillingEstimation::class); + $this->billing_estimation = $var; + + return $this; + } + + /** + * Config to store data store type configuration for workspace data. This + * must be set when + * [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config] + * is set as + * [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE]. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25; + * @return \Google\Cloud\DiscoveryEngine\V1\WorkspaceConfig|null + */ + public function getWorkspaceConfig() + { + return $this->workspace_config; + } + + public function hasWorkspaceConfig() + { + return isset($this->workspace_config); + } + + public function clearWorkspaceConfig() + { + unset($this->workspace_config); + } + + /** + * Config to store data store type configuration for workspace data. This + * must be set when + * [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config] + * is set as + * [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE]. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25; + * @param \Google\Cloud\DiscoveryEngine\V1\WorkspaceConfig $var + * @return $this + */ + public function setWorkspaceConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\WorkspaceConfig::class); + $this->workspace_config = $var; + + return $this; + } + /** * Configuration for Document understanding and enrichment. * diff --git a/DiscoveryEngine/src/V1/DataStore/BillingEstimation.php b/DiscoveryEngine/src/V1/DataStore/BillingEstimation.php new file mode 100644 index 000000000000..1442b27407a8 --- /dev/null +++ b/DiscoveryEngine/src/V1/DataStore/BillingEstimation.php @@ -0,0 +1,268 @@ +google.cloud.discoveryengine.v1.DataStore.BillingEstimation + */ +class BillingEstimation extends \Google\Protobuf\Internal\Message +{ + /** + * Data size for structured data in terms of bytes. + * + * Generated from protobuf field int64 structured_data_size = 1; + */ + protected $structured_data_size = 0; + /** + * Data size for unstructured data in terms of bytes. + * + * Generated from protobuf field int64 unstructured_data_size = 2; + */ + protected $unstructured_data_size = 0; + /** + * Data size for websites in terms of bytes. + * + * Generated from protobuf field int64 website_data_size = 3; + */ + protected $website_data_size = 0; + /** + * Last updated timestamp for structured data. + * + * Generated from protobuf field .google.protobuf.Timestamp structured_data_update_time = 4; + */ + protected $structured_data_update_time = null; + /** + * Last updated timestamp for unstructured data. + * + * Generated from protobuf field .google.protobuf.Timestamp unstructured_data_update_time = 5; + */ + protected $unstructured_data_update_time = null; + /** + * Last updated timestamp for websites. + * + * Generated from protobuf field .google.protobuf.Timestamp website_data_update_time = 6; + */ + protected $website_data_update_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $structured_data_size + * Data size for structured data in terms of bytes. + * @type int|string $unstructured_data_size + * Data size for unstructured data in terms of bytes. + * @type int|string $website_data_size + * Data size for websites in terms of bytes. + * @type \Google\Protobuf\Timestamp $structured_data_update_time + * Last updated timestamp for structured data. + * @type \Google\Protobuf\Timestamp $unstructured_data_update_time + * Last updated timestamp for unstructured data. + * @type \Google\Protobuf\Timestamp $website_data_update_time + * Last updated timestamp for websites. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\DataStore::initOnce(); + parent::__construct($data); + } + + /** + * Data size for structured data in terms of bytes. + * + * Generated from protobuf field int64 structured_data_size = 1; + * @return int|string + */ + public function getStructuredDataSize() + { + return $this->structured_data_size; + } + + /** + * Data size for structured data in terms of bytes. + * + * Generated from protobuf field int64 structured_data_size = 1; + * @param int|string $var + * @return $this + */ + public function setStructuredDataSize($var) + { + GPBUtil::checkInt64($var); + $this->structured_data_size = $var; + + return $this; + } + + /** + * Data size for unstructured data in terms of bytes. + * + * Generated from protobuf field int64 unstructured_data_size = 2; + * @return int|string + */ + public function getUnstructuredDataSize() + { + return $this->unstructured_data_size; + } + + /** + * Data size for unstructured data in terms of bytes. + * + * Generated from protobuf field int64 unstructured_data_size = 2; + * @param int|string $var + * @return $this + */ + public function setUnstructuredDataSize($var) + { + GPBUtil::checkInt64($var); + $this->unstructured_data_size = $var; + + return $this; + } + + /** + * Data size for websites in terms of bytes. + * + * Generated from protobuf field int64 website_data_size = 3; + * @return int|string + */ + public function getWebsiteDataSize() + { + return $this->website_data_size; + } + + /** + * Data size for websites in terms of bytes. + * + * Generated from protobuf field int64 website_data_size = 3; + * @param int|string $var + * @return $this + */ + public function setWebsiteDataSize($var) + { + GPBUtil::checkInt64($var); + $this->website_data_size = $var; + + return $this; + } + + /** + * Last updated timestamp for structured data. + * + * Generated from protobuf field .google.protobuf.Timestamp structured_data_update_time = 4; + * @return \Google\Protobuf\Timestamp|null + */ + public function getStructuredDataUpdateTime() + { + return $this->structured_data_update_time; + } + + public function hasStructuredDataUpdateTime() + { + return isset($this->structured_data_update_time); + } + + public function clearStructuredDataUpdateTime() + { + unset($this->structured_data_update_time); + } + + /** + * Last updated timestamp for structured data. + * + * Generated from protobuf field .google.protobuf.Timestamp structured_data_update_time = 4; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setStructuredDataUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->structured_data_update_time = $var; + + return $this; + } + + /** + * Last updated timestamp for unstructured data. + * + * Generated from protobuf field .google.protobuf.Timestamp unstructured_data_update_time = 5; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUnstructuredDataUpdateTime() + { + return $this->unstructured_data_update_time; + } + + public function hasUnstructuredDataUpdateTime() + { + return isset($this->unstructured_data_update_time); + } + + public function clearUnstructuredDataUpdateTime() + { + unset($this->unstructured_data_update_time); + } + + /** + * Last updated timestamp for unstructured data. + * + * Generated from protobuf field .google.protobuf.Timestamp unstructured_data_update_time = 5; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUnstructuredDataUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->unstructured_data_update_time = $var; + + return $this; + } + + /** + * Last updated timestamp for websites. + * + * Generated from protobuf field .google.protobuf.Timestamp website_data_update_time = 6; + * @return \Google\Protobuf\Timestamp|null + */ + public function getWebsiteDataUpdateTime() + { + return $this->website_data_update_time; + } + + public function hasWebsiteDataUpdateTime() + { + return isset($this->website_data_update_time); + } + + public function clearWebsiteDataUpdateTime() + { + unset($this->website_data_update_time); + } + + /** + * Last updated timestamp for websites. + * + * Generated from protobuf field .google.protobuf.Timestamp website_data_update_time = 6; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setWebsiteDataUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->website_data_update_time = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/DataStore/ContentConfig.php b/DiscoveryEngine/src/V1/DataStore/ContentConfig.php index ee0c678f6ecd..0adade69e8df 100644 --- a/DiscoveryEngine/src/V1/DataStore/ContentConfig.php +++ b/DiscoveryEngine/src/V1/DataStore/ContentConfig.php @@ -39,12 +39,21 @@ class ContentConfig * Generated from protobuf enum PUBLIC_WEBSITE = 3; */ const PUBLIC_WEBSITE = 3; + /** + * The data store is used for workspace search. Details of workspace + * data store are specified in the + * [WorkspaceConfig][google.cloud.discoveryengine.v1.WorkspaceConfig]. + * + * Generated from protobuf enum GOOGLE_WORKSPACE = 4; + */ + const GOOGLE_WORKSPACE = 4; private static $valueToName = [ self::CONTENT_CONFIG_UNSPECIFIED => 'CONTENT_CONFIG_UNSPECIFIED', self::NO_CONTENT => 'NO_CONTENT', self::CONTENT_REQUIRED => 'CONTENT_REQUIRED', self::PUBLIC_WEBSITE => 'PUBLIC_WEBSITE', + self::GOOGLE_WORKSPACE => 'GOOGLE_WORKSPACE', ]; public static function name($value) diff --git a/DiscoveryEngine/src/V1/DeleteControlRequest.php b/DiscoveryEngine/src/V1/DeleteControlRequest.php index e8a08f540dff..b0f69214b856 100644 --- a/DiscoveryEngine/src/V1/DeleteControlRequest.php +++ b/DiscoveryEngine/src/V1/DeleteControlRequest.php @@ -17,7 +17,7 @@ class DeleteControlRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the Control to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -25,7 +25,7 @@ class DeleteControlRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The resource name of the Control to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * Please see {@see ControlServiceClient::controlName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\DeleteControlRequest @@ -46,7 +46,7 @@ public static function build(string $name): self * * @type string $name * Required. The resource name of the Control to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the Control to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -68,7 +68,7 @@ public function getName() /** * Required. The resource name of the Control to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/DeleteConversationRequest.php b/DiscoveryEngine/src/V1/DeleteConversationRequest.php index 594b7c155630..0407ba5aac86 100644 --- a/DiscoveryEngine/src/V1/DeleteConversationRequest.php +++ b/DiscoveryEngine/src/V1/DeleteConversationRequest.php @@ -17,7 +17,7 @@ class DeleteConversationRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the Conversation to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -25,7 +25,7 @@ class DeleteConversationRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The resource name of the Conversation to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * Please see {@see ConversationalSearchServiceClient::conversationName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\DeleteConversationRequest @@ -46,7 +46,7 @@ public static function build(string $name): self * * @type string $name * Required. The resource name of the Conversation to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the Conversation to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -68,7 +68,7 @@ public function getName() /** * Required. The resource name of the Conversation to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/DeleteSessionRequest.php b/DiscoveryEngine/src/V1/DeleteSessionRequest.php index 248bc92618cc..9cdb049a1385 100644 --- a/DiscoveryEngine/src/V1/DeleteSessionRequest.php +++ b/DiscoveryEngine/src/V1/DeleteSessionRequest.php @@ -17,7 +17,7 @@ class DeleteSessionRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the Session to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -25,7 +25,7 @@ class DeleteSessionRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The resource name of the Session to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * Please see {@see ConversationalSearchServiceClient::sessionName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\DeleteSessionRequest @@ -46,7 +46,7 @@ public static function build(string $name): self * * @type string $name * Required. The resource name of the Session to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the Session to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -68,7 +68,7 @@ public function getName() /** * Required. The resource name of the Session to delete. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/DocumentInfo.php b/DiscoveryEngine/src/V1/DocumentInfo.php index d38dadf1851d..7fc6f5f76793 100644 --- a/DiscoveryEngine/src/V1/DocumentInfo.php +++ b/DiscoveryEngine/src/V1/DocumentInfo.php @@ -53,7 +53,7 @@ class DocumentInfo extends \Google\Protobuf\Internal\Message * @type string $name * The [Document][google.cloud.discoveryengine.v1.Document] resource full * name, of the form: - * `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` * @type string $uri * The [Document][google.cloud.discoveryengine.v1.Document] URI - only * allowed for website data stores. @@ -111,7 +111,7 @@ public function setId($var) /** * The [Document][google.cloud.discoveryengine.v1.Document] resource full * name, of the form: - * `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` * * Generated from protobuf field string name = 2 [(.google.api.resource_reference) = { * @return string @@ -129,7 +129,7 @@ public function hasName() /** * The [Document][google.cloud.discoveryengine.v1.Document] resource full * name, of the form: - * `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` * * Generated from protobuf field string name = 2 [(.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/DocumentProcessingConfig.php b/DiscoveryEngine/src/V1/DocumentProcessingConfig.php index 8ab3a3fffa9d..1fa538c15c1d 100644 --- a/DiscoveryEngine/src/V1/DocumentProcessingConfig.php +++ b/DiscoveryEngine/src/V1/DocumentProcessingConfig.php @@ -10,11 +10,11 @@ /** * A singleton resource of - * [DataStore][google.cloud.discoveryengine.v1.DataStore]. It's empty when - * [DataStore][google.cloud.discoveryengine.v1.DataStore] is created, which - * defaults to digital parser. The first call to - * [DataStoreService.UpdateDocumentProcessingConfig][] method will initialize - * the config. + * [DataStore][google.cloud.discoveryengine.v1.DataStore]. If it's empty when + * [DataStore][google.cloud.discoveryengine.v1.DataStore] is created and + * [DataStore][google.cloud.discoveryengine.v1.DataStore] is set to + * [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1.DataStore.ContentConfig.CONTENT_REQUIRED], + * the default parser will default to digital parser. * * Generated from protobuf message google.cloud.discoveryengine.v1.DocumentProcessingConfig */ @@ -54,6 +54,8 @@ class DocumentProcessingConfig extends \Google\Protobuf\Internal\Message * layout parsing are supported. * * `pptx`: Override parsing config for PPTX files, only digital parsing and * layout parsing are supported. + * * `xlsm`: Override parsing config for XLSM files, only digital parsing and + * layout parsing are supported. * * `xlsx`: Override parsing config for XLSX files, only digital parsing and * layout parsing are supported. * @@ -89,6 +91,8 @@ class DocumentProcessingConfig extends \Google\Protobuf\Internal\Message * layout parsing are supported. * * `pptx`: Override parsing config for PPTX files, only digital parsing and * layout parsing are supported. + * * `xlsm`: Override parsing config for XLSM files, only digital parsing and + * layout parsing are supported. * * `xlsx`: Override parsing config for XLSX files, only digital parsing and * layout parsing are supported. * } @@ -217,6 +221,8 @@ public function setDefaultParsingConfig($var) * layout parsing are supported. * * `pptx`: Override parsing config for PPTX files, only digital parsing and * layout parsing are supported. + * * `xlsm`: Override parsing config for XLSM files, only digital parsing and + * layout parsing are supported. * * `xlsx`: Override parsing config for XLSX files, only digital parsing and * layout parsing are supported. * @@ -239,6 +245,8 @@ public function getParsingConfigOverrides() * layout parsing are supported. * * `pptx`: Override parsing config for PPTX files, only digital parsing and * layout parsing are supported. + * * `xlsm`: Override parsing config for XLSM files, only digital parsing and + * layout parsing are supported. * * `xlsx`: Override parsing config for XLSX files, only digital parsing and * layout parsing are supported. * diff --git a/DiscoveryEngine/src/V1/Engine.php b/DiscoveryEngine/src/V1/Engine.php index b5d7db997a93..ed9ff51d0f6c 100644 --- a/DiscoveryEngine/src/V1/Engine.php +++ b/DiscoveryEngine/src/V1/Engine.php @@ -21,7 +21,7 @@ class Engine extends \Google\Protobuf\Internal\Message * This field must be a UTF-8 encoded string with a length limit of 1024 * characters. * Format: - * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` * engine should be 1-63 characters, and valid characters are * /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned. * @@ -89,6 +89,13 @@ class Engine extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15; */ protected $common_config = null; + /** + * Optional. Whether to disable analytics for searches performed on this + * engine. + * + * Generated from protobuf field bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disable_analytics = false; protected $engine_config; protected $engine_metadata; @@ -116,7 +123,7 @@ class Engine extends \Google\Protobuf\Internal\Message * This field must be a UTF-8 encoded string with a length limit of 1024 * characters. * Format: - * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` * engine should be 1-63 characters, and valid characters are * /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned. * @type string $display_name @@ -152,6 +159,9 @@ class Engine extends \Google\Protobuf\Internal\Message * DataStore linked to the engine. * @type \Google\Cloud\DiscoveryEngine\V1\Engine\CommonConfig $common_config * Common config spec that specifies the metadata of the engine. + * @type bool $disable_analytics + * Optional. Whether to disable analytics for searches performed on this + * engine. * } */ public function __construct($data = NULL) { @@ -271,7 +281,7 @@ public function setChatEngineMetadata($var) * This field must be a UTF-8 encoded string with a length limit of 1024 * characters. * Format: - * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` * engine should be 1-63 characters, and valid characters are * /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned. * @@ -288,7 +298,7 @@ public function getName() * This field must be a UTF-8 encoded string with a length limit of 1024 * characters. * Format: - * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` * engine should be 1-63 characters, and valid characters are * /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned. * @@ -554,6 +564,34 @@ public function setCommonConfig($var) return $this; } + /** + * Optional. Whether to disable analytics for searches performed on this + * engine. + * + * Generated from protobuf field bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getDisableAnalytics() + { + return $this->disable_analytics; + } + + /** + * Optional. Whether to disable analytics for searches performed on this + * engine. + * + * Generated from protobuf field bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setDisableAnalytics($var) + { + GPBUtil::checkBool($var); + $this->disable_analytics = $var; + + return $this; + } + /** * @return string */ diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest.php new file mode 100644 index 000000000000..53bf90431c9a --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest.php @@ -0,0 +1,352 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest + */ +class GenerateGroundedContentRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Location resource. + * Format: `projects/{project}/locations/{location}`. + * + * Generated from protobuf field string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $location = ''; + /** + * Content of the system instruction for the current API. + * These instructions will take priority over any other prompt instructions + * if the selected model is supporting them. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GroundedGenerationContent system_instruction = 5; + */ + protected $system_instruction = null; + /** + * Content of the current conversation with the model. + * For single-turn queries, this is a single instance. For multi-turn queries, + * this is a repeated field that contains conversation history + latest + * request. + * Only a single-turn query is supported currently. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2; + */ + private $contents; + /** + * Content generation specification. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3; + */ + protected $generation_spec = null; + /** + * Grounding specification. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4; + */ + protected $grounding_spec = null; + /** + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. + * * Each label must be a key-value pair. + * * Keys have a minimum length of 1 character and a maximum length of 63 + * characters and cannot be empty. Values can be empty and have a maximum + * length of 63 characters. + * * Keys and values can contain only lowercase letters, numeric characters, + * underscores, and dashes. All characters must use UTF-8 encoding, and + * international characters are allowed. + * * The key portion of a label must be unique. However, you can use the same + * key with multiple resources. + * * Keys must start with a lowercase letter or international character. + * See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + * + * Generated from protobuf field map user_labels = 6; + */ + private $user_labels; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $location + * Required. Location resource. + * Format: `projects/{project}/locations/{location}`. + * @type \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent $system_instruction + * Content of the system instruction for the current API. + * These instructions will take priority over any other prompt instructions + * if the selected model is supporting them. + * @type array<\Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent>|\Google\Protobuf\Internal\RepeatedField $contents + * Content of the current conversation with the model. + * For single-turn queries, this is a single instance. For multi-turn queries, + * this is a repeated field that contains conversation history + latest + * request. + * Only a single-turn query is supported currently. + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GenerationSpec $generation_spec + * Content generation specification. + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSpec $grounding_spec + * Grounding specification. + * @type array|\Google\Protobuf\Internal\MapField $user_labels + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. + * * Each label must be a key-value pair. + * * Keys have a minimum length of 1 character and a maximum length of 63 + * characters and cannot be empty. Values can be empty and have a maximum + * length of 63 characters. + * * Keys and values can contain only lowercase letters, numeric characters, + * underscores, and dashes. All characters must use UTF-8 encoding, and + * international characters are allowed. + * * The key portion of a label must be unique. However, you can use the same + * key with multiple resources. + * * Keys must start with a lowercase letter or international character. + * See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Required. Location resource. + * Format: `projects/{project}/locations/{location}`. + * + * Generated from protobuf field string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getLocation() + { + return $this->location; + } + + /** + * Required. Location resource. + * Format: `projects/{project}/locations/{location}`. + * + * Generated from protobuf field string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setLocation($var) + { + GPBUtil::checkString($var, True); + $this->location = $var; + + return $this; + } + + /** + * Content of the system instruction for the current API. + * These instructions will take priority over any other prompt instructions + * if the selected model is supporting them. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GroundedGenerationContent system_instruction = 5; + * @return \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent|null + */ + public function getSystemInstruction() + { + return $this->system_instruction; + } + + public function hasSystemInstruction() + { + return isset($this->system_instruction); + } + + public function clearSystemInstruction() + { + unset($this->system_instruction); + } + + /** + * Content of the system instruction for the current API. + * These instructions will take priority over any other prompt instructions + * if the selected model is supporting them. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GroundedGenerationContent system_instruction = 5; + * @param \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent $var + * @return $this + */ + public function setSystemInstruction($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent::class); + $this->system_instruction = $var; + + return $this; + } + + /** + * Content of the current conversation with the model. + * For single-turn queries, this is a single instance. For multi-turn queries, + * this is a repeated field that contains conversation history + latest + * request. + * Only a single-turn query is supported currently. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getContents() + { + return $this->contents; + } + + /** + * Content of the current conversation with the model. + * For single-turn queries, this is a single instance. For multi-turn queries, + * this is a repeated field that contains conversation history + latest + * request. + * Only a single-turn query is supported currently. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2; + * @param array<\Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setContents($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent::class); + $this->contents = $arr; + + return $this; + } + + /** + * Content generation specification. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GenerationSpec|null + */ + public function getGenerationSpec() + { + return $this->generation_spec; + } + + public function hasGenerationSpec() + { + return isset($this->generation_spec); + } + + public function clearGenerationSpec() + { + unset($this->generation_spec); + } + + /** + * Content generation specification. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GenerationSpec $var + * @return $this + */ + public function setGenerationSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GenerationSpec::class); + $this->generation_spec = $var; + + return $this; + } + + /** + * Grounding specification. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSpec|null + */ + public function getGroundingSpec() + { + return $this->grounding_spec; + } + + public function hasGroundingSpec() + { + return isset($this->grounding_spec); + } + + public function clearGroundingSpec() + { + unset($this->grounding_spec); + } + + /** + * Grounding specification. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSpec $var + * @return $this + */ + public function setGroundingSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSpec::class); + $this->grounding_spec = $var; + + return $this; + } + + /** + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. + * * Each label must be a key-value pair. + * * Keys have a minimum length of 1 character and a maximum length of 63 + * characters and cannot be empty. Values can be empty and have a maximum + * length of 63 characters. + * * Keys and values can contain only lowercase letters, numeric characters, + * underscores, and dashes. All characters must use UTF-8 encoding, and + * international characters are allowed. + * * The key portion of a label must be unique. However, you can use the same + * key with multiple resources. + * * Keys must start with a lowercase letter or international character. + * See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + * + * Generated from protobuf field map user_labels = 6; + * @return \Google\Protobuf\Internal\MapField + */ + public function getUserLabels() + { + return $this->user_labels; + } + + /** + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. + * * Each label must be a key-value pair. + * * Keys have a minimum length of 1 character and a maximum length of 63 + * characters and cannot be empty. Values can be empty and have a maximum + * length of 63 characters. + * * Keys and values can contain only lowercase letters, numeric characters, + * underscores, and dashes. All characters must use UTF-8 encoding, and + * international characters are allowed. + * * The key portion of a label must be unique. However, you can use the same + * key with multiple resources. + * * Keys must start with a lowercase letter or international character. + * See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + * + * Generated from protobuf field map user_labels = 6; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setUserLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->user_labels = $arr; + + return $this; + } + +} + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration.php new file mode 100644 index 000000000000..ce0b1477ab70 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration.php @@ -0,0 +1,78 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration + */ +class DynamicRetrievalConfiguration extends \Google\Protobuf\Internal\Message +{ + /** + * Specification for the predictor for dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration.DynamicRetrievalPredictor predictor = 1; + */ + protected $predictor = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration\DynamicRetrievalPredictor $predictor + * Specification for the predictor for dynamic retrieval. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Specification for the predictor for dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration.DynamicRetrievalPredictor predictor = 1; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration\DynamicRetrievalPredictor|null + */ + public function getPredictor() + { + return $this->predictor; + } + + public function hasPredictor() + { + return isset($this->predictor); + } + + public function clearPredictor() + { + unset($this->predictor); + } + + /** + * Specification for the predictor for dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration.DynamicRetrievalPredictor predictor = 1; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration\DynamicRetrievalPredictor $var + * @return $this + */ + public function setPredictor($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration\DynamicRetrievalPredictor::class); + $this->predictor = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration/DynamicRetrievalPredictor.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration/DynamicRetrievalPredictor.php new file mode 100644 index 000000000000..4eb8ab405fa4 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration/DynamicRetrievalPredictor.php @@ -0,0 +1,116 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration.DynamicRetrievalPredictor + */ +class DynamicRetrievalPredictor extends \Google\Protobuf\Internal\Message +{ + /** + * The version of the predictor to be used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration.DynamicRetrievalPredictor.Version version = 1; + */ + protected $version = 0; + /** + * The value of the threshold. If the predictor will predict a + * value smaller than this, it would suppress grounding in the source. + * + * Generated from protobuf field optional float threshold = 2; + */ + protected $threshold = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $version + * The version of the predictor to be used in dynamic retrieval. + * @type float $threshold + * The value of the threshold. If the predictor will predict a + * value smaller than this, it would suppress grounding in the source. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * The version of the predictor to be used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration.DynamicRetrievalPredictor.Version version = 1; + * @return int + */ + public function getVersion() + { + return $this->version; + } + + /** + * The version of the predictor to be used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration.DynamicRetrievalPredictor.Version version = 1; + * @param int $var + * @return $this + */ + public function setVersion($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration\DynamicRetrievalPredictor\Version::class); + $this->version = $var; + + return $this; + } + + /** + * The value of the threshold. If the predictor will predict a + * value smaller than this, it would suppress grounding in the source. + * + * Generated from protobuf field optional float threshold = 2; + * @return float + */ + public function getThreshold() + { + return isset($this->threshold) ? $this->threshold : 0.0; + } + + public function hasThreshold() + { + return isset($this->threshold); + } + + public function clearThreshold() + { + unset($this->threshold); + } + + /** + * The value of the threshold. If the predictor will predict a + * value smaller than this, it would suppress grounding in the source. + * + * Generated from protobuf field optional float threshold = 2; + * @param float $var + * @return $this + */ + public function setThreshold($var) + { + GPBUtil::checkFloat($var); + $this->threshold = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration/DynamicRetrievalPredictor/Version.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration/DynamicRetrievalPredictor/Version.php new file mode 100644 index 000000000000..0e2e497ea8c9 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/DynamicRetrievalConfiguration/DynamicRetrievalPredictor/Version.php @@ -0,0 +1,55 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration.DynamicRetrievalPredictor.Version + */ +class Version +{ + /** + * Automatically choose the best version of the retrieval predictor. + * + * Generated from protobuf enum VERSION_UNSPECIFIED = 0; + */ + const VERSION_UNSPECIFIED = 0; + /** + * The V1 model which is evaluating each source independently. + * + * Generated from protobuf enum V1_INDEPENDENT = 1; + */ + const V1_INDEPENDENT = 1; + + private static $valueToName = [ + self::VERSION_UNSPECIFIED => 'VERSION_UNSPECIFIED', + self::V1_INDEPENDENT => 'V1_INDEPENDENT', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GenerationSpec.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GenerationSpec.php new file mode 100644 index 000000000000..ae4538bcf438 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GenerationSpec.php @@ -0,0 +1,370 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec + */ +class GenerationSpec extends \Google\Protobuf\Internal\Message +{ + /** + * Specifies which Vertex model id to use for generation. + * + * Generated from protobuf field string model_id = 3; + */ + protected $model_id = ''; + /** + * Language code for content. Use language tags defined by + * [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). + * + * Generated from protobuf field string language_code = 2; + */ + protected $language_code = ''; + /** + * If specified, custom value for the temperature will be used. + * + * Generated from protobuf field optional float temperature = 4; + */ + protected $temperature = null; + /** + * If specified, custom value for nucleus sampling will be used. + * + * Generated from protobuf field optional float top_p = 5; + */ + protected $top_p = null; + /** + * If specified, custom value for top-k sampling will be used. + * + * Generated from protobuf field optional int32 top_k = 7; + */ + protected $top_k = null; + /** + * If specified, custom value for frequency penalty will be used. + * + * Generated from protobuf field optional float frequency_penalty = 8; + */ + protected $frequency_penalty = null; + /** + * If specified, custom value for presence penalty will be used. + * + * Generated from protobuf field optional float presence_penalty = 9; + */ + protected $presence_penalty = null; + /** + * If specified, custom value for max output tokens will be used. + * + * Generated from protobuf field optional int32 max_output_tokens = 10; + */ + protected $max_output_tokens = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $model_id + * Specifies which Vertex model id to use for generation. + * @type string $language_code + * Language code for content. Use language tags defined by + * [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). + * @type float $temperature + * If specified, custom value for the temperature will be used. + * @type float $top_p + * If specified, custom value for nucleus sampling will be used. + * @type int $top_k + * If specified, custom value for top-k sampling will be used. + * @type float $frequency_penalty + * If specified, custom value for frequency penalty will be used. + * @type float $presence_penalty + * If specified, custom value for presence penalty will be used. + * @type int $max_output_tokens + * If specified, custom value for max output tokens will be used. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Specifies which Vertex model id to use for generation. + * + * Generated from protobuf field string model_id = 3; + * @return string + */ + public function getModelId() + { + return $this->model_id; + } + + /** + * Specifies which Vertex model id to use for generation. + * + * Generated from protobuf field string model_id = 3; + * @param string $var + * @return $this + */ + public function setModelId($var) + { + GPBUtil::checkString($var, True); + $this->model_id = $var; + + return $this; + } + + /** + * Language code for content. Use language tags defined by + * [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). + * + * Generated from protobuf field string language_code = 2; + * @return string + */ + public function getLanguageCode() + { + return $this->language_code; + } + + /** + * Language code for content. Use language tags defined by + * [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). + * + * Generated from protobuf field string language_code = 2; + * @param string $var + * @return $this + */ + public function setLanguageCode($var) + { + GPBUtil::checkString($var, True); + $this->language_code = $var; + + return $this; + } + + /** + * If specified, custom value for the temperature will be used. + * + * Generated from protobuf field optional float temperature = 4; + * @return float + */ + public function getTemperature() + { + return isset($this->temperature) ? $this->temperature : 0.0; + } + + public function hasTemperature() + { + return isset($this->temperature); + } + + public function clearTemperature() + { + unset($this->temperature); + } + + /** + * If specified, custom value for the temperature will be used. + * + * Generated from protobuf field optional float temperature = 4; + * @param float $var + * @return $this + */ + public function setTemperature($var) + { + GPBUtil::checkFloat($var); + $this->temperature = $var; + + return $this; + } + + /** + * If specified, custom value for nucleus sampling will be used. + * + * Generated from protobuf field optional float top_p = 5; + * @return float + */ + public function getTopP() + { + return isset($this->top_p) ? $this->top_p : 0.0; + } + + public function hasTopP() + { + return isset($this->top_p); + } + + public function clearTopP() + { + unset($this->top_p); + } + + /** + * If specified, custom value for nucleus sampling will be used. + * + * Generated from protobuf field optional float top_p = 5; + * @param float $var + * @return $this + */ + public function setTopP($var) + { + GPBUtil::checkFloat($var); + $this->top_p = $var; + + return $this; + } + + /** + * If specified, custom value for top-k sampling will be used. + * + * Generated from protobuf field optional int32 top_k = 7; + * @return int + */ + public function getTopK() + { + return isset($this->top_k) ? $this->top_k : 0; + } + + public function hasTopK() + { + return isset($this->top_k); + } + + public function clearTopK() + { + unset($this->top_k); + } + + /** + * If specified, custom value for top-k sampling will be used. + * + * Generated from protobuf field optional int32 top_k = 7; + * @param int $var + * @return $this + */ + public function setTopK($var) + { + GPBUtil::checkInt32($var); + $this->top_k = $var; + + return $this; + } + + /** + * If specified, custom value for frequency penalty will be used. + * + * Generated from protobuf field optional float frequency_penalty = 8; + * @return float + */ + public function getFrequencyPenalty() + { + return isset($this->frequency_penalty) ? $this->frequency_penalty : 0.0; + } + + public function hasFrequencyPenalty() + { + return isset($this->frequency_penalty); + } + + public function clearFrequencyPenalty() + { + unset($this->frequency_penalty); + } + + /** + * If specified, custom value for frequency penalty will be used. + * + * Generated from protobuf field optional float frequency_penalty = 8; + * @param float $var + * @return $this + */ + public function setFrequencyPenalty($var) + { + GPBUtil::checkFloat($var); + $this->frequency_penalty = $var; + + return $this; + } + + /** + * If specified, custom value for presence penalty will be used. + * + * Generated from protobuf field optional float presence_penalty = 9; + * @return float + */ + public function getPresencePenalty() + { + return isset($this->presence_penalty) ? $this->presence_penalty : 0.0; + } + + public function hasPresencePenalty() + { + return isset($this->presence_penalty); + } + + public function clearPresencePenalty() + { + unset($this->presence_penalty); + } + + /** + * If specified, custom value for presence penalty will be used. + * + * Generated from protobuf field optional float presence_penalty = 9; + * @param float $var + * @return $this + */ + public function setPresencePenalty($var) + { + GPBUtil::checkFloat($var); + $this->presence_penalty = $var; + + return $this; + } + + /** + * If specified, custom value for max output tokens will be used. + * + * Generated from protobuf field optional int32 max_output_tokens = 10; + * @return int + */ + public function getMaxOutputTokens() + { + return isset($this->max_output_tokens) ? $this->max_output_tokens : 0; + } + + public function hasMaxOutputTokens() + { + return isset($this->max_output_tokens); + } + + public function clearMaxOutputTokens() + { + unset($this->max_output_tokens); + } + + /** + * If specified, custom value for max output tokens will be used. + * + * Generated from protobuf field optional int32 max_output_tokens = 10; + * @param int $var + * @return $this + */ + public function setMaxOutputTokens($var) + { + GPBUtil::checkInt32($var); + $this->max_output_tokens = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource.php new file mode 100644 index 000000000000..d430aa462d6c --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource.php @@ -0,0 +1,142 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource + */ +class GroundingSource extends \Google\Protobuf\Internal\Message +{ + protected $source; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\InlineSource $inline_source + * If set, grounding is performed with inline content. + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\SearchSource $search_source + * If set, grounding is performed with Vertex AI Search. + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\GoogleSearchSource $google_search_source + * If set, grounding is performed with Google Search. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * If set, grounding is performed with inline content. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.InlineSource inline_source = 1; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\InlineSource|null + */ + public function getInlineSource() + { + return $this->readOneof(1); + } + + public function hasInlineSource() + { + return $this->hasOneof(1); + } + + /** + * If set, grounding is performed with inline content. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.InlineSource inline_source = 1; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\InlineSource $var + * @return $this + */ + public function setInlineSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\InlineSource::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * If set, grounding is performed with Vertex AI Search. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.SearchSource search_source = 2; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\SearchSource|null + */ + public function getSearchSource() + { + return $this->readOneof(2); + } + + public function hasSearchSource() + { + return $this->hasOneof(2); + } + + /** + * If set, grounding is performed with Vertex AI Search. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.SearchSource search_source = 2; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\SearchSource $var + * @return $this + */ + public function setSearchSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\SearchSource::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * If set, grounding is performed with Google Search. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.GoogleSearchSource google_search_source = 3; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\GoogleSearchSource|null + */ + public function getGoogleSearchSource() + { + return $this->readOneof(3); + } + + public function hasGoogleSearchSource() + { + return $this->hasOneof(3); + } + + /** + * If set, grounding is performed with Google Search. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.GoogleSearchSource google_search_source = 3; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\GoogleSearchSource $var + * @return $this + */ + public function setGoogleSearchSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource\GoogleSearchSource::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * @return string + */ + public function getSource() + { + return $this->whichOneof("source"); + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/GoogleSearchSource.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/GoogleSearchSource.php new file mode 100644 index 000000000000..17da05eb8ce0 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/GoogleSearchSource.php @@ -0,0 +1,82 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.GoogleSearchSource + */ +class GoogleSearchSource extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Specifies the dynamic retrieval configuration for the given + * source. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration dynamic_retrieval_config = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $dynamic_retrieval_config = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration $dynamic_retrieval_config + * Optional. Specifies the dynamic retrieval configuration for the given + * source. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Specifies the dynamic retrieval configuration for the given + * source. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration dynamic_retrieval_config = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration|null + */ + public function getDynamicRetrievalConfig() + { + return $this->dynamic_retrieval_config; + } + + public function hasDynamicRetrievalConfig() + { + return isset($this->dynamic_retrieval_config); + } + + public function clearDynamicRetrievalConfig() + { + unset($this->dynamic_retrieval_config); + } + + /** + * Optional. Specifies the dynamic retrieval configuration for the given + * source. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.DynamicRetrievalConfiguration dynamic_retrieval_config = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration $var + * @return $this + */ + public function setDynamicRetrievalConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\DynamicRetrievalConfiguration::class); + $this->dynamic_retrieval_config = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/InlineSource.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/InlineSource.php new file mode 100644 index 000000000000..591966907408 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/InlineSource.php @@ -0,0 +1,110 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.InlineSource + */ +class InlineSource extends \Google\Protobuf\Internal\Message +{ + /** + * List of facts to be used for grounding. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundingFact grounding_facts = 1; + */ + private $grounding_facts; + /** + * Attributes associated with the content. + * Common attributes include `source` (indicating where the content was + * sourced from) and `author` (indicating the author of the content). + * + * Generated from protobuf field map attributes = 2; + */ + private $attributes; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DiscoveryEngine\V1\GroundingFact>|\Google\Protobuf\Internal\RepeatedField $grounding_facts + * List of facts to be used for grounding. + * @type array|\Google\Protobuf\Internal\MapField $attributes + * Attributes associated with the content. + * Common attributes include `source` (indicating where the content was + * sourced from) and `author` (indicating the author of the content). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * List of facts to be used for grounding. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundingFact grounding_facts = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGroundingFacts() + { + return $this->grounding_facts; + } + + /** + * List of facts to be used for grounding. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundingFact grounding_facts = 1; + * @param array<\Google\Cloud\DiscoveryEngine\V1\GroundingFact>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGroundingFacts($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\GroundingFact::class); + $this->grounding_facts = $arr; + + return $this; + } + + /** + * Attributes associated with the content. + * Common attributes include `source` (indicating where the content was + * sourced from) and `author` (indicating the author of the content). + * + * Generated from protobuf field map attributes = 2; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAttributes() + { + return $this->attributes; + } + + /** + * Attributes associated with the content. + * Common attributes include `source` (indicating where the content was + * sourced from) and `author` (indicating the author of the content). + * + * Generated from protobuf field map attributes = 2; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAttributes($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->attributes = $arr; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/SearchSource.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/SearchSource.php new file mode 100644 index 000000000000..b55ac4302b74 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSource/SearchSource.php @@ -0,0 +1,190 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.SearchSource + */ +class SearchSource extends \Google\Protobuf\Internal\Message +{ + /** + * The resource name of the Engine to use. + * Format: + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` + * + * Generated from protobuf field string serving_config = 1 [(.google.api.resource_reference) = { + */ + protected $serving_config = ''; + /** + * Number of search results to return. + * The default value is 10. The maximumm allowed value is 10. + * + * Generated from protobuf field int32 max_result_count = 2; + */ + protected $max_result_count = 0; + /** + * Filter expression to be applied to the search. + * The syntax is the same as + * [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]. + * + * Generated from protobuf field string filter = 3; + */ + protected $filter = ''; + /** + * If set, safe search is enabled in Vertex AI Search requests. + * + * Generated from protobuf field bool safe_search = 5; + */ + protected $safe_search = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $serving_config + * The resource name of the Engine to use. + * Format: + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` + * @type int $max_result_count + * Number of search results to return. + * The default value is 10. The maximumm allowed value is 10. + * @type string $filter + * Filter expression to be applied to the search. + * The syntax is the same as + * [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]. + * @type bool $safe_search + * If set, safe search is enabled in Vertex AI Search requests. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * The resource name of the Engine to use. + * Format: + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` + * + * Generated from protobuf field string serving_config = 1 [(.google.api.resource_reference) = { + * @return string + */ + public function getServingConfig() + { + return $this->serving_config; + } + + /** + * The resource name of the Engine to use. + * Format: + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` + * + * Generated from protobuf field string serving_config = 1 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setServingConfig($var) + { + GPBUtil::checkString($var, True); + $this->serving_config = $var; + + return $this; + } + + /** + * Number of search results to return. + * The default value is 10. The maximumm allowed value is 10. + * + * Generated from protobuf field int32 max_result_count = 2; + * @return int + */ + public function getMaxResultCount() + { + return $this->max_result_count; + } + + /** + * Number of search results to return. + * The default value is 10. The maximumm allowed value is 10. + * + * Generated from protobuf field int32 max_result_count = 2; + * @param int $var + * @return $this + */ + public function setMaxResultCount($var) + { + GPBUtil::checkInt32($var); + $this->max_result_count = $var; + + return $this; + } + + /** + * Filter expression to be applied to the search. + * The syntax is the same as + * [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]. + * + * Generated from protobuf field string filter = 3; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Filter expression to be applied to the search. + * The syntax is the same as + * [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]. + * + * Generated from protobuf field string filter = 3; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * If set, safe search is enabled in Vertex AI Search requests. + * + * Generated from protobuf field bool safe_search = 5; + * @return bool + */ + public function getSafeSearch() + { + return $this->safe_search; + } + + /** + * If set, safe search is enabled in Vertex AI Search requests. + * + * Generated from protobuf field bool safe_search = 5; + * @param bool $var + * @return $this + */ + public function setSafeSearch($var) + { + GPBUtil::checkBool($var); + $this->safe_search = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSpec.php b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSpec.php new file mode 100644 index 000000000000..fc371d8552df --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentRequest/GroundingSpec.php @@ -0,0 +1,68 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec + */ +class GroundingSpec extends \Google\Protobuf\Internal\Message +{ + /** + * Grounding sources. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource grounding_sources = 1; + */ + private $grounding_sources; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource>|\Google\Protobuf\Internal\RepeatedField $grounding_sources + * Grounding sources. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Grounding sources. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource grounding_sources = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGroundingSources() + { + return $this->grounding_sources; + } + + /** + * Grounding sources. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource grounding_sources = 1; + * @param array<\Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGroundingSources($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest\GroundingSource::class); + $this->grounding_sources = $arr; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse.php new file mode 100644 index 000000000000..7fccd238f7af --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse.php @@ -0,0 +1,65 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse + */ +class GenerateGroundedContentResponse extends \Google\Protobuf\Internal\Message +{ + /** + * Generated candidates. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate candidates = 1; + */ + private $candidates; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate>|\Google\Protobuf\Internal\RepeatedField $candidates + * Generated candidates. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Generated candidates. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate candidates = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCandidates() + { + return $this->candidates; + } + + /** + * Generated candidates. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate candidates = 1; + * @param array<\Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCandidates($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate::class); + $this->candidates = $arr; + + return $this; + } + +} + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate.php new file mode 100644 index 000000000000..794673fedb97 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate.php @@ -0,0 +1,200 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate + */ +class Candidate extends \Google\Protobuf\Internal\Message +{ + /** + * Index of the candidate. + * + * Generated from protobuf field int32 index = 1; + */ + protected $index = 0; + /** + * Content of the candidate. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2; + */ + protected $content = null; + /** + * The overall grounding score for the candidate, in the range of [0, 1]. + * + * Generated from protobuf field optional float grounding_score = 3; + */ + protected $grounding_score = null; + /** + * Grounding metadata for the generated content. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4; + */ + protected $grounding_metadata = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $index + * Index of the candidate. + * @type \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent $content + * Content of the candidate. + * @type float $grounding_score + * The overall grounding score for the candidate, in the range of [0, 1]. + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata $grounding_metadata + * Grounding metadata for the generated content. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Index of the candidate. + * + * Generated from protobuf field int32 index = 1; + * @return int + */ + public function getIndex() + { + return $this->index; + } + + /** + * Index of the candidate. + * + * Generated from protobuf field int32 index = 1; + * @param int $var + * @return $this + */ + public function setIndex($var) + { + GPBUtil::checkInt32($var); + $this->index = $var; + + return $this; + } + + /** + * Content of the candidate. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2; + * @return \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent|null + */ + public function getContent() + { + return $this->content; + } + + public function hasContent() + { + return isset($this->content); + } + + public function clearContent() + { + unset($this->content); + } + + /** + * Content of the candidate. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2; + * @param \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent $var + * @return $this + */ + public function setContent($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent::class); + $this->content = $var; + + return $this; + } + + /** + * The overall grounding score for the candidate, in the range of [0, 1]. + * + * Generated from protobuf field optional float grounding_score = 3; + * @return float + */ + public function getGroundingScore() + { + return isset($this->grounding_score) ? $this->grounding_score : 0.0; + } + + public function hasGroundingScore() + { + return isset($this->grounding_score); + } + + public function clearGroundingScore() + { + unset($this->grounding_score); + } + + /** + * The overall grounding score for the candidate, in the range of [0, 1]. + * + * Generated from protobuf field optional float grounding_score = 3; + * @param float $var + * @return $this + */ + public function setGroundingScore($var) + { + GPBUtil::checkFloat($var); + $this->grounding_score = $var; + + return $this; + } + + /** + * Grounding metadata for the generated content. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata|null + */ + public function getGroundingMetadata() + { + return $this->grounding_metadata; + } + + public function hasGroundingMetadata() + { + return isset($this->grounding_metadata); + } + + public function clearGroundingMetadata() + { + unset($this->grounding_metadata); + } + + /** + * Grounding metadata for the generated content. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata $var + * @return $this + */ + public function setGroundingMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata::class); + $this->grounding_metadata = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata.php new file mode 100644 index 000000000000..e3964f7c856f --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata.php @@ -0,0 +1,238 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata + */ +class GroundingMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Retrieval metadata to provide an understanding in the + * retrieval steps performed by the model. There can be multiple such + * messages which can correspond to different parts of the retrieval. This + * is a mechanism used to ensure transparency to our users. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5; + */ + private $retrieval_metadata; + /** + * List of chunks to be attributed across all claims in the candidate. + * These are derived from the grounding sources supplied in the request. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1; + */ + private $support_chunks; + /** + * Web search queries for the following-up web search. + * + * Generated from protobuf field repeated string web_search_queries = 3; + */ + private $web_search_queries; + /** + * Google search entry for the following-up web searches. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4; + */ + protected $search_entry_point = null; + /** + * GroundingSupport across all claims in the answer candidate. + * An support to a fact indicates that the claim is supported by + * the fact. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2; + */ + private $grounding_support; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\RetrievalMetadata>|\Google\Protobuf\Internal\RepeatedField $retrieval_metadata + * Retrieval metadata to provide an understanding in the + * retrieval steps performed by the model. There can be multiple such + * messages which can correspond to different parts of the retrieval. This + * is a mechanism used to ensure transparency to our users. + * @type array<\Google\Cloud\DiscoveryEngine\V1\FactChunk>|\Google\Protobuf\Internal\RepeatedField $support_chunks + * List of chunks to be attributed across all claims in the candidate. + * These are derived from the grounding sources supplied in the request. + * @type array|\Google\Protobuf\Internal\RepeatedField $web_search_queries + * Web search queries for the following-up web search. + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\SearchEntryPoint $search_entry_point + * Google search entry for the following-up web searches. + * @type array<\Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\GroundingSupport>|\Google\Protobuf\Internal\RepeatedField $grounding_support + * GroundingSupport across all claims in the answer candidate. + * An support to a fact indicates that the claim is supported by + * the fact. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Retrieval metadata to provide an understanding in the + * retrieval steps performed by the model. There can be multiple such + * messages which can correspond to different parts of the retrieval. This + * is a mechanism used to ensure transparency to our users. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRetrievalMetadata() + { + return $this->retrieval_metadata; + } + + /** + * Retrieval metadata to provide an understanding in the + * retrieval steps performed by the model. There can be multiple such + * messages which can correspond to different parts of the retrieval. This + * is a mechanism used to ensure transparency to our users. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5; + * @param array<\Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\RetrievalMetadata>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRetrievalMetadata($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\RetrievalMetadata::class); + $this->retrieval_metadata = $arr; + + return $this; + } + + /** + * List of chunks to be attributed across all claims in the candidate. + * These are derived from the grounding sources supplied in the request. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSupportChunks() + { + return $this->support_chunks; + } + + /** + * List of chunks to be attributed across all claims in the candidate. + * These are derived from the grounding sources supplied in the request. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1; + * @param array<\Google\Cloud\DiscoveryEngine\V1\FactChunk>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSupportChunks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\FactChunk::class); + $this->support_chunks = $arr; + + return $this; + } + + /** + * Web search queries for the following-up web search. + * + * Generated from protobuf field repeated string web_search_queries = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getWebSearchQueries() + { + return $this->web_search_queries; + } + + /** + * Web search queries for the following-up web search. + * + * Generated from protobuf field repeated string web_search_queries = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setWebSearchQueries($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->web_search_queries = $arr; + + return $this; + } + + /** + * Google search entry for the following-up web searches. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\SearchEntryPoint|null + */ + public function getSearchEntryPoint() + { + return $this->search_entry_point; + } + + public function hasSearchEntryPoint() + { + return isset($this->search_entry_point); + } + + public function clearSearchEntryPoint() + { + unset($this->search_entry_point); + } + + /** + * Google search entry for the following-up web searches. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\SearchEntryPoint $var + * @return $this + */ + public function setSearchEntryPoint($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\SearchEntryPoint::class); + $this->search_entry_point = $var; + + return $this; + } + + /** + * GroundingSupport across all claims in the answer candidate. + * An support to a fact indicates that the claim is supported by + * the fact. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGroundingSupport() + { + return $this->grounding_support; + } + + /** + * GroundingSupport across all claims in the answer candidate. + * An support to a fact indicates that the claim is supported by + * the fact. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2; + * @param array<\Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\GroundingSupport>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGroundingSupport($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\GroundingSupport::class); + $this->grounding_support = $arr; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalMetadata.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalMetadata.php new file mode 100644 index 000000000000..1a4f54402b27 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalMetadata.php @@ -0,0 +1,78 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata + */ +class DynamicRetrievalMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Metadata for the dynamic retrieval predictor. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata predictor_metadata = 1; + */ + protected $predictor_metadata = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalPredictorMetadata $predictor_metadata + * Metadata for the dynamic retrieval predictor. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Metadata for the dynamic retrieval predictor. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata predictor_metadata = 1; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalPredictorMetadata|null + */ + public function getPredictorMetadata() + { + return $this->predictor_metadata; + } + + public function hasPredictorMetadata() + { + return isset($this->predictor_metadata); + } + + public function clearPredictorMetadata() + { + unset($this->predictor_metadata); + } + + /** + * Metadata for the dynamic retrieval predictor. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata predictor_metadata = 1; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalPredictorMetadata $var + * @return $this + */ + public function setPredictorMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalPredictorMetadata::class); + $this->predictor_metadata = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalPredictorMetadata.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalPredictorMetadata.php new file mode 100644 index 000000000000..09207799172c --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalPredictorMetadata.php @@ -0,0 +1,128 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata + */ +class DynamicRetrievalPredictorMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * The version of the predictor which was used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1; + */ + protected $version = 0; + /** + * The value of the predictor. This should be between [0, 1] where + * a value of 0 means that the query would not benefit from grounding, + * while a value of 1.0 means that the query would benefit the most. + * In between values allow to differentiate between different usefulness + * scores for grounding. + * + * Generated from protobuf field optional float prediction = 2; + */ + protected $prediction = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $version + * The version of the predictor which was used in dynamic retrieval. + * @type float $prediction + * The value of the predictor. This should be between [0, 1] where + * a value of 0 means that the query would not benefit from grounding, + * while a value of 1.0 means that the query would benefit the most. + * In between values allow to differentiate between different usefulness + * scores for grounding. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * The version of the predictor which was used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1; + * @return int + */ + public function getVersion() + { + return $this->version; + } + + /** + * The version of the predictor which was used in dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1; + * @param int $var + * @return $this + */ + public function setVersion($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalPredictorMetadata\Version::class); + $this->version = $var; + + return $this; + } + + /** + * The value of the predictor. This should be between [0, 1] where + * a value of 0 means that the query would not benefit from grounding, + * while a value of 1.0 means that the query would benefit the most. + * In between values allow to differentiate between different usefulness + * scores for grounding. + * + * Generated from protobuf field optional float prediction = 2; + * @return float + */ + public function getPrediction() + { + return isset($this->prediction) ? $this->prediction : 0.0; + } + + public function hasPrediction() + { + return isset($this->prediction); + } + + public function clearPrediction() + { + unset($this->prediction); + } + + /** + * The value of the predictor. This should be between [0, 1] where + * a value of 0 means that the query would not benefit from grounding, + * while a value of 1.0 means that the query would benefit the most. + * In between values allow to differentiate between different usefulness + * scores for grounding. + * + * Generated from protobuf field optional float prediction = 2; + * @param float $var + * @return $this + */ + public function setPrediction($var) + { + GPBUtil::checkFloat($var); + $this->prediction = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalPredictorMetadata/Version.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalPredictorMetadata/Version.php new file mode 100644 index 000000000000..30ec19cc89e1 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/DynamicRetrievalPredictorMetadata/Version.php @@ -0,0 +1,55 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version + */ +class Version +{ + /** + * Unspecified version, should never be used. + * + * Generated from protobuf enum VERSION_UNSPECIFIED = 0; + */ + const VERSION_UNSPECIFIED = 0; + /** + * The V1 model which is evaluating each source independently. + * + * Generated from protobuf enum V1_INDEPENDENT = 1; + */ + const V1_INDEPENDENT = 1; + + private static $valueToName = [ + self::VERSION_UNSPECIFIED => 'VERSION_UNSPECIFIED', + self::V1_INDEPENDENT => 'V1_INDEPENDENT', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/GroundingSupport.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/GroundingSupport.php new file mode 100644 index 000000000000..4e68b69f4502 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/GroundingSupport.php @@ -0,0 +1,170 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport + */ +class GroundingSupport extends \Google\Protobuf\Internal\Message +{ + /** + * Text for the claim in the candidate. Always provided when a + * support is found. + * + * Generated from protobuf field string claim_text = 1; + */ + protected $claim_text = ''; + /** + * A list of indices (into 'support_chunks') specifying the + * citations associated with the claim. For instance [1,3,4] means + * that support_chunks[1], support_chunks[3], + * support_chunks[4] are the chunks attributed to the claim. + * + * Generated from protobuf field repeated int32 support_chunk_indices = 3; + */ + private $support_chunk_indices; + /** + * A score in the range of [0, 1] describing how grounded is a specific + * claim in the support chunks indicated. + * Higher value means that the claim is better supported by the chunks. + * + * Generated from protobuf field optional float support_score = 2; + */ + protected $support_score = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $claim_text + * Text for the claim in the candidate. Always provided when a + * support is found. + * @type array|\Google\Protobuf\Internal\RepeatedField $support_chunk_indices + * A list of indices (into 'support_chunks') specifying the + * citations associated with the claim. For instance [1,3,4] means + * that support_chunks[1], support_chunks[3], + * support_chunks[4] are the chunks attributed to the claim. + * @type float $support_score + * A score in the range of [0, 1] describing how grounded is a specific + * claim in the support chunks indicated. + * Higher value means that the claim is better supported by the chunks. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Text for the claim in the candidate. Always provided when a + * support is found. + * + * Generated from protobuf field string claim_text = 1; + * @return string + */ + public function getClaimText() + { + return $this->claim_text; + } + + /** + * Text for the claim in the candidate. Always provided when a + * support is found. + * + * Generated from protobuf field string claim_text = 1; + * @param string $var + * @return $this + */ + public function setClaimText($var) + { + GPBUtil::checkString($var, True); + $this->claim_text = $var; + + return $this; + } + + /** + * A list of indices (into 'support_chunks') specifying the + * citations associated with the claim. For instance [1,3,4] means + * that support_chunks[1], support_chunks[3], + * support_chunks[4] are the chunks attributed to the claim. + * + * Generated from protobuf field repeated int32 support_chunk_indices = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSupportChunkIndices() + { + return $this->support_chunk_indices; + } + + /** + * A list of indices (into 'support_chunks') specifying the + * citations associated with the claim. For instance [1,3,4] means + * that support_chunks[1], support_chunks[3], + * support_chunks[4] are the chunks attributed to the claim. + * + * Generated from protobuf field repeated int32 support_chunk_indices = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSupportChunkIndices($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32); + $this->support_chunk_indices = $arr; + + return $this; + } + + /** + * A score in the range of [0, 1] describing how grounded is a specific + * claim in the support chunks indicated. + * Higher value means that the claim is better supported by the chunks. + * + * Generated from protobuf field optional float support_score = 2; + * @return float + */ + public function getSupportScore() + { + return isset($this->support_score) ? $this->support_score : 0.0; + } + + public function hasSupportScore() + { + return isset($this->support_score); + } + + public function clearSupportScore() + { + unset($this->support_score); + } + + /** + * A score in the range of [0, 1] describing how grounded is a specific + * claim in the support chunks indicated. + * Higher value means that the claim is better supported by the chunks. + * + * Generated from protobuf field optional float support_score = 2; + * @param float $var + * @return $this + */ + public function setSupportScore($var) + { + GPBUtil::checkFloat($var); + $this->support_score = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/RetrievalMetadata.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/RetrievalMetadata.php new file mode 100644 index 000000000000..e6273801e7e6 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/RetrievalMetadata.php @@ -0,0 +1,112 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata + */ +class RetrievalMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Describes the source to which the metadata is referring to. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1; + */ + protected $source = 0; + /** + * Metadata for dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2; + */ + protected $dynamic_retrieval_metadata = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $source + * Describes the source to which the metadata is referring to. + * @type \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalMetadata $dynamic_retrieval_metadata + * Metadata for dynamic retrieval. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Describes the source to which the metadata is referring to. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1; + * @return int + */ + public function getSource() + { + return $this->source; + } + + /** + * Describes the source to which the metadata is referring to. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1; + * @param int $var + * @return $this + */ + public function setSource($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\RetrievalMetadata\Source::class); + $this->source = $var; + + return $this; + } + + /** + * Metadata for dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2; + * @return \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalMetadata|null + */ + public function getDynamicRetrievalMetadata() + { + return $this->dynamic_retrieval_metadata; + } + + public function hasDynamicRetrievalMetadata() + { + return isset($this->dynamic_retrieval_metadata); + } + + public function clearDynamicRetrievalMetadata() + { + unset($this->dynamic_retrieval_metadata); + } + + /** + * Metadata for dynamic retrieval. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2; + * @param \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalMetadata $var + * @return $this + */ + public function setDynamicRetrievalMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalMetadata::class); + $this->dynamic_retrieval_metadata = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/RetrievalMetadata/Source.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/RetrievalMetadata/Source.php new file mode 100644 index 000000000000..f635460ed8dd --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/RetrievalMetadata/Source.php @@ -0,0 +1,76 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source + */ +class Source +{ + /** + * Unspecified source. + * + * Generated from protobuf enum SOURCE_UNSPECIFIED = 0; + */ + const SOURCE_UNSPECIFIED = 0; + /** + * Vertex AI search. + * + * Generated from protobuf enum VERTEX_AI_SEARCH = 1; + */ + const VERTEX_AI_SEARCH = 1; + /** + * Google Search. + * + * Generated from protobuf enum GOOGLE_SEARCH = 3; + */ + const GOOGLE_SEARCH = 3; + /** + * User inline provided content. + * + * Generated from protobuf enum INLINE_CONTENT = 2; + */ + const INLINE_CONTENT = 2; + /** + * Google Maps. + * + * Generated from protobuf enum GOOGLE_MAPS = 4; + */ + const GOOGLE_MAPS = 4; + + private static $valueToName = [ + self::SOURCE_UNSPECIFIED => 'SOURCE_UNSPECIFIED', + self::VERTEX_AI_SEARCH => 'VERTEX_AI_SEARCH', + self::GOOGLE_SEARCH => 'GOOGLE_SEARCH', + self::INLINE_CONTENT => 'INLINE_CONTENT', + self::GOOGLE_MAPS => 'GOOGLE_MAPS', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/SearchEntryPoint.php b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/SearchEntryPoint.php new file mode 100644 index 000000000000..1e61988c5f57 --- /dev/null +++ b/DiscoveryEngine/src/V1/GenerateGroundedContentResponse/Candidate/GroundingMetadata/SearchEntryPoint.php @@ -0,0 +1,110 @@ +google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint + */ +class SearchEntryPoint extends \Google\Protobuf\Internal\Message +{ + /** + * Web content snippet that can be embedded in a web page or an app + * webview. + * + * Generated from protobuf field string rendered_content = 1; + */ + protected $rendered_content = ''; + /** + * Base64 encoded JSON representing array of + * tuple. + * + * Generated from protobuf field bytes sdk_blob = 2; + */ + protected $sdk_blob = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $rendered_content + * Web content snippet that can be embedded in a web page or an app + * webview. + * @type string $sdk_blob + * Base64 encoded JSON representing array of + * tuple. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Web content snippet that can be embedded in a web page or an app + * webview. + * + * Generated from protobuf field string rendered_content = 1; + * @return string + */ + public function getRenderedContent() + { + return $this->rendered_content; + } + + /** + * Web content snippet that can be embedded in a web page or an app + * webview. + * + * Generated from protobuf field string rendered_content = 1; + * @param string $var + * @return $this + */ + public function setRenderedContent($var) + { + GPBUtil::checkString($var, True); + $this->rendered_content = $var; + + return $this; + } + + /** + * Base64 encoded JSON representing array of + * tuple. + * + * Generated from protobuf field bytes sdk_blob = 2; + * @return string + */ + public function getSdkBlob() + { + return $this->sdk_blob; + } + + /** + * Base64 encoded JSON representing array of + * tuple. + * + * Generated from protobuf field bytes sdk_blob = 2; + * @param string $var + * @return $this + */ + public function setSdkBlob($var) + { + GPBUtil::checkString($var, False); + $this->sdk_blob = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/GetAnswerRequest.php b/DiscoveryEngine/src/V1/GetAnswerRequest.php index 15f35eb2bc75..624260872ffc 100644 --- a/DiscoveryEngine/src/V1/GetAnswerRequest.php +++ b/DiscoveryEngine/src/V1/GetAnswerRequest.php @@ -17,7 +17,7 @@ class GetAnswerRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the Answer to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -25,7 +25,7 @@ class GetAnswerRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The resource name of the Answer to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` * Please see {@see ConversationalSearchServiceClient::answerName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\GetAnswerRequest @@ -46,7 +46,7 @@ public static function build(string $name): self * * @type string $name * Required. The resource name of the Answer to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the Answer to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -68,7 +68,7 @@ public function getName() /** * Required. The resource name of the Answer to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/GetControlRequest.php b/DiscoveryEngine/src/V1/GetControlRequest.php index 083e30a65dfc..a477700e21c1 100644 --- a/DiscoveryEngine/src/V1/GetControlRequest.php +++ b/DiscoveryEngine/src/V1/GetControlRequest.php @@ -17,7 +17,7 @@ class GetControlRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the Control to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -25,7 +25,7 @@ class GetControlRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The resource name of the Control to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * Please see {@see ControlServiceClient::controlName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\GetControlRequest @@ -46,7 +46,7 @@ public static function build(string $name): self * * @type string $name * Required. The resource name of the Control to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the Control to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -68,7 +68,7 @@ public function getName() /** * Required. The resource name of the Control to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/GetConversationRequest.php b/DiscoveryEngine/src/V1/GetConversationRequest.php index 833c847e2909..52237d85f733 100644 --- a/DiscoveryEngine/src/V1/GetConversationRequest.php +++ b/DiscoveryEngine/src/V1/GetConversationRequest.php @@ -17,7 +17,7 @@ class GetConversationRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -25,7 +25,7 @@ class GetConversationRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * Please see {@see ConversationalSearchServiceClient::conversationName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\GetConversationRequest @@ -46,7 +46,7 @@ public static function build(string $name): self * * @type string $name * Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -68,7 +68,7 @@ public function getName() /** * Required. The resource name of the Conversation to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/GetSessionRequest.php b/DiscoveryEngine/src/V1/GetSessionRequest.php index dd3fa5c5da5f..cee01b9265bc 100644 --- a/DiscoveryEngine/src/V1/GetSessionRequest.php +++ b/DiscoveryEngine/src/V1/GetSessionRequest.php @@ -17,7 +17,7 @@ class GetSessionRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the Session to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -25,7 +25,7 @@ class GetSessionRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The resource name of the Session to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * Please see {@see ConversationalSearchServiceClient::sessionName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\GetSessionRequest @@ -46,7 +46,7 @@ public static function build(string $name): self * * @type string $name * Required. The resource name of the Session to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the Session to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -68,7 +68,7 @@ public function getName() /** * Required. The resource name of the Session to get. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/GroundedGenerationContent.php b/DiscoveryEngine/src/V1/GroundedGenerationContent.php new file mode 100644 index 000000000000..b0e40bee2852 --- /dev/null +++ b/DiscoveryEngine/src/V1/GroundedGenerationContent.php @@ -0,0 +1,109 @@ +google.cloud.discoveryengine.v1.GroundedGenerationContent + */ +class GroundedGenerationContent extends \Google\Protobuf\Internal\Message +{ + /** + * Producer of the content. Must be either `user` or `model`. + * Intended to be used for multi-turn conversations. Otherwise, it can be left + * unset. + * + * Generated from protobuf field string role = 1; + */ + protected $role = ''; + /** + * Ordered `Parts` that constitute a single message. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent.Part parts = 2; + */ + private $parts; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $role + * Producer of the content. Must be either `user` or `model`. + * Intended to be used for multi-turn conversations. Otherwise, it can be left + * unset. + * @type array<\Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent\Part>|\Google\Protobuf\Internal\RepeatedField $parts + * Ordered `Parts` that constitute a single message. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Producer of the content. Must be either `user` or `model`. + * Intended to be used for multi-turn conversations. Otherwise, it can be left + * unset. + * + * Generated from protobuf field string role = 1; + * @return string + */ + public function getRole() + { + return $this->role; + } + + /** + * Producer of the content. Must be either `user` or `model`. + * Intended to be used for multi-turn conversations. Otherwise, it can be left + * unset. + * + * Generated from protobuf field string role = 1; + * @param string $var + * @return $this + */ + public function setRole($var) + { + GPBUtil::checkString($var, True); + $this->role = $var; + + return $this; + } + + /** + * Ordered `Parts` that constitute a single message. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent.Part parts = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getParts() + { + return $this->parts; + } + + /** + * Ordered `Parts` that constitute a single message. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent.Part parts = 2; + * @param array<\Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent\Part>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setParts($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\GroundedGenerationContent\Part::class); + $this->parts = $arr; + + return $this; + } + +} + diff --git a/DiscoveryEngine/src/V1/GroundedGenerationContent/Part.php b/DiscoveryEngine/src/V1/GroundedGenerationContent/Part.php new file mode 100644 index 000000000000..8cea7f9b48b6 --- /dev/null +++ b/DiscoveryEngine/src/V1/GroundedGenerationContent/Part.php @@ -0,0 +1,76 @@ +google.cloud.discoveryengine.v1.GroundedGenerationContent.Part + */ +class Part extends \Google\Protobuf\Internal\Message +{ + protected $data; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $text + * Inline text. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\GroundedGenerationService::initOnce(); + parent::__construct($data); + } + + /** + * Inline text. + * + * Generated from protobuf field string text = 1; + * @return string + */ + public function getText() + { + return $this->readOneof(1); + } + + public function hasText() + { + return $this->hasOneof(1); + } + + /** + * Inline text. + * + * Generated from protobuf field string text = 1; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * @return string + */ + public function getData() + { + return $this->whichOneof("data"); + } + +} + + diff --git a/DiscoveryEngine/src/V1/ListControlsRequest.php b/DiscoveryEngine/src/V1/ListControlsRequest.php index c980c9323f2d..6f617ecbea6f 100644 --- a/DiscoveryEngine/src/V1/ListControlsRequest.php +++ b/DiscoveryEngine/src/V1/ListControlsRequest.php @@ -17,9 +17,9 @@ class ListControlsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -50,9 +50,9 @@ class ListControlsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. Please see + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Please see * {@see ControlServiceClient::dataStoreName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\ListControlsRequest @@ -73,9 +73,9 @@ public static function build(string $parent): self * * @type string $parent * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. * @type int $page_size * Optional. Maximum number of results to return. If unspecified, defaults * to 50. Max allowed value is 1000. @@ -96,9 +96,9 @@ public function __construct($data = NULL) { /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -110,9 +110,9 @@ public function getParent() /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` * or - * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/ListConversationsRequest.php b/DiscoveryEngine/src/V1/ListConversationsRequest.php index 8a934e8645dd..0168464597dd 100644 --- a/DiscoveryEngine/src/V1/ListConversationsRequest.php +++ b/DiscoveryEngine/src/V1/ListConversationsRequest.php @@ -17,7 +17,7 @@ class ListConversationsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -62,7 +62,7 @@ class ListConversationsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * Please see {@see ConversationalSearchServiceClient::dataStoreName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\ListConversationsRequest @@ -83,7 +83,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * @type int $page_size * Maximum number of results to return. If unspecified, defaults * to 50. Max allowed value is 1000. @@ -114,7 +114,7 @@ public function __construct($data = NULL) { /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -126,7 +126,7 @@ public function getParent() /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/ListSessionsRequest.php b/DiscoveryEngine/src/V1/ListSessionsRequest.php index ce9a4ffb95c8..9788fe85f40c 100644 --- a/DiscoveryEngine/src/V1/ListSessionsRequest.php +++ b/DiscoveryEngine/src/V1/ListSessionsRequest.php @@ -17,7 +17,7 @@ class ListSessionsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -62,7 +62,7 @@ class ListSessionsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * Please see {@see ConversationalSearchServiceClient::dataStoreName()} for help formatting this field. * * @return \Google\Cloud\DiscoveryEngine\V1\ListSessionsRequest @@ -83,7 +83,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * @type int $page_size * Maximum number of results to return. If unspecified, defaults * to 50. Max allowed value is 1000. @@ -114,7 +114,7 @@ public function __construct($data = NULL) { /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -126,7 +126,7 @@ public function getParent() /** * Required. The data store resource name. Format: - * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/Project.php b/DiscoveryEngine/src/V1/Project.php index bb68bc5df75e..5af8ff910b7e 100644 --- a/DiscoveryEngine/src/V1/Project.php +++ b/DiscoveryEngine/src/V1/Project.php @@ -17,7 +17,7 @@ class Project extends \Google\Protobuf\Internal\Message { /** * Output only. Full resource name of the project, for example - * `projects/{project_number}`. + * `projects/{project}`. * Note that when making requests, project number and project id are both * acceptable, but the server will always respond in project number. * @@ -54,7 +54,7 @@ class Project extends \Google\Protobuf\Internal\Message * * @type string $name * Output only. Full resource name of the project, for example - * `projects/{project_number}`. + * `projects/{project}`. * Note that when making requests, project number and project id are both * acceptable, but the server will always respond in project number. * @type \Google\Protobuf\Timestamp $create_time @@ -75,7 +75,7 @@ public function __construct($data = NULL) { /** * Output only. Full resource name of the project, for example - * `projects/{project_number}`. + * `projects/{project}`. * Note that when making requests, project number and project id are both * acceptable, but the server will always respond in project number. * @@ -89,7 +89,7 @@ public function getName() /** * Output only. Full resource name of the project, for example - * `projects/{project_number}`. + * `projects/{project}`. * Note that when making requests, project number and project id are both * acceptable, but the server will always respond in project number. * diff --git a/DiscoveryEngine/src/V1/PurgeUserEventsRequest.php b/DiscoveryEngine/src/V1/PurgeUserEventsRequest.php index c9549b1fd46e..7557c8a63bdc 100644 --- a/DiscoveryEngine/src/V1/PurgeUserEventsRequest.php +++ b/DiscoveryEngine/src/V1/PurgeUserEventsRequest.php @@ -18,7 +18,7 @@ class PurgeUserEventsRequest extends \Google\Protobuf\Internal\Message /** * Required. The resource name of the catalog under which the events are * created. The format is - * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}` + * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -70,7 +70,7 @@ class PurgeUserEventsRequest extends \Google\Protobuf\Internal\Message * @type string $parent * Required. The resource name of the catalog under which the events are * created. The format is - * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}` + * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. * @type string $filter * Required. The filter string to specify the events to be deleted with a * length limit of 5,000 characters. The eligible fields for filtering are: @@ -110,7 +110,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the catalog under which the events are * created. The format is - * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}` + * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -123,7 +123,7 @@ public function getParent() /** * Required. The resource name of the catalog under which the events are * created. The format is - * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}` + * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/RankRequest.php b/DiscoveryEngine/src/V1/RankRequest.php index 2a243f093ecb..37ff3389d13c 100644 --- a/DiscoveryEngine/src/V1/RankRequest.php +++ b/DiscoveryEngine/src/V1/RankRequest.php @@ -18,7 +18,7 @@ class RankRequest extends \Google\Protobuf\Internal\Message { /** * Required. The resource name of the rank service config, such as - * `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. + * `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. * * Generated from protobuf field string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -87,7 +87,7 @@ class RankRequest extends \Google\Protobuf\Internal\Message * * @type string $ranking_config * Required. The resource name of the rank service config, such as - * `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. + * `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. * @type string $model * The identifier of the model to use. It is one of: * * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input @@ -128,7 +128,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the rank service config, such as - * `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. + * `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. * * Generated from protobuf field string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -140,7 +140,7 @@ public function getRankingConfig() /** * Required. The resource name of the rank service config, such as - * `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. + * `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. * * Generated from protobuf field string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DiscoveryEngine/src/V1/RecrawlUrisRequest.php b/DiscoveryEngine/src/V1/RecrawlUrisRequest.php index 4074c86d35e8..c06134acc221 100644 --- a/DiscoveryEngine/src/V1/RecrawlUrisRequest.php +++ b/DiscoveryEngine/src/V1/RecrawlUrisRequest.php @@ -34,6 +34,14 @@ class RecrawlUrisRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated string uris = 2 [(.google.api.field_behavior) = REQUIRED]; */ private $uris; + /** + * Optional. Full resource name of the [SiteCredential][], such as + * `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. + * Only set to crawl private URIs. + * + * Generated from protobuf field string site_credential = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $site_credential = ''; /** * Constructor. @@ -50,6 +58,10 @@ class RecrawlUrisRequest extends \Google\Protobuf\Internal\Message * an INVALID_ARGUMENT error is thrown. Each URI should match at least one * [TargetSite][google.cloud.discoveryengine.v1.TargetSite] in * `site_search_engine`. + * @type string $site_credential + * Optional. Full resource name of the [SiteCredential][], such as + * `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. + * Only set to crawl private URIs. * } */ public function __construct($data = NULL) { @@ -119,5 +131,35 @@ public function setUris($var) return $this; } + /** + * Optional. Full resource name of the [SiteCredential][], such as + * `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. + * Only set to crawl private URIs. + * + * Generated from protobuf field string site_credential = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSiteCredential() + { + return $this->site_credential; + } + + /** + * Optional. Full resource name of the [SiteCredential][], such as + * `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. + * Only set to crawl private URIs. + * + * Generated from protobuf field string site_credential = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSiteCredential($var) + { + GPBUtil::checkString($var, True); + $this->site_credential = $var; + + return $this; + } + } diff --git a/DiscoveryEngine/src/V1/SearchRequest.php b/DiscoveryEngine/src/V1/SearchRequest.php index 7a7ce92eeccb..64d4084b0fcd 100644 --- a/DiscoveryEngine/src/V1/SearchRequest.php +++ b/DiscoveryEngine/src/V1/SearchRequest.php @@ -85,6 +85,14 @@ class SearchRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field int32 offset = 6; */ protected $offset = 0; + /** + * The maximum number of results to return for OneBox. + * This applies to each OneBox type individually. + * Default number is 10. + * + * Generated from protobuf field int32 one_box_page_size = 47; + */ + protected $one_box_page_size = 0; /** * Specs defining dataStores to filter on in a search call and configurations * for those dataStores. This is only considered for engines with multiple @@ -344,6 +352,10 @@ class SearchRequest extends \Google\Protobuf\Internal\Message * [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is * unset. * If this field is negative, an `INVALID_ARGUMENT` is returned. + * @type int $one_box_page_size + * The maximum number of results to return for OneBox. + * This applies to each OneBox type individually. + * Default number is 10. * @type array<\Google\Cloud\DiscoveryEngine\V1\SearchRequest\DataStoreSpec>|\Google\Protobuf\Internal\RepeatedField $data_store_specs * Specs defining dataStores to filter on in a search call and configurations * for those dataStores. This is only considered for engines with multiple @@ -735,6 +747,36 @@ public function setOffset($var) return $this; } + /** + * The maximum number of results to return for OneBox. + * This applies to each OneBox type individually. + * Default number is 10. + * + * Generated from protobuf field int32 one_box_page_size = 47; + * @return int + */ + public function getOneBoxPageSize() + { + return $this->one_box_page_size; + } + + /** + * The maximum number of results to return for OneBox. + * This applies to each OneBox type individually. + * Default number is 10. + * + * Generated from protobuf field int32 one_box_page_size = 47; + * @param int $var + * @return $this + */ + public function setOneBoxPageSize($var) + { + GPBUtil::checkInt32($var); + $this->one_box_page_size = $var; + + return $this; + } + /** * Specs defining dataStores to filter on in a search call and configurations * for those dataStores. This is only considered for engines with multiple diff --git a/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec.php b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec.php index 8326b453bf08..2c903bbd62ba 100644 --- a/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec.php +++ b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec.php @@ -49,6 +49,13 @@ class ConditionBoostSpec extends \Google\Protobuf\Internal\Message * Generated from protobuf field float boost = 2; */ protected $boost = 0.0; + /** + * Complex specification for custom ranking based on customer defined + * attribute value. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3; + */ + protected $boost_control_spec = null; /** * Constructor. @@ -82,6 +89,9 @@ class ConditionBoostSpec extends \Google\Protobuf\Internal\Message * ignored. Only one of the (condition, boost) combination or the * boost_control_spec below are set. If both are set then the global boost * is ignored and the more fine-grained boost_control_spec is applied. + * @type \Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec $boost_control_spec + * Complex specification for custom ranking based on customer defined + * attribute value. * } */ public function __construct($data = NULL) { @@ -185,6 +195,44 @@ public function setBoost($var) return $this; } + /** + * Complex specification for custom ranking based on customer defined + * attribute value. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3; + * @return \Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec|null + */ + public function getBoostControlSpec() + { + return $this->boost_control_spec; + } + + public function hasBoostControlSpec() + { + return isset($this->boost_control_spec); + } + + public function clearBoostControlSpec() + { + unset($this->boost_control_spec); + } + + /** + * Complex specification for custom ranking based on customer defined + * attribute value. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3; + * @param \Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec $var + * @return $this + */ + public function setBoostControlSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec::class); + $this->boost_control_spec = $var; + + return $this; + } + } diff --git a/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec.php b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec.php new file mode 100644 index 000000000000..ac9f682896a5 --- /dev/null +++ b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec.php @@ -0,0 +1,204 @@ +google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec + */ +class BoostControlSpec extends \Google\Protobuf\Internal\Message +{ + /** + * The name of the field whose value will be used to determine the + * boost amount. + * + * Generated from protobuf field string field_name = 1; + */ + protected $field_name = ''; + /** + * The attribute type to be used to determine the boost amount. The + * attribute value can be derived from the field value of the specified + * field_name. In the case of numerical it is straightforward i.e. + * attribute_value = numerical_field_value. In the case of freshness + * however, attribute_value = (time.now() - datetime_field_value). + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2; + */ + protected $attribute_type = 0; + /** + * The interpolation type to be applied to connect the control points + * listed below. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3; + */ + protected $interpolation_type = 0; + /** + * The control points used to define the curve. The monotonic function + * (defined through the interpolation_type above) passes through the + * control points listed here. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4; + */ + private $control_points; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $field_name + * The name of the field whose value will be used to determine the + * boost amount. + * @type int $attribute_type + * The attribute type to be used to determine the boost amount. The + * attribute value can be derived from the field value of the specified + * field_name. In the case of numerical it is straightforward i.e. + * attribute_value = numerical_field_value. In the case of freshness + * however, attribute_value = (time.now() - datetime_field_value). + * @type int $interpolation_type + * The interpolation type to be applied to connect the control points + * listed below. + * @type array<\Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec\ControlPoint>|\Google\Protobuf\Internal\RepeatedField $control_points + * The control points used to define the curve. The monotonic function + * (defined through the interpolation_type above) passes through the + * control points listed here. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * The name of the field whose value will be used to determine the + * boost amount. + * + * Generated from protobuf field string field_name = 1; + * @return string + */ + public function getFieldName() + { + return $this->field_name; + } + + /** + * The name of the field whose value will be used to determine the + * boost amount. + * + * Generated from protobuf field string field_name = 1; + * @param string $var + * @return $this + */ + public function setFieldName($var) + { + GPBUtil::checkString($var, True); + $this->field_name = $var; + + return $this; + } + + /** + * The attribute type to be used to determine the boost amount. The + * attribute value can be derived from the field value of the specified + * field_name. In the case of numerical it is straightforward i.e. + * attribute_value = numerical_field_value. In the case of freshness + * however, attribute_value = (time.now() - datetime_field_value). + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2; + * @return int + */ + public function getAttributeType() + { + return $this->attribute_type; + } + + /** + * The attribute type to be used to determine the boost amount. The + * attribute value can be derived from the field value of the specified + * field_name. In the case of numerical it is straightforward i.e. + * attribute_value = numerical_field_value. In the case of freshness + * however, attribute_value = (time.now() - datetime_field_value). + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2; + * @param int $var + * @return $this + */ + public function setAttributeType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec\AttributeType::class); + $this->attribute_type = $var; + + return $this; + } + + /** + * The interpolation type to be applied to connect the control points + * listed below. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3; + * @return int + */ + public function getInterpolationType() + { + return $this->interpolation_type; + } + + /** + * The interpolation type to be applied to connect the control points + * listed below. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3; + * @param int $var + * @return $this + */ + public function setInterpolationType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec\InterpolationType::class); + $this->interpolation_type = $var; + + return $this; + } + + /** + * The control points used to define the curve. The monotonic function + * (defined through the interpolation_type above) passes through the + * control points listed here. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getControlPoints() + { + return $this->control_points; + } + + /** + * The control points used to define the curve. The monotonic function + * (defined through the interpolation_type above) passes through the + * control points listed here. + * + * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4; + * @param array<\Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec\ControlPoint>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setControlPoints($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec\ControlPoint::class); + $this->control_points = $arr; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/AttributeType.php b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/AttributeType.php new file mode 100644 index 000000000000..34a5c6593803 --- /dev/null +++ b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/AttributeType.php @@ -0,0 +1,71 @@ +google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType + */ +class AttributeType +{ + /** + * Unspecified AttributeType. + * + * Generated from protobuf enum ATTRIBUTE_TYPE_UNSPECIFIED = 0; + */ + const ATTRIBUTE_TYPE_UNSPECIFIED = 0; + /** + * The value of the numerical field will be used to dynamically update + * the boost amount. In this case, the attribute_value (the x value) + * of the control point will be the actual value of the numerical + * field for which the boost_amount is specified. + * + * Generated from protobuf enum NUMERICAL = 1; + */ + const NUMERICAL = 1; + /** + * For the freshness use case the attribute value will be the duration + * between the current time and the date in the datetime field + * specified. The value must be formatted as an XSD `dayTimeDuration` + * value (a restricted subset of an ISO 8601 duration value). The + * pattern for this is: `[nD][T[nH][nM][nS]]`. + * For example, `5D`, `3DT12H30M`, `T24H`. + * + * Generated from protobuf enum FRESHNESS = 2; + */ + const FRESHNESS = 2; + + private static $valueToName = [ + self::ATTRIBUTE_TYPE_UNSPECIFIED => 'ATTRIBUTE_TYPE_UNSPECIFIED', + self::NUMERICAL => 'NUMERICAL', + self::FRESHNESS => 'FRESHNESS', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/ControlPoint.php b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/ControlPoint.php new file mode 100644 index 000000000000..a7f6686d99f0 --- /dev/null +++ b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/ControlPoint.php @@ -0,0 +1,128 @@ +google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint + */ +class ControlPoint extends \Google\Protobuf\Internal\Message +{ + /** + * Can be one of: + * 1. The numerical field value. + * 2. The duration spec for freshness: + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for + * this is: `[nD][T[nH][nM][nS]]`. + * + * Generated from protobuf field string attribute_value = 1; + */ + protected $attribute_value = ''; + /** + * The value between -1 to 1 by which to boost the score if the + * attribute_value evaluates to the value specified above. + * + * Generated from protobuf field float boost_amount = 2; + */ + protected $boost_amount = 0.0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $attribute_value + * Can be one of: + * 1. The numerical field value. + * 2. The duration spec for freshness: + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for + * this is: `[nD][T[nH][nM][nS]]`. + * @type float $boost_amount + * The value between -1 to 1 by which to boost the score if the + * attribute_value evaluates to the value specified above. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\SearchService::initOnce(); + parent::__construct($data); + } + + /** + * Can be one of: + * 1. The numerical field value. + * 2. The duration spec for freshness: + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for + * this is: `[nD][T[nH][nM][nS]]`. + * + * Generated from protobuf field string attribute_value = 1; + * @return string + */ + public function getAttributeValue() + { + return $this->attribute_value; + } + + /** + * Can be one of: + * 1. The numerical field value. + * 2. The duration spec for freshness: + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for + * this is: `[nD][T[nH][nM][nS]]`. + * + * Generated from protobuf field string attribute_value = 1; + * @param string $var + * @return $this + */ + public function setAttributeValue($var) + { + GPBUtil::checkString($var, True); + $this->attribute_value = $var; + + return $this; + } + + /** + * The value between -1 to 1 by which to boost the score if the + * attribute_value evaluates to the value specified above. + * + * Generated from protobuf field float boost_amount = 2; + * @return float + */ + public function getBoostAmount() + { + return $this->boost_amount; + } + + /** + * The value between -1 to 1 by which to boost the score if the + * attribute_value evaluates to the value specified above. + * + * Generated from protobuf field float boost_amount = 2; + * @param float $var + * @return $this + */ + public function setBoostAmount($var) + { + GPBUtil::checkFloat($var); + $this->boost_amount = $var; + + return $this; + } + +} + + diff --git a/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/InterpolationType.php b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/InterpolationType.php new file mode 100644 index 000000000000..121bd8d5936e --- /dev/null +++ b/DiscoveryEngine/src/V1/SearchRequest/BoostSpec/ConditionBoostSpec/BoostControlSpec/InterpolationType.php @@ -0,0 +1,57 @@ +google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType + */ +class InterpolationType +{ + /** + * Interpolation type is unspecified. In this case, it defaults to + * Linear. + * + * Generated from protobuf enum INTERPOLATION_TYPE_UNSPECIFIED = 0; + */ + const INTERPOLATION_TYPE_UNSPECIFIED = 0; + /** + * Piecewise linear interpolation will be applied. + * + * Generated from protobuf enum LINEAR = 1; + */ + const LINEAR = 1; + + private static $valueToName = [ + self::INTERPOLATION_TYPE_UNSPECIFIED => 'INTERPOLATION_TYPE_UNSPECIFIED', + self::LINEAR => 'LINEAR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DiscoveryEngine/src/V1/SearchRequest/ContentSearchSpec/SummarySpec.php b/DiscoveryEngine/src/V1/SearchRequest/ContentSearchSpec/SummarySpec.php index 24a64d3c8253..28e3138cf661 100644 --- a/DiscoveryEngine/src/V1/SearchRequest/ContentSearchSpec/SummarySpec.php +++ b/DiscoveryEngine/src/V1/SearchRequest/ContentSearchSpec/SummarySpec.php @@ -86,6 +86,21 @@ class SummarySpec extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool ignore_low_relevant_content = 9; */ protected $ignore_low_relevant_content = false; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The + * default value is `false`. + * Google employs search-query classification to detect jail-breaking + * queries. No summary is returned if the search query is classified as a + * jail-breaking query. A user might add instructions to the query to + * change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a + * competing company's CEO". If this field is set to `true`, we skip + * generating summaries for jail-breaking queries and return fallback + * messages instead. + * + * Generated from protobuf field bool ignore_jail_breaking_query = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $ignore_jail_breaking_query = false; /** * If specified, the spec will be used to modify the prompt provided to * the LLM. @@ -176,6 +191,17 @@ class SummarySpec extends \Google\Protobuf\Internal\Message * If this field is set to `false`, all search results are used regardless * of relevance to generate answers. If set to `true`, only queries with * high relevance search results will generate answers. + * @type bool $ignore_jail_breaking_query + * Optional. Specifies whether to filter out jail-breaking queries. The + * default value is `false`. + * Google employs search-query classification to detect jail-breaking + * queries. No summary is returned if the search query is classified as a + * jail-breaking query. A user might add instructions to the query to + * change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a + * competing company's CEO". If this field is set to `true`, we skip + * generating summaries for jail-breaking queries and return fallback + * messages instead. * @type \Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SummarySpec\ModelPromptSpec $model_prompt_spec * If specified, the spec will be used to modify the prompt provided to * the LLM. @@ -410,6 +436,50 @@ public function setIgnoreLowRelevantContent($var) return $this; } + /** + * Optional. Specifies whether to filter out jail-breaking queries. The + * default value is `false`. + * Google employs search-query classification to detect jail-breaking + * queries. No summary is returned if the search query is classified as a + * jail-breaking query. A user might add instructions to the query to + * change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a + * competing company's CEO". If this field is set to `true`, we skip + * generating summaries for jail-breaking queries and return fallback + * messages instead. + * + * Generated from protobuf field bool ignore_jail_breaking_query = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getIgnoreJailBreakingQuery() + { + return $this->ignore_jail_breaking_query; + } + + /** + * Optional. Specifies whether to filter out jail-breaking queries. The + * default value is `false`. + * Google employs search-query classification to detect jail-breaking + * queries. No summary is returned if the search query is classified as a + * jail-breaking query. A user might add instructions to the query to + * change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a + * competing company's CEO". If this field is set to `true`, we skip + * generating summaries for jail-breaking queries and return fallback + * messages instead. + * + * Generated from protobuf field bool ignore_jail_breaking_query = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setIgnoreJailBreakingQuery($var) + { + GPBUtil::checkBool($var); + $this->ignore_jail_breaking_query = $var; + + return $this; + } + /** * If specified, the spec will be used to modify the prompt provided to * the LLM. diff --git a/DiscoveryEngine/src/V1/SearchRequest/DataStoreSpec.php b/DiscoveryEngine/src/V1/SearchRequest/DataStoreSpec.php index e2097d0612a5..bb8b0728e012 100644 --- a/DiscoveryEngine/src/V1/SearchRequest/DataStoreSpec.php +++ b/DiscoveryEngine/src/V1/SearchRequest/DataStoreSpec.php @@ -25,6 +25,14 @@ class DataStoreSpec extends \Google\Protobuf\Internal\Message * Generated from protobuf field string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $data_store = ''; + /** + * Optional. Filter specification to filter documents in the data store + * specified by data_store field. For more information on filtering, see + * [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; /** * Constructor. @@ -36,6 +44,10 @@ class DataStoreSpec extends \Google\Protobuf\Internal\Message * Required. Full resource name of * [DataStore][google.cloud.discoveryengine.v1.DataStore], such as * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + * @type string $filter + * Optional. Filter specification to filter documents in the data store + * specified by data_store field. For more information on filtering, see + * [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) * } */ public function __construct($data = NULL) { @@ -73,6 +85,36 @@ public function setDataStore($var) return $this; } + /** + * Optional. Filter specification to filter documents in the data store + * specified by data_store field. For more information on filtering, see + * [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filter specification to filter documents in the data store + * specified by data_store field. For more information on filtering, see + * [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + } diff --git a/DiscoveryEngine/src/V1/SearchResponse/Summary/SummarySkippedReason.php b/DiscoveryEngine/src/V1/SearchResponse/Summary/SummarySkippedReason.php index 607ba3713278..d780e736cd93 100644 --- a/DiscoveryEngine/src/V1/SearchResponse/Summary/SummarySkippedReason.php +++ b/DiscoveryEngine/src/V1/SearchResponse/Summary/SummarySkippedReason.php @@ -30,6 +30,7 @@ class SummarySkippedReason const ADVERSARIAL_QUERY_IGNORED = 1; /** * The non-summary seeking query ignored case. + * Google skips the summary if the query is chit chat. * Only used when * [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query] * is set to `true`. @@ -87,6 +88,16 @@ class SummarySkippedReason * Generated from protobuf enum CUSTOMER_POLICY_VIOLATION = 8; */ const CUSTOMER_POLICY_VIOLATION = 8; + /** + * The non-answer seeking query ignored case. + * Google skips the summary if the query doesn't have clear intent. + * Only used when + * [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] + * is set to `true`. + * + * Generated from protobuf enum NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9; + */ + const NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9; private static $valueToName = [ self::SUMMARY_SKIPPED_REASON_UNSPECIFIED => 'SUMMARY_SKIPPED_REASON_UNSPECIFIED', @@ -98,6 +109,7 @@ class SummarySkippedReason self::NO_RELEVANT_CONTENT => 'NO_RELEVANT_CONTENT', self::JAIL_BREAKING_QUERY_IGNORED => 'JAIL_BREAKING_QUERY_IGNORED', self::CUSTOMER_POLICY_VIOLATION => 'CUSTOMER_POLICY_VIOLATION', + self::NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 => 'NON_SUMMARY_SEEKING_QUERY_IGNORED_V2', ]; public static function name($value) diff --git a/DiscoveryEngine/src/V1/WorkspaceConfig.php b/DiscoveryEngine/src/V1/WorkspaceConfig.php new file mode 100644 index 000000000000..eebbfc3e2900 --- /dev/null +++ b/DiscoveryEngine/src/V1/WorkspaceConfig.php @@ -0,0 +1,185 @@ +google.cloud.discoveryengine.v1.WorkspaceConfig + */ +class WorkspaceConfig extends \Google\Protobuf\Internal\Message +{ + /** + * The Google Workspace data source. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.WorkspaceConfig.Type type = 1; + */ + protected $type = 0; + /** + * Obfuscated Dasher customer ID. + * + * Generated from protobuf field string dasher_customer_id = 2; + */ + protected $dasher_customer_id = ''; + /** + * Optional. The super admin service account for the workspace that will be + * used for access token generation. For now we only use it for Native Google + * Drive connector data ingestion. + * + * Generated from protobuf field string super_admin_service_account = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $super_admin_service_account = ''; + /** + * Optional. The super admin email address for the workspace that will be used + * for access token generation. For now we only use it for Native Google Drive + * connector data ingestion. + * + * Generated from protobuf field string super_admin_email_address = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $super_admin_email_address = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $type + * The Google Workspace data source. + * @type string $dasher_customer_id + * Obfuscated Dasher customer ID. + * @type string $super_admin_service_account + * Optional. The super admin service account for the workspace that will be + * used for access token generation. For now we only use it for Native Google + * Drive connector data ingestion. + * @type string $super_admin_email_address + * Optional. The super admin email address for the workspace that will be used + * for access token generation. For now we only use it for Native Google Drive + * connector data ingestion. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Discoveryengine\V1\DataStore::initOnce(); + parent::__construct($data); + } + + /** + * The Google Workspace data source. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.WorkspaceConfig.Type type = 1; + * @return int + */ + public function getType() + { + return $this->type; + } + + /** + * The Google Workspace data source. + * + * Generated from protobuf field .google.cloud.discoveryengine.v1.WorkspaceConfig.Type type = 1; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\DiscoveryEngine\V1\WorkspaceConfig\Type::class); + $this->type = $var; + + return $this; + } + + /** + * Obfuscated Dasher customer ID. + * + * Generated from protobuf field string dasher_customer_id = 2; + * @return string + */ + public function getDasherCustomerId() + { + return $this->dasher_customer_id; + } + + /** + * Obfuscated Dasher customer ID. + * + * Generated from protobuf field string dasher_customer_id = 2; + * @param string $var + * @return $this + */ + public function setDasherCustomerId($var) + { + GPBUtil::checkString($var, True); + $this->dasher_customer_id = $var; + + return $this; + } + + /** + * Optional. The super admin service account for the workspace that will be + * used for access token generation. For now we only use it for Native Google + * Drive connector data ingestion. + * + * Generated from protobuf field string super_admin_service_account = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSuperAdminServiceAccount() + { + return $this->super_admin_service_account; + } + + /** + * Optional. The super admin service account for the workspace that will be + * used for access token generation. For now we only use it for Native Google + * Drive connector data ingestion. + * + * Generated from protobuf field string super_admin_service_account = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSuperAdminServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->super_admin_service_account = $var; + + return $this; + } + + /** + * Optional. The super admin email address for the workspace that will be used + * for access token generation. For now we only use it for Native Google Drive + * connector data ingestion. + * + * Generated from protobuf field string super_admin_email_address = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSuperAdminEmailAddress() + { + return $this->super_admin_email_address; + } + + /** + * Optional. The super admin email address for the workspace that will be used + * for access token generation. For now we only use it for Native Google Drive + * connector data ingestion. + * + * Generated from protobuf field string super_admin_email_address = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSuperAdminEmailAddress($var) + { + GPBUtil::checkString($var, True); + $this->super_admin_email_address = $var; + + return $this; + } + +} + diff --git a/DiscoveryEngine/src/V1/WorkspaceConfig/Type.php b/DiscoveryEngine/src/V1/WorkspaceConfig/Type.php new file mode 100644 index 000000000000..b9e4b7e4570d --- /dev/null +++ b/DiscoveryEngine/src/V1/WorkspaceConfig/Type.php @@ -0,0 +1,97 @@ +google.cloud.discoveryengine.v1.WorkspaceConfig.Type + */ +class Type +{ + /** + * Defaults to an unspecified Workspace type. + * + * Generated from protobuf enum TYPE_UNSPECIFIED = 0; + */ + const TYPE_UNSPECIFIED = 0; + /** + * Workspace Data Store contains Drive data + * + * Generated from protobuf enum GOOGLE_DRIVE = 1; + */ + const GOOGLE_DRIVE = 1; + /** + * Workspace Data Store contains Mail data + * + * Generated from protobuf enum GOOGLE_MAIL = 2; + */ + const GOOGLE_MAIL = 2; + /** + * Workspace Data Store contains Sites data + * + * Generated from protobuf enum GOOGLE_SITES = 3; + */ + const GOOGLE_SITES = 3; + /** + * Workspace Data Store contains Calendar data + * + * Generated from protobuf enum GOOGLE_CALENDAR = 4; + */ + const GOOGLE_CALENDAR = 4; + /** + * Workspace Data Store contains Chat data + * + * Generated from protobuf enum GOOGLE_CHAT = 5; + */ + const GOOGLE_CHAT = 5; + /** + * Workspace Data Store contains Groups data + * + * Generated from protobuf enum GOOGLE_GROUPS = 6; + */ + const GOOGLE_GROUPS = 6; + /** + * Workspace Data Store contains Keep data + * + * Generated from protobuf enum GOOGLE_KEEP = 7; + */ + const GOOGLE_KEEP = 7; + + private static $valueToName = [ + self::TYPE_UNSPECIFIED => 'TYPE_UNSPECIFIED', + self::GOOGLE_DRIVE => 'GOOGLE_DRIVE', + self::GOOGLE_MAIL => 'GOOGLE_MAIL', + self::GOOGLE_SITES => 'GOOGLE_SITES', + self::GOOGLE_CALENDAR => 'GOOGLE_CALENDAR', + self::GOOGLE_CHAT => 'GOOGLE_CHAT', + self::GOOGLE_GROUPS => 'GOOGLE_GROUPS', + self::GOOGLE_KEEP => 'GOOGLE_KEEP', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DiscoveryEngine/src/V1/gapic_metadata.json b/DiscoveryEngine/src/V1/gapic_metadata.json index cf51e0e4954a..b7befe39ec3f 100644 --- a/DiscoveryEngine/src/V1/gapic_metadata.json +++ b/DiscoveryEngine/src/V1/gapic_metadata.json @@ -287,6 +287,16 @@ "methods": [ "checkGrounding" ] + }, + "GenerateGroundedContent": { + "methods": [ + "generateGroundedContent" + ] + }, + "StreamGenerateGroundedContent": { + "methods": [ + "streamGenerateGroundedContent" + ] } } } diff --git a/DiscoveryEngine/src/V1/resources/completion_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/completion_service_rest_client_config.php index e06351c17fa0..77562ec9af55 100644 --- a/DiscoveryEngine/src/V1/resources/completion_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/completion_service_rest_client_config.php @@ -196,7 +196,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -269,7 +269,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/control_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/control_service_rest_client_config.php index 26212d2a414d..744ce1c6caa2 100644 --- a/DiscoveryEngine/src/V1/resources/control_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/control_service_rest_client_config.php @@ -224,7 +224,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -297,7 +297,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/conversational_search_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/conversational_search_service_rest_client_config.php index 0377adfbd825..72f19e677eea 100644 --- a/DiscoveryEngine/src/V1/resources/conversational_search_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/conversational_search_service_rest_client_config.php @@ -396,7 +396,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -469,7 +469,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/data_store_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/data_store_service_rest_client_config.php index 44ba3f283e60..80dec2169fdb 100644 --- a/DiscoveryEngine/src/V1/resources/data_store_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/data_store_service_rest_client_config.php @@ -199,7 +199,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -272,7 +272,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/document_service_descriptor_config.php b/DiscoveryEngine/src/V1/resources/document_service_descriptor_config.php index 4c0c33b5f6b5..0ce6edcf1c89 100644 --- a/DiscoveryEngine/src/V1/resources/document_service_descriptor_config.php +++ b/DiscoveryEngine/src/V1/resources/document_service_descriptor_config.php @@ -145,6 +145,7 @@ 'templateMap' => [ 'branch' => 'projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}', 'document' => 'projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}', + 'fhirResource' => 'projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}', 'fhirStore' => 'projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}', 'projectLocationCollectionDataStoreBranch' => 'projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}', 'projectLocationCollectionDataStoreBranchDocument' => 'projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}', diff --git a/DiscoveryEngine/src/V1/resources/document_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/document_service_rest_client_config.php index ddeabc3c3ca2..ee26521bf65c 100644 --- a/DiscoveryEngine/src/V1/resources/document_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/document_service_rest_client_config.php @@ -260,7 +260,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -333,7 +333,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/engine_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/engine_service_rest_client_config.php index ebec300e8482..0ef80187bf41 100644 --- a/DiscoveryEngine/src/V1/resources/engine_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/engine_service_rest_client_config.php @@ -164,7 +164,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -237,7 +237,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/grounded_generation_service_client_config.json b/DiscoveryEngine/src/V1/resources/grounded_generation_service_client_config.json index 7ee5457d398f..527fcc44020a 100644 --- a/DiscoveryEngine/src/V1/resources/grounded_generation_service_client_config.json +++ b/DiscoveryEngine/src/V1/resources/grounded_generation_service_client_config.json @@ -32,6 +32,14 @@ "timeout_millis": 5000, "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" + }, + "GenerateGroundedContent": { + "timeout_millis": 5000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "StreamGenerateGroundedContent": { + "timeout_millis": 5000 } } } diff --git a/DiscoveryEngine/src/V1/resources/grounded_generation_service_descriptor_config.php b/DiscoveryEngine/src/V1/resources/grounded_generation_service_descriptor_config.php index 4049f6280469..e4fc58d92897 100644 --- a/DiscoveryEngine/src/V1/resources/grounded_generation_service_descriptor_config.php +++ b/DiscoveryEngine/src/V1/resources/grounded_generation_service_descriptor_config.php @@ -35,8 +35,40 @@ ], ], ], + 'GenerateGroundedContent' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse', + 'headerParams' => [ + [ + 'keyName' => 'location', + 'fieldAccessors' => [ + 'getLocation', + ], + ], + ], + ], + 'StreamGenerateGroundedContent' => [ + 'grpcStreaming' => [ + 'grpcStreamingType' => 'BidiStreaming', + ], + 'callType' => \Google\ApiCore\Call::BIDI_STREAMING_CALL, + 'responseType' => 'Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse', + 'headerParams' => [ + [ + 'keyName' => 'location', + 'fieldAccessors' => [ + 'getLocation', + ], + ], + ], + ], 'templateMap' => [ 'groundingConfig' => 'projects/{project}/locations/{location}/groundingConfigs/{grounding_config}', + 'location' => 'projects/{project}/locations/{location}', + 'projectLocationCollectionDataStoreServingConfig' => 'projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}', + 'projectLocationCollectionEngineServingConfig' => 'projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}', + 'projectLocationDataStoreServingConfig' => 'projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}', + 'servingConfig' => 'projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}', ], ], ], diff --git a/DiscoveryEngine/src/V1/resources/grounded_generation_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/grounded_generation_service_rest_client_config.php index 321f48799e17..4ff1f90c475f 100644 --- a/DiscoveryEngine/src/V1/resources/grounded_generation_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/grounded_generation_service_rest_client_config.php @@ -35,6 +35,18 @@ ], ], ], + 'GenerateGroundedContent' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{location=projects/*/locations/*}:generateGroundedContent', + 'body' => '*', + 'placeholders' => [ + 'location' => [ + 'getters' => [ + 'getLocation', + ], + ], + ], + ], ], 'google.longrunning.Operations' => [ 'CancelOperation' => [ @@ -115,7 +127,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -188,7 +200,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/project_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/project_service_rest_client_config.php index 5178b3171844..273237494a76 100644 --- a/DiscoveryEngine/src/V1/resources/project_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/project_service_rest_client_config.php @@ -115,7 +115,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -188,7 +188,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/rank_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/rank_service_rest_client_config.php index 5ff62f84aa3c..c9c4ea80db4a 100644 --- a/DiscoveryEngine/src/V1/resources/rank_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/rank_service_rest_client_config.php @@ -115,7 +115,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -188,7 +188,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/recommendation_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/recommendation_service_rest_client_config.php index 2036147e8bb6..1dcb170de077 100644 --- a/DiscoveryEngine/src/V1/resources/recommendation_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/recommendation_service_rest_client_config.php @@ -127,7 +127,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -200,7 +200,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/schema_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/schema_service_rest_client_config.php index 36f625272192..b7810150dda4 100644 --- a/DiscoveryEngine/src/V1/resources/schema_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/schema_service_rest_client_config.php @@ -199,7 +199,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -272,7 +272,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/search_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/search_service_rest_client_config.php index 461ada07c9eb..61ff8f48813e 100644 --- a/DiscoveryEngine/src/V1/resources/search_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/search_service_rest_client_config.php @@ -127,7 +127,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -200,7 +200,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/search_tuning_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/search_tuning_service_rest_client_config.php index 2180fb0a0519..24a6d6eb4c13 100644 --- a/DiscoveryEngine/src/V1/resources/search_tuning_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/search_tuning_service_rest_client_config.php @@ -126,7 +126,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -199,7 +199,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/site_search_engine_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/site_search_engine_service_rest_client_config.php index aef730fd5b60..a8fa128e0290 100644 --- a/DiscoveryEngine/src/V1/resources/site_search_engine_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/site_search_engine_service_rest_client_config.php @@ -309,7 +309,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -382,7 +382,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/src/V1/resources/user_event_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/user_event_service_rest_client_config.php index 9a2a15cdd96c..806309062225 100644 --- a/DiscoveryEngine/src/V1/resources/user_event_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/user_event_service_rest_client_config.php @@ -186,7 +186,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}', ], [ 'method' => 'get', @@ -259,7 +259,7 @@ ], [ 'method' => 'get', - 'uriTemplate' => '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations', ], [ 'method' => 'get', diff --git a/DiscoveryEngine/tests/Unit/V1/Client/EngineServiceClientTest.php b/DiscoveryEngine/tests/Unit/V1/Client/EngineServiceClientTest.php index 36b41762afc7..2cd3c5299674 100644 --- a/DiscoveryEngine/tests/Unit/V1/Client/EngineServiceClientTest.php +++ b/DiscoveryEngine/tests/Unit/V1/Client/EngineServiceClientTest.php @@ -96,9 +96,11 @@ public function createEngineTest() $transport->addResponse($incompleteOperation); $name = 'name3373707'; $displayName = 'displayName1615086568'; + $disableAnalytics = false; $expectedResponse = new Engine(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDisableAnalytics($disableAnalytics); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -354,9 +356,11 @@ public function getEngineTest() // Mock response $name2 = 'name2-1052831874'; $displayName = 'displayName1615086568'; + $disableAnalytics = false; $expectedResponse = new Engine(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDisableAnalytics($disableAnalytics); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->engineName('[PROJECT]', '[LOCATION]', '[COLLECTION]', '[ENGINE]'); @@ -492,9 +496,11 @@ public function updateEngineTest() // Mock response $name = 'name3373707'; $displayName = 'displayName1615086568'; + $disableAnalytics = false; $expectedResponse = new Engine(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDisableAnalytics($disableAnalytics); $transport->addResponse($expectedResponse); // Mock request $engine = new Engine(); @@ -579,9 +585,11 @@ public function createEngineAsyncTest() $transport->addResponse($incompleteOperation); $name = 'name3373707'; $displayName = 'displayName1615086568'; + $disableAnalytics = false; $expectedResponse = new Engine(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDisableAnalytics($disableAnalytics); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); diff --git a/DiscoveryEngine/tests/Unit/V1/Client/GroundedGenerationServiceClientTest.php b/DiscoveryEngine/tests/Unit/V1/Client/GroundedGenerationServiceClientTest.php index fce50c2ed29f..48a125a0c6f5 100644 --- a/DiscoveryEngine/tests/Unit/V1/Client/GroundedGenerationServiceClientTest.php +++ b/DiscoveryEngine/tests/Unit/V1/Client/GroundedGenerationServiceClientTest.php @@ -23,12 +23,15 @@ namespace Google\Cloud\DiscoveryEngine\Tests\Unit\V1\Client; use Google\ApiCore\ApiException; +use Google\ApiCore\BidiStream; use Google\ApiCore\CredentialsWrapper; use Google\ApiCore\Testing\GeneratedTest; use Google\ApiCore\Testing\MockTransport; use Google\Cloud\DiscoveryEngine\V1\CheckGroundingRequest; use Google\Cloud\DiscoveryEngine\V1\CheckGroundingResponse; use Google\Cloud\DiscoveryEngine\V1\Client\GroundedGenerationServiceClient; +use Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentRequest; +use Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse; use Google\Rpc\Code; use stdClass; @@ -127,6 +130,169 @@ public function checkGroundingExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function generateGroundedContentTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new GenerateGroundedContentResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedLocation = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new GenerateGroundedContentRequest())->setLocation($formattedLocation); + $response = $gapicClient->generateGroundedContent($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.discoveryengine.v1.GroundedGenerationService/GenerateGroundedContent', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getLocation(); + $this->assertProtobufEquals($formattedLocation, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function generateGroundedContentExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedLocation = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new GenerateGroundedContentRequest())->setLocation($formattedLocation); + try { + $gapicClient->generateGroundedContent($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function streamGenerateGroundedContentTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new GenerateGroundedContentResponse(); + $transport->addResponse($expectedResponse); + $expectedResponse2 = new GenerateGroundedContentResponse(); + $transport->addResponse($expectedResponse2); + $expectedResponse3 = new GenerateGroundedContentResponse(); + $transport->addResponse($expectedResponse3); + // Mock request + $formattedLocation = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = new GenerateGroundedContentRequest(); + $request->setLocation($formattedLocation); + $formattedLocation2 = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request2 = new GenerateGroundedContentRequest(); + $request2->setLocation($formattedLocation2); + $formattedLocation3 = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request3 = new GenerateGroundedContentRequest(); + $request3->setLocation($formattedLocation3); + $bidi = $gapicClient->streamGenerateGroundedContent(); + $this->assertInstanceOf(BidiStream::class, $bidi); + $bidi->write($request); + $responses = []; + $responses[] = $bidi->read(); + $bidi->writeAll([$request2, $request3]); + foreach ($bidi->closeWriteAndReadAll() as $response) { + $responses[] = $response; + } + + $expectedResponses = []; + $expectedResponses[] = $expectedResponse; + $expectedResponses[] = $expectedResponse2; + $expectedResponses[] = $expectedResponse3; + $this->assertEquals($expectedResponses, $responses); + $createStreamRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($createStreamRequests)); + $streamFuncCall = $createStreamRequests[0]->getFuncCall(); + $streamRequestObject = $createStreamRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.discoveryengine.v1.GroundedGenerationService/StreamGenerateGroundedContent', + $streamFuncCall + ); + $this->assertNull($streamRequestObject); + $callObjects = $transport->popCallObjects(); + $this->assertSame(1, count($callObjects)); + $bidiCall = $callObjects[0]; + $writeRequests = $bidiCall->popReceivedCalls(); + $expectedRequests = []; + $expectedRequests[] = $request; + $expectedRequests[] = $request2; + $expectedRequests[] = $request3; + $this->assertEquals($expectedRequests, $writeRequests); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function streamGenerateGroundedContentExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->setStreamingStatus($status); + $this->assertTrue($transport->isExhausted()); + $bidi = $gapicClient->streamGenerateGroundedContent(); + $results = $bidi->closeWriteAndReadAll(); + try { + iterator_to_array($results); + // If the close stream method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function checkGroundingAsyncTest() { From 764bb32bb2c092828be889c3f951234f605b16ad Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 19:05:08 +0000 Subject: [PATCH 023/157] feat: Add backupplan proto (#7732) feat: Add backupplan proto feat: Add backupplanassociation proto feat: Add backupvault_ba proto feat: Add backupvault_gce proto PiperOrigin-RevId: 683196317 Source-Link: https://github.com/googleapis/googleapis/commit/c532f355b2bae18fdff19ced316897433de5f093 Source-Link: https://github.com/googleapis/googleapis-gen/commit/fd43f5733b002358fa679623f6099aafb6660c8e Copy-Tag: eyJwIjoiQmFja3VwRHIvLk93bEJvdC55YW1sIiwiaCI6ImZkNDNmNTczM2IwMDIzNThmYTY3OTYyM2Y2MDk5YWFmYjY2NjBjOGUifQ== --- BackupDr/metadata/V1/Backupdr.php | Bin 5611 -> 11158 bytes BackupDr/metadata/V1/Backupplan.php | Bin 0 -> 3876 bytes .../metadata/V1/Backupplanassociation.php | Bin 0 -> 3399 bytes BackupDr/metadata/V1/Backupvault.php | Bin 0 -> 11613 bytes BackupDr/metadata/V1/BackupvaultBa.php | Bin 0 -> 1358 bytes BackupDr/metadata/V1/BackupvaultGce.php | Bin 0 -> 11739 bytes .../V1/BackupDRClient/create_backup_plan.php | 174 + .../create_backup_plan_association.php | 114 + .../V1/BackupDRClient/create_backup_vault.php | 93 + .../create_management_server.php | 4 +- .../V1/BackupDRClient/delete_backup.php | 89 + .../V1/BackupDRClient/delete_backup_plan.php | 82 + .../delete_backup_plan_association.php | 85 + .../V1/BackupDRClient/delete_backup_vault.php | 80 + .../fetch_usable_backup_vaults.php | 83 + .../samples/V1/BackupDRClient/get_backup.php | 78 + .../V1/BackupDRClient/get_backup_plan.php | 73 + .../get_backup_plan_association.php | 76 + .../V1/BackupDRClient/get_backup_vault.php | 72 + .../V1/BackupDRClient/get_data_source.php | 77 + .../BackupDRClient/get_management_server.php | 2 +- .../list_backup_plan_associations.php | 81 + .../V1/BackupDRClient/list_backup_plans.php | 80 + .../V1/BackupDRClient/list_backup_vaults.php | 81 + .../V1/BackupDRClient/list_backups.php | 86 + .../V1/BackupDRClient/list_data_sources.php | 81 + .../list_management_servers.php | 9 +- .../V1/BackupDRClient/restore_backup.php | 90 + .../V1/BackupDRClient/trigger_backup.php | 91 + .../V1/BackupDRClient/update_backup.php | 74 + .../V1/BackupDRClient/update_backup_vault.php | 77 + .../V1/BackupDRClient/update_data_source.php | 74 + BackupDr/src/V1/AcceleratorConfig.php | 130 + BackupDr/src/V1/AccessConfig.php | 406 +++ BackupDr/src/V1/AccessConfig/AccessType.php | 62 + BackupDr/src/V1/AccessConfig/NetworkTier.php | 64 + BackupDr/src/V1/AdvancedMachineFeatures.php | 241 ++ BackupDr/src/V1/AliasIpRange.php | 129 + BackupDr/src/V1/AllocationAffinity.php | 159 + BackupDr/src/V1/AllocationAffinity/Type.php | 70 + BackupDr/src/V1/AttachedDisk.php | 804 +++++ .../src/V1/AttachedDisk/DiskInterface.php | 76 + BackupDr/src/V1/AttachedDisk/DiskMode.php | 74 + .../src/V1/AttachedDisk/DiskSavedState.php | 55 + BackupDr/src/V1/AttachedDisk/DiskType.php | 62 + .../src/V1/AttachedDisk/InitializeParams.php | 120 + BackupDr/src/V1/Backup.php | 728 +++++ BackupDr/src/V1/Backup/BackupType.php | 62 + BackupDr/src/V1/Backup/GCPBackupPlanInfo.php | 119 + BackupDr/src/V1/Backup/State.php | 76 + .../src/V1/BackupApplianceBackupConfig.php | 272 ++ .../V1/BackupApplianceBackupProperties.php | 218 ++ BackupDr/src/V1/BackupApplianceLockInfo.php | 252 ++ BackupDr/src/V1/BackupConfigInfo.php | 235 ++ .../V1/BackupConfigInfo/LastBackupState.php | 78 + BackupDr/src/V1/BackupConfigState.php | 63 + BackupDr/src/V1/BackupLock.php | 163 + BackupDr/src/V1/BackupPlan.php | 490 +++ BackupDr/src/V1/BackupPlan/State.php | 76 + BackupDr/src/V1/BackupPlanAssociation.php | 396 +++ .../src/V1/BackupPlanAssociation/State.php | 76 + BackupDr/src/V1/BackupRule.php | 166 + BackupDr/src/V1/BackupVault.php | 715 +++++ .../src/V1/BackupVault/AccessRestriction.php | 70 + BackupDr/src/V1/BackupVault/State.php | 76 + BackupDr/src/V1/BackupVaultView.php | 62 + BackupDr/src/V1/BackupView.php | 62 + BackupDr/src/V1/BackupWindow.php | 125 + BackupDr/src/V1/Client/BackupDRClient.php | 779 +++++ .../V1/ComputeInstanceBackupProperties.php | 716 +++++ .../ComputeInstanceDataSourceProperties.php | 204 ++ .../V1/ComputeInstanceRestoreProperties.php | 1150 +++++++ .../InstancePrivateIpv6GoogleAccess.php | 76 + .../V1/ComputeInstanceTargetEnvironment.php | 102 + .../src/V1/ConfidentialInstanceConfig.php | 81 + .../V1/CreateBackupPlanAssociationRequest.php | 252 ++ BackupDr/src/V1/CreateBackupPlanRequest.php | 262 ++ BackupDr/src/V1/CreateBackupVaultRequest.php | 285 ++ .../src/V1/CreateManagementServerRequest.php | 20 +- BackupDr/src/V1/CustomerEncryptionKey.php | 205 ++ BackupDr/src/V1/DataSource.php | 543 ++++ BackupDr/src/V1/DataSource/State.php | 76 + .../DataSourceBackupApplianceApplication.php | 272 ++ BackupDr/src/V1/DataSourceGcpResource.php | 190 ++ .../V1/DeleteBackupPlanAssociationRequest.php | 160 + BackupDr/src/V1/DeleteBackupPlanRequest.php | 161 + BackupDr/src/V1/DeleteBackupRequest.php | 155 + BackupDr/src/V1/DeleteBackupVaultRequest.php | 311 ++ BackupDr/src/V1/DisplayDevice.php | 77 + BackupDr/src/V1/Entry.php | 133 + .../src/V1/FetchUsableBackupVaultsRequest.php | 246 ++ .../V1/FetchUsableBackupVaultsResponse.php | 159 + BackupDr/src/V1/GcpBackupConfig.php | 171 + BackupDr/src/V1/GcpResource.php | 139 + .../V1/GetBackupPlanAssociationRequest.php | 86 + BackupDr/src/V1/GetBackupPlanRequest.php | 87 + BackupDr/src/V1/GetBackupRequest.php | 124 + BackupDr/src/V1/GetBackupVaultRequest.php | 124 + BackupDr/src/V1/GetDataSourceRequest.php | 86 + .../src/V1/GetManagementServerRequest.php | 10 +- BackupDr/src/V1/GuestOsFeature.php | 77 + .../src/V1/GuestOsFeature/FeatureType.php | 146 + BackupDr/src/V1/InstanceParams.php | 67 + BackupDr/src/V1/KeyRevocationActionType.php | 63 + .../V1/ListBackupPlanAssociationsRequest.php | 212 ++ .../V1/ListBackupPlanAssociationsResponse.php | 159 + BackupDr/src/V1/ListBackupPlansRequest.php | 277 ++ BackupDr/src/V1/ListBackupPlansResponse.php | 179 ++ BackupDr/src/V1/ListBackupVaultsRequest.php | 284 ++ BackupDr/src/V1/ListBackupVaultsResponse.php | 159 + BackupDr/src/V1/ListBackupsRequest.php | 284 ++ BackupDr/src/V1/ListBackupsResponse.php | 159 + BackupDr/src/V1/ListDataSourcesRequest.php | 246 ++ BackupDr/src/V1/ListDataSourcesResponse.php | 159 + .../src/V1/ListManagementServersRequest.php | 45 +- .../src/V1/ListManagementServersResponse.php | 8 +- BackupDr/src/V1/ManagementServer.php | 8 +- BackupDr/src/V1/Metadata.php | 71 + BackupDr/src/V1/NetworkInterface.php | 700 +++++ .../V1/NetworkInterface/Ipv6AccessType.php | 63 + BackupDr/src/V1/NetworkInterface/NicType.php | 62 + .../src/V1/NetworkInterface/StackType.php | 62 + BackupDr/src/V1/NetworkPerformanceConfig.php | 77 + .../src/V1/NetworkPerformanceConfig/Tier.php | 66 + BackupDr/src/V1/OperationMetadata.php | 8 +- BackupDr/src/V1/RestoreBackupRequest.php | 244 ++ BackupDr/src/V1/RestoreBackupResponse.php | 77 + BackupDr/src/V1/RuleConfigInfo.php | 201 ++ .../src/V1/RuleConfigInfo/LastBackupState.php | 77 + BackupDr/src/V1/Scheduling.php | 399 +++ .../Scheduling/InstanceTerminationAction.php | 62 + BackupDr/src/V1/Scheduling/NodeAffinity.php | 157 + .../V1/Scheduling/NodeAffinity/Operator.php | 62 + .../src/V1/Scheduling/OnHostMaintenance.php | 64 + .../src/V1/Scheduling/ProvisioningModel.php | 62 + BackupDr/src/V1/SchedulingDuration.php | 128 + BackupDr/src/V1/ServiceAccount.php | 111 + BackupDr/src/V1/ServiceLockInfo.php | 72 + BackupDr/src/V1/StandardSchedule.php | 447 +++ .../V1/StandardSchedule/RecurrenceType.php | 83 + BackupDr/src/V1/Tags.php | 71 + BackupDr/src/V1/TargetResource.php | 75 + BackupDr/src/V1/TriggerBackupRequest.php | 196 ++ BackupDr/src/V1/UpdateBackupRequest.php | 230 ++ BackupDr/src/V1/UpdateBackupVaultRequest.php | 306 ++ BackupDr/src/V1/UpdateDataSourceRequest.php | 264 ++ BackupDr/src/V1/WeekDayOfMonth.php | 103 + .../src/V1/WeekDayOfMonth/WeekOfMonth.php | 84 + BackupDr/src/V1/gapic_metadata.json | 115 + .../V1/resources/backup_dr_client_config.json | 115 + .../resources/backup_dr_descriptor_config.php | 416 +++ .../backup_dr_rest_client_config.php | 282 ++ .../Unit/V1/Client/BackupDRClientTest.php | 2800 ++++++++++++++++- 153 files changed, 27238 insertions(+), 186 deletions(-) create mode 100644 BackupDr/metadata/V1/Backupplan.php create mode 100644 BackupDr/metadata/V1/Backupplanassociation.php create mode 100644 BackupDr/metadata/V1/Backupvault.php create mode 100644 BackupDr/metadata/V1/BackupvaultBa.php create mode 100644 BackupDr/metadata/V1/BackupvaultGce.php create mode 100644 BackupDr/samples/V1/BackupDRClient/create_backup_plan.php create mode 100644 BackupDr/samples/V1/BackupDRClient/create_backup_plan_association.php create mode 100644 BackupDr/samples/V1/BackupDRClient/create_backup_vault.php create mode 100644 BackupDr/samples/V1/BackupDRClient/delete_backup.php create mode 100644 BackupDr/samples/V1/BackupDRClient/delete_backup_plan.php create mode 100644 BackupDr/samples/V1/BackupDRClient/delete_backup_plan_association.php create mode 100644 BackupDr/samples/V1/BackupDRClient/delete_backup_vault.php create mode 100644 BackupDr/samples/V1/BackupDRClient/fetch_usable_backup_vaults.php create mode 100644 BackupDr/samples/V1/BackupDRClient/get_backup.php create mode 100644 BackupDr/samples/V1/BackupDRClient/get_backup_plan.php create mode 100644 BackupDr/samples/V1/BackupDRClient/get_backup_plan_association.php create mode 100644 BackupDr/samples/V1/BackupDRClient/get_backup_vault.php create mode 100644 BackupDr/samples/V1/BackupDRClient/get_data_source.php create mode 100644 BackupDr/samples/V1/BackupDRClient/list_backup_plan_associations.php create mode 100644 BackupDr/samples/V1/BackupDRClient/list_backup_plans.php create mode 100644 BackupDr/samples/V1/BackupDRClient/list_backup_vaults.php create mode 100644 BackupDr/samples/V1/BackupDRClient/list_backups.php create mode 100644 BackupDr/samples/V1/BackupDRClient/list_data_sources.php create mode 100644 BackupDr/samples/V1/BackupDRClient/restore_backup.php create mode 100644 BackupDr/samples/V1/BackupDRClient/trigger_backup.php create mode 100644 BackupDr/samples/V1/BackupDRClient/update_backup.php create mode 100644 BackupDr/samples/V1/BackupDRClient/update_backup_vault.php create mode 100644 BackupDr/samples/V1/BackupDRClient/update_data_source.php create mode 100644 BackupDr/src/V1/AcceleratorConfig.php create mode 100644 BackupDr/src/V1/AccessConfig.php create mode 100644 BackupDr/src/V1/AccessConfig/AccessType.php create mode 100644 BackupDr/src/V1/AccessConfig/NetworkTier.php create mode 100644 BackupDr/src/V1/AdvancedMachineFeatures.php create mode 100644 BackupDr/src/V1/AliasIpRange.php create mode 100644 BackupDr/src/V1/AllocationAffinity.php create mode 100644 BackupDr/src/V1/AllocationAffinity/Type.php create mode 100644 BackupDr/src/V1/AttachedDisk.php create mode 100644 BackupDr/src/V1/AttachedDisk/DiskInterface.php create mode 100644 BackupDr/src/V1/AttachedDisk/DiskMode.php create mode 100644 BackupDr/src/V1/AttachedDisk/DiskSavedState.php create mode 100644 BackupDr/src/V1/AttachedDisk/DiskType.php create mode 100644 BackupDr/src/V1/AttachedDisk/InitializeParams.php create mode 100644 BackupDr/src/V1/Backup.php create mode 100644 BackupDr/src/V1/Backup/BackupType.php create mode 100644 BackupDr/src/V1/Backup/GCPBackupPlanInfo.php create mode 100644 BackupDr/src/V1/Backup/State.php create mode 100644 BackupDr/src/V1/BackupApplianceBackupConfig.php create mode 100644 BackupDr/src/V1/BackupApplianceBackupProperties.php create mode 100644 BackupDr/src/V1/BackupApplianceLockInfo.php create mode 100644 BackupDr/src/V1/BackupConfigInfo.php create mode 100644 BackupDr/src/V1/BackupConfigInfo/LastBackupState.php create mode 100644 BackupDr/src/V1/BackupConfigState.php create mode 100644 BackupDr/src/V1/BackupLock.php create mode 100644 BackupDr/src/V1/BackupPlan.php create mode 100644 BackupDr/src/V1/BackupPlan/State.php create mode 100644 BackupDr/src/V1/BackupPlanAssociation.php create mode 100644 BackupDr/src/V1/BackupPlanAssociation/State.php create mode 100644 BackupDr/src/V1/BackupRule.php create mode 100644 BackupDr/src/V1/BackupVault.php create mode 100644 BackupDr/src/V1/BackupVault/AccessRestriction.php create mode 100644 BackupDr/src/V1/BackupVault/State.php create mode 100644 BackupDr/src/V1/BackupVaultView.php create mode 100644 BackupDr/src/V1/BackupView.php create mode 100644 BackupDr/src/V1/BackupWindow.php create mode 100644 BackupDr/src/V1/ComputeInstanceBackupProperties.php create mode 100644 BackupDr/src/V1/ComputeInstanceDataSourceProperties.php create mode 100644 BackupDr/src/V1/ComputeInstanceRestoreProperties.php create mode 100644 BackupDr/src/V1/ComputeInstanceRestoreProperties/InstancePrivateIpv6GoogleAccess.php create mode 100644 BackupDr/src/V1/ComputeInstanceTargetEnvironment.php create mode 100644 BackupDr/src/V1/ConfidentialInstanceConfig.php create mode 100644 BackupDr/src/V1/CreateBackupPlanAssociationRequest.php create mode 100644 BackupDr/src/V1/CreateBackupPlanRequest.php create mode 100644 BackupDr/src/V1/CreateBackupVaultRequest.php create mode 100644 BackupDr/src/V1/CustomerEncryptionKey.php create mode 100644 BackupDr/src/V1/DataSource.php create mode 100644 BackupDr/src/V1/DataSource/State.php create mode 100644 BackupDr/src/V1/DataSourceBackupApplianceApplication.php create mode 100644 BackupDr/src/V1/DataSourceGcpResource.php create mode 100644 BackupDr/src/V1/DeleteBackupPlanAssociationRequest.php create mode 100644 BackupDr/src/V1/DeleteBackupPlanRequest.php create mode 100644 BackupDr/src/V1/DeleteBackupRequest.php create mode 100644 BackupDr/src/V1/DeleteBackupVaultRequest.php create mode 100644 BackupDr/src/V1/DisplayDevice.php create mode 100644 BackupDr/src/V1/Entry.php create mode 100644 BackupDr/src/V1/FetchUsableBackupVaultsRequest.php create mode 100644 BackupDr/src/V1/FetchUsableBackupVaultsResponse.php create mode 100644 BackupDr/src/V1/GcpBackupConfig.php create mode 100644 BackupDr/src/V1/GcpResource.php create mode 100644 BackupDr/src/V1/GetBackupPlanAssociationRequest.php create mode 100644 BackupDr/src/V1/GetBackupPlanRequest.php create mode 100644 BackupDr/src/V1/GetBackupRequest.php create mode 100644 BackupDr/src/V1/GetBackupVaultRequest.php create mode 100644 BackupDr/src/V1/GetDataSourceRequest.php create mode 100644 BackupDr/src/V1/GuestOsFeature.php create mode 100644 BackupDr/src/V1/GuestOsFeature/FeatureType.php create mode 100644 BackupDr/src/V1/InstanceParams.php create mode 100644 BackupDr/src/V1/KeyRevocationActionType.php create mode 100644 BackupDr/src/V1/ListBackupPlanAssociationsRequest.php create mode 100644 BackupDr/src/V1/ListBackupPlanAssociationsResponse.php create mode 100644 BackupDr/src/V1/ListBackupPlansRequest.php create mode 100644 BackupDr/src/V1/ListBackupPlansResponse.php create mode 100644 BackupDr/src/V1/ListBackupVaultsRequest.php create mode 100644 BackupDr/src/V1/ListBackupVaultsResponse.php create mode 100644 BackupDr/src/V1/ListBackupsRequest.php create mode 100644 BackupDr/src/V1/ListBackupsResponse.php create mode 100644 BackupDr/src/V1/ListDataSourcesRequest.php create mode 100644 BackupDr/src/V1/ListDataSourcesResponse.php create mode 100644 BackupDr/src/V1/Metadata.php create mode 100644 BackupDr/src/V1/NetworkInterface.php create mode 100644 BackupDr/src/V1/NetworkInterface/Ipv6AccessType.php create mode 100644 BackupDr/src/V1/NetworkInterface/NicType.php create mode 100644 BackupDr/src/V1/NetworkInterface/StackType.php create mode 100644 BackupDr/src/V1/NetworkPerformanceConfig.php create mode 100644 BackupDr/src/V1/NetworkPerformanceConfig/Tier.php create mode 100644 BackupDr/src/V1/RestoreBackupRequest.php create mode 100644 BackupDr/src/V1/RestoreBackupResponse.php create mode 100644 BackupDr/src/V1/RuleConfigInfo.php create mode 100644 BackupDr/src/V1/RuleConfigInfo/LastBackupState.php create mode 100644 BackupDr/src/V1/Scheduling.php create mode 100644 BackupDr/src/V1/Scheduling/InstanceTerminationAction.php create mode 100644 BackupDr/src/V1/Scheduling/NodeAffinity.php create mode 100644 BackupDr/src/V1/Scheduling/NodeAffinity/Operator.php create mode 100644 BackupDr/src/V1/Scheduling/OnHostMaintenance.php create mode 100644 BackupDr/src/V1/Scheduling/ProvisioningModel.php create mode 100644 BackupDr/src/V1/SchedulingDuration.php create mode 100644 BackupDr/src/V1/ServiceAccount.php create mode 100644 BackupDr/src/V1/ServiceLockInfo.php create mode 100644 BackupDr/src/V1/StandardSchedule.php create mode 100644 BackupDr/src/V1/StandardSchedule/RecurrenceType.php create mode 100644 BackupDr/src/V1/Tags.php create mode 100644 BackupDr/src/V1/TargetResource.php create mode 100644 BackupDr/src/V1/TriggerBackupRequest.php create mode 100644 BackupDr/src/V1/UpdateBackupRequest.php create mode 100644 BackupDr/src/V1/UpdateBackupVaultRequest.php create mode 100644 BackupDr/src/V1/UpdateDataSourceRequest.php create mode 100644 BackupDr/src/V1/WeekDayOfMonth.php create mode 100644 BackupDr/src/V1/WeekDayOfMonth/WeekOfMonth.php diff --git a/BackupDr/metadata/V1/Backupdr.php b/BackupDr/metadata/V1/Backupdr.php index ad9d53d4795104ebe54e55f0f4947c64580359cd..fde6b0d8cfbdf7d0c8a52d61ff14ec9a42a21a7e 100644 GIT binary patch literal 11158 zcmb_iO>7&-70!ybEDilbj}x1b?PNncuuRxwr2NyiVoIbH+LlC6KY?B0B*wcSFO)J4NG9NjY-YHeTjwhguA*q&Xtn`*7SxoJ3R-QH=L zO~c8kYGFlPURhI%h0@wf;Og3Kr*7obE!*B|8rgc&Za1YB<^58UJ^Nj){<^ z?-*`NuN&%Od49?8^oH)~)kW%FT_En&dG21_n7M&ay{WsdDz2eNNQHl`cCBgFRoBx! z`0ujmYNlm+rrtC^1QfT_O}*(F;M{Aw*|zGQXEzfq!V4BNq8J@p< zX*-8-Em@oPXl@mQGi+#VJsjeEYBhCh___Oy0(`XVCSCKVA8=Q1H%Hio`?j^^v@OfD zwyG;FlC`7lyiaJLQ*o!|?GKN@cU?0fg*|Xjjt2Pc_fhDuaMNK|HbX6hUtLT{NMU?eM;SWUes-Pk15*J_;m z+~9nVfe8%fH=mboI-JJ*)>VFs#^Ot4AeV%z-1M~}OeI2cuk-*f$~ta)iQ6^hjGERqgYaWGfnvZh8Z`wJOYNac?*Zsd8;WSD0lucU zKd-w+qjR+C6*RSJIXm%k+n#0R zp;W+E(FJ*GTPJrlmM5Coknw@3Ja><&H2bFrB?64AhO=upu<1ugd%%Yr|2z+yK7o@c z-rz+Sv@SU*ASn1A8gJ?~qv>JTU=$%j)A7Ax5Zn-6chM1Vzhxv(QvSXvCh3u;Oi$P)3zQeSmNjr^ zaTn0ZE;__%5Y;Qg3=3RkKwOYgl7Eznu&<1ZT8)sgn{Np^!L8`=!-*Au@n^k{j*|Y! zNFJjr@mBPZfiojZMy$jt@n;z3&;%C^H#tEW(Qgqtw1EsThEJm-(2;H>Pe3$WaxS7o z506iY+cCV0u12m}kKbv!ZgbHf!`H1dAsN)?(eawD0V_Y)rxJhxE=z0-TI51o;6lZ6 zwbqAj@(i7}m&)_du5RefHebD|PCqmGEci{(>87ruxRfwBj$#jueU_*A1UkA)Mq#>^ z8+%Jh<wMubyZKYBKMg15`f*6Bt zF@6C}`Gde%Aj6&dd>lMvK zisgKXh<@TIK84~-`O@-Qahb%L7$?INE0vW>;#lsd%9r_{C}`Sm9az-?MRzmsfRycK zD83Kd^DU$9x!Fhj*Fm;v*ICP!eI$M!WP|)=+y;l>l1sJmAbmQx#I0r%-Ir4TP|$_@ zrt2;F1%lgFjQ88nwBg%m97+fzHy7Dgfc9VI(|CAPXVGK}3Z3S{qZZxrql6*~K8Fy! z?%59wD@lZqXHXK2Z<;goAa_*z&mmmsE&!bnbO882~zE86S|63uqZCTEL*T$J-W^ ziu$%*YZ?F*QZH4lqNzorXW_-V&vleGzUsqsDfKUay+F%TcbsB|r{CF^(6c=YM=HEu zw#V>YB+-zsE#2#pmX?Vv5XNDwB$EW(NPU1V7L2Ch8BtK5axn>2rI~$rO6tckblQKa z5{DC{#><@n=|_jC@iS<`uo@#Z6VNnzx&tQ)LHfi_^yhrpShlb#B6OM`)3(o>P@%d5vX(J8&rfU^`EPCMXK zWz*)R^quI`=~=Q2Jh|~9$RoesWyPjmM`uFr4Js(JPqJu&9RU?8_%8~2E>r?=p9V10 zf#=RtpAIa-k7-Tn&XYXX(~my;;)i2z;@8PT+#@Ejw|xCiOS+#9(R=(m1)T{|5Bys6 zqKB9ZI3uWBs_-OFo9>SINf#aweMqrNAK*{M(AjW#!hO~@+(V$aD6mTprWv1Vsh=y4 z^Dl=yMD!-`ll*nIA=i53t@jFO5nYPAsl#n$u2&%OKNWN~T+#ZiPPoUAtMmTjd>TE+ zpNoNq^b|8gPkeCL3P~JDGvFh0;C~7_&32S!>IOO4!n0x*dmnCkjEBVbG3>mG;_@tE zkS_5}XZ@N+k36o)e~7KVoqA=MtYxkgm79a^o1Ag8QSomTlpsPePcJePJQIz)+g1SY zvsk?@T!QkQ5;TiP27~{upmTQ&ufDzRl8&YWMW08q2p0k7?P&awo*dIsC#E@kbL0)$ z4DjGzDCi`}rGyJ-ql4?T6lh+Kc96zRy(7!1*o%ItRFf!^1tt9ovS^*2C`iNh%c34* z5%B>1{QhuRlw<+&^xp=!rBqyfmSYLaCL`Ji3kN2Imn!j%FeT zjLec3bRz0s!&5orM=%%8MC0f%6euo7+XthjKmdY@B*Gqk$>o?yQhhXr5-d-GIr`~y zx2*_%KuUcADfJ>k(i~xR>0ARARAaBTu5~BWgW0=uizJ&7@~I1VE-np&|D?bnj$fo) zd@Xt>Br^g1`jFO~c@H|7cNf1qGV{8?a9+CjR|=Z+H5&Knb$ug&L5;@1^d|M5%sUbE zVR1KWnICBoem{Zb(ya~BkFT?A}e)8FEJ0$S$G5KU9rgMZ5`K8Xbp1dj*T|N0N zn)0kxhaM0k~IB7 zK~q6j)dkAMH==0~?Im#a;Z#3op2zn(^H{(fI*(L{5 z6a8lTY4(>VEzO{UZ|AGL1tO`##`(#QGE6TFJHH8UdrLCQ;0rFCTh49$Z&e zh(mlmB&O0iP{JLec)lCDhHERGUbjnp#c=mL%O-wKQL1%iz1~vPYOVDVss?V)H%L+0 zcHM28HnfZ=x?Djm<&+jjZXV2E19J31G=zApabb}}>jq)QB>ZTs*?GeA&@9IaE#0=B;ZE)=UEK}{s-Ilj z?KwthxsE~=>W)FOiwd_%*DiQ2?)<(Ih18&6AQ0`E6B6Ii?RJ#}hHrVH>o;&|vA9jb zK7{m3c2T&c=B%!gv3K`Y5(6On<2Fd1v?7I`Bxlsvo%Br-bajr`{vi z33uMC!!mvAfhF=@R44Qg%FN6iNEtrCCZy3_rAN>~sxTMXing5VvxjQMWz@n()7MIzP3s|y z^L%K2&n7`S$pT-9oSn#+2)v1lsoR+R01~vMN%|Z*oGjdYmnH=^w?Q>{*mE!u$8f#REe<@=D#&5S&U3gosfxS^ zSHzZ?2`wQ0zGVP_1SIx#yGJ+yim|&=rUePM zGx;LSY_v)(ReQX?(NHV3<(gWZ{y-jw(MnS-wQB1t(~=C3ELB>yO?5g(B~^7zWs*33 ztE~&!NbyJMRq1;PGNTuI)7DW4cU-zPZj zIOS-4PZqv-J9Up6$u;{HXhY_kx(d@fcm%Kyw60IS?Vu=q|ag+T3Ln(k=m!0W4cdS&8G^VMC(ubE3?zf7F*3xx&&jit7*?L zMMJfo*@MZWpvu=^zNuCoH=F8uMb%nQ8pq2C3uv|exViQOi)joJ)lv-~W3;ZeRP`%- zj$_51dsJUViF6+BT(bbTVT2IIrA$saOC`k_WsNC8D$8L%p+3T__;Lm zT7t==(8>*%VEO6ihLh~h+p#)oAV**8-9Gv;`8LiSo@{EEQR`Ix#4;wNhOEd};W7nA zt1oK|lw;iqAzZFCH(I2|rl3=#N z<`qYjwvHw(fFP8Mko0t{v`{pOo2*eU$Y*J0^DrscMmrO2H2qOa$Bt-J8WmzO(HZ&9 zu|-4UG`t4DiZlqRVLD>R$|$3>{>RSwndPvFvLSt{i7c;;|0^~R3g!46JOJ!6>$Tv#DPxJ9ttJ#v~7 zOgPI}%Y-mnB{oizK{EccQEV^64B*rnWLV;h{uusHPH0E&OOd=`uHN2USZe1T!miy#4)Sd%xy0H5sBL3N+|Ax)n*$n zg|A}sT(MYWn#CfIs@g0TH&a#P$L&^&H>(7V^7~ zhmM~Ru=M)gVHUVFI7}6`0+&>7U~ZG{y&i>t$9Z;h116--lj!&!JCSR3q0Ct_TZdKb z)~BARk3JZT%drk*u8aYsaIT`iFQD81hsCnOwN%D^HRrzibZz;nu;)Zxbx5lLTpWg+ z{LAl631b1A5M2`@)+NBPYMP@XHe3-K;>fL17G((+l>eAVmw0!yq2u&P$H^Db9PKtm z!ct|azOb(^?(0Q)8J*63+v&52C;El7dQf)Y-gWlqH5BO|slW^UR}s37zlu^qygFx4LbkVXm7-^V~b~yJ)e| zG4!6<+Bhf42rcN1p1EV3D^N+(*ff}=NdK8FA)C{FlV0h+O6b;q*Jdhp`4JHCE8?a} z^||=ktNNkKMmVhHpL=4+AEF%W;O-bpY#7}6_}{yEnM)39)Gp0jFMnS|XAZ&$d_F~M zVS58XX-1Jp=scVdsVyAy!c+2|sogzph15;3P-n-^RPAdAEt5D7W5)baP0lStJ2JXt z39oV+S*t9ZBy(MoB*V`eBwjaHL02x!(eIuFfm*W7B^O`}C=R*+AlrS5j4VHi#LTckW&*Ue4%o-4m7 zpmKwCF9+#R5j*7T3`V(ZpoPeZNsx;A++p*fDxZ*p)+$;S)uh8_nntwt<9St(x6zd& zHnQC3yk<-`F`Zv&%n@=Sm$!uX{yh@<{J&N}+}b3xf)&jGbT zp9A8IZg$k2wU@cb5>Ey3R%muCcr3gsT;+kf!(b>UL9WoKjL@p WsVh1?JUn;C^_=bGm*_pThtR)C1XW7_ literal 0 HcmV?d00001 diff --git a/BackupDr/metadata/V1/Backupvault.php b/BackupDr/metadata/V1/Backupvault.php new file mode 100644 index 0000000000000000000000000000000000000000..23fe823241043284d974fec1af5d3221db551edf GIT binary patch literal 11613 zcmd5?O>7(25%!9bEDmM;tYn#%6Pux(SXN@GW}C#JV<#jOt|nHDs$uJ{QAzAQNw|-UMBT2rwQ|i$>^1iH4Leb;9o9|D zuon`ErH#b;##SP~RM>g}Nu655E*t5@L9KRR8H;7B)~GD*>E*|bdc|Hmx+Q-f=?%+W zV735N{m^jgdf7;<6tnjYSFh-=A(tg~=6+&M$e2#I z33)f++6^PTdLm&PZo{tLVY!LHvHxqg!--|;=I*j-Se2~tNIx=bb~+vGDqwOVX`#Ab zI~`fckgD%{u{O<0Ewe_mdjHFx$Y=$vv2T%l#V$3_{?Q(uf|QT`zV1AJ3fe6bJ;Buv z>;2P~>gC-{H28+onTBom<~>tdYNk^04RaY?c+NK^GOX+HaS7)8_gytE<}R?GFL-{w zaCB?-lH{V-&BcAPM)bw~nsE8qi=jbV8jc*g+0W|Qo-U^^^fmpUY{>bS<$Q)7bm7H{ z)U+J;fXg2jvLB*8<%}z>99&Ona>4~U!LFAV$;}&%7)bsDASOU-hu}}0hCzb9xROxj zqS@ikGLg?RBkJ=It4K6K1B?&wAdV=jXFgICbs2^&eb2C*cq9>-i=}SK6KGe#LTIgp zHKxf|UHeIvn5l0-tZW+y@*2q>AH-#1sacPixBUg*B8e)ps*ngsifHbW4)sSmK%@^~ zUKojXh?sQPIMfWZ3XB*P4MEPRlFwG9@-~CHt8c=XfdLUi z$B{h8Q5Lz!IV!8ewERUFm4{KTHL7lW5@{oX@pCZl81|7_HZ;8~MpaMvhu=+k zfG}i8-vJdxG#m#t=(x7YaWo#srN>gQ_sN*)F@kvHtfSeR5DS^D8iUAVQcd9vu=@1fZ`iyz8g$BS02ER16DL+|IY%+{C) z=L*&wpO5FI?TWEfOpNhg*)bT^LKwz>hrova4k1YPCcKP@PB~&fu#g=EK=#tvvu9yQ zBk#^m!noG#jmf``04!lLxye~+7r?#ep#ZtdSZcnz%?7L%LLiX$5qXfk=^K492w65; zdn+LKiK?9dc^LQ62bMD+w_?y)q>Ttjos_6KhM%IV45Xcb=K|9(qAtT|xmMjb4-lFN zSOpC91lAnWgwFIGP^Cdgc9cBCFY?AtP*9eQNN}SRR)Fay#HpgtM1ravlu`t5OaJL_e7s@ zIOm}cN7?{U&cl?}9%z%F4#GsMrKt~L601_z<0Qd*qroPN9!cD=X-I;@>G65xKt&`zZ?S_T9Cq=$!^0x|H z5=0#}gQd-RNg60VsDLnspK2S%ES4-fqK?6^W9b_HO;#FF<1oQY1UPEUhKiV|ItkH7 zHS|ROM3xlAY-z-?V2@%?kllMRBam3Q1v2*%CVB3o zFz7z18{&}F8oWgPvIdq~W)*RPqC zk<$2Vg@(rAEUOWxa8i=I0ppvZCR(eNA5(b8!Y)dOCrnzD(Nv};|DeEymd*JziOyC= z)DcqX04D2Q%+#;N2k;bPsPxBZ6d04LaW*qSt-{EAwLM{3yc0yc8Nbpq5A_3sHx$M1 z6TVUNDWLAoNxmY8CI6!Uh>ei^>TMY3Rk2z$ErItWcTc<@z`}dBRcjiv;>1b-f6rC| z8wlAi2}26NExZGhUZooF6WxRpf-JM5&E9?YOZk{7)!m> z^L#?t(A#h>Y;g|uO{fuetrrinDS_ApnCa*YPFy`5D@C;+*#_>CcL><2H4{s{(Otq8 zU>8OafV%V#TCGj+_SLA4J#jU`-uLEitL6RlgrgaC@^ z)ccjr9ovQa+;%Elndx*;<=bu;QR zJlCly?IADo3&AN#K($a)73P^l4U**#sBilj2an3q?!{itCi-{G;R=8)3#*D9y85H|F``i%iml~zO-`(0{ zqbjQ#9+-mRebd5gTDb-OcpgS-cEzv}F@n@hL1Y*_GL84+6kNwrC!{Z-ZS5cdi;(;& zs=9s8P91H-K-OM8$og|QwZ*EylQ;lYN0JM-l$V}6;nm?DnH_j54sZKGVJoQ z;g%n5JM=Xq?Ek+Gk{>H@rK|8?!(sj$%fb~SY{;G+ztMDkCw;fS{<~*rq{P!3+TYR8 zw)p}sq*_m^Z~2#VbZ5!H(kWTc-O1qs%#bqWs6a6x%?veCQrt+y|$@!Rf@RBv`k94{A28 zz=NoJr3S&rH>=lL%<3gJtAr{Wu} zS}3DxqF0)8O6&WP0uz1=2#h5BdP5#;&ve<_yFmU^?EMo3rox~fh~YiPI1S#v3NnF~ zX4><_`ZLj_1yf;@y|u ztqwXF$%k;h<;0~EW?)=$K{3VMs%TBlb$3RwapcGIlLs)?{6)PBqv1}r%w|qVnpeVi zwAmS$Zjp&Q4_G6|LKCT@9bP5q?^9PAo0_7%%$Wi{`v|r6=ih}%VR*UV0$aTbS7gnd z+gM*NtaQ9<3Z9ZE_(|~U^Co7t*S53{O9cIconVT$&@9Zf(~IS@zgOTn z^p&o<&&nHAE;!K~-C9w3cw5{aiuZH;Xyu?LdjR-&7+j?G2;l iyR~m#_a8~VB3|c)9`n*guUYQ!ke6qQ=eEai4DeqB=RFhv literal 0 HcmV?d00001 diff --git a/BackupDr/metadata/V1/BackupvaultBa.php b/BackupDr/metadata/V1/BackupvaultBa.php new file mode 100644 index 0000000000000000000000000000000000000000..06aa2a0bd4645dba1cef687094ee9f551bca84db GIT binary patch literal 1358 zcmb7E&2G~`5XK4Ru&4;-LI{<*K&7Svg1p zdgo1$cnpp_1!pAQf%UHK^be`{VtaSyn{Q^mnb&W{i9k>B7*dc_L5#ywtWE$6$rX=y zg2Q||1&Jd*7c2qkVmvy)9}bT2&S?MWv3AXPE+Zg##`!FPUX<`W?u9h^l#5vQ7X9*j zLGwffA$1KhLMfd?CTIkBJn`OxqA^v}9~%(=T>;{IC5V6AA0QMZG|R9(GhiM?Ul7)h z$isw1I8#*V*9OZ1mNLa?!anPSw(*oE8EAy7w$nU~6yqr_91hY5x?9*{7PcFL>jG@! ziq)j3iLQsgpDK_kP5cpLkz_(~Inkzs%s|zZEKa&xW!M6aO>x(9B;*RoZLDMt=c8jR zLFFor~*zO+lW&VP*Qm zIIgqZ)#B*Z{0g?4=-Uc<{$HwSwXL~pMC4W?au@y1dI@CIqkGU(6;&&!Cx04f-HKx< zM8c?Urv25)36P3G)>=oaGb?o6^MJ)|2Rq#rulZ}(+`IMFaasekI%T@CS~x)wpxw|0 zcVBeel2;YotqWzHox*vH9!iM#0_15RX*z>Imr^PV)Vv9hv)3qqcF==MK#;~3=Jw5C zni|HtkM0E*(lsX+^7GbEC%6=AN!sh6_T}4(iTA@nYkDbEmATR}uXSNmjl?F-$5+;{ z>NB7BW_-CVs9^QNh@}Vzl>|iiz0n?<<=~p-;9B(2p?lo_SzY<%;wU%A=+M`z<9Fkc nbtJ@i5>mMma@-H^n4Z4ethM{hPU5-2{pZjcOFLR;=nSF1X05`D literal 0 HcmV?d00001 diff --git a/BackupDr/metadata/V1/BackupvaultGce.php b/BackupDr/metadata/V1/BackupvaultGce.php new file mode 100644 index 0000000000000000000000000000000000000000..6a830e43e0cc9174e3ea1d1be57d0949eca741d2 GIT binary patch literal 11739 zcmcIq&2Jl7avxG(R8gX+mTl3p$7XtF$DY|88rIG_vzp8-*kns;So{b{(Q8MWPK#{G zjHqs=yQvv(Ft-3%Ah`s{e-Px7T!I9-<(5N$T#{Q5Acsv(i~JR-s`t9t{Iq?DFP7Br z)vNbj)vtb4^?v7PgVzK2D1T%-wr2%)H-G*nAH25n1J4cIj@!?l4=*lkFW+&m2fe=S z74rFVEnls*@_N~5{T5F3-J#d95Av6;d)c?2bo%bF`{dl}Tnz_Z@5#+m`SXo6><8v$ z$1bpF0LQwv{eji7^G9{9Vh2{&3aqmumU31iDQB9La@KzO6+owN`F>vfjinuRZ1`iy zie9&+7MniCg+Qe_{1~8%0cyy%;*3pyxVynox5(_Tx|U zLMDy`W z$aE~n>&nyN3s%dx2I9mBBq^_lt<<@ww>in6ZJ035S-bL8*ZSSVnu}!Pf zafeQjOYz!|=Sygc2}Lnp`5M3{RfheZbD3M`^*>%PI~seuLK+;x_T|v_16tok6td9Y za=<$LaK02=JRDqdor~V3@*!ledyd%|49!8`3h<7ub7{W4Ra)j1>|NP!OwYb?JBTE% zgX{5se9ap;Fth)3{(8^tH;rg&k!QBhK91K&_I*4=MoPSUVWhcDUO7cyPhquho!fms zm*HLM^H+I`sTWRIj_w5Bo4wB=9s5;D!xHXKSiiCfD>qhuXtU+7A0)p_Xc^crV{W3Y z!HP-Fp>4sY88>-t8@9}GL)X%`{UAVRb+veoKYahZrbN+E_3S`ZR6I1_Q zf&9e&8)z1;XUBZ~4lGk_5!=+3eqBroPyc0yr+lA)AtgpII&|TFhYYc6I~1HEOECGbmy8wZ{Vx{X{b+WGb;7j8Dhx9} zfSoSdJsU2?TAM8qfhJOhz52s(NL(dj6jIpb4q$~)#z(LqfOTL(Bj|3V#^jE)jPx%p?sR=t21CZJ6dCd#ykgQDtP+2ZQksA zL{G7yKY+bZ7%~J30|X198!Eho{rM*-LvnpIHSUC)q^<_51Ix3n{oD>qTM#NkN3QdD zQgHb=Lo$AqfW3j&yFp%#jN;~*DOeB(LEq2aLcy8+SM$|;8&VdcmBk_ku5rZtn1MrQw2Lj>H0teV=25M7bfTNZQb}(%&C_bLu9u8MLoa7P zKxVpYRFCzB(J~JkwTjt1)v9{yMXm8Xn^4Xk!AE+vsNv+=X-lh}R?B9)5(;Y7q~vT; z`4oO22Wm#yXy~PuQL7eDriU&udmy0I?!%rrH}cM+5)a`+;fr$urFI8yVPu(#aZ?0_ zXv%mbVww_$0BsL)qaZwv`ER2qQKzc;{1MPtF4a%aHls!;lUwlmN&C7EpHcRSX zCt-IEM^g%L-*&9?zHK_l7Loqpwu2#62bksah9ytqoDkzt@Y=Jju5V&^KovZ30xQC= zISKq2l$)O4Bcb$N>Pd`Gj$+3581BfGhxSDem*@14av;tNg*;+y8rl3JC7DA{YNg$V z9o)>M8rogh4TVjtt6sq#2P^4XA=ZchrhE?fq!OJtQSAuIFnLhg1GpcqGi$tBhRrcv zryxg`@}*l&i6oaDAEN$g0=B1fIlQD;HYhT2&g;dY@s^a-YQU2e{#F&$n<#%qP+GXarloR1<-DtN1XNqdT3g?B&?N}lhJFeZalu&$N*{iTj z3Ti1>H92Wie+H?rNPzKZr5D&pbrKv{AI_%(ygJKO|7;zyl1Gh78+Tz%y2#imQXs#N zWMFt6evO@=^hUs%i`DHSq3}gPMoVL6_CJ6AZ~u`>rjp0(ji0~<^Qdqf`QUnd+>$8N zpcjN?E6~#krbL>3>q|C=u^Raz_QYna5&1L zGK(_S$tx~2X)>2ZIKBG?WaHc8LJMVEnf;&6H=`+`#9WKKVUjEimvcHya{p*(4?}pS z5{|q%PRpv0a(W%H6{^N$_TSF>BWo>Gd!5m8oP}XfkQQoMTzsR@iY1*WwWf4Q)nPq4 z1&nETkjj;wo2{31eS))X!aDN0FU(r?+#ZDMWNW2DOL|MpwWbxLrdh0}$xQnXTk0?YIl zq(#}5p*JRsAq{I~{jhj?LdOoU%0r&wxl<5cpr87;E3hG)L*NRQXO`K|C|WKoXvSw1 zCjE;8YzTdmc#M8$e4u&<-|2Bkf~L56LT*5uUe$r-h#Bqwb-T6^$#H(TL@!gPUdpvY{RKH^ons> z5iU=eW4YKUqv>#lK!`~{aIQur;MmD)S;)kHzj-D&-~7Abd~WUf9R+O#p`+95dLn8~F#}9qZ;z;f7$mNC!YX+)W3sdy+%ad)RsSJ@@G2|yqB5h{ za6773V8O_`#N2>;M}qeh=Oe(lph81dJt{&7b(TiVXzu`W^9H=Fg0KEn5|rthi*j}b zyU0QO;Wf5!qLR#rGcQJgXhK-SDU8A%qkyE76UU7?-zt+uB4lAvM>P@T(Bc^6rXwC& zf3;>d^rqgxvIdqG&}4UDt5|(G_QxbeC|TVojeS{S0z7B0n&h$Sf2{*FqaKs;3)sP4 z4^;)QF+g$1p>m)E_Gk02btIxtbB=L(Wi)$)>k4HdLo5$da~hjVNT0lba{!rhGJ{3L zM2xeqvFMCBB_n3Mbx?yX$L-?ni82~h%9fdJFKAiB)T`p$@b(0cL${)i3=746m>*}g z48dqK3RVOtyL27QSj}sc(Pv=I?7!QgU^O6`UZL6IP?$7d6UWA*pt>st3e+XuapM+c zX8)UaI{VPOS|c%{`zDrS{KwWFl`s3I?|1PII_{0_y}|f>ZM(w&TZvTPUr@&!9c6il z-A6nTA)6w`-hU%x#SeI1dew#$HKe(DNxqWVKX|A8#bp<2Qi52YO=qT`eF>>>C^<{5 zt~ZLU+9au1g``0~hI|6wbeQ;aGISE=O`*Q(DQr)fI2!iDTGc$RHCtw-NW8MjHOUwU zMaqe+6)9%Lz)+@h09vaUN2rUQ{mq(MgY79J!FIrddZX4hn&|&V^~kK$%KFJfm_+It z#j%8vg5_qt*22h$O}@G2p!^Wd9z~VYP$^sltCxf|6HDNk;JP|%O$)SYbvzv^JPxY|2#@PhRk@8TtNXgf@gm!Jfn5`9ke479Yz6`#KYA+j0YJ1 z6eV6n5PVGiiw)!g@kb1ZN!z2BJ+fNLE2b9_@VE?YdW0{7MhzFN)Sx5d^8kD$!tWfI z8H)12sKJY5_p0Y~87U=WWH#G|TU@FnQjKM4yl;FxV0R@{F6bJL>4k+d&Wp8VE+NVg zN3cwoE3xo>NS0vTl-3KMFI zWup3Sb7NF~=7bun$k@lR9pBDvM7OQ9xgQ*V^&*n(1)c7xqlwaPu`f=yvAH99!>(`2 zPQH9Uv7otgL=Q=7zHH#LG*obhZ*aT?kQ2Sk1qVN~7AO?t#wa#US#DUWrlzJmWo~@F zfV6MjU{w$uJ+QHxNkQQ!^Mk_FsWfSJlO}7cSnm3Dap{=5r4L{|GRYkEGuNZ<+@3_! z;uMgYlbJ=0?Wq+<)Q@_UdoLk7=}?&8h{f57CQGt=u<6+YG!o0C&cYZfYygO&Kh0D% zNQFLu$aTAHG-nn`FfVSFFrJi-F}h%R0s~#sXksj)a8MUA$R8pZ6iz0f9;Y?*V%dCw z?J){c7_<0yF1#cuI-b-@&#{lTq`u;k_Elt#*u~sq)wr&5Sj3*(c>JT#QED0}6@RL> zD>`=3DBQNoMx~Nnq6&(^1D4eyWN62uOQnhq3vU+NdfCK?hpoPG@u(_hcf^-by#$A$ zDTI`Lu?X2X-6JT|cHy=-@d@nW5d=Qml@j2=pv`E(UkM&qa10MP`D4T5Y7RYD6TLd> zN1L?*~(hurCEn{F@E<{KP3x7t9)Tp%e5Cxyl%{3_#>w8vhRxb zj(o!QN|jnKJ#RUZVB18uFQyQGIPyd~2JfVx1bb*)`0J?`cIGTG3nB zfju#*r$3KNOJO{_+dRcI3A?#yBBvES{&^ik_D)l8fvzh4LK6?qf_$Fr713Be0_~f}x8D6_q;;b(uWHSz( zoCqr;!kr{1`{x8bth%0yo7#?e5E{N3M#>qu^~9?$#Y7TyC7setStartHourOfDay($backupPlanBackupRulesStandardScheduleBackupWindowStartHourOfDay) + ->setEndHourOfDay($backupPlanBackupRulesStandardScheduleBackupWindowEndHourOfDay); + $backupPlanBackupRulesStandardSchedule = (new StandardSchedule()) + ->setRecurrenceType($backupPlanBackupRulesStandardScheduleRecurrenceType) + ->setBackupWindow($backupPlanBackupRulesStandardScheduleBackupWindow) + ->setTimeZone($backupPlanBackupRulesStandardScheduleTimeZone); + $backupRule = (new BackupRule()) + ->setRuleId($backupPlanBackupRulesRuleId) + ->setBackupRetentionDays($backupPlanBackupRulesBackupRetentionDays) + ->setStandardSchedule($backupPlanBackupRulesStandardSchedule); + $backupPlanBackupRules = [$backupRule,]; + $backupPlan = (new BackupPlan()) + ->setBackupRules($backupPlanBackupRules) + ->setResourceType($backupPlanResourceType) + ->setBackupVault($formattedBackupPlanBackupVault); + $request = (new CreateBackupPlanRequest()) + ->setParent($formattedParent) + ->setBackupPlanId($backupPlanId) + ->setBackupPlan($backupPlan); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->createBackupPlan($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var BackupPlan $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 +{ + $formattedParent = BackupDRClient::locationName('[PROJECT]', '[LOCATION]'); + $backupPlanId = '[BACKUP_PLAN_ID]'; + $backupPlanBackupRulesRuleId = '[RULE_ID]'; + $backupPlanBackupRulesBackupRetentionDays = 0; + $backupPlanBackupRulesStandardScheduleRecurrenceType = RecurrenceType::RECURRENCE_TYPE_UNSPECIFIED; + $backupPlanBackupRulesStandardScheduleBackupWindowStartHourOfDay = 0; + $backupPlanBackupRulesStandardScheduleBackupWindowEndHourOfDay = 0; + $backupPlanBackupRulesStandardScheduleTimeZone = '[TIME_ZONE]'; + $backupPlanResourceType = '[RESOURCE_TYPE]'; + $formattedBackupPlanBackupVault = BackupDRClient::backupVaultName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]' + ); + + create_backup_plan_sample( + $formattedParent, + $backupPlanId, + $backupPlanBackupRulesRuleId, + $backupPlanBackupRulesBackupRetentionDays, + $backupPlanBackupRulesStandardScheduleRecurrenceType, + $backupPlanBackupRulesStandardScheduleBackupWindowStartHourOfDay, + $backupPlanBackupRulesStandardScheduleBackupWindowEndHourOfDay, + $backupPlanBackupRulesStandardScheduleTimeZone, + $backupPlanResourceType, + $formattedBackupPlanBackupVault + ); +} +// [END backupdr_v1_generated_BackupDR_CreateBackupPlan_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/create_backup_plan_association.php b/BackupDr/samples/V1/BackupDRClient/create_backup_plan_association.php new file mode 100644 index 000000000000..16cba9b49c8c --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/create_backup_plan_association.php @@ -0,0 +1,114 @@ +setResource($backupPlanAssociationResource) + ->setBackupPlan($formattedBackupPlanAssociationBackupPlan); + $request = (new CreateBackupPlanAssociationRequest()) + ->setParent($formattedParent) + ->setBackupPlanAssociationId($backupPlanAssociationId) + ->setBackupPlanAssociation($backupPlanAssociation); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->createBackupPlanAssociation($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var BackupPlanAssociation $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 +{ + $formattedParent = BackupDRClient::locationName('[PROJECT]', '[LOCATION]'); + $backupPlanAssociationId = '[BACKUP_PLAN_ASSOCIATION_ID]'; + $backupPlanAssociationResource = '[RESOURCE]'; + $formattedBackupPlanAssociationBackupPlan = BackupDRClient::backupPlanName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN]' + ); + + create_backup_plan_association_sample( + $formattedParent, + $backupPlanAssociationId, + $backupPlanAssociationResource, + $formattedBackupPlanAssociationBackupPlan + ); +} +// [END backupdr_v1_generated_BackupDR_CreateBackupPlanAssociation_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/create_backup_vault.php b/BackupDr/samples/V1/BackupDRClient/create_backup_vault.php new file mode 100644 index 000000000000..0eb8a39cdfc9 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/create_backup_vault.php @@ -0,0 +1,93 @@ +setBackupMinimumEnforcedRetentionDuration($backupVaultBackupMinimumEnforcedRetentionDuration); + $request = (new CreateBackupVaultRequest()) + ->setParent($formattedParent) + ->setBackupVaultId($backupVaultId) + ->setBackupVault($backupVault); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->createBackupVault($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var BackupVault $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 +{ + $formattedParent = BackupDRClient::locationName('[PROJECT]', '[LOCATION]'); + $backupVaultId = '[BACKUP_VAULT_ID]'; + + create_backup_vault_sample($formattedParent, $backupVaultId); +} +// [END backupdr_v1_generated_BackupDR_CreateBackupVault_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/create_management_server.php b/BackupDr/samples/V1/BackupDRClient/create_management_server.php index 363df2a44dd8..c453145930c7 100644 --- a/BackupDr/samples/V1/BackupDRClient/create_management_server.php +++ b/BackupDr/samples/V1/BackupDRClient/create_management_server.php @@ -35,8 +35,8 @@ * Creates a new ManagementServer in a given project and location. * * @param string $formattedParent The management server project and location in the format - * `projects/{project_id}/locations/{location}`. In Cloud Backup and DR - * locations map to GCP regions, for example **us-central1**. Please see + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR + * locations map to Google Cloud regions, for example **us-central1**. Please see * {@see BackupDRClient::locationName()} for help formatting this field. * @param string $managementServerId The name of the management server to create. The name must be * unique for the specified project and location. diff --git a/BackupDr/samples/V1/BackupDRClient/delete_backup.php b/BackupDr/samples/V1/BackupDRClient/delete_backup.php new file mode 100644 index 000000000000..e57d2bbfa7fe --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/delete_backup.php @@ -0,0 +1,89 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->deleteBackup($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Backup $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 +{ + $formattedName = BackupDRClient::backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + + delete_backup_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_DeleteBackup_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/delete_backup_plan.php b/BackupDr/samples/V1/BackupDRClient/delete_backup_plan.php new file mode 100644 index 000000000000..ceefc320aa66 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/delete_backup_plan.php @@ -0,0 +1,82 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->deleteBackupPlan($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } 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 +{ + $formattedName = BackupDRClient::backupPlanName('[PROJECT]', '[LOCATION]', '[BACKUP_PLAN]'); + + delete_backup_plan_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_DeleteBackupPlan_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/delete_backup_plan_association.php b/BackupDr/samples/V1/BackupDRClient/delete_backup_plan_association.php new file mode 100644 index 000000000000..8ebdabee84f5 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/delete_backup_plan_association.php @@ -0,0 +1,85 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->deleteBackupPlanAssociation($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } 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 +{ + $formattedName = BackupDRClient::backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + + delete_backup_plan_association_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_DeleteBackupPlanAssociation_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/delete_backup_vault.php b/BackupDr/samples/V1/BackupDRClient/delete_backup_vault.php new file mode 100644 index 000000000000..d1035e0287a1 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/delete_backup_vault.php @@ -0,0 +1,80 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->deleteBackupVault($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } 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 +{ + $formattedName = BackupDRClient::backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + + delete_backup_vault_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_DeleteBackupVault_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/fetch_usable_backup_vaults.php b/BackupDr/samples/V1/BackupDRClient/fetch_usable_backup_vaults.php new file mode 100644 index 000000000000..ca3baa61001d --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/fetch_usable_backup_vaults.php @@ -0,0 +1,83 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $backupDRClient->fetchUsableBackupVaults($request); + + /** @var BackupVault $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = BackupDRClient::locationName('[PROJECT]', '[LOCATION]'); + + fetch_usable_backup_vaults_sample($formattedParent); +} +// [END backupdr_v1_generated_BackupDR_FetchUsableBackupVaults_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/get_backup.php b/BackupDr/samples/V1/BackupDRClient/get_backup.php new file mode 100644 index 000000000000..d022b8e9926a --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/get_backup.php @@ -0,0 +1,78 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Backup $response */ + $response = $backupDRClient->getBackup($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = BackupDRClient::backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + + get_backup_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_GetBackup_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/get_backup_plan.php b/BackupDr/samples/V1/BackupDRClient/get_backup_plan.php new file mode 100644 index 000000000000..bafab40279bf --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/get_backup_plan.php @@ -0,0 +1,73 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var BackupPlan $response */ + $response = $backupDRClient->getBackupPlan($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = BackupDRClient::backupPlanName('[PROJECT]', '[LOCATION]', '[BACKUP_PLAN]'); + + get_backup_plan_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_GetBackupPlan_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/get_backup_plan_association.php b/BackupDr/samples/V1/BackupDRClient/get_backup_plan_association.php new file mode 100644 index 000000000000..9eec0a558560 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/get_backup_plan_association.php @@ -0,0 +1,76 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var BackupPlanAssociation $response */ + $response = $backupDRClient->getBackupPlanAssociation($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = BackupDRClient::backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + + get_backup_plan_association_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_GetBackupPlanAssociation_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/get_backup_vault.php b/BackupDr/samples/V1/BackupDRClient/get_backup_vault.php new file mode 100644 index 000000000000..7eda9342994a --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/get_backup_vault.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var BackupVault $response */ + $response = $backupDRClient->getBackupVault($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = BackupDRClient::backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + + get_backup_vault_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_GetBackupVault_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/get_data_source.php b/BackupDr/samples/V1/BackupDRClient/get_data_source.php new file mode 100644 index 000000000000..53f3211d7c1a --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/get_data_source.php @@ -0,0 +1,77 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var DataSource $response */ + $response = $backupDRClient->getDataSource($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = BackupDRClient::dataSourceName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]' + ); + + get_data_source_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_GetDataSource_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/get_management_server.php b/BackupDr/samples/V1/BackupDRClient/get_management_server.php index c6ad450d29fa..f7fa6231f8c0 100644 --- a/BackupDr/samples/V1/BackupDRClient/get_management_server.php +++ b/BackupDr/samples/V1/BackupDRClient/get_management_server.php @@ -32,7 +32,7 @@ * Gets details of a single ManagementServer. * * @param string $formattedName Name of the management server resource name, in the format - * `projects/{project_id}/locations/{location}/managementServers/{resource_name}` + * 'projects/{project_id}/locations/{location}/managementServers/{resource_name}' * Please see {@see BackupDRClient::managementServerName()} for help formatting this field. */ function get_management_server_sample(string $formattedName): void diff --git a/BackupDr/samples/V1/BackupDRClient/list_backup_plan_associations.php b/BackupDr/samples/V1/BackupDRClient/list_backup_plan_associations.php new file mode 100644 index 000000000000..8f286295c44b --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/list_backup_plan_associations.php @@ -0,0 +1,81 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $backupDRClient->listBackupPlanAssociations($request); + + /** @var BackupPlanAssociation $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = BackupDRClient::locationName('[PROJECT]', '[LOCATION]'); + + list_backup_plan_associations_sample($formattedParent); +} +// [END backupdr_v1_generated_BackupDR_ListBackupPlanAssociations_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/list_backup_plans.php b/BackupDr/samples/V1/BackupDRClient/list_backup_plans.php new file mode 100644 index 000000000000..7e5f8ceee6a8 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/list_backup_plans.php @@ -0,0 +1,80 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $backupDRClient->listBackupPlans($request); + + /** @var BackupPlan $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = BackupDRClient::locationName('[PROJECT]', '[LOCATION]'); + + list_backup_plans_sample($formattedParent); +} +// [END backupdr_v1_generated_BackupDR_ListBackupPlans_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/list_backup_vaults.php b/BackupDr/samples/V1/BackupDRClient/list_backup_vaults.php new file mode 100644 index 000000000000..3ebc85f7ddef --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/list_backup_vaults.php @@ -0,0 +1,81 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $backupDRClient->listBackupVaults($request); + + /** @var BackupVault $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = BackupDRClient::locationName('[PROJECT]', '[LOCATION]'); + + list_backup_vaults_sample($formattedParent); +} +// [END backupdr_v1_generated_BackupDR_ListBackupVaults_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/list_backups.php b/BackupDr/samples/V1/BackupDRClient/list_backups.php new file mode 100644 index 000000000000..def0a0a36513 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/list_backups.php @@ -0,0 +1,86 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $backupDRClient->listBackups($request); + + /** @var Backup $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = BackupDRClient::dataSourceName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]' + ); + + list_backups_sample($formattedParent); +} +// [END backupdr_v1_generated_BackupDR_ListBackups_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/list_data_sources.php b/BackupDr/samples/V1/BackupDRClient/list_data_sources.php new file mode 100644 index 000000000000..833e650fed27 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/list_data_sources.php @@ -0,0 +1,81 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $backupDRClient->listDataSources($request); + + /** @var DataSource $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = BackupDRClient::backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + + list_data_sources_sample($formattedParent); +} +// [END backupdr_v1_generated_BackupDR_ListDataSources_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/list_management_servers.php b/BackupDr/samples/V1/BackupDRClient/list_management_servers.php index 5d3871049b33..c1a2219808e9 100644 --- a/BackupDr/samples/V1/BackupDRClient/list_management_servers.php +++ b/BackupDr/samples/V1/BackupDRClient/list_management_servers.php @@ -33,10 +33,11 @@ * Lists ManagementServers in a given project and location. * * @param string $formattedParent The project and location for which to retrieve management servers - * information, in the format `projects/{project_id}/locations/{location}`. In - * Cloud BackupDR, locations map to GCP regions, for example **us-central1**. - * To retrieve management servers for all locations, use "-" for the - * `{location}` value. Please see + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud BackupDR, locations map to Google Cloud regions, for example + * **us-central1**. To retrieve management servers for all locations, use "-" + * for the + * '{location}' value. Please see * {@see BackupDRClient::locationName()} for help formatting this field. */ function list_management_servers_sample(string $formattedParent): void diff --git a/BackupDr/samples/V1/BackupDRClient/restore_backup.php b/BackupDr/samples/V1/BackupDRClient/restore_backup.php new file mode 100644 index 000000000000..6a6199b2a611 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/restore_backup.php @@ -0,0 +1,90 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->restoreBackup($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var RestoreBackupResponse $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 +{ + $formattedName = BackupDRClient::backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + + restore_backup_sample($formattedName); +} +// [END backupdr_v1_generated_BackupDR_RestoreBackup_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/trigger_backup.php b/BackupDr/samples/V1/BackupDRClient/trigger_backup.php new file mode 100644 index 000000000000..e5d82046cf0e --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/trigger_backup.php @@ -0,0 +1,91 @@ +setName($formattedName) + ->setRuleId($ruleId); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->triggerBackup($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var BackupPlanAssociation $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 +{ + $formattedName = BackupDRClient::backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + $ruleId = '[RULE_ID]'; + + trigger_backup_sample($formattedName, $ruleId); +} +// [END backupdr_v1_generated_BackupDR_TriggerBackup_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/update_backup.php b/BackupDr/samples/V1/BackupDRClient/update_backup.php new file mode 100644 index 000000000000..0986bd437465 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/update_backup.php @@ -0,0 +1,74 @@ +setUpdateMask($updateMask) + ->setBackup($backup); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->updateBackup($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Backup $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()); + } +} +// [END backupdr_v1_generated_BackupDR_UpdateBackup_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/update_backup_vault.php b/BackupDr/samples/V1/BackupDRClient/update_backup_vault.php new file mode 100644 index 000000000000..6cc6d590003a --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/update_backup_vault.php @@ -0,0 +1,77 @@ +setBackupMinimumEnforcedRetentionDuration($backupVaultBackupMinimumEnforcedRetentionDuration); + $request = (new UpdateBackupVaultRequest()) + ->setUpdateMask($updateMask) + ->setBackupVault($backupVault); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->updateBackupVault($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var BackupVault $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()); + } +} +// [END backupdr_v1_generated_BackupDR_UpdateBackupVault_sync] diff --git a/BackupDr/samples/V1/BackupDRClient/update_data_source.php b/BackupDr/samples/V1/BackupDRClient/update_data_source.php new file mode 100644 index 000000000000..e62566e4e330 --- /dev/null +++ b/BackupDr/samples/V1/BackupDRClient/update_data_source.php @@ -0,0 +1,74 @@ +setUpdateMask($updateMask) + ->setDataSource($dataSource); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $backupDRClient->updateDataSource($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var DataSource $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()); + } +} +// [END backupdr_v1_generated_BackupDR_UpdateDataSource_sync] diff --git a/BackupDr/src/V1/AcceleratorConfig.php b/BackupDr/src/V1/AcceleratorConfig.php new file mode 100644 index 000000000000..5a0f3dce0b04 --- /dev/null +++ b/BackupDr/src/V1/AcceleratorConfig.php @@ -0,0 +1,130 @@ +google.cloud.backupdr.v1.AcceleratorConfig + */ +class AcceleratorConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Full or partial URL of the accelerator type resource to attach to + * this instance. + * + * Generated from protobuf field optional string accelerator_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $accelerator_type = null; + /** + * Optional. The number of the guest accelerator cards exposed to this + * instance. + * + * Generated from protobuf field optional int32 accelerator_count = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $accelerator_count = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $accelerator_type + * Optional. Full or partial URL of the accelerator type resource to attach to + * this instance. + * @type int $accelerator_count + * Optional. The number of the guest accelerator cards exposed to this + * instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Full or partial URL of the accelerator type resource to attach to + * this instance. + * + * Generated from protobuf field optional string accelerator_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getAcceleratorType() + { + return isset($this->accelerator_type) ? $this->accelerator_type : ''; + } + + public function hasAcceleratorType() + { + return isset($this->accelerator_type); + } + + public function clearAcceleratorType() + { + unset($this->accelerator_type); + } + + /** + * Optional. Full or partial URL of the accelerator type resource to attach to + * this instance. + * + * Generated from protobuf field optional string accelerator_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setAcceleratorType($var) + { + GPBUtil::checkString($var, True); + $this->accelerator_type = $var; + + return $this; + } + + /** + * Optional. The number of the guest accelerator cards exposed to this + * instance. + * + * Generated from protobuf field optional int32 accelerator_count = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getAcceleratorCount() + { + return isset($this->accelerator_count) ? $this->accelerator_count : 0; + } + + public function hasAcceleratorCount() + { + return isset($this->accelerator_count); + } + + public function clearAcceleratorCount() + { + unset($this->accelerator_count); + } + + /** + * Optional. The number of the guest accelerator cards exposed to this + * instance. + * + * Generated from protobuf field optional int32 accelerator_count = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setAcceleratorCount($var) + { + GPBUtil::checkInt32($var); + $this->accelerator_count = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/AccessConfig.php b/BackupDr/src/V1/AccessConfig.php new file mode 100644 index 000000000000..325e5e49dd31 --- /dev/null +++ b/BackupDr/src/V1/AccessConfig.php @@ -0,0 +1,406 @@ +google.cloud.backupdr.v1.AccessConfig + */ +class AccessConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. In accessConfigs (IPv4), the + * default and only option is ONE_TO_ONE_NAT. In + * ipv6AccessConfigs, the default and only option is + * DIRECT_IPV6. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AccessConfig.AccessType type = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $type = null; + /** + * Optional. The name of this access configuration. + * + * Generated from protobuf field optional string name = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $name = null; + /** + * Optional. The external IP address of this access configuration. + * + * Generated from protobuf field optional string external_ip = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $external_ip = null; + /** + * Optional. The external IPv6 address of this access configuration. + * + * Generated from protobuf field optional string external_ipv6 = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $external_ipv6 = null; + /** + * Optional. The prefix length of the external IPv6 range. + * + * Generated from protobuf field optional int32 external_ipv6_prefix_length = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $external_ipv6_prefix_length = null; + /** + * Optional. Specifies whether a public DNS 'PTR' record should be created to + * map the external IP address of the instance to a DNS domain name. + * + * Generated from protobuf field optional bool set_public_ptr = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $set_public_ptr = null; + /** + * Optional. The DNS domain name for the public PTR record. + * + * Generated from protobuf field optional string public_ptr_domain_name = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $public_ptr_domain_name = null; + /** + * Optional. This signifies the networking tier used for configuring this + * access + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AccessConfig.NetworkTier network_tier = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $network_tier = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $type + * Optional. In accessConfigs (IPv4), the + * default and only option is ONE_TO_ONE_NAT. In + * ipv6AccessConfigs, the default and only option is + * DIRECT_IPV6. + * @type string $name + * Optional. The name of this access configuration. + * @type string $external_ip + * Optional. The external IP address of this access configuration. + * @type string $external_ipv6 + * Optional. The external IPv6 address of this access configuration. + * @type int $external_ipv6_prefix_length + * Optional. The prefix length of the external IPv6 range. + * @type bool $set_public_ptr + * Optional. Specifies whether a public DNS 'PTR' record should be created to + * map the external IP address of the instance to a DNS domain name. + * @type string $public_ptr_domain_name + * Optional. The DNS domain name for the public PTR record. + * @type int $network_tier + * Optional. This signifies the networking tier used for configuring this + * access + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. In accessConfigs (IPv4), the + * default and only option is ONE_TO_ONE_NAT. In + * ipv6AccessConfigs, the default and only option is + * DIRECT_IPV6. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AccessConfig.AccessType type = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getType() + { + return isset($this->type) ? $this->type : 0; + } + + public function hasType() + { + return isset($this->type); + } + + public function clearType() + { + unset($this->type); + } + + /** + * Optional. In accessConfigs (IPv4), the + * default and only option is ONE_TO_ONE_NAT. In + * ipv6AccessConfigs, the default and only option is + * DIRECT_IPV6. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AccessConfig.AccessType type = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\AccessConfig\AccessType::class); + $this->type = $var; + + return $this; + } + + /** + * Optional. The name of this access configuration. + * + * Generated from protobuf field optional string name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getName() + { + return isset($this->name) ? $this->name : ''; + } + + public function hasName() + { + return isset($this->name); + } + + public function clearName() + { + unset($this->name); + } + + /** + * Optional. The name of this access configuration. + * + * Generated from protobuf field optional string name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. The external IP address of this access configuration. + * + * Generated from protobuf field optional string external_ip = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getExternalIp() + { + return isset($this->external_ip) ? $this->external_ip : ''; + } + + public function hasExternalIp() + { + return isset($this->external_ip); + } + + public function clearExternalIp() + { + unset($this->external_ip); + } + + /** + * Optional. The external IP address of this access configuration. + * + * Generated from protobuf field optional string external_ip = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setExternalIp($var) + { + GPBUtil::checkString($var, True); + $this->external_ip = $var; + + return $this; + } + + /** + * Optional. The external IPv6 address of this access configuration. + * + * Generated from protobuf field optional string external_ipv6 = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getExternalIpv6() + { + return isset($this->external_ipv6) ? $this->external_ipv6 : ''; + } + + public function hasExternalIpv6() + { + return isset($this->external_ipv6); + } + + public function clearExternalIpv6() + { + unset($this->external_ipv6); + } + + /** + * Optional. The external IPv6 address of this access configuration. + * + * Generated from protobuf field optional string external_ipv6 = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setExternalIpv6($var) + { + GPBUtil::checkString($var, True); + $this->external_ipv6 = $var; + + return $this; + } + + /** + * Optional. The prefix length of the external IPv6 range. + * + * Generated from protobuf field optional int32 external_ipv6_prefix_length = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getExternalIpv6PrefixLength() + { + return isset($this->external_ipv6_prefix_length) ? $this->external_ipv6_prefix_length : 0; + } + + public function hasExternalIpv6PrefixLength() + { + return isset($this->external_ipv6_prefix_length); + } + + public function clearExternalIpv6PrefixLength() + { + unset($this->external_ipv6_prefix_length); + } + + /** + * Optional. The prefix length of the external IPv6 range. + * + * Generated from protobuf field optional int32 external_ipv6_prefix_length = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setExternalIpv6PrefixLength($var) + { + GPBUtil::checkInt32($var); + $this->external_ipv6_prefix_length = $var; + + return $this; + } + + /** + * Optional. Specifies whether a public DNS 'PTR' record should be created to + * map the external IP address of the instance to a DNS domain name. + * + * Generated from protobuf field optional bool set_public_ptr = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getSetPublicPtr() + { + return isset($this->set_public_ptr) ? $this->set_public_ptr : false; + } + + public function hasSetPublicPtr() + { + return isset($this->set_public_ptr); + } + + public function clearSetPublicPtr() + { + unset($this->set_public_ptr); + } + + /** + * Optional. Specifies whether a public DNS 'PTR' record should be created to + * map the external IP address of the instance to a DNS domain name. + * + * Generated from protobuf field optional bool set_public_ptr = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setSetPublicPtr($var) + { + GPBUtil::checkBool($var); + $this->set_public_ptr = $var; + + return $this; + } + + /** + * Optional. The DNS domain name for the public PTR record. + * + * Generated from protobuf field optional string public_ptr_domain_name = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPublicPtrDomainName() + { + return isset($this->public_ptr_domain_name) ? $this->public_ptr_domain_name : ''; + } + + public function hasPublicPtrDomainName() + { + return isset($this->public_ptr_domain_name); + } + + public function clearPublicPtrDomainName() + { + unset($this->public_ptr_domain_name); + } + + /** + * Optional. The DNS domain name for the public PTR record. + * + * Generated from protobuf field optional string public_ptr_domain_name = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPublicPtrDomainName($var) + { + GPBUtil::checkString($var, True); + $this->public_ptr_domain_name = $var; + + return $this; + } + + /** + * Optional. This signifies the networking tier used for configuring this + * access + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AccessConfig.NetworkTier network_tier = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getNetworkTier() + { + return isset($this->network_tier) ? $this->network_tier : 0; + } + + public function hasNetworkTier() + { + return isset($this->network_tier); + } + + public function clearNetworkTier() + { + unset($this->network_tier); + } + + /** + * Optional. This signifies the networking tier used for configuring this + * access + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AccessConfig.NetworkTier network_tier = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setNetworkTier($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\AccessConfig\NetworkTier::class); + $this->network_tier = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/AccessConfig/AccessType.php b/BackupDr/src/V1/AccessConfig/AccessType.php new file mode 100644 index 000000000000..b8aba7880571 --- /dev/null +++ b/BackupDr/src/V1/AccessConfig/AccessType.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.AccessConfig.AccessType + */ +class AccessType +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum ACCESS_TYPE_UNSPECIFIED = 0; + */ + const ACCESS_TYPE_UNSPECIFIED = 0; + /** + * ONE_TO_ONE_NAT + * + * Generated from protobuf enum ONE_TO_ONE_NAT = 1; + */ + const ONE_TO_ONE_NAT = 1; + /** + * Direct IPv6 access. + * + * Generated from protobuf enum DIRECT_IPV6 = 2; + */ + const DIRECT_IPV6 = 2; + + private static $valueToName = [ + self::ACCESS_TYPE_UNSPECIFIED => 'ACCESS_TYPE_UNSPECIFIED', + self::ONE_TO_ONE_NAT => 'ONE_TO_ONE_NAT', + self::DIRECT_IPV6 => 'DIRECT_IPV6', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/AccessConfig/NetworkTier.php b/BackupDr/src/V1/AccessConfig/NetworkTier.php new file mode 100644 index 000000000000..f99138563a34 --- /dev/null +++ b/BackupDr/src/V1/AccessConfig/NetworkTier.php @@ -0,0 +1,64 @@ +google.cloud.backupdr.v1.AccessConfig.NetworkTier + */ +class NetworkTier +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum NETWORK_TIER_UNSPECIFIED = 0; + */ + const NETWORK_TIER_UNSPECIFIED = 0; + /** + * High quality, Google-grade network tier, support for all networking + * products. + * + * Generated from protobuf enum PREMIUM = 1; + */ + const PREMIUM = 1; + /** + * Public internet quality, only limited support for other networking + * products. + * + * Generated from protobuf enum STANDARD = 2; + */ + const STANDARD = 2; + + private static $valueToName = [ + self::NETWORK_TIER_UNSPECIFIED => 'NETWORK_TIER_UNSPECIFIED', + self::PREMIUM => 'PREMIUM', + self::STANDARD => 'STANDARD', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/AdvancedMachineFeatures.php b/BackupDr/src/V1/AdvancedMachineFeatures.php new file mode 100644 index 000000000000..29901b19bd41 --- /dev/null +++ b/BackupDr/src/V1/AdvancedMachineFeatures.php @@ -0,0 +1,241 @@ +google.cloud.backupdr.v1.AdvancedMachineFeatures + */ +class AdvancedMachineFeatures extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Whether to enable nested virtualization or not (default is + * false). + * + * Generated from protobuf field optional bool enable_nested_virtualization = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_nested_virtualization = null; + /** + * Optional. The number of threads per physical core. To disable simultaneous + * multithreading (SMT) set this to 1. If unset, the maximum number + * of threads supported per core by the underlying processor is + * assumed. + * + * Generated from protobuf field optional int32 threads_per_core = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $threads_per_core = null; + /** + * Optional. The number of physical cores to expose to an instance. Multiply + * by the number of threads per core to compute the total number of virtual + * CPUs to expose to the instance. If unset, the number of cores is + * inferred from the instance's nominal CPU count and the underlying + * platform's SMT width. + * + * Generated from protobuf field optional int32 visible_core_count = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $visible_core_count = null; + /** + * Optional. Whether to enable UEFI networking for instance creation. + * + * Generated from protobuf field optional bool enable_uefi_networking = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_uefi_networking = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enable_nested_virtualization + * Optional. Whether to enable nested virtualization or not (default is + * false). + * @type int $threads_per_core + * Optional. The number of threads per physical core. To disable simultaneous + * multithreading (SMT) set this to 1. If unset, the maximum number + * of threads supported per core by the underlying processor is + * assumed. + * @type int $visible_core_count + * Optional. The number of physical cores to expose to an instance. Multiply + * by the number of threads per core to compute the total number of virtual + * CPUs to expose to the instance. If unset, the number of cores is + * inferred from the instance's nominal CPU count and the underlying + * platform's SMT width. + * @type bool $enable_uefi_networking + * Optional. Whether to enable UEFI networking for instance creation. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Whether to enable nested virtualization or not (default is + * false). + * + * Generated from protobuf field optional bool enable_nested_virtualization = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnableNestedVirtualization() + { + return isset($this->enable_nested_virtualization) ? $this->enable_nested_virtualization : false; + } + + public function hasEnableNestedVirtualization() + { + return isset($this->enable_nested_virtualization); + } + + public function clearEnableNestedVirtualization() + { + unset($this->enable_nested_virtualization); + } + + /** + * Optional. Whether to enable nested virtualization or not (default is + * false). + * + * Generated from protobuf field optional bool enable_nested_virtualization = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnableNestedVirtualization($var) + { + GPBUtil::checkBool($var); + $this->enable_nested_virtualization = $var; + + return $this; + } + + /** + * Optional. The number of threads per physical core. To disable simultaneous + * multithreading (SMT) set this to 1. If unset, the maximum number + * of threads supported per core by the underlying processor is + * assumed. + * + * Generated from protobuf field optional int32 threads_per_core = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getThreadsPerCore() + { + return isset($this->threads_per_core) ? $this->threads_per_core : 0; + } + + public function hasThreadsPerCore() + { + return isset($this->threads_per_core); + } + + public function clearThreadsPerCore() + { + unset($this->threads_per_core); + } + + /** + * Optional. The number of threads per physical core. To disable simultaneous + * multithreading (SMT) set this to 1. If unset, the maximum number + * of threads supported per core by the underlying processor is + * assumed. + * + * Generated from protobuf field optional int32 threads_per_core = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setThreadsPerCore($var) + { + GPBUtil::checkInt32($var); + $this->threads_per_core = $var; + + return $this; + } + + /** + * Optional. The number of physical cores to expose to an instance. Multiply + * by the number of threads per core to compute the total number of virtual + * CPUs to expose to the instance. If unset, the number of cores is + * inferred from the instance's nominal CPU count and the underlying + * platform's SMT width. + * + * Generated from protobuf field optional int32 visible_core_count = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getVisibleCoreCount() + { + return isset($this->visible_core_count) ? $this->visible_core_count : 0; + } + + public function hasVisibleCoreCount() + { + return isset($this->visible_core_count); + } + + public function clearVisibleCoreCount() + { + unset($this->visible_core_count); + } + + /** + * Optional. The number of physical cores to expose to an instance. Multiply + * by the number of threads per core to compute the total number of virtual + * CPUs to expose to the instance. If unset, the number of cores is + * inferred from the instance's nominal CPU count and the underlying + * platform's SMT width. + * + * Generated from protobuf field optional int32 visible_core_count = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setVisibleCoreCount($var) + { + GPBUtil::checkInt32($var); + $this->visible_core_count = $var; + + return $this; + } + + /** + * Optional. Whether to enable UEFI networking for instance creation. + * + * Generated from protobuf field optional bool enable_uefi_networking = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnableUefiNetworking() + { + return isset($this->enable_uefi_networking) ? $this->enable_uefi_networking : false; + } + + public function hasEnableUefiNetworking() + { + return isset($this->enable_uefi_networking); + } + + public function clearEnableUefiNetworking() + { + unset($this->enable_uefi_networking); + } + + /** + * Optional. Whether to enable UEFI networking for instance creation. + * + * Generated from protobuf field optional bool enable_uefi_networking = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnableUefiNetworking($var) + { + GPBUtil::checkBool($var); + $this->enable_uefi_networking = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/AliasIpRange.php b/BackupDr/src/V1/AliasIpRange.php new file mode 100644 index 000000000000..c7fa6c80788b --- /dev/null +++ b/BackupDr/src/V1/AliasIpRange.php @@ -0,0 +1,129 @@ +google.cloud.backupdr.v1.AliasIpRange + */ +class AliasIpRange extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The IP alias ranges to allocate for this interface. + * + * Generated from protobuf field optional string ip_cidr_range = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $ip_cidr_range = null; + /** + * Optional. The name of a subnetwork secondary IP range from which to + * allocate an IP alias range. If not specified, the primary range of the + * subnetwork is used. + * + * Generated from protobuf field optional string subnetwork_range_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $subnetwork_range_name = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $ip_cidr_range + * Optional. The IP alias ranges to allocate for this interface. + * @type string $subnetwork_range_name + * Optional. The name of a subnetwork secondary IP range from which to + * allocate an IP alias range. If not specified, the primary range of the + * subnetwork is used. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The IP alias ranges to allocate for this interface. + * + * Generated from protobuf field optional string ip_cidr_range = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getIpCidrRange() + { + return isset($this->ip_cidr_range) ? $this->ip_cidr_range : ''; + } + + public function hasIpCidrRange() + { + return isset($this->ip_cidr_range); + } + + public function clearIpCidrRange() + { + unset($this->ip_cidr_range); + } + + /** + * Optional. The IP alias ranges to allocate for this interface. + * + * Generated from protobuf field optional string ip_cidr_range = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setIpCidrRange($var) + { + GPBUtil::checkString($var, True); + $this->ip_cidr_range = $var; + + return $this; + } + + /** + * Optional. The name of a subnetwork secondary IP range from which to + * allocate an IP alias range. If not specified, the primary range of the + * subnetwork is used. + * + * Generated from protobuf field optional string subnetwork_range_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSubnetworkRangeName() + { + return isset($this->subnetwork_range_name) ? $this->subnetwork_range_name : ''; + } + + public function hasSubnetworkRangeName() + { + return isset($this->subnetwork_range_name); + } + + public function clearSubnetworkRangeName() + { + unset($this->subnetwork_range_name); + } + + /** + * Optional. The name of a subnetwork secondary IP range from which to + * allocate an IP alias range. If not specified, the primary range of the + * subnetwork is used. + * + * Generated from protobuf field optional string subnetwork_range_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSubnetworkRangeName($var) + { + GPBUtil::checkString($var, True); + $this->subnetwork_range_name = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/AllocationAffinity.php b/BackupDr/src/V1/AllocationAffinity.php new file mode 100644 index 000000000000..6eb73d7b0b92 --- /dev/null +++ b/BackupDr/src/V1/AllocationAffinity.php @@ -0,0 +1,159 @@ +google.cloud.backupdr.v1.AllocationAffinity + */ +class AllocationAffinity extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Specifies the type of reservation from which this instance can + * consume + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AllocationAffinity.Type consume_allocation_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $consume_allocation_type = null; + /** + * Optional. Corresponds to the label key of a reservation resource. + * + * Generated from protobuf field optional string key = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $key = null; + /** + * Optional. Corresponds to the label values of a reservation resource. + * + * Generated from protobuf field repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $values; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $consume_allocation_type + * Optional. Specifies the type of reservation from which this instance can + * consume + * @type string $key + * Optional. Corresponds to the label key of a reservation resource. + * @type array|\Google\Protobuf\Internal\RepeatedField $values + * Optional. Corresponds to the label values of a reservation resource. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Specifies the type of reservation from which this instance can + * consume + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AllocationAffinity.Type consume_allocation_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getConsumeAllocationType() + { + return isset($this->consume_allocation_type) ? $this->consume_allocation_type : 0; + } + + public function hasConsumeAllocationType() + { + return isset($this->consume_allocation_type); + } + + public function clearConsumeAllocationType() + { + unset($this->consume_allocation_type); + } + + /** + * Optional. Specifies the type of reservation from which this instance can + * consume + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AllocationAffinity.Type consume_allocation_type = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setConsumeAllocationType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\AllocationAffinity\Type::class); + $this->consume_allocation_type = $var; + + return $this; + } + + /** + * Optional. Corresponds to the label key of a reservation resource. + * + * Generated from protobuf field optional string key = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getKey() + { + return isset($this->key) ? $this->key : ''; + } + + public function hasKey() + { + return isset($this->key); + } + + public function clearKey() + { + unset($this->key); + } + + /** + * Optional. Corresponds to the label key of a reservation resource. + * + * Generated from protobuf field optional string key = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setKey($var) + { + GPBUtil::checkString($var, True); + $this->key = $var; + + return $this; + } + + /** + * Optional. Corresponds to the label values of a reservation resource. + * + * Generated from protobuf field repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getValues() + { + return $this->values; + } + + /** + * Optional. Corresponds to the label values of a reservation resource. + * + * Generated from protobuf field repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->values = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/AllocationAffinity/Type.php b/BackupDr/src/V1/AllocationAffinity/Type.php new file mode 100644 index 000000000000..949d11e75468 --- /dev/null +++ b/BackupDr/src/V1/AllocationAffinity/Type.php @@ -0,0 +1,70 @@ +google.cloud.backupdr.v1.AllocationAffinity.Type + */ +class Type +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum TYPE_UNSPECIFIED = 0; + */ + const TYPE_UNSPECIFIED = 0; + /** + * Do not consume from any allocated capacity. + * + * Generated from protobuf enum NO_RESERVATION = 1; + */ + const NO_RESERVATION = 1; + /** + * Consume any allocation available. + * + * Generated from protobuf enum ANY_RESERVATION = 2; + */ + const ANY_RESERVATION = 2; + /** + * Must consume from a specific reservation. Must specify key value fields + * for specifying the reservations. + * + * Generated from protobuf enum SPECIFIC_RESERVATION = 3; + */ + const SPECIFIC_RESERVATION = 3; + + private static $valueToName = [ + self::TYPE_UNSPECIFIED => 'TYPE_UNSPECIFIED', + self::NO_RESERVATION => 'NO_RESERVATION', + self::ANY_RESERVATION => 'ANY_RESERVATION', + self::SPECIFIC_RESERVATION => 'SPECIFIC_RESERVATION', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/AttachedDisk.php b/BackupDr/src/V1/AttachedDisk.php new file mode 100644 index 000000000000..6d06c12af671 --- /dev/null +++ b/BackupDr/src/V1/AttachedDisk.php @@ -0,0 +1,804 @@ +google.cloud.backupdr.v1.AttachedDisk + */ +class AttachedDisk extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Specifies the parameters to initialize this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.InitializeParams initialize_params = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $initialize_params = null; + /** + * Optional. This is used as an identifier for the disks. This is the unique + * name has to provided to modify disk parameters like disk_name and + * replica_zones (in case of RePDs) + * + * Generated from protobuf field optional string device_name = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $device_name = null; + /** + * Optional. Type of the resource. + * + * Generated from protobuf field optional string kind = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $kind = null; + /** + * Specifies the type of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskType disk_type_deprecated = 6 [deprecated = true]; + * @deprecated + */ + protected $disk_type_deprecated = null; + /** + * Optional. The mode in which to attach this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskMode mode = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $mode = null; + /** + * Optional. Specifies a valid partial or full URL to an existing Persistent + * Disk resource. + * + * Generated from protobuf field optional string source = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $source = null; + /** + * Optional. A zero-based index to this disk, where 0 is reserved for the + * boot disk. + * + * Generated from protobuf field optional int64 index = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $index = null; + /** + * Optional. Indicates that this is a boot disk. The virtual machine will use + * the first partition of the disk for its root filesystem. + * + * Generated from protobuf field optional bool boot = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $boot = null; + /** + * Optional. Specifies whether the disk will be auto-deleted when the instance + * is deleted (but not when the disk is detached from the instance). + * + * Generated from protobuf field optional bool auto_delete = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $auto_delete = null; + /** + * Optional. Any valid publicly visible licenses. + * + * Generated from protobuf field repeated string license = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $license; + /** + * Optional. Specifies the disk interface to use for attaching this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskInterface disk_interface = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disk_interface = null; + /** + * Optional. A list of features to enable on the guest operating system. + * Applicable only for bootable images. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.GuestOsFeature guest_os_feature = 14 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $guest_os_feature; + /** + * Optional. Encrypts or decrypts a disk using a customer-supplied + * encryption key. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.CustomerEncryptionKey disk_encryption_key = 15 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disk_encryption_key = null; + /** + * Optional. The size of the disk in GB. + * + * Generated from protobuf field optional int64 disk_size_gb = 16 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disk_size_gb = null; + /** + * Optional. Output only. The state of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskSavedState saved_state = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $saved_state = null; + /** + * Optional. Output only. The URI of the disk type resource. For example: + * projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + * + * Generated from protobuf field optional string disk_type = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $disk_type = null; + /** + * Optional. Specifies the type of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskType type = 19 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $type = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\BackupDR\V1\AttachedDisk\InitializeParams $initialize_params + * Optional. Specifies the parameters to initialize this disk. + * @type string $device_name + * Optional. This is used as an identifier for the disks. This is the unique + * name has to provided to modify disk parameters like disk_name and + * replica_zones (in case of RePDs) + * @type string $kind + * Optional. Type of the resource. + * @type int $disk_type_deprecated + * Specifies the type of the disk. + * @type int $mode + * Optional. The mode in which to attach this disk. + * @type string $source + * Optional. Specifies a valid partial or full URL to an existing Persistent + * Disk resource. + * @type int|string $index + * Optional. A zero-based index to this disk, where 0 is reserved for the + * boot disk. + * @type bool $boot + * Optional. Indicates that this is a boot disk. The virtual machine will use + * the first partition of the disk for its root filesystem. + * @type bool $auto_delete + * Optional. Specifies whether the disk will be auto-deleted when the instance + * is deleted (but not when the disk is detached from the instance). + * @type array|\Google\Protobuf\Internal\RepeatedField $license + * Optional. Any valid publicly visible licenses. + * @type int $disk_interface + * Optional. Specifies the disk interface to use for attaching this disk. + * @type array<\Google\Cloud\BackupDR\V1\GuestOsFeature>|\Google\Protobuf\Internal\RepeatedField $guest_os_feature + * Optional. A list of features to enable on the guest operating system. + * Applicable only for bootable images. + * @type \Google\Cloud\BackupDR\V1\CustomerEncryptionKey $disk_encryption_key + * Optional. Encrypts or decrypts a disk using a customer-supplied + * encryption key. + * @type int|string $disk_size_gb + * Optional. The size of the disk in GB. + * @type int $saved_state + * Optional. Output only. The state of the disk. + * @type string $disk_type + * Optional. Output only. The URI of the disk type resource. For example: + * projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + * @type int $type + * Optional. Specifies the type of the disk. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Specifies the parameters to initialize this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.InitializeParams initialize_params = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\AttachedDisk\InitializeParams|null + */ + public function getInitializeParams() + { + return $this->initialize_params; + } + + public function hasInitializeParams() + { + return isset($this->initialize_params); + } + + public function clearInitializeParams() + { + unset($this->initialize_params); + } + + /** + * Optional. Specifies the parameters to initialize this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.InitializeParams initialize_params = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\AttachedDisk\InitializeParams $var + * @return $this + */ + public function setInitializeParams($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\AttachedDisk\InitializeParams::class); + $this->initialize_params = $var; + + return $this; + } + + /** + * Optional. This is used as an identifier for the disks. This is the unique + * name has to provided to modify disk parameters like disk_name and + * replica_zones (in case of RePDs) + * + * Generated from protobuf field optional string device_name = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDeviceName() + { + return isset($this->device_name) ? $this->device_name : ''; + } + + public function hasDeviceName() + { + return isset($this->device_name); + } + + public function clearDeviceName() + { + unset($this->device_name); + } + + /** + * Optional. This is used as an identifier for the disks. This is the unique + * name has to provided to modify disk parameters like disk_name and + * replica_zones (in case of RePDs) + * + * Generated from protobuf field optional string device_name = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDeviceName($var) + { + GPBUtil::checkString($var, True); + $this->device_name = $var; + + return $this; + } + + /** + * Optional. Type of the resource. + * + * Generated from protobuf field optional string kind = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getKind() + { + return isset($this->kind) ? $this->kind : ''; + } + + public function hasKind() + { + return isset($this->kind); + } + + public function clearKind() + { + unset($this->kind); + } + + /** + * Optional. Type of the resource. + * + * Generated from protobuf field optional string kind = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setKind($var) + { + GPBUtil::checkString($var, True); + $this->kind = $var; + + return $this; + } + + /** + * Specifies the type of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskType disk_type_deprecated = 6 [deprecated = true]; + * @return int + * @deprecated + */ + public function getDiskTypeDeprecated() + { + @trigger_error('disk_type_deprecated is deprecated.', E_USER_DEPRECATED); + return isset($this->disk_type_deprecated) ? $this->disk_type_deprecated : 0; + } + + public function hasDiskTypeDeprecated() + { + @trigger_error('disk_type_deprecated is deprecated.', E_USER_DEPRECATED); + return isset($this->disk_type_deprecated); + } + + public function clearDiskTypeDeprecated() + { + @trigger_error('disk_type_deprecated is deprecated.', E_USER_DEPRECATED); + unset($this->disk_type_deprecated); + } + + /** + * Specifies the type of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskType disk_type_deprecated = 6 [deprecated = true]; + * @param int $var + * @return $this + * @deprecated + */ + public function setDiskTypeDeprecated($var) + { + @trigger_error('disk_type_deprecated is deprecated.', E_USER_DEPRECATED); + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\AttachedDisk\DiskType::class); + $this->disk_type_deprecated = $var; + + return $this; + } + + /** + * Optional. The mode in which to attach this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskMode mode = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getMode() + { + return isset($this->mode) ? $this->mode : 0; + } + + public function hasMode() + { + return isset($this->mode); + } + + public function clearMode() + { + unset($this->mode); + } + + /** + * Optional. The mode in which to attach this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskMode mode = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setMode($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\AttachedDisk\DiskMode::class); + $this->mode = $var; + + return $this; + } + + /** + * Optional. Specifies a valid partial or full URL to an existing Persistent + * Disk resource. + * + * Generated from protobuf field optional string source = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSource() + { + return isset($this->source) ? $this->source : ''; + } + + public function hasSource() + { + return isset($this->source); + } + + public function clearSource() + { + unset($this->source); + } + + /** + * Optional. Specifies a valid partial or full URL to an existing Persistent + * Disk resource. + * + * Generated from protobuf field optional string source = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSource($var) + { + GPBUtil::checkString($var, True); + $this->source = $var; + + return $this; + } + + /** + * Optional. A zero-based index to this disk, where 0 is reserved for the + * boot disk. + * + * Generated from protobuf field optional int64 index = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getIndex() + { + return isset($this->index) ? $this->index : 0; + } + + public function hasIndex() + { + return isset($this->index); + } + + public function clearIndex() + { + unset($this->index); + } + + /** + * Optional. A zero-based index to this disk, where 0 is reserved for the + * boot disk. + * + * Generated from protobuf field optional int64 index = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setIndex($var) + { + GPBUtil::checkInt64($var); + $this->index = $var; + + return $this; + } + + /** + * Optional. Indicates that this is a boot disk. The virtual machine will use + * the first partition of the disk for its root filesystem. + * + * Generated from protobuf field optional bool boot = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getBoot() + { + return isset($this->boot) ? $this->boot : false; + } + + public function hasBoot() + { + return isset($this->boot); + } + + public function clearBoot() + { + unset($this->boot); + } + + /** + * Optional. Indicates that this is a boot disk. The virtual machine will use + * the first partition of the disk for its root filesystem. + * + * Generated from protobuf field optional bool boot = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setBoot($var) + { + GPBUtil::checkBool($var); + $this->boot = $var; + + return $this; + } + + /** + * Optional. Specifies whether the disk will be auto-deleted when the instance + * is deleted (but not when the disk is detached from the instance). + * + * Generated from protobuf field optional bool auto_delete = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAutoDelete() + { + return isset($this->auto_delete) ? $this->auto_delete : false; + } + + public function hasAutoDelete() + { + return isset($this->auto_delete); + } + + public function clearAutoDelete() + { + unset($this->auto_delete); + } + + /** + * Optional. Specifies whether the disk will be auto-deleted when the instance + * is deleted (but not when the disk is detached from the instance). + * + * Generated from protobuf field optional bool auto_delete = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAutoDelete($var) + { + GPBUtil::checkBool($var); + $this->auto_delete = $var; + + return $this; + } + + /** + * Optional. Any valid publicly visible licenses. + * + * Generated from protobuf field repeated string license = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getLicense() + { + return $this->license; + } + + /** + * Optional. Any valid publicly visible licenses. + * + * Generated from protobuf field repeated string license = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setLicense($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->license = $arr; + + return $this; + } + + /** + * Optional. Specifies the disk interface to use for attaching this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskInterface disk_interface = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getDiskInterface() + { + return isset($this->disk_interface) ? $this->disk_interface : 0; + } + + public function hasDiskInterface() + { + return isset($this->disk_interface); + } + + public function clearDiskInterface() + { + unset($this->disk_interface); + } + + /** + * Optional. Specifies the disk interface to use for attaching this disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskInterface disk_interface = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setDiskInterface($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\AttachedDisk\DiskInterface::class); + $this->disk_interface = $var; + + return $this; + } + + /** + * Optional. A list of features to enable on the guest operating system. + * Applicable only for bootable images. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.GuestOsFeature guest_os_feature = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGuestOsFeature() + { + return $this->guest_os_feature; + } + + /** + * Optional. A list of features to enable on the guest operating system. + * Applicable only for bootable images. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.GuestOsFeature guest_os_feature = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\GuestOsFeature>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGuestOsFeature($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\GuestOsFeature::class); + $this->guest_os_feature = $arr; + + return $this; + } + + /** + * Optional. Encrypts or decrypts a disk using a customer-supplied + * encryption key. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.CustomerEncryptionKey disk_encryption_key = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\CustomerEncryptionKey|null + */ + public function getDiskEncryptionKey() + { + return $this->disk_encryption_key; + } + + public function hasDiskEncryptionKey() + { + return isset($this->disk_encryption_key); + } + + public function clearDiskEncryptionKey() + { + unset($this->disk_encryption_key); + } + + /** + * Optional. Encrypts or decrypts a disk using a customer-supplied + * encryption key. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.CustomerEncryptionKey disk_encryption_key = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\CustomerEncryptionKey $var + * @return $this + */ + public function setDiskEncryptionKey($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\CustomerEncryptionKey::class); + $this->disk_encryption_key = $var; + + return $this; + } + + /** + * Optional. The size of the disk in GB. + * + * Generated from protobuf field optional int64 disk_size_gb = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getDiskSizeGb() + { + return isset($this->disk_size_gb) ? $this->disk_size_gb : 0; + } + + public function hasDiskSizeGb() + { + return isset($this->disk_size_gb); + } + + public function clearDiskSizeGb() + { + unset($this->disk_size_gb); + } + + /** + * Optional. The size of the disk in GB. + * + * Generated from protobuf field optional int64 disk_size_gb = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setDiskSizeGb($var) + { + GPBUtil::checkInt64($var); + $this->disk_size_gb = $var; + + return $this; + } + + /** + * Optional. Output only. The state of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskSavedState saved_state = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getSavedState() + { + return isset($this->saved_state) ? $this->saved_state : 0; + } + + public function hasSavedState() + { + return isset($this->saved_state); + } + + public function clearSavedState() + { + unset($this->saved_state); + } + + /** + * Optional. Output only. The state of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskSavedState saved_state = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setSavedState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\AttachedDisk\DiskSavedState::class); + $this->saved_state = $var; + + return $this; + } + + /** + * Optional. Output only. The URI of the disk type resource. For example: + * projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + * + * Generated from protobuf field optional string disk_type = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getDiskType() + { + return isset($this->disk_type) ? $this->disk_type : ''; + } + + public function hasDiskType() + { + return isset($this->disk_type); + } + + public function clearDiskType() + { + unset($this->disk_type); + } + + /** + * Optional. Output only. The URI of the disk type resource. For example: + * projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + * + * Generated from protobuf field optional string disk_type = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setDiskType($var) + { + GPBUtil::checkString($var, True); + $this->disk_type = $var; + + return $this; + } + + /** + * Optional. Specifies the type of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskType type = 19 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getType() + { + return isset($this->type) ? $this->type : 0; + } + + public function hasType() + { + return isset($this->type); + } + + public function clearType() + { + unset($this->type); + } + + /** + * Optional. Specifies the type of the disk. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AttachedDisk.DiskType type = 19 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\AttachedDisk\DiskType::class); + $this->type = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/AttachedDisk/DiskInterface.php b/BackupDr/src/V1/AttachedDisk/DiskInterface.php new file mode 100644 index 000000000000..69ac3c141578 --- /dev/null +++ b/BackupDr/src/V1/AttachedDisk/DiskInterface.php @@ -0,0 +1,76 @@ +google.cloud.backupdr.v1.AttachedDisk.DiskInterface + */ +class DiskInterface +{ + /** + * Default value, which is unused. + * + * Generated from protobuf enum DISK_INTERFACE_UNSPECIFIED = 0; + */ + const DISK_INTERFACE_UNSPECIFIED = 0; + /** + * SCSI Disk Interface. + * + * Generated from protobuf enum SCSI = 1; + */ + const SCSI = 1; + /** + * NVME Disk Interface. + * + * Generated from protobuf enum NVME = 2; + */ + const NVME = 2; + /** + * NVDIMM Disk Interface. + * + * Generated from protobuf enum NVDIMM = 3; + */ + const NVDIMM = 3; + /** + * ISCSI Disk Interface. + * + * Generated from protobuf enum ISCSI = 4; + */ + const ISCSI = 4; + + private static $valueToName = [ + self::DISK_INTERFACE_UNSPECIFIED => 'DISK_INTERFACE_UNSPECIFIED', + self::SCSI => 'SCSI', + self::NVME => 'NVME', + self::NVDIMM => 'NVDIMM', + self::ISCSI => 'ISCSI', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/AttachedDisk/DiskMode.php b/BackupDr/src/V1/AttachedDisk/DiskMode.php new file mode 100644 index 000000000000..57c501a544cb --- /dev/null +++ b/BackupDr/src/V1/AttachedDisk/DiskMode.php @@ -0,0 +1,74 @@ +google.cloud.backupdr.v1.AttachedDisk.DiskMode + */ +class DiskMode +{ + /** + * Default value, which is unused. + * + * Generated from protobuf enum DISK_MODE_UNSPECIFIED = 0; + */ + const DISK_MODE_UNSPECIFIED = 0; + /** + * Attaches this disk in read-write mode. Only one + * virtual machine at a time can be attached to a disk in read-write mode. + * + * Generated from protobuf enum READ_WRITE = 1; + */ + const READ_WRITE = 1; + /** + * Attaches this disk in read-only mode. Multiple virtual machines can use + * a disk in read-only mode at a time. + * + * Generated from protobuf enum READ_ONLY = 2; + */ + const READ_ONLY = 2; + /** + * The disk is locked for administrative reasons. Nobody else + * can use the disk. This mode is used (for example) when taking + * a snapshot of a disk to prevent mounting the disk while it is + * being snapshotted. + * + * Generated from protobuf enum LOCKED = 3; + */ + const LOCKED = 3; + + private static $valueToName = [ + self::DISK_MODE_UNSPECIFIED => 'DISK_MODE_UNSPECIFIED', + self::READ_WRITE => 'READ_WRITE', + self::READ_ONLY => 'READ_ONLY', + self::LOCKED => 'LOCKED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/AttachedDisk/DiskSavedState.php b/BackupDr/src/V1/AttachedDisk/DiskSavedState.php new file mode 100644 index 000000000000..c17852da2280 --- /dev/null +++ b/BackupDr/src/V1/AttachedDisk/DiskSavedState.php @@ -0,0 +1,55 @@ +google.cloud.backupdr.v1.AttachedDisk.DiskSavedState + */ +class DiskSavedState +{ + /** + * Default Disk state has not been preserved. + * + * Generated from protobuf enum DISK_SAVED_STATE_UNSPECIFIED = 0; + */ + const DISK_SAVED_STATE_UNSPECIFIED = 0; + /** + * Disk state has been preserved. + * + * Generated from protobuf enum PRESERVED = 1; + */ + const PRESERVED = 1; + + private static $valueToName = [ + self::DISK_SAVED_STATE_UNSPECIFIED => 'DISK_SAVED_STATE_UNSPECIFIED', + self::PRESERVED => 'PRESERVED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/AttachedDisk/DiskType.php b/BackupDr/src/V1/AttachedDisk/DiskType.php new file mode 100644 index 000000000000..323c3423bf3d --- /dev/null +++ b/BackupDr/src/V1/AttachedDisk/DiskType.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.AttachedDisk.DiskType + */ +class DiskType +{ + /** + * Default value, which is unused. + * + * Generated from protobuf enum DISK_TYPE_UNSPECIFIED = 0; + */ + const DISK_TYPE_UNSPECIFIED = 0; + /** + * A scratch disk type. + * + * Generated from protobuf enum SCRATCH = 1; + */ + const SCRATCH = 1; + /** + * A persistent disk type. + * + * Generated from protobuf enum PERSISTENT = 2; + */ + const PERSISTENT = 2; + + private static $valueToName = [ + self::DISK_TYPE_UNSPECIFIED => 'DISK_TYPE_UNSPECIFIED', + self::SCRATCH => 'SCRATCH', + self::PERSISTENT => 'PERSISTENT', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/AttachedDisk/InitializeParams.php b/BackupDr/src/V1/AttachedDisk/InitializeParams.php new file mode 100644 index 000000000000..549109c5f495 --- /dev/null +++ b/BackupDr/src/V1/AttachedDisk/InitializeParams.php @@ -0,0 +1,120 @@ +google.cloud.backupdr.v1.AttachedDisk.InitializeParams + */ +class InitializeParams extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Specifies the disk name. If not specified, the default is to + * use the name of the instance. + * + * Generated from protobuf field optional string disk_name = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disk_name = null; + /** + * Optional. URL of the zone where the disk should be created. + * Required for each regional disk associated with the instance. + * + * Generated from protobuf field repeated string replica_zones = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $replica_zones; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $disk_name + * Optional. Specifies the disk name. If not specified, the default is to + * use the name of the instance. + * @type array|\Google\Protobuf\Internal\RepeatedField $replica_zones + * Optional. URL of the zone where the disk should be created. + * Required for each regional disk associated with the instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Specifies the disk name. If not specified, the default is to + * use the name of the instance. + * + * Generated from protobuf field optional string disk_name = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDiskName() + { + return isset($this->disk_name) ? $this->disk_name : ''; + } + + public function hasDiskName() + { + return isset($this->disk_name); + } + + public function clearDiskName() + { + unset($this->disk_name); + } + + /** + * Optional. Specifies the disk name. If not specified, the default is to + * use the name of the instance. + * + * Generated from protobuf field optional string disk_name = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDiskName($var) + { + GPBUtil::checkString($var, True); + $this->disk_name = $var; + + return $this; + } + + /** + * Optional. URL of the zone where the disk should be created. + * Required for each regional disk associated with the instance. + * + * Generated from protobuf field repeated string replica_zones = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getReplicaZones() + { + return $this->replica_zones; + } + + /** + * Optional. URL of the zone where the disk should be created. + * Required for each regional disk associated with the instance. + * + * Generated from protobuf field repeated string replica_zones = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setReplicaZones($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->replica_zones = $arr; + + return $this; + } + +} + + diff --git a/BackupDr/src/V1/Backup.php b/BackupDr/src/V1/Backup.php new file mode 100644 index 000000000000..5639d7923c1e --- /dev/null +++ b/BackupDr/src/V1/Backup.php @@ -0,0 +1,728 @@ +google.cloud.backupdr.v1.Backup + */ +class Backup extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Identifier. Name of the backup to create. It must have the + * format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. + * `{backup}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the datasource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. The description of the Backup instance (2048 characters or + * less). + * + * Generated from protobuf field optional string description = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $description = null; + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined. + * + * Generated from protobuf field map labels = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Optional. The backup can not be deleted before this time. + * + * Generated from protobuf field optional .google.protobuf.Timestamp enforced_retention_end_time = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enforced_retention_end_time = null; + /** + * Optional. When this backup is automatically expired. + * + * Generated from protobuf field optional .google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $expire_time = null; + /** + * Output only. The point in time when this backup was captured from the + * source. + * + * Generated from protobuf field optional .google.protobuf.Timestamp consistency_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $consistency_time = null; + /** + * Optional. Server specified ETag to prevent updates from overwriting each + * other. + * + * Generated from protobuf field optional string etag = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = null; + /** + * Output only. The Backup resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $state = 0; + /** + * Output only. The list of BackupLocks taken by the service to prevent the + * deletion of the backup. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupLock service_locks = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $service_locks; + /** + * Optional. The list of BackupLocks taken by the accessor Backup Appliance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupLock backup_appliance_locks = 18 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $backup_appliance_locks; + /** + * Output only. Type of the backup, unspecified, scheduled or ondemand. + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup.BackupType backup_type = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $backup_type = 0; + /** + * Output only. source resource size in bytes at the time of the backup. + * + * Generated from protobuf field int64 resource_size_bytes = 23 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $resource_size_bytes = 0; + protected $backup_properties; + protected $plan_info; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Output only. Identifier. Name of the backup to create. It must have the + * format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. + * `{backup}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the datasource. + * @type string $description + * Output only. The description of the Backup instance (2048 characters or + * less). + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the instance was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the instance was updated. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined. + * @type \Google\Protobuf\Timestamp $enforced_retention_end_time + * Optional. The backup can not be deleted before this time. + * @type \Google\Protobuf\Timestamp $expire_time + * Optional. When this backup is automatically expired. + * @type \Google\Protobuf\Timestamp $consistency_time + * Output only. The point in time when this backup was captured from the + * source. + * @type string $etag + * Optional. Server specified ETag to prevent updates from overwriting each + * other. + * @type int $state + * Output only. The Backup resource instance state. + * @type array<\Google\Cloud\BackupDR\V1\BackupLock>|\Google\Protobuf\Internal\RepeatedField $service_locks + * Output only. The list of BackupLocks taken by the service to prevent the + * deletion of the backup. + * @type array<\Google\Cloud\BackupDR\V1\BackupLock>|\Google\Protobuf\Internal\RepeatedField $backup_appliance_locks + * Optional. The list of BackupLocks taken by the accessor Backup Appliance. + * @type \Google\Cloud\BackupDR\V1\ComputeInstanceBackupProperties $compute_instance_backup_properties + * Output only. Compute Engine specific backup properties. + * @type \Google\Cloud\BackupDR\V1\BackupApplianceBackupProperties $backup_appliance_backup_properties + * Output only. Backup Appliance specific backup properties. + * @type int $backup_type + * Output only. Type of the backup, unspecified, scheduled or ondemand. + * @type \Google\Cloud\BackupDR\V1\Backup\GCPBackupPlanInfo $gcp_backup_plan_info + * Output only. Configuration for a Google Cloud resource. + * @type int|string $resource_size_bytes + * Output only. source resource size in bytes at the time of the backup. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Identifier. Name of the backup to create. It must have the + * format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. + * `{backup}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the datasource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Output only. Identifier. Name of the backup to create. It must have the + * format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. + * `{backup}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the datasource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. The description of the Backup instance (2048 characters or + * less). + * + * Generated from protobuf field optional string description = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getDescription() + { + return isset($this->description) ? $this->description : ''; + } + + public function hasDescription() + { + return isset($this->description); + } + + public function clearDescription() + { + unset($this->description); + } + + /** + * Output only. The description of the Backup instance (2048 characters or + * less). + * + * Generated from protobuf field optional string description = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined. + * + * Generated from protobuf field map labels = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined. + * + * Generated from protobuf field map labels = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Optional. The backup can not be deleted before this time. + * + * Generated from protobuf field optional .google.protobuf.Timestamp enforced_retention_end_time = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEnforcedRetentionEndTime() + { + return $this->enforced_retention_end_time; + } + + public function hasEnforcedRetentionEndTime() + { + return isset($this->enforced_retention_end_time); + } + + public function clearEnforcedRetentionEndTime() + { + unset($this->enforced_retention_end_time); + } + + /** + * Optional. The backup can not be deleted before this time. + * + * Generated from protobuf field optional .google.protobuf.Timestamp enforced_retention_end_time = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEnforcedRetentionEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->enforced_retention_end_time = $var; + + return $this; + } + + /** + * Optional. When this backup is automatically expired. + * + * Generated from protobuf field optional .google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getExpireTime() + { + return $this->expire_time; + } + + public function hasExpireTime() + { + return isset($this->expire_time); + } + + public function clearExpireTime() + { + unset($this->expire_time); + } + + /** + * Optional. When this backup is automatically expired. + * + * Generated from protobuf field optional .google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setExpireTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->expire_time = $var; + + return $this; + } + + /** + * Output only. The point in time when this backup was captured from the + * source. + * + * Generated from protobuf field optional .google.protobuf.Timestamp consistency_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getConsistencyTime() + { + return $this->consistency_time; + } + + public function hasConsistencyTime() + { + return isset($this->consistency_time); + } + + public function clearConsistencyTime() + { + unset($this->consistency_time); + } + + /** + * Output only. The point in time when this backup was captured from the + * source. + * + * Generated from protobuf field optional .google.protobuf.Timestamp consistency_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setConsistencyTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->consistency_time = $var; + + return $this; + } + + /** + * Optional. Server specified ETag to prevent updates from overwriting each + * other. + * + * Generated from protobuf field optional string etag = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return isset($this->etag) ? $this->etag : ''; + } + + public function hasEtag() + { + return isset($this->etag); + } + + public function clearEtag() + { + unset($this->etag); + } + + /** + * Optional. Server specified ETag to prevent updates from overwriting each + * other. + * + * Generated from protobuf field optional string etag = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Output only. The Backup resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getState() + { + return $this->state; + } + + /** + * Output only. The Backup resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\Backup\State::class); + $this->state = $var; + + return $this; + } + + /** + * Output only. The list of BackupLocks taken by the service to prevent the + * deletion of the backup. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupLock service_locks = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getServiceLocks() + { + return $this->service_locks; + } + + /** + * Output only. The list of BackupLocks taken by the service to prevent the + * deletion of the backup. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupLock service_locks = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array<\Google\Cloud\BackupDR\V1\BackupLock>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setServiceLocks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\BackupLock::class); + $this->service_locks = $arr; + + return $this; + } + + /** + * Optional. The list of BackupLocks taken by the accessor Backup Appliance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupLock backup_appliance_locks = 18 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBackupApplianceLocks() + { + return $this->backup_appliance_locks; + } + + /** + * Optional. The list of BackupLocks taken by the accessor Backup Appliance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupLock backup_appliance_locks = 18 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\BackupLock>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBackupApplianceLocks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\BackupLock::class); + $this->backup_appliance_locks = $arr; + + return $this; + } + + /** + * Output only. Compute Engine specific backup properties. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ComputeInstanceBackupProperties compute_instance_backup_properties = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\BackupDR\V1\ComputeInstanceBackupProperties|null + */ + public function getComputeInstanceBackupProperties() + { + return $this->readOneof(19); + } + + public function hasComputeInstanceBackupProperties() + { + return $this->hasOneof(19); + } + + /** + * Output only. Compute Engine specific backup properties. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ComputeInstanceBackupProperties compute_instance_backup_properties = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\BackupDR\V1\ComputeInstanceBackupProperties $var + * @return $this + */ + public function setComputeInstanceBackupProperties($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\ComputeInstanceBackupProperties::class); + $this->writeOneof(19, $var); + + return $this; + } + + /** + * Output only. Backup Appliance specific backup properties. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupApplianceBackupProperties backup_appliance_backup_properties = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\BackupDR\V1\BackupApplianceBackupProperties|null + */ + public function getBackupApplianceBackupProperties() + { + return $this->readOneof(21); + } + + public function hasBackupApplianceBackupProperties() + { + return $this->hasOneof(21); + } + + /** + * Output only. Backup Appliance specific backup properties. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupApplianceBackupProperties backup_appliance_backup_properties = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\BackupDR\V1\BackupApplianceBackupProperties $var + * @return $this + */ + public function setBackupApplianceBackupProperties($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupApplianceBackupProperties::class); + $this->writeOneof(21, $var); + + return $this; + } + + /** + * Output only. Type of the backup, unspecified, scheduled or ondemand. + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup.BackupType backup_type = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getBackupType() + { + return $this->backup_type; + } + + /** + * Output only. Type of the backup, unspecified, scheduled or ondemand. + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup.BackupType backup_type = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setBackupType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\Backup\BackupType::class); + $this->backup_type = $var; + + return $this; + } + + /** + * Output only. Configuration for a Google Cloud resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup.GCPBackupPlanInfo gcp_backup_plan_info = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\BackupDR\V1\Backup\GCPBackupPlanInfo|null + */ + public function getGcpBackupPlanInfo() + { + return $this->readOneof(22); + } + + public function hasGcpBackupPlanInfo() + { + return $this->hasOneof(22); + } + + /** + * Output only. Configuration for a Google Cloud resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup.GCPBackupPlanInfo gcp_backup_plan_info = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\BackupDR\V1\Backup\GCPBackupPlanInfo $var + * @return $this + */ + public function setGcpBackupPlanInfo($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\Backup\GCPBackupPlanInfo::class); + $this->writeOneof(22, $var); + + return $this; + } + + /** + * Output only. source resource size in bytes at the time of the backup. + * + * Generated from protobuf field int64 resource_size_bytes = 23 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getResourceSizeBytes() + { + return $this->resource_size_bytes; + } + + /** + * Output only. source resource size in bytes at the time of the backup. + * + * Generated from protobuf field int64 resource_size_bytes = 23 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setResourceSizeBytes($var) + { + GPBUtil::checkInt64($var); + $this->resource_size_bytes = $var; + + return $this; + } + + /** + * @return string + */ + public function getBackupProperties() + { + return $this->whichOneof("backup_properties"); + } + + /** + * @return string + */ + public function getPlanInfo() + { + return $this->whichOneof("plan_info"); + } + +} + diff --git a/BackupDr/src/V1/Backup/BackupType.php b/BackupDr/src/V1/Backup/BackupType.php new file mode 100644 index 000000000000..5858858dc7d8 --- /dev/null +++ b/BackupDr/src/V1/Backup/BackupType.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.Backup.BackupType + */ +class BackupType +{ + /** + * Backup type is unspecified. + * + * Generated from protobuf enum BACKUP_TYPE_UNSPECIFIED = 0; + */ + const BACKUP_TYPE_UNSPECIFIED = 0; + /** + * Scheduled backup. + * + * Generated from protobuf enum SCHEDULED = 1; + */ + const SCHEDULED = 1; + /** + * On demand backup. + * + * Generated from protobuf enum ON_DEMAND = 2; + */ + const ON_DEMAND = 2; + + private static $valueToName = [ + self::BACKUP_TYPE_UNSPECIFIED => 'BACKUP_TYPE_UNSPECIFIED', + self::SCHEDULED => 'SCHEDULED', + self::ON_DEMAND => 'ON_DEMAND', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/Backup/GCPBackupPlanInfo.php b/BackupDr/src/V1/Backup/GCPBackupPlanInfo.php new file mode 100644 index 000000000000..b8c387cdfd06 --- /dev/null +++ b/BackupDr/src/V1/Backup/GCPBackupPlanInfo.php @@ -0,0 +1,119 @@ +google.cloud.backupdr.v1.Backup.GCPBackupPlanInfo + */ +class GCPBackupPlanInfo extends \Google\Protobuf\Internal\Message +{ + /** + * Resource name of backup plan by which workload is protected at the time + * of the backup. + * Format: + * projects/{project}/locations/{location}/backupPlans/{backupPlanId} + * + * Generated from protobuf field string backup_plan = 1 [(.google.api.resource_reference) = { + */ + protected $backup_plan = ''; + /** + * The rule id of the backup plan which triggered this backup in case of + * scheduled backup or used for + * + * Generated from protobuf field string backup_plan_rule_id = 2; + */ + protected $backup_plan_rule_id = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $backup_plan + * Resource name of backup plan by which workload is protected at the time + * of the backup. + * Format: + * projects/{project}/locations/{location}/backupPlans/{backupPlanId} + * @type string $backup_plan_rule_id + * The rule id of the backup plan which triggered this backup in case of + * scheduled backup or used for + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Resource name of backup plan by which workload is protected at the time + * of the backup. + * Format: + * projects/{project}/locations/{location}/backupPlans/{backupPlanId} + * + * Generated from protobuf field string backup_plan = 1 [(.google.api.resource_reference) = { + * @return string + */ + public function getBackupPlan() + { + return $this->backup_plan; + } + + /** + * Resource name of backup plan by which workload is protected at the time + * of the backup. + * Format: + * projects/{project}/locations/{location}/backupPlans/{backupPlanId} + * + * Generated from protobuf field string backup_plan = 1 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setBackupPlan($var) + { + GPBUtil::checkString($var, True); + $this->backup_plan = $var; + + return $this; + } + + /** + * The rule id of the backup plan which triggered this backup in case of + * scheduled backup or used for + * + * Generated from protobuf field string backup_plan_rule_id = 2; + * @return string + */ + public function getBackupPlanRuleId() + { + return $this->backup_plan_rule_id; + } + + /** + * The rule id of the backup plan which triggered this backup in case of + * scheduled backup or used for + * + * Generated from protobuf field string backup_plan_rule_id = 2; + * @param string $var + * @return $this + */ + public function setBackupPlanRuleId($var) + { + GPBUtil::checkString($var, True); + $this->backup_plan_rule_id = $var; + + return $this; + } + +} + + diff --git a/BackupDr/src/V1/Backup/State.php b/BackupDr/src/V1/Backup/State.php new file mode 100644 index 000000000000..a82ffb90bab8 --- /dev/null +++ b/BackupDr/src/V1/Backup/State.php @@ -0,0 +1,76 @@ +google.cloud.backupdr.v1.Backup.State + */ +class State +{ + /** + * State not set. + * + * Generated from protobuf enum STATE_UNSPECIFIED = 0; + */ + const STATE_UNSPECIFIED = 0; + /** + * The backup is being created. + * + * Generated from protobuf enum CREATING = 1; + */ + const CREATING = 1; + /** + * The backup has been created and is fully usable. + * + * Generated from protobuf enum ACTIVE = 2; + */ + const ACTIVE = 2; + /** + * The backup is being deleted. + * + * Generated from protobuf enum DELETING = 3; + */ + const DELETING = 3; + /** + * The backup is experiencing an issue and might be unusable. + * + * Generated from protobuf enum ERROR = 4; + */ + const ERROR = 4; + + private static $valueToName = [ + self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', + self::CREATING => 'CREATING', + self::ACTIVE => 'ACTIVE', + self::DELETING => 'DELETING', + self::ERROR => 'ERROR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/BackupApplianceBackupConfig.php b/BackupDr/src/V1/BackupApplianceBackupConfig.php new file mode 100644 index 000000000000..b5d4c27f9480 --- /dev/null +++ b/BackupDr/src/V1/BackupApplianceBackupConfig.php @@ -0,0 +1,272 @@ +google.cloud.backupdr.v1.BackupApplianceBackupConfig + */ +class BackupApplianceBackupConfig extends \Google\Protobuf\Internal\Message +{ + /** + * The name of the backup appliance. + * + * Generated from protobuf field string backup_appliance_name = 1; + */ + protected $backup_appliance_name = ''; + /** + * The ID of the backup appliance. + * + * Generated from protobuf field int64 backup_appliance_id = 2; + */ + protected $backup_appliance_id = 0; + /** + * The ID of the SLA of this application. + * + * Generated from protobuf field int64 sla_id = 3; + */ + protected $sla_id = 0; + /** + * The name of the application. + * + * Generated from protobuf field string application_name = 4; + */ + protected $application_name = ''; + /** + * The name of the host where the application is running. + * + * Generated from protobuf field string host_name = 5; + */ + protected $host_name = ''; + /** + * The name of the SLT associated with the application. + * + * Generated from protobuf field string slt_name = 6; + */ + protected $slt_name = ''; + /** + * The name of the SLP associated with the application. + * + * Generated from protobuf field string slp_name = 7; + */ + protected $slp_name = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $backup_appliance_name + * The name of the backup appliance. + * @type int|string $backup_appliance_id + * The ID of the backup appliance. + * @type int|string $sla_id + * The ID of the SLA of this application. + * @type string $application_name + * The name of the application. + * @type string $host_name + * The name of the host where the application is running. + * @type string $slt_name + * The name of the SLT associated with the application. + * @type string $slp_name + * The name of the SLP associated with the application. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * The name of the backup appliance. + * + * Generated from protobuf field string backup_appliance_name = 1; + * @return string + */ + public function getBackupApplianceName() + { + return $this->backup_appliance_name; + } + + /** + * The name of the backup appliance. + * + * Generated from protobuf field string backup_appliance_name = 1; + * @param string $var + * @return $this + */ + public function setBackupApplianceName($var) + { + GPBUtil::checkString($var, True); + $this->backup_appliance_name = $var; + + return $this; + } + + /** + * The ID of the backup appliance. + * + * Generated from protobuf field int64 backup_appliance_id = 2; + * @return int|string + */ + public function getBackupApplianceId() + { + return $this->backup_appliance_id; + } + + /** + * The ID of the backup appliance. + * + * Generated from protobuf field int64 backup_appliance_id = 2; + * @param int|string $var + * @return $this + */ + public function setBackupApplianceId($var) + { + GPBUtil::checkInt64($var); + $this->backup_appliance_id = $var; + + return $this; + } + + /** + * The ID of the SLA of this application. + * + * Generated from protobuf field int64 sla_id = 3; + * @return int|string + */ + public function getSlaId() + { + return $this->sla_id; + } + + /** + * The ID of the SLA of this application. + * + * Generated from protobuf field int64 sla_id = 3; + * @param int|string $var + * @return $this + */ + public function setSlaId($var) + { + GPBUtil::checkInt64($var); + $this->sla_id = $var; + + return $this; + } + + /** + * The name of the application. + * + * Generated from protobuf field string application_name = 4; + * @return string + */ + public function getApplicationName() + { + return $this->application_name; + } + + /** + * The name of the application. + * + * Generated from protobuf field string application_name = 4; + * @param string $var + * @return $this + */ + public function setApplicationName($var) + { + GPBUtil::checkString($var, True); + $this->application_name = $var; + + return $this; + } + + /** + * The name of the host where the application is running. + * + * Generated from protobuf field string host_name = 5; + * @return string + */ + public function getHostName() + { + return $this->host_name; + } + + /** + * The name of the host where the application is running. + * + * Generated from protobuf field string host_name = 5; + * @param string $var + * @return $this + */ + public function setHostName($var) + { + GPBUtil::checkString($var, True); + $this->host_name = $var; + + return $this; + } + + /** + * The name of the SLT associated with the application. + * + * Generated from protobuf field string slt_name = 6; + * @return string + */ + public function getSltName() + { + return $this->slt_name; + } + + /** + * The name of the SLT associated with the application. + * + * Generated from protobuf field string slt_name = 6; + * @param string $var + * @return $this + */ + public function setSltName($var) + { + GPBUtil::checkString($var, True); + $this->slt_name = $var; + + return $this; + } + + /** + * The name of the SLP associated with the application. + * + * Generated from protobuf field string slp_name = 7; + * @return string + */ + public function getSlpName() + { + return $this->slp_name; + } + + /** + * The name of the SLP associated with the application. + * + * Generated from protobuf field string slp_name = 7; + * @param string $var + * @return $this + */ + public function setSlpName($var) + { + GPBUtil::checkString($var, True); + $this->slp_name = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/BackupApplianceBackupProperties.php b/BackupDr/src/V1/BackupApplianceBackupProperties.php new file mode 100644 index 000000000000..62bf277eea5e --- /dev/null +++ b/BackupDr/src/V1/BackupApplianceBackupProperties.php @@ -0,0 +1,218 @@ +google.cloud.backupdr.v1.BackupApplianceBackupProperties + */ +class BackupApplianceBackupProperties extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The numeric generation ID of the backup (monotonically + * increasing). + * + * Generated from protobuf field optional int32 generation_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $generation_id = null; + /** + * Output only. The time when this backup object was finalized (if none, + * backup is not finalized). + * + * Generated from protobuf field optional .google.protobuf.Timestamp finalize_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $finalize_time = null; + /** + * Optional. The earliest timestamp of data available in this Backup. + * + * Generated from protobuf field optional .google.protobuf.Timestamp recovery_range_start_time = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $recovery_range_start_time = null; + /** + * Optional. The latest timestamp of data available in this Backup. + * + * Generated from protobuf field optional .google.protobuf.Timestamp recovery_range_end_time = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $recovery_range_end_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $generation_id + * Output only. The numeric generation ID of the backup (monotonically + * increasing). + * @type \Google\Protobuf\Timestamp $finalize_time + * Output only. The time when this backup object was finalized (if none, + * backup is not finalized). + * @type \Google\Protobuf\Timestamp $recovery_range_start_time + * Optional. The earliest timestamp of data available in this Backup. + * @type \Google\Protobuf\Timestamp $recovery_range_end_time + * Optional. The latest timestamp of data available in this Backup. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultBa::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The numeric generation ID of the backup (monotonically + * increasing). + * + * Generated from protobuf field optional int32 generation_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getGenerationId() + { + return isset($this->generation_id) ? $this->generation_id : 0; + } + + public function hasGenerationId() + { + return isset($this->generation_id); + } + + public function clearGenerationId() + { + unset($this->generation_id); + } + + /** + * Output only. The numeric generation ID of the backup (monotonically + * increasing). + * + * Generated from protobuf field optional int32 generation_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setGenerationId($var) + { + GPBUtil::checkInt32($var); + $this->generation_id = $var; + + return $this; + } + + /** + * Output only. The time when this backup object was finalized (if none, + * backup is not finalized). + * + * Generated from protobuf field optional .google.protobuf.Timestamp finalize_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getFinalizeTime() + { + return $this->finalize_time; + } + + public function hasFinalizeTime() + { + return isset($this->finalize_time); + } + + public function clearFinalizeTime() + { + unset($this->finalize_time); + } + + /** + * Output only. The time when this backup object was finalized (if none, + * backup is not finalized). + * + * Generated from protobuf field optional .google.protobuf.Timestamp finalize_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setFinalizeTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->finalize_time = $var; + + return $this; + } + + /** + * Optional. The earliest timestamp of data available in this Backup. + * + * Generated from protobuf field optional .google.protobuf.Timestamp recovery_range_start_time = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getRecoveryRangeStartTime() + { + return $this->recovery_range_start_time; + } + + public function hasRecoveryRangeStartTime() + { + return isset($this->recovery_range_start_time); + } + + public function clearRecoveryRangeStartTime() + { + unset($this->recovery_range_start_time); + } + + /** + * Optional. The earliest timestamp of data available in this Backup. + * + * Generated from protobuf field optional .google.protobuf.Timestamp recovery_range_start_time = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setRecoveryRangeStartTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->recovery_range_start_time = $var; + + return $this; + } + + /** + * Optional. The latest timestamp of data available in this Backup. + * + * Generated from protobuf field optional .google.protobuf.Timestamp recovery_range_end_time = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getRecoveryRangeEndTime() + { + return $this->recovery_range_end_time; + } + + public function hasRecoveryRangeEndTime() + { + return isset($this->recovery_range_end_time); + } + + public function clearRecoveryRangeEndTime() + { + unset($this->recovery_range_end_time); + } + + /** + * Optional. The latest timestamp of data available in this Backup. + * + * Generated from protobuf field optional .google.protobuf.Timestamp recovery_range_end_time = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setRecoveryRangeEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->recovery_range_end_time = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/BackupApplianceLockInfo.php b/BackupDr/src/V1/BackupApplianceLockInfo.php new file mode 100644 index 000000000000..f024d90f7bd8 --- /dev/null +++ b/BackupDr/src/V1/BackupApplianceLockInfo.php @@ -0,0 +1,252 @@ +google.cloud.backupdr.v1.BackupApplianceLockInfo + */ +class BackupApplianceLockInfo extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The ID of the backup/recovery appliance that created this lock. + * + * Generated from protobuf field int64 backup_appliance_id = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_appliance_id = 0; + /** + * Required. The name of the backup/recovery appliance that created this lock. + * + * Generated from protobuf field string backup_appliance_name = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_appliance_name = ''; + /** + * Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The + * value of this string is only meaningful to the client and it is not + * interpreted by the BackupVault service. + * + * Generated from protobuf field string lock_reason = 5 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $lock_reason = ''; + protected $lock_source; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $backup_appliance_id + * Required. The ID of the backup/recovery appliance that created this lock. + * @type string $backup_appliance_name + * Required. The name of the backup/recovery appliance that created this lock. + * @type string $lock_reason + * Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The + * value of this string is only meaningful to the client and it is not + * interpreted by the BackupVault service. + * @type string $job_name + * The job name on the backup/recovery appliance that created this lock. + * @type string $backup_image + * The image name that depends on this Backup. + * @type int|string $sla_id + * The SLA on the backup/recovery appliance that owns the lock. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. The ID of the backup/recovery appliance that created this lock. + * + * Generated from protobuf field int64 backup_appliance_id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return int|string + */ + public function getBackupApplianceId() + { + return $this->backup_appliance_id; + } + + /** + * Required. The ID of the backup/recovery appliance that created this lock. + * + * Generated from protobuf field int64 backup_appliance_id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param int|string $var + * @return $this + */ + public function setBackupApplianceId($var) + { + GPBUtil::checkInt64($var); + $this->backup_appliance_id = $var; + + return $this; + } + + /** + * Required. The name of the backup/recovery appliance that created this lock. + * + * Generated from protobuf field string backup_appliance_name = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getBackupApplianceName() + { + return $this->backup_appliance_name; + } + + /** + * Required. The name of the backup/recovery appliance that created this lock. + * + * Generated from protobuf field string backup_appliance_name = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setBackupApplianceName($var) + { + GPBUtil::checkString($var, True); + $this->backup_appliance_name = $var; + + return $this; + } + + /** + * Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The + * value of this string is only meaningful to the client and it is not + * interpreted by the BackupVault service. + * + * Generated from protobuf field string lock_reason = 5 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getLockReason() + { + return $this->lock_reason; + } + + /** + * Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The + * value of this string is only meaningful to the client and it is not + * interpreted by the BackupVault service. + * + * Generated from protobuf field string lock_reason = 5 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setLockReason($var) + { + GPBUtil::checkString($var, True); + $this->lock_reason = $var; + + return $this; + } + + /** + * The job name on the backup/recovery appliance that created this lock. + * + * Generated from protobuf field string job_name = 6; + * @return string + */ + public function getJobName() + { + return $this->readOneof(6); + } + + public function hasJobName() + { + return $this->hasOneof(6); + } + + /** + * The job name on the backup/recovery appliance that created this lock. + * + * Generated from protobuf field string job_name = 6; + * @param string $var + * @return $this + */ + public function setJobName($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(6, $var); + + return $this; + } + + /** + * The image name that depends on this Backup. + * + * Generated from protobuf field string backup_image = 7; + * @return string + */ + public function getBackupImage() + { + return $this->readOneof(7); + } + + public function hasBackupImage() + { + return $this->hasOneof(7); + } + + /** + * The image name that depends on this Backup. + * + * Generated from protobuf field string backup_image = 7; + * @param string $var + * @return $this + */ + public function setBackupImage($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(7, $var); + + return $this; + } + + /** + * The SLA on the backup/recovery appliance that owns the lock. + * + * Generated from protobuf field int64 sla_id = 8; + * @return int|string + */ + public function getSlaId() + { + return $this->readOneof(8); + } + + public function hasSlaId() + { + return $this->hasOneof(8); + } + + /** + * The SLA on the backup/recovery appliance that owns the lock. + * + * Generated from protobuf field int64 sla_id = 8; + * @param int|string $var + * @return $this + */ + public function setSlaId($var) + { + GPBUtil::checkInt64($var); + $this->writeOneof(8, $var); + + return $this; + } + + /** + * @return string + */ + public function getLockSource() + { + return $this->whichOneof("lock_source"); + } + +} + diff --git a/BackupDr/src/V1/BackupConfigInfo.php b/BackupDr/src/V1/BackupConfigInfo.php new file mode 100644 index 000000000000..910ef56ebd1e --- /dev/null +++ b/BackupDr/src/V1/BackupConfigInfo.php @@ -0,0 +1,235 @@ +google.cloud.backupdr.v1.BackupConfigInfo + */ +class BackupConfigInfo extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The status of the last backup to this BackupVault + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigInfo.LastBackupState last_backup_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $last_backup_state = 0; + /** + * Output only. If the last backup were successful, this field has the + * consistency date. + * + * Generated from protobuf field .google.protobuf.Timestamp last_successful_backup_consistency_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $last_successful_backup_consistency_time = null; + /** + * Output only. If the last backup failed, this field has the error message. + * + * Generated from protobuf field .google.rpc.Status last_backup_error = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $last_backup_error = null; + protected $backup_config; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $last_backup_state + * Output only. The status of the last backup to this BackupVault + * @type \Google\Protobuf\Timestamp $last_successful_backup_consistency_time + * Output only. If the last backup were successful, this field has the + * consistency date. + * @type \Google\Rpc\Status $last_backup_error + * Output only. If the last backup failed, this field has the error message. + * @type \Google\Cloud\BackupDR\V1\GcpBackupConfig $gcp_backup_config + * Configuration for a Google Cloud resource. + * @type \Google\Cloud\BackupDR\V1\BackupApplianceBackupConfig $backup_appliance_backup_config + * Configuration for an application backed up by a Backup Appliance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The status of the last backup to this BackupVault + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigInfo.LastBackupState last_backup_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getLastBackupState() + { + return $this->last_backup_state; + } + + /** + * Output only. The status of the last backup to this BackupVault + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigInfo.LastBackupState last_backup_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setLastBackupState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupConfigInfo\LastBackupState::class); + $this->last_backup_state = $var; + + return $this; + } + + /** + * Output only. If the last backup were successful, this field has the + * consistency date. + * + * Generated from protobuf field .google.protobuf.Timestamp last_successful_backup_consistency_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getLastSuccessfulBackupConsistencyTime() + { + return $this->last_successful_backup_consistency_time; + } + + public function hasLastSuccessfulBackupConsistencyTime() + { + return isset($this->last_successful_backup_consistency_time); + } + + public function clearLastSuccessfulBackupConsistencyTime() + { + unset($this->last_successful_backup_consistency_time); + } + + /** + * Output only. If the last backup were successful, this field has the + * consistency date. + * + * Generated from protobuf field .google.protobuf.Timestamp last_successful_backup_consistency_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setLastSuccessfulBackupConsistencyTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->last_successful_backup_consistency_time = $var; + + return $this; + } + + /** + * Output only. If the last backup failed, this field has the error message. + * + * Generated from protobuf field .google.rpc.Status last_backup_error = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Rpc\Status|null + */ + public function getLastBackupError() + { + return $this->last_backup_error; + } + + public function hasLastBackupError() + { + return isset($this->last_backup_error); + } + + public function clearLastBackupError() + { + unset($this->last_backup_error); + } + + /** + * Output only. If the last backup failed, this field has the error message. + * + * Generated from protobuf field .google.rpc.Status last_backup_error = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Rpc\Status $var + * @return $this + */ + public function setLastBackupError($var) + { + GPBUtil::checkMessage($var, \Google\Rpc\Status::class); + $this->last_backup_error = $var; + + return $this; + } + + /** + * Configuration for a Google Cloud resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.GcpBackupConfig gcp_backup_config = 4; + * @return \Google\Cloud\BackupDR\V1\GcpBackupConfig|null + */ + public function getGcpBackupConfig() + { + return $this->readOneof(4); + } + + public function hasGcpBackupConfig() + { + return $this->hasOneof(4); + } + + /** + * Configuration for a Google Cloud resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.GcpBackupConfig gcp_backup_config = 4; + * @param \Google\Cloud\BackupDR\V1\GcpBackupConfig $var + * @return $this + */ + public function setGcpBackupConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\GcpBackupConfig::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * Configuration for an application backed up by a Backup Appliance. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupApplianceBackupConfig backup_appliance_backup_config = 5; + * @return \Google\Cloud\BackupDR\V1\BackupApplianceBackupConfig|null + */ + public function getBackupApplianceBackupConfig() + { + return $this->readOneof(5); + } + + public function hasBackupApplianceBackupConfig() + { + return $this->hasOneof(5); + } + + /** + * Configuration for an application backed up by a Backup Appliance. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupApplianceBackupConfig backup_appliance_backup_config = 5; + * @param \Google\Cloud\BackupDR\V1\BackupApplianceBackupConfig $var + * @return $this + */ + public function setBackupApplianceBackupConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupApplianceBackupConfig::class); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * @return string + */ + public function getBackupConfig() + { + return $this->whichOneof("backup_config"); + } + +} + diff --git a/BackupDr/src/V1/BackupConfigInfo/LastBackupState.php b/BackupDr/src/V1/BackupConfigInfo/LastBackupState.php new file mode 100644 index 000000000000..a451de244b95 --- /dev/null +++ b/BackupDr/src/V1/BackupConfigInfo/LastBackupState.php @@ -0,0 +1,78 @@ +google.cloud.backupdr.v1.BackupConfigInfo.LastBackupState + */ +class LastBackupState +{ + /** + * Status not set. + * + * Generated from protobuf enum LAST_BACKUP_STATE_UNSPECIFIED = 0; + */ + const LAST_BACKUP_STATE_UNSPECIFIED = 0; + /** + * The first backup has not yet completed + * + * Generated from protobuf enum FIRST_BACKUP_PENDING = 1; + */ + const FIRST_BACKUP_PENDING = 1; + /** + * The most recent backup was successful + * + * Generated from protobuf enum SUCCEEDED = 2; + */ + const SUCCEEDED = 2; + /** + * The most recent backup failed + * + * Generated from protobuf enum FAILED = 3; + */ + const FAILED = 3; + /** + * The most recent backup could not be run/failed because of the lack of + * permissions + * + * Generated from protobuf enum PERMISSION_DENIED = 4; + */ + const PERMISSION_DENIED = 4; + + private static $valueToName = [ + self::LAST_BACKUP_STATE_UNSPECIFIED => 'LAST_BACKUP_STATE_UNSPECIFIED', + self::FIRST_BACKUP_PENDING => 'FIRST_BACKUP_PENDING', + self::SUCCEEDED => 'SUCCEEDED', + self::FAILED => 'FAILED', + self::PERMISSION_DENIED => 'PERMISSION_DENIED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/BackupConfigState.php b/BackupDr/src/V1/BackupConfigState.php new file mode 100644 index 000000000000..8c760774704c --- /dev/null +++ b/BackupDr/src/V1/BackupConfigState.php @@ -0,0 +1,63 @@ +google.cloud.backupdr.v1.BackupConfigState + */ +class BackupConfigState +{ + /** + * The possible states of backup configuration. + * Status not set. + * + * Generated from protobuf enum BACKUP_CONFIG_STATE_UNSPECIFIED = 0; + */ + const BACKUP_CONFIG_STATE_UNSPECIFIED = 0; + /** + * The data source is actively protected (i.e. there is a + * BackupPlanAssociation or Appliance SLA pointing to it) + * + * Generated from protobuf enum ACTIVE = 1; + */ + const ACTIVE = 1; + /** + * The data source is no longer protected (but may have backups under it) + * + * Generated from protobuf enum PASSIVE = 2; + */ + const PASSIVE = 2; + + private static $valueToName = [ + self::BACKUP_CONFIG_STATE_UNSPECIFIED => 'BACKUP_CONFIG_STATE_UNSPECIFIED', + self::ACTIVE => 'ACTIVE', + self::PASSIVE => 'PASSIVE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/BackupDr/src/V1/BackupLock.php b/BackupDr/src/V1/BackupLock.php new file mode 100644 index 000000000000..16c344cda822 --- /dev/null +++ b/BackupDr/src/V1/BackupLock.php @@ -0,0 +1,163 @@ +google.cloud.backupdr.v1.BackupLock + */ +class BackupLock extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The time after which this lock is not considered valid and will + * no longer protect the Backup from deletion. + * + * Generated from protobuf field .google.protobuf.Timestamp lock_until_time = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $lock_until_time = null; + protected $ClientLockInfo; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Timestamp $lock_until_time + * Required. The time after which this lock is not considered valid and will + * no longer protect the Backup from deletion. + * @type \Google\Cloud\BackupDR\V1\BackupApplianceLockInfo $backup_appliance_lock_info + * If the client is a backup and recovery appliance, this + * contains metadata about why the lock exists. + * @type \Google\Cloud\BackupDR\V1\ServiceLockInfo $service_lock_info + * Output only. Contains metadata about the lock exist for Google Cloud + * native backups. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. The time after which this lock is not considered valid and will + * no longer protect the Backup from deletion. + * + * Generated from protobuf field .google.protobuf.Timestamp lock_until_time = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getLockUntilTime() + { + return $this->lock_until_time; + } + + public function hasLockUntilTime() + { + return isset($this->lock_until_time); + } + + public function clearLockUntilTime() + { + unset($this->lock_until_time); + } + + /** + * Required. The time after which this lock is not considered valid and will + * no longer protect the Backup from deletion. + * + * Generated from protobuf field .google.protobuf.Timestamp lock_until_time = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setLockUntilTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->lock_until_time = $var; + + return $this; + } + + /** + * If the client is a backup and recovery appliance, this + * contains metadata about why the lock exists. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupApplianceLockInfo backup_appliance_lock_info = 3; + * @return \Google\Cloud\BackupDR\V1\BackupApplianceLockInfo|null + */ + public function getBackupApplianceLockInfo() + { + return $this->readOneof(3); + } + + public function hasBackupApplianceLockInfo() + { + return $this->hasOneof(3); + } + + /** + * If the client is a backup and recovery appliance, this + * contains metadata about why the lock exists. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupApplianceLockInfo backup_appliance_lock_info = 3; + * @param \Google\Cloud\BackupDR\V1\BackupApplianceLockInfo $var + * @return $this + */ + public function setBackupApplianceLockInfo($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupApplianceLockInfo::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Output only. Contains metadata about the lock exist for Google Cloud + * native backups. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ServiceLockInfo service_lock_info = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\BackupDR\V1\ServiceLockInfo|null + */ + public function getServiceLockInfo() + { + return $this->readOneof(4); + } + + public function hasServiceLockInfo() + { + return $this->hasOneof(4); + } + + /** + * Output only. Contains metadata about the lock exist for Google Cloud + * native backups. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ServiceLockInfo service_lock_info = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\BackupDR\V1\ServiceLockInfo $var + * @return $this + */ + public function setServiceLockInfo($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\ServiceLockInfo::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * @return string + */ + public function getClientLockInfo() + { + return $this->whichOneof("ClientLockInfo"); + } + +} + diff --git a/BackupDr/src/V1/BackupPlan.php b/BackupDr/src/V1/BackupPlan.php new file mode 100644 index 000000000000..5f4feca856b7 --- /dev/null +++ b/BackupDr/src/V1/BackupPlan.php @@ -0,0 +1,490 @@ +google.cloud.backupdr.v1.BackupPlan + */ +class BackupPlan extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Identifier. The resource name of the `BackupPlan`. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Optional. The description of the `BackupPlan` resource. + * The description allows for additional details about `BackupPlan` and its + * use cases to be provided. An example description is the following: "This + * is a backup plan that performs a daily backup at 6pm and retains data for 3 + * months". The description must be at most 2048 characters. + * + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $description = ''; + /** + * Optional. This collection of key/value pairs allows for custom labels to be + * supplied by the user. Example, {"tag": "Weekly"}. + * + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Output only. When the `BackupPlan` was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. When the `BackupPlan` was last updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Required. The backup rules for this `BackupPlan`. There must be at least + * one `BackupRule` message. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED]; + */ + private $backup_rules; + /** + * Output only. The `State` for the `BackupPlan`. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $state = 0; + /** + * Required. The resource type to which the `BackupPlan` will be applied. + * Examples include, "compute.googleapis.com/Instance" and + * "storage.googleapis.com/Bucket". + * + * Generated from protobuf field string resource_type = 8 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $resource_type = ''; + /** + * Optional. `etag` is returned from the service in the response. As a user of + * the service, you may provide an etag value in this field to prevent stale + * resources. + * + * Generated from protobuf field string etag = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = ''; + /** + * Required. Resource name of backup vault which will be used as storage + * location for backups. Format: + * projects/{project}/locations/{location}/backupVaults/{backupvault} + * + * Generated from protobuf field string backup_vault = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $backup_vault = ''; + /** + * Output only. The Google Cloud Platform Service Account to be used by the + * BackupVault for taking backups. Specify the email address of the Backup + * Vault Service Account. + * + * Generated from protobuf field string backup_vault_service_account = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $backup_vault_service_account = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Output only. Identifier. The resource name of the `BackupPlan`. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * @type string $description + * Optional. The description of the `BackupPlan` resource. + * The description allows for additional details about `BackupPlan` and its + * use cases to be provided. An example description is the following: "This + * is a backup plan that performs a daily backup at 6pm and retains data for 3 + * months". The description must be at most 2048 characters. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. This collection of key/value pairs allows for custom labels to be + * supplied by the user. Example, {"tag": "Weekly"}. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. When the `BackupPlan` was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. When the `BackupPlan` was last updated. + * @type array<\Google\Cloud\BackupDR\V1\BackupRule>|\Google\Protobuf\Internal\RepeatedField $backup_rules + * Required. The backup rules for this `BackupPlan`. There must be at least + * one `BackupRule` message. + * @type int $state + * Output only. The `State` for the `BackupPlan`. + * @type string $resource_type + * Required. The resource type to which the `BackupPlan` will be applied. + * Examples include, "compute.googleapis.com/Instance" and + * "storage.googleapis.com/Bucket". + * @type string $etag + * Optional. `etag` is returned from the service in the response. As a user of + * the service, you may provide an etag value in this field to prevent stale + * resources. + * @type string $backup_vault + * Required. Resource name of backup vault which will be used as storage + * location for backups. Format: + * projects/{project}/locations/{location}/backupVaults/{backupvault} + * @type string $backup_vault_service_account + * Output only. The Google Cloud Platform Service Account to be used by the + * BackupVault for taking backups. Specify the email address of the Backup + * Vault Service Account. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Identifier. The resource name of the `BackupPlan`. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Output only. Identifier. The resource name of the `BackupPlan`. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. The description of the `BackupPlan` resource. + * The description allows for additional details about `BackupPlan` and its + * use cases to be provided. An example description is the following: "This + * is a backup plan that performs a daily backup at 6pm and retains data for 3 + * months". The description must be at most 2048 characters. + * + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDescription() + { + return $this->description; + } + + /** + * Optional. The description of the `BackupPlan` resource. + * The description allows for additional details about `BackupPlan` and its + * use cases to be provided. An example description is the following: "This + * is a backup plan that performs a daily backup at 6pm and retains data for 3 + * months". The description must be at most 2048 characters. + * + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Optional. This collection of key/value pairs allows for custom labels to be + * supplied by the user. Example, {"tag": "Weekly"}. + * + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. This collection of key/value pairs allows for custom labels to be + * supplied by the user. Example, {"tag": "Weekly"}. + * + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Output only. When the `BackupPlan` was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. When the `BackupPlan` was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. When the `BackupPlan` was last updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. When the `BackupPlan` was last updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Required. The backup rules for this `BackupPlan`. There must be at least + * one `BackupRule` message. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBackupRules() + { + return $this->backup_rules; + } + + /** + * Required. The backup rules for this `BackupPlan`. There must be at least + * one `BackupRule` message. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Cloud\BackupDR\V1\BackupRule>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBackupRules($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\BackupRule::class); + $this->backup_rules = $arr; + + return $this; + } + + /** + * Output only. The `State` for the `BackupPlan`. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getState() + { + return $this->state; + } + + /** + * Output only. The `State` for the `BackupPlan`. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupPlan\State::class); + $this->state = $var; + + return $this; + } + + /** + * Required. The resource type to which the `BackupPlan` will be applied. + * Examples include, "compute.googleapis.com/Instance" and + * "storage.googleapis.com/Bucket". + * + * Generated from protobuf field string resource_type = 8 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getResourceType() + { + return $this->resource_type; + } + + /** + * Required. The resource type to which the `BackupPlan` will be applied. + * Examples include, "compute.googleapis.com/Instance" and + * "storage.googleapis.com/Bucket". + * + * Generated from protobuf field string resource_type = 8 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setResourceType($var) + { + GPBUtil::checkString($var, True); + $this->resource_type = $var; + + return $this; + } + + /** + * Optional. `etag` is returned from the service in the response. As a user of + * the service, you may provide an etag value in this field to prevent stale + * resources. + * + * Generated from protobuf field string etag = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Optional. `etag` is returned from the service in the response. As a user of + * the service, you may provide an etag value in this field to prevent stale + * resources. + * + * Generated from protobuf field string etag = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Required. Resource name of backup vault which will be used as storage + * location for backups. Format: + * projects/{project}/locations/{location}/backupVaults/{backupvault} + * + * Generated from protobuf field string backup_vault = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getBackupVault() + { + return $this->backup_vault; + } + + /** + * Required. Resource name of backup vault which will be used as storage + * location for backups. Format: + * projects/{project}/locations/{location}/backupVaults/{backupvault} + * + * Generated from protobuf field string backup_vault = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setBackupVault($var) + { + GPBUtil::checkString($var, True); + $this->backup_vault = $var; + + return $this; + } + + /** + * Output only. The Google Cloud Platform Service Account to be used by the + * BackupVault for taking backups. Specify the email address of the Backup + * Vault Service Account. + * + * Generated from protobuf field string backup_vault_service_account = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getBackupVaultServiceAccount() + { + return $this->backup_vault_service_account; + } + + /** + * Output only. The Google Cloud Platform Service Account to be used by the + * BackupVault for taking backups. Specify the email address of the Backup + * Vault Service Account. + * + * Generated from protobuf field string backup_vault_service_account = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setBackupVaultServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->backup_vault_service_account = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/BackupPlan/State.php b/BackupDr/src/V1/BackupPlan/State.php new file mode 100644 index 000000000000..81636c4e541e --- /dev/null +++ b/BackupDr/src/V1/BackupPlan/State.php @@ -0,0 +1,76 @@ +google.cloud.backupdr.v1.BackupPlan.State + */ +class State +{ + /** + * State not set. + * + * Generated from protobuf enum STATE_UNSPECIFIED = 0; + */ + const STATE_UNSPECIFIED = 0; + /** + * The resource is being created. + * + * Generated from protobuf enum CREATING = 1; + */ + const CREATING = 1; + /** + * The resource has been created and is fully usable. + * + * Generated from protobuf enum ACTIVE = 2; + */ + const ACTIVE = 2; + /** + * The resource is being deleted. + * + * Generated from protobuf enum DELETING = 3; + */ + const DELETING = 3; + /** + * The resource has been created but is not usable. + * + * Generated from protobuf enum INACTIVE = 4; + */ + const INACTIVE = 4; + + private static $valueToName = [ + self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', + self::CREATING => 'CREATING', + self::ACTIVE => 'ACTIVE', + self::DELETING => 'DELETING', + self::INACTIVE => 'INACTIVE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/BackupPlanAssociation.php b/BackupDr/src/V1/BackupPlanAssociation.php new file mode 100644 index 000000000000..2a5804c13ae5 --- /dev/null +++ b/BackupDr/src/V1/BackupPlanAssociation.php @@ -0,0 +1,396 @@ +google.cloud.backupdr.v1.BackupPlanAssociation + */ +class BackupPlanAssociation extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Identifier. The resource name of BackupPlanAssociation in + * below format Format : + * projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $name = ''; + /** + * Optional. Resource type of workload on which backupplan is applied + * + * Generated from protobuf field string resource_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $resource_type = ''; + /** + * Required. Immutable. Resource name of workload on which backupplan is + * applied + * + * Generated from protobuf field string resource = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + */ + protected $resource = ''; + /** + * Required. Resource name of backup plan which needs to be applied on + * workload. Format: + * projects/{project}/locations/{location}/backupPlans/{backupPlanId} + * + * Generated from protobuf field string backup_plan = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $backup_plan = ''; + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Output only. The BackupPlanAssociation resource state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlanAssociation.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $state = 0; + /** + * Output only. The config info related to backup rules. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.RuleConfigInfo rules_config_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $rules_config_info; + /** + * Output only. Output Only. + * Resource name of data source which will be used as storage location for + * backups taken. + * Format : + * projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} + * + * Generated from protobuf field string data_source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $data_source = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Output only. Identifier. The resource name of BackupPlanAssociation in + * below format Format : + * projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} + * @type string $resource_type + * Optional. Resource type of workload on which backupplan is applied + * @type string $resource + * Required. Immutable. Resource name of workload on which backupplan is + * applied + * @type string $backup_plan + * Required. Resource name of backup plan which needs to be applied on + * workload. Format: + * projects/{project}/locations/{location}/backupPlans/{backupPlanId} + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the instance was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the instance was updated. + * @type int $state + * Output only. The BackupPlanAssociation resource state. + * @type array<\Google\Cloud\BackupDR\V1\RuleConfigInfo>|\Google\Protobuf\Internal\RepeatedField $rules_config_info + * Output only. The config info related to backup rules. + * @type string $data_source + * Output only. Output Only. + * Resource name of data source which will be used as storage location for + * backups taken. + * Format : + * projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplanassociation::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Identifier. The resource name of BackupPlanAssociation in + * below format Format : + * projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Output only. Identifier. The resource name of BackupPlanAssociation in + * below format Format : + * projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. Resource type of workload on which backupplan is applied + * + * Generated from protobuf field string resource_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getResourceType() + { + return $this->resource_type; + } + + /** + * Optional. Resource type of workload on which backupplan is applied + * + * Generated from protobuf field string resource_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setResourceType($var) + { + GPBUtil::checkString($var, True); + $this->resource_type = $var; + + return $this; + } + + /** + * Required. Immutable. Resource name of workload on which backupplan is + * applied + * + * Generated from protobuf field string resource = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getResource() + { + return $this->resource; + } + + /** + * Required. Immutable. Resource name of workload on which backupplan is + * applied + * + * Generated from protobuf field string resource = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setResource($var) + { + GPBUtil::checkString($var, True); + $this->resource = $var; + + return $this; + } + + /** + * Required. Resource name of backup plan which needs to be applied on + * workload. Format: + * projects/{project}/locations/{location}/backupPlans/{backupPlanId} + * + * Generated from protobuf field string backup_plan = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getBackupPlan() + { + return $this->backup_plan; + } + + /** + * Required. Resource name of backup plan which needs to be applied on + * workload. Format: + * projects/{project}/locations/{location}/backupPlans/{backupPlanId} + * + * Generated from protobuf field string backup_plan = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setBackupPlan($var) + { + GPBUtil::checkString($var, True); + $this->backup_plan = $var; + + return $this; + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Output only. The BackupPlanAssociation resource state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlanAssociation.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getState() + { + return $this->state; + } + + /** + * Output only. The BackupPlanAssociation resource state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlanAssociation.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupPlanAssociation\State::class); + $this->state = $var; + + return $this; + } + + /** + * Output only. The config info related to backup rules. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.RuleConfigInfo rules_config_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRulesConfigInfo() + { + return $this->rules_config_info; + } + + /** + * Output only. The config info related to backup rules. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.RuleConfigInfo rules_config_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array<\Google\Cloud\BackupDR\V1\RuleConfigInfo>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRulesConfigInfo($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\RuleConfigInfo::class); + $this->rules_config_info = $arr; + + return $this; + } + + /** + * Output only. Output Only. + * Resource name of data source which will be used as storage location for + * backups taken. + * Format : + * projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} + * + * Generated from protobuf field string data_source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getDataSource() + { + return $this->data_source; + } + + /** + * Output only. Output Only. + * Resource name of data source which will be used as storage location for + * backups taken. + * Format : + * projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} + * + * Generated from protobuf field string data_source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setDataSource($var) + { + GPBUtil::checkString($var, True); + $this->data_source = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/BackupPlanAssociation/State.php b/BackupDr/src/V1/BackupPlanAssociation/State.php new file mode 100644 index 000000000000..5b9acba42bd6 --- /dev/null +++ b/BackupDr/src/V1/BackupPlanAssociation/State.php @@ -0,0 +1,76 @@ +google.cloud.backupdr.v1.BackupPlanAssociation.State + */ +class State +{ + /** + * State not set. + * + * Generated from protobuf enum STATE_UNSPECIFIED = 0; + */ + const STATE_UNSPECIFIED = 0; + /** + * The resource is being created. + * + * Generated from protobuf enum CREATING = 1; + */ + const CREATING = 1; + /** + * The resource has been created and is fully usable. + * + * Generated from protobuf enum ACTIVE = 2; + */ + const ACTIVE = 2; + /** + * The resource is being deleted. + * + * Generated from protobuf enum DELETING = 3; + */ + const DELETING = 3; + /** + * The resource has been created but is not usable. + * + * Generated from protobuf enum INACTIVE = 4; + */ + const INACTIVE = 4; + + private static $valueToName = [ + self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', + self::CREATING => 'CREATING', + self::ACTIVE => 'ACTIVE', + self::DELETING => 'DELETING', + self::INACTIVE => 'INACTIVE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/BackupRule.php b/BackupDr/src/V1/BackupRule.php new file mode 100644 index 000000000000..a66eb5362db0 --- /dev/null +++ b/BackupDr/src/V1/BackupRule.php @@ -0,0 +1,166 @@ +google.cloud.backupdr.v1.BackupRule + */ +class BackupRule extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is + * unique per `BackupPlan`.The `rule_id` must start with a lowercase letter + * followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, + * /[a-z][a-z0-9-]{,62}/. + * + * Generated from protobuf field string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; + */ + protected $rule_id = ''; + /** + * Required. 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. + * + * Generated from protobuf field int32 backup_retention_days = 4 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_retention_days = 0; + protected $backup_schedule_oneof; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $rule_id + * Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is + * unique per `BackupPlan`.The `rule_id` must start with a lowercase letter + * followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, + * /[a-z][a-z0-9-]{,62}/. + * @type int $backup_retention_days + * Required. 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. + * @type \Google\Cloud\BackupDR\V1\StandardSchedule $standard_schedule + * Required. Defines a schedule that runs within the confines of a defined + * window of time. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is + * unique per `BackupPlan`.The `rule_id` must start with a lowercase letter + * followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, + * /[a-z][a-z0-9-]{,62}/. + * + * Generated from protobuf field string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; + * @return string + */ + public function getRuleId() + { + return $this->rule_id; + } + + /** + * Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is + * unique per `BackupPlan`.The `rule_id` must start with a lowercase letter + * followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, + * /[a-z][a-z0-9-]{,62}/. + * + * Generated from protobuf field string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; + * @param string $var + * @return $this + */ + public function setRuleId($var) + { + GPBUtil::checkString($var, True); + $this->rule_id = $var; + + return $this; + } + + /** + * Required. 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. + * + * Generated from protobuf field int32 backup_retention_days = 4 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getBackupRetentionDays() + { + return $this->backup_retention_days; + } + + /** + * Required. 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. + * + * Generated from protobuf field int32 backup_retention_days = 4 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setBackupRetentionDays($var) + { + GPBUtil::checkInt32($var); + $this->backup_retention_days = $var; + + return $this; + } + + /** + * Required. Defines a schedule that runs within the confines of a defined + * window of time. + * + * Generated from protobuf field .google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\BackupDR\V1\StandardSchedule|null + */ + public function getStandardSchedule() + { + return $this->readOneof(5); + } + + public function hasStandardSchedule() + { + return $this->hasOneof(5); + } + + /** + * Required. Defines a schedule that runs within the confines of a defined + * window of time. + * + * Generated from protobuf field .google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\BackupDR\V1\StandardSchedule $var + * @return $this + */ + public function setStandardSchedule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\StandardSchedule::class); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * @return string + */ + public function getBackupScheduleOneof() + { + return $this->whichOneof("backup_schedule_oneof"); + } + +} + diff --git a/BackupDr/src/V1/BackupVault.php b/BackupDr/src/V1/BackupVault.php new file mode 100644 index 000000000000..03d965e14bae --- /dev/null +++ b/BackupDr/src/V1/BackupVault.php @@ -0,0 +1,715 @@ +google.cloud.backupdr.v1.BackupVault + */ +class BackupVault extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Identifier. Name of the backup vault to create. It must have + * the + * format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. + * `{backupvault}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the project and location. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Optional. The description of the BackupVault instance (2048 characters or + * less). + * + * Generated from protobuf field optional string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $description = null; + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined: + * + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Required. The default and minimum enforced retention for each backup within + * the backup vault. The enforced retention for each backup can be extended. + * + * Generated from protobuf field optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_minimum_enforced_retention_duration = null; + /** + * Output only. Set to true when there are no backups nested under this + * resource. + * + * Generated from protobuf field optional bool deletable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $deletable = null; + /** + * Optional. Server specified ETag for the backup vault resource to + * prevent simultaneous updates from overwiting each other. + * + * Generated from protobuf field optional string etag = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = null; + /** + * Output only. The BackupVault resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $state = 0; + /** + * Optional. Time after which the BackupVault resource is locked. + * + * Generated from protobuf field optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $effective_time = null; + /** + * Output only. The number of backups in this backup vault. + * + * Generated from protobuf field int64 backup_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $backup_count = 0; + /** + * Output only. Service account used by the BackupVault Service for this + * BackupVault. The user should grant this account permissions in their + * workload project to enable the service to run backups and restores there. + * + * Generated from protobuf field string service_account = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $service_account = ''; + /** + * Output only. Total size of the storage used by all backup resources. + * + * Generated from protobuf field int64 total_stored_bytes = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $total_stored_bytes = 0; + /** + * Output only. Output only + * Immutable after resource creation until resource deletion. + * + * Generated from protobuf field string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + */ + protected $uid = ''; + /** + * Optional. User annotations. See https://google.aip.dev/128#annotations + * Stores small amounts of arbitrary data. + * + * Generated from protobuf field map annotations = 22 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; + /** + * Optional. Note: This field is added for future use case and will not be + * supported in the current release. + * Optional. + * Access restriction for the backup vault. + * Default value is WITHIN_ORGANIZATION if not provided during creation. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault.AccessRestriction access_restriction = 24 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $access_restriction = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Output only. Identifier. Name of the backup vault to create. It must have + * the + * format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. + * `{backupvault}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the project and location. + * @type string $description + * Optional. The description of the BackupVault instance (2048 characters or + * less). + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined: + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the instance was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the instance was updated. + * @type \Google\Protobuf\Duration $backup_minimum_enforced_retention_duration + * Required. The default and minimum enforced retention for each backup within + * the backup vault. The enforced retention for each backup can be extended. + * @type bool $deletable + * Output only. Set to true when there are no backups nested under this + * resource. + * @type string $etag + * Optional. Server specified ETag for the backup vault resource to + * prevent simultaneous updates from overwiting each other. + * @type int $state + * Output only. The BackupVault resource instance state. + * @type \Google\Protobuf\Timestamp $effective_time + * Optional. Time after which the BackupVault resource is locked. + * @type int|string $backup_count + * Output only. The number of backups in this backup vault. + * @type string $service_account + * Output only. Service account used by the BackupVault Service for this + * BackupVault. The user should grant this account permissions in their + * workload project to enable the service to run backups and restores there. + * @type int|string $total_stored_bytes + * Output only. Total size of the storage used by all backup resources. + * @type string $uid + * Output only. Output only + * Immutable after resource creation until resource deletion. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. User annotations. See https://google.aip.dev/128#annotations + * Stores small amounts of arbitrary data. + * @type int $access_restriction + * Optional. Note: This field is added for future use case and will not be + * supported in the current release. + * Optional. + * Access restriction for the backup vault. + * Default value is WITHIN_ORGANIZATION if not provided during creation. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Identifier. Name of the backup vault to create. It must have + * the + * format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. + * `{backupvault}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the project and location. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Output only. Identifier. Name of the backup vault to create. It must have + * the + * format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. + * `{backupvault}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the project and location. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. The description of the BackupVault instance (2048 characters or + * less). + * + * Generated from protobuf field optional string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDescription() + { + return isset($this->description) ? $this->description : ''; + } + + public function hasDescription() + { + return isset($this->description); + } + + public function clearDescription() + { + unset($this->description); + } + + /** + * Optional. The description of the BackupVault instance (2048 characters or + * less). + * + * Generated from protobuf field optional string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined: + * + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined: + * + * Generated from protobuf field map labels = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Required. The default and minimum enforced retention for each backup within + * the backup vault. The enforced retention for each backup can be extended. + * + * Generated from protobuf field optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Duration|null + */ + public function getBackupMinimumEnforcedRetentionDuration() + { + return $this->backup_minimum_enforced_retention_duration; + } + + public function hasBackupMinimumEnforcedRetentionDuration() + { + return isset($this->backup_minimum_enforced_retention_duration); + } + + public function clearBackupMinimumEnforcedRetentionDuration() + { + unset($this->backup_minimum_enforced_retention_duration); + } + + /** + * Required. The default and minimum enforced retention for each backup within + * the backup vault. The enforced retention for each backup can be extended. + * + * Generated from protobuf field optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setBackupMinimumEnforcedRetentionDuration($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->backup_minimum_enforced_retention_duration = $var; + + return $this; + } + + /** + * Output only. Set to true when there are no backups nested under this + * resource. + * + * Generated from protobuf field optional bool deletable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getDeletable() + { + return isset($this->deletable) ? $this->deletable : false; + } + + public function hasDeletable() + { + return isset($this->deletable); + } + + public function clearDeletable() + { + unset($this->deletable); + } + + /** + * Output only. Set to true when there are no backups nested under this + * resource. + * + * Generated from protobuf field optional bool deletable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setDeletable($var) + { + GPBUtil::checkBool($var); + $this->deletable = $var; + + return $this; + } + + /** + * Optional. Server specified ETag for the backup vault resource to + * prevent simultaneous updates from overwiting each other. + * + * Generated from protobuf field optional string etag = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return isset($this->etag) ? $this->etag : ''; + } + + public function hasEtag() + { + return isset($this->etag); + } + + public function clearEtag() + { + unset($this->etag); + } + + /** + * Optional. Server specified ETag for the backup vault resource to + * prevent simultaneous updates from overwiting each other. + * + * Generated from protobuf field optional string etag = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Output only. The BackupVault resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getState() + { + return $this->state; + } + + /** + * Output only. The BackupVault resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupVault\State::class); + $this->state = $var; + + return $this; + } + + /** + * Optional. Time after which the BackupVault resource is locked. + * + * Generated from protobuf field optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEffectiveTime() + { + return $this->effective_time; + } + + public function hasEffectiveTime() + { + return isset($this->effective_time); + } + + public function clearEffectiveTime() + { + unset($this->effective_time); + } + + /** + * Optional. Time after which the BackupVault resource is locked. + * + * Generated from protobuf field optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEffectiveTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->effective_time = $var; + + return $this; + } + + /** + * Output only. The number of backups in this backup vault. + * + * Generated from protobuf field int64 backup_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getBackupCount() + { + return $this->backup_count; + } + + /** + * Output only. The number of backups in this backup vault. + * + * Generated from protobuf field int64 backup_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setBackupCount($var) + { + GPBUtil::checkInt64($var); + $this->backup_count = $var; + + return $this; + } + + /** + * Output only. Service account used by the BackupVault Service for this + * BackupVault. The user should grant this account permissions in their + * workload project to enable the service to run backups and restores there. + * + * Generated from protobuf field string service_account = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getServiceAccount() + { + return $this->service_account; + } + + /** + * Output only. Service account used by the BackupVault Service for this + * BackupVault. The user should grant this account permissions in their + * workload project to enable the service to run backups and restores there. + * + * Generated from protobuf field string service_account = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->service_account = $var; + + return $this; + } + + /** + * Output only. Total size of the storage used by all backup resources. + * + * Generated from protobuf field int64 total_stored_bytes = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getTotalStoredBytes() + { + return $this->total_stored_bytes; + } + + /** + * Output only. Total size of the storage used by all backup resources. + * + * Generated from protobuf field int64 total_stored_bytes = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setTotalStoredBytes($var) + { + GPBUtil::checkInt64($var); + $this->total_stored_bytes = $var; + + return $this; + } + + /** + * Output only. Output only + * Immutable after resource creation until resource deletion. + * + * Generated from protobuf field string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @return string + */ + public function getUid() + { + return $this->uid; + } + + /** + * Output only. Output only + * Immutable after resource creation until resource deletion. + * + * Generated from protobuf field string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setUid($var) + { + GPBUtil::checkString($var, True); + $this->uid = $var; + + return $this; + } + + /** + * Optional. User annotations. See https://google.aip.dev/128#annotations + * Stores small amounts of arbitrary data. + * + * Generated from protobuf field map annotations = 22 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. User annotations. See https://google.aip.dev/128#annotations + * Stores small amounts of arbitrary data. + * + * Generated from protobuf field map annotations = 22 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + + /** + * Optional. Note: This field is added for future use case and will not be + * supported in the current release. + * Optional. + * Access restriction for the backup vault. + * Default value is WITHIN_ORGANIZATION if not provided during creation. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault.AccessRestriction access_restriction = 24 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getAccessRestriction() + { + return $this->access_restriction; + } + + /** + * Optional. Note: This field is added for future use case and will not be + * supported in the current release. + * Optional. + * Access restriction for the backup vault. + * Default value is WITHIN_ORGANIZATION if not provided during creation. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault.AccessRestriction access_restriction = 24 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setAccessRestriction($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupVault\AccessRestriction::class); + $this->access_restriction = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/BackupVault/AccessRestriction.php b/BackupDr/src/V1/BackupVault/AccessRestriction.php new file mode 100644 index 000000000000..a48fa59cab20 --- /dev/null +++ b/BackupDr/src/V1/BackupVault/AccessRestriction.php @@ -0,0 +1,70 @@ +google.cloud.backupdr.v1.BackupVault.AccessRestriction + */ +class AccessRestriction +{ + /** + * Access restriction not set. + * + * Generated from protobuf enum ACCESS_RESTRICTION_UNSPECIFIED = 0; + */ + const ACCESS_RESTRICTION_UNSPECIFIED = 0; + /** + * Access to or from resources outside your current project will be denied. + * + * Generated from protobuf enum WITHIN_PROJECT = 1; + */ + const WITHIN_PROJECT = 1; + /** + * Access to or from resources outside your current organization will be + * denied. + * + * Generated from protobuf enum WITHIN_ORGANIZATION = 2; + */ + const WITHIN_ORGANIZATION = 2; + /** + * No access restriction. + * + * Generated from protobuf enum UNRESTRICTED = 3; + */ + const UNRESTRICTED = 3; + + private static $valueToName = [ + self::ACCESS_RESTRICTION_UNSPECIFIED => 'ACCESS_RESTRICTION_UNSPECIFIED', + self::WITHIN_PROJECT => 'WITHIN_PROJECT', + self::WITHIN_ORGANIZATION => 'WITHIN_ORGANIZATION', + self::UNRESTRICTED => 'UNRESTRICTED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/BackupVault/State.php b/BackupDr/src/V1/BackupVault/State.php new file mode 100644 index 000000000000..04633e6f97d1 --- /dev/null +++ b/BackupDr/src/V1/BackupVault/State.php @@ -0,0 +1,76 @@ +google.cloud.backupdr.v1.BackupVault.State + */ +class State +{ + /** + * State not set. + * + * Generated from protobuf enum STATE_UNSPECIFIED = 0; + */ + const STATE_UNSPECIFIED = 0; + /** + * The backup vault is being created. + * + * Generated from protobuf enum CREATING = 1; + */ + const CREATING = 1; + /** + * The backup vault has been created and is fully usable. + * + * Generated from protobuf enum ACTIVE = 2; + */ + const ACTIVE = 2; + /** + * The backup vault is being deleted. + * + * Generated from protobuf enum DELETING = 3; + */ + const DELETING = 3; + /** + * The backup vault is experiencing an issue and might be unusable. + * + * Generated from protobuf enum ERROR = 4; + */ + const ERROR = 4; + + private static $valueToName = [ + self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', + self::CREATING => 'CREATING', + self::ACTIVE => 'ACTIVE', + self::DELETING => 'DELETING', + self::ERROR => 'ERROR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/BackupVaultView.php b/BackupDr/src/V1/BackupVaultView.php new file mode 100644 index 000000000000..2fb4c1492dc7 --- /dev/null +++ b/BackupDr/src/V1/BackupVaultView.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.BackupVaultView + */ +class BackupVaultView +{ + /** + * If the value is not set, the default 'FULL' view is used. + * + * Generated from protobuf enum BACKUP_VAULT_VIEW_UNSPECIFIED = 0; + */ + const BACKUP_VAULT_VIEW_UNSPECIFIED = 0; + /** + * Includes basic data about the Backup Vault, but not the full contents. + * + * Generated from protobuf enum BACKUP_VAULT_VIEW_BASIC = 1; + */ + const BACKUP_VAULT_VIEW_BASIC = 1; + /** + * Includes all data about the Backup Vault. + * This is the default value (for both ListBackupVaults and GetBackupVault). + * + * Generated from protobuf enum BACKUP_VAULT_VIEW_FULL = 2; + */ + const BACKUP_VAULT_VIEW_FULL = 2; + + private static $valueToName = [ + self::BACKUP_VAULT_VIEW_UNSPECIFIED => 'BACKUP_VAULT_VIEW_UNSPECIFIED', + self::BACKUP_VAULT_VIEW_BASIC => 'BACKUP_VAULT_VIEW_BASIC', + self::BACKUP_VAULT_VIEW_FULL => 'BACKUP_VAULT_VIEW_FULL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/BackupDr/src/V1/BackupView.php b/BackupDr/src/V1/BackupView.php new file mode 100644 index 000000000000..27ea4394600a --- /dev/null +++ b/BackupDr/src/V1/BackupView.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.BackupView + */ +class BackupView +{ + /** + * If the value is not set, the default 'FULL' view is used. + * + * Generated from protobuf enum BACKUP_VIEW_UNSPECIFIED = 0; + */ + const BACKUP_VIEW_UNSPECIFIED = 0; + /** + * Includes basic data about the Backup, but not the full contents. + * + * Generated from protobuf enum BACKUP_VIEW_BASIC = 1; + */ + const BACKUP_VIEW_BASIC = 1; + /** + * Includes all data about the Backup. + * This is the default value (for both ListBackups and GetBackup). + * + * Generated from protobuf enum BACKUP_VIEW_FULL = 2; + */ + const BACKUP_VIEW_FULL = 2; + + private static $valueToName = [ + self::BACKUP_VIEW_UNSPECIFIED => 'BACKUP_VIEW_UNSPECIFIED', + self::BACKUP_VIEW_BASIC => 'BACKUP_VIEW_BASIC', + self::BACKUP_VIEW_FULL => 'BACKUP_VIEW_FULL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/BackupDr/src/V1/BackupWindow.php b/BackupDr/src/V1/BackupWindow.php new file mode 100644 index 000000000000..8e4da2ca5064 --- /dev/null +++ b/BackupDr/src/V1/BackupWindow.php @@ -0,0 +1,125 @@ +google.cloud.backupdr.v1.BackupWindow + */ +class BackupWindow extends \Google\Protobuf\Internal\Message +{ + /** + * Required. 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. + * + * Generated from protobuf field int32 start_hour_of_day = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $start_hour_of_day = 0; + /** + * Required. The hour of day (1-24) when the window end for e.g. if value of + * end hour of day is 10 that mean backup window end time is 10:00. + * End hour of day should be greater than start hour of day. + * 0 <= start_hour_of_day < end_hour_of_day <= 24 + * End hour of day is not include in backup window that mean if + * end_hour_of_day= 10 jobs should start before 10:00. + * + * Generated from protobuf field int32 end_hour_of_day = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $end_hour_of_day = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $start_hour_of_day + * Required. 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. + * @type int $end_hour_of_day + * Required. The hour of day (1-24) when the window end for e.g. if value of + * end hour of day is 10 that mean backup window end time is 10:00. + * End hour of day should be greater than start hour of day. + * 0 <= start_hour_of_day < end_hour_of_day <= 24 + * End hour of day is not include in backup window that mean if + * end_hour_of_day= 10 jobs should start before 10:00. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Required. 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. + * + * Generated from protobuf field int32 start_hour_of_day = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getStartHourOfDay() + { + return $this->start_hour_of_day; + } + + /** + * Required. 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. + * + * Generated from protobuf field int32 start_hour_of_day = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setStartHourOfDay($var) + { + GPBUtil::checkInt32($var); + $this->start_hour_of_day = $var; + + return $this; + } + + /** + * Required. The hour of day (1-24) when the window end for e.g. if value of + * end hour of day is 10 that mean backup window end time is 10:00. + * End hour of day should be greater than start hour of day. + * 0 <= start_hour_of_day < end_hour_of_day <= 24 + * End hour of day is not include in backup window that mean if + * end_hour_of_day= 10 jobs should start before 10:00. + * + * Generated from protobuf field int32 end_hour_of_day = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getEndHourOfDay() + { + return $this->end_hour_of_day; + } + + /** + * Required. The hour of day (1-24) when the window end for e.g. if value of + * end hour of day is 10 that mean backup window end time is 10:00. + * End hour of day should be greater than start hour of day. + * 0 <= start_hour_of_day < end_hour_of_day <= 24 + * End hour of day is not include in backup window that mean if + * end_hour_of_day= 10 jobs should start before 10:00. + * + * Generated from protobuf field int32 end_hour_of_day = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setEndHourOfDay($var) + { + GPBUtil::checkInt32($var); + $this->end_hour_of_day = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/Client/BackupDRClient.php b/BackupDr/src/V1/Client/BackupDRClient.php index b3150d620337..05d8d344e49c 100644 --- a/BackupDr/src/V1/Client/BackupDRClient.php +++ b/BackupDr/src/V1/Client/BackupDRClient.php @@ -34,11 +34,39 @@ use Google\ApiCore\Transport\TransportInterface; use Google\ApiCore\ValidationException; use Google\Auth\FetchAuthTokenInterface; +use Google\Cloud\BackupDR\V1\Backup; +use Google\Cloud\BackupDR\V1\BackupPlan; +use Google\Cloud\BackupDR\V1\BackupPlanAssociation; +use Google\Cloud\BackupDR\V1\BackupVault; +use Google\Cloud\BackupDR\V1\CreateBackupPlanAssociationRequest; +use Google\Cloud\BackupDR\V1\CreateBackupPlanRequest; +use Google\Cloud\BackupDR\V1\CreateBackupVaultRequest; use Google\Cloud\BackupDR\V1\CreateManagementServerRequest; +use Google\Cloud\BackupDR\V1\DataSource; +use Google\Cloud\BackupDR\V1\DeleteBackupPlanAssociationRequest; +use Google\Cloud\BackupDR\V1\DeleteBackupPlanRequest; +use Google\Cloud\BackupDR\V1\DeleteBackupRequest; +use Google\Cloud\BackupDR\V1\DeleteBackupVaultRequest; use Google\Cloud\BackupDR\V1\DeleteManagementServerRequest; +use Google\Cloud\BackupDR\V1\FetchUsableBackupVaultsRequest; +use Google\Cloud\BackupDR\V1\GetBackupPlanAssociationRequest; +use Google\Cloud\BackupDR\V1\GetBackupPlanRequest; +use Google\Cloud\BackupDR\V1\GetBackupRequest; +use Google\Cloud\BackupDR\V1\GetBackupVaultRequest; +use Google\Cloud\BackupDR\V1\GetDataSourceRequest; use Google\Cloud\BackupDR\V1\GetManagementServerRequest; +use Google\Cloud\BackupDR\V1\ListBackupPlanAssociationsRequest; +use Google\Cloud\BackupDR\V1\ListBackupPlansRequest; +use Google\Cloud\BackupDR\V1\ListBackupVaultsRequest; +use Google\Cloud\BackupDR\V1\ListBackupsRequest; +use Google\Cloud\BackupDR\V1\ListDataSourcesRequest; use Google\Cloud\BackupDR\V1\ListManagementServersRequest; use Google\Cloud\BackupDR\V1\ManagementServer; +use Google\Cloud\BackupDR\V1\RestoreBackupRequest; +use Google\Cloud\BackupDR\V1\TriggerBackupRequest; +use Google\Cloud\BackupDR\V1\UpdateBackupRequest; +use Google\Cloud\BackupDR\V1\UpdateBackupVaultRequest; +use Google\Cloud\BackupDR\V1\UpdateDataSourceRequest; use Google\Cloud\Iam\V1\GetIamPolicyRequest; use Google\Cloud\Iam\V1\Policy; use Google\Cloud\Iam\V1\SetIamPolicyRequest; @@ -62,10 +90,33 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * + * @method PromiseInterface createBackupPlanAsync(CreateBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupPlanAssociationAsync(CreateBackupPlanAssociationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupVaultAsync(CreateBackupVaultRequest $request, array $optionalArgs = []) * @method PromiseInterface createManagementServerAsync(CreateManagementServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupPlanAsync(DeleteBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupPlanAssociationAsync(DeleteBackupPlanAssociationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupVaultAsync(DeleteBackupVaultRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteManagementServerAsync(DeleteManagementServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchUsableBackupVaultsAsync(FetchUsableBackupVaultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupPlanAsync(GetBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupPlanAssociationAsync(GetBackupPlanAssociationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupVaultAsync(GetBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataSourceAsync(GetDataSourceRequest $request, array $optionalArgs = []) * @method PromiseInterface getManagementServerAsync(GetManagementServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupPlanAssociationsAsync(ListBackupPlanAssociationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupPlansAsync(ListBackupPlansRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupVaultsAsync(ListBackupVaultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataSourcesAsync(ListDataSourcesRequest $request, array $optionalArgs = []) * @method PromiseInterface listManagementServersAsync(ListManagementServersRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreBackupAsync(RestoreBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface triggerBackupAsync(TriggerBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupVaultAsync(UpdateBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataSourceAsync(UpdateDataSourceRequest $request, array $optionalArgs = []) * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) @@ -170,6 +221,119 @@ private function createOperationsClient(array $options) return new OperationsClient($options); } + /** + * Formats a string containing the fully-qualified path to represent a backup + * resource. + * + * @param string $project + * @param string $location + * @param string $backupvault + * @param string $datasource + * @param string $backup + * + * @return string The formatted backup resource. + */ + public static function backupName( + string $project, + string $location, + string $backupvault, + string $datasource, + string $backup + ): string { + return self::getPathTemplate('backup')->render([ + 'project' => $project, + 'location' => $location, + 'backupvault' => $backupvault, + 'datasource' => $datasource, + 'backup' => $backup, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a backup_plan + * resource. + * + * @param string $project + * @param string $location + * @param string $backupPlan + * + * @return string The formatted backup_plan resource. + */ + public static function backupPlanName(string $project, string $location, string $backupPlan): string + { + return self::getPathTemplate('backupPlan')->render([ + 'project' => $project, + 'location' => $location, + 'backup_plan' => $backupPlan, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * backup_plan_association resource. + * + * @param string $project + * @param string $location + * @param string $backupPlanAssociation + * + * @return string The formatted backup_plan_association resource. + */ + public static function backupPlanAssociationName( + string $project, + string $location, + string $backupPlanAssociation + ): string { + return self::getPathTemplate('backupPlanAssociation')->render([ + 'project' => $project, + 'location' => $location, + 'backup_plan_association' => $backupPlanAssociation, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a backup_vault + * resource. + * + * @param string $project + * @param string $location + * @param string $backupvault + * + * @return string The formatted backup_vault resource. + */ + public static function backupVaultName(string $project, string $location, string $backupvault): string + { + return self::getPathTemplate('backupVault')->render([ + 'project' => $project, + 'location' => $location, + 'backupvault' => $backupvault, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a data_source + * resource. + * + * @param string $project + * @param string $location + * @param string $backupvault + * @param string $datasource + * + * @return string The formatted data_source resource. + */ + public static function dataSourceName( + string $project, + string $location, + string $backupvault, + string $datasource + ): string { + return self::getPathTemplate('dataSource')->render([ + 'project' => $project, + 'location' => $location, + 'backupvault' => $backupvault, + 'datasource' => $datasource, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a location * resource. @@ -210,6 +374,11 @@ public static function managementServerName(string $project, string $location, s * Parses a formatted name string and returns an associative array of the components in the name. * The following name formats are supported: * Template: Pattern + * - backup: projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup} + * - backupPlan: projects/{project}/locations/{location}/backupPlans/{backup_plan} + * - backupPlanAssociation: projects/{project}/locations/{location}/backupPlanAssociations/{backup_plan_association} + * - backupVault: projects/{project}/locations/{location}/backupVaults/{backupvault} + * - dataSource: projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} * - location: projects/{project}/locations/{location} * - managementServer: projects/{project}/locations/{location}/managementServers/{managementserver} * @@ -303,6 +472,86 @@ public function __call($method, $args) return call_user_func_array([$this, 'startAsyncCall'], $args); } + /** + * Create a BackupPlan + * + * The async variant is {@see BackupDRClient::createBackupPlanAsync()} . + * + * @example samples/V1/BackupDRClient/create_backup_plan.php + * + * @param CreateBackupPlanRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createBackupPlan(CreateBackupPlanRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreateBackupPlan', $request, $callOptions)->wait(); + } + + /** + * Create a BackupPlanAssociation + * + * The async variant is {@see BackupDRClient::createBackupPlanAssociationAsync()} . + * + * @example samples/V1/BackupDRClient/create_backup_plan_association.php + * + * @param CreateBackupPlanAssociationRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createBackupPlanAssociation( + CreateBackupPlanAssociationRequest $request, + array $callOptions = [] + ): OperationResponse { + return $this->startApiCall('CreateBackupPlanAssociation', $request, $callOptions)->wait(); + } + + /** + * Creates a new BackupVault in a given project and location. + * + * The async variant is {@see BackupDRClient::createBackupVaultAsync()} . + * + * @example samples/V1/BackupDRClient/create_backup_vault.php + * + * @param CreateBackupVaultRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createBackupVault(CreateBackupVaultRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreateBackupVault', $request, $callOptions)->wait(); + } + /** * Creates a new ManagementServer in a given project and location. * @@ -331,6 +580,112 @@ public function createManagementServer( return $this->startApiCall('CreateManagementServer', $request, $callOptions)->wait(); } + /** + * Deletes a Backup. + * + * The async variant is {@see BackupDRClient::deleteBackupAsync()} . + * + * @example samples/V1/BackupDRClient/delete_backup.php + * + * @param DeleteBackupRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteBackup(DeleteBackupRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteBackup', $request, $callOptions)->wait(); + } + + /** + * Deletes a single BackupPlan. + * + * The async variant is {@see BackupDRClient::deleteBackupPlanAsync()} . + * + * @example samples/V1/BackupDRClient/delete_backup_plan.php + * + * @param DeleteBackupPlanRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteBackupPlan(DeleteBackupPlanRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteBackupPlan', $request, $callOptions)->wait(); + } + + /** + * Deletes a single BackupPlanAssociation. + * + * The async variant is {@see BackupDRClient::deleteBackupPlanAssociationAsync()} . + * + * @example samples/V1/BackupDRClient/delete_backup_plan_association.php + * + * @param DeleteBackupPlanAssociationRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteBackupPlanAssociation( + DeleteBackupPlanAssociationRequest $request, + array $callOptions = [] + ): OperationResponse { + return $this->startApiCall('DeleteBackupPlanAssociation', $request, $callOptions)->wait(); + } + + /** + * Deletes a BackupVault. + * + * The async variant is {@see BackupDRClient::deleteBackupVaultAsync()} . + * + * @example samples/V1/BackupDRClient/delete_backup_vault.php + * + * @param DeleteBackupVaultRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteBackupVault(DeleteBackupVaultRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteBackupVault', $request, $callOptions)->wait(); + } + /** * Deletes a single ManagementServer. * @@ -359,6 +714,168 @@ public function deleteManagementServer( return $this->startApiCall('DeleteManagementServer', $request, $callOptions)->wait(); } + /** + * FetchUsableBackupVaults lists usable BackupVaults in a given project and + * location. Usable BackupVault are the ones that user has + * backupdr.backupVaults.get permission. + * + * The async variant is {@see BackupDRClient::fetchUsableBackupVaultsAsync()} . + * + * @example samples/V1/BackupDRClient/fetch_usable_backup_vaults.php + * + * @param FetchUsableBackupVaultsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function fetchUsableBackupVaults( + FetchUsableBackupVaultsRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('FetchUsableBackupVaults', $request, $callOptions); + } + + /** + * Gets details of a Backup. + * + * The async variant is {@see BackupDRClient::getBackupAsync()} . + * + * @example samples/V1/BackupDRClient/get_backup.php + * + * @param GetBackupRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Backup + * + * @throws ApiException Thrown if the API call fails. + */ + public function getBackup(GetBackupRequest $request, array $callOptions = []): Backup + { + return $this->startApiCall('GetBackup', $request, $callOptions)->wait(); + } + + /** + * Gets details of a single BackupPlan. + * + * The async variant is {@see BackupDRClient::getBackupPlanAsync()} . + * + * @example samples/V1/BackupDRClient/get_backup_plan.php + * + * @param GetBackupPlanRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return BackupPlan + * + * @throws ApiException Thrown if the API call fails. + */ + public function getBackupPlan(GetBackupPlanRequest $request, array $callOptions = []): BackupPlan + { + return $this->startApiCall('GetBackupPlan', $request, $callOptions)->wait(); + } + + /** + * Gets details of a single BackupPlanAssociation. + * + * The async variant is {@see BackupDRClient::getBackupPlanAssociationAsync()} . + * + * @example samples/V1/BackupDRClient/get_backup_plan_association.php + * + * @param GetBackupPlanAssociationRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return BackupPlanAssociation + * + * @throws ApiException Thrown if the API call fails. + */ + public function getBackupPlanAssociation( + GetBackupPlanAssociationRequest $request, + array $callOptions = [] + ): BackupPlanAssociation { + return $this->startApiCall('GetBackupPlanAssociation', $request, $callOptions)->wait(); + } + + /** + * Gets details of a BackupVault. + * + * The async variant is {@see BackupDRClient::getBackupVaultAsync()} . + * + * @example samples/V1/BackupDRClient/get_backup_vault.php + * + * @param GetBackupVaultRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return BackupVault + * + * @throws ApiException Thrown if the API call fails. + */ + public function getBackupVault(GetBackupVaultRequest $request, array $callOptions = []): BackupVault + { + return $this->startApiCall('GetBackupVault', $request, $callOptions)->wait(); + } + + /** + * Gets details of a DataSource. + * + * The async variant is {@see BackupDRClient::getDataSourceAsync()} . + * + * @example samples/V1/BackupDRClient/get_data_source.php + * + * @param GetDataSourceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return DataSource + * + * @throws ApiException Thrown if the API call fails. + */ + public function getDataSource(GetDataSourceRequest $request, array $callOptions = []): DataSource + { + return $this->startApiCall('GetDataSource', $request, $callOptions)->wait(); + } + /** * Gets details of a single ManagementServer. * @@ -385,6 +902,138 @@ public function getManagementServer(GetManagementServerRequest $request, array $ return $this->startApiCall('GetManagementServer', $request, $callOptions)->wait(); } + /** + * Lists BackupPlanAssociations in a given project and location. + * + * The async variant is {@see BackupDRClient::listBackupPlanAssociationsAsync()} . + * + * @example samples/V1/BackupDRClient/list_backup_plan_associations.php + * + * @param ListBackupPlanAssociationsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listBackupPlanAssociations( + ListBackupPlanAssociationsRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('ListBackupPlanAssociations', $request, $callOptions); + } + + /** + * Lists BackupPlans in a given project and location. + * + * The async variant is {@see BackupDRClient::listBackupPlansAsync()} . + * + * @example samples/V1/BackupDRClient/list_backup_plans.php + * + * @param ListBackupPlansRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listBackupPlans(ListBackupPlansRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListBackupPlans', $request, $callOptions); + } + + /** + * Lists BackupVaults in a given project and location. + * + * The async variant is {@see BackupDRClient::listBackupVaultsAsync()} . + * + * @example samples/V1/BackupDRClient/list_backup_vaults.php + * + * @param ListBackupVaultsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listBackupVaults(ListBackupVaultsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListBackupVaults', $request, $callOptions); + } + + /** + * Lists Backups in a given project and location. + * + * The async variant is {@see BackupDRClient::listBackupsAsync()} . + * + * @example samples/V1/BackupDRClient/list_backups.php + * + * @param ListBackupsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listBackups(ListBackupsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListBackups', $request, $callOptions); + } + + /** + * Lists DataSources in a given project and location. + * + * The async variant is {@see BackupDRClient::listDataSourcesAsync()} . + * + * @example samples/V1/BackupDRClient/list_data_sources.php + * + * @param ListDataSourcesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listDataSources(ListDataSourcesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListDataSources', $request, $callOptions); + } + /** * Lists ManagementServers in a given project and location. * @@ -413,6 +1062,136 @@ public function listManagementServers( return $this->startApiCall('ListManagementServers', $request, $callOptions); } + /** + * Restore from a Backup + * + * The async variant is {@see BackupDRClient::restoreBackupAsync()} . + * + * @example samples/V1/BackupDRClient/restore_backup.php + * + * @param RestoreBackupRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function restoreBackup(RestoreBackupRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('RestoreBackup', $request, $callOptions)->wait(); + } + + /** + * Triggers a new Backup. + * + * The async variant is {@see BackupDRClient::triggerBackupAsync()} . + * + * @example samples/V1/BackupDRClient/trigger_backup.php + * + * @param TriggerBackupRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function triggerBackup(TriggerBackupRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('TriggerBackup', $request, $callOptions)->wait(); + } + + /** + * Updates the settings of a Backup. + * + * The async variant is {@see BackupDRClient::updateBackupAsync()} . + * + * @example samples/V1/BackupDRClient/update_backup.php + * + * @param UpdateBackupRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateBackup(UpdateBackupRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('UpdateBackup', $request, $callOptions)->wait(); + } + + /** + * Updates the settings of a BackupVault. + * + * The async variant is {@see BackupDRClient::updateBackupVaultAsync()} . + * + * @example samples/V1/BackupDRClient/update_backup_vault.php + * + * @param UpdateBackupVaultRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateBackupVault(UpdateBackupVaultRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('UpdateBackupVault', $request, $callOptions)->wait(); + } + + /** + * Updates the settings of a DataSource. + * + * The async variant is {@see BackupDRClient::updateDataSourceAsync()} . + * + * @example samples/V1/BackupDRClient/update_data_source.php + * + * @param UpdateDataSourceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateDataSource(UpdateDataSourceRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('UpdateDataSource', $request, $callOptions)->wait(); + } + /** * Gets information about a location. * diff --git a/BackupDr/src/V1/ComputeInstanceBackupProperties.php b/BackupDr/src/V1/ComputeInstanceBackupProperties.php new file mode 100644 index 000000000000..8f9a6f915880 --- /dev/null +++ b/BackupDr/src/V1/ComputeInstanceBackupProperties.php @@ -0,0 +1,716 @@ +google.cloud.backupdr.v1.ComputeInstanceBackupProperties + */ +class ComputeInstanceBackupProperties extends \Google\Protobuf\Internal\Message +{ + /** + * An optional text description for the instances that are created from these + * properties. + * + * Generated from protobuf field optional string description = 1; + */ + protected $description = null; + /** + * A list of tags to apply to the instances that are created from these + * properties. The tags identify valid sources or targets for network + * firewalls. The setTags method can modify this list of tags. Each tag within + * the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Tags tags = 2; + */ + protected $tags = null; + /** + * The machine type to use for instances that are created from these + * properties. + * + * Generated from protobuf field optional string machine_type = 3; + */ + protected $machine_type = null; + /** + * Enables instances created based on these properties to send packets with + * source IP addresses other than their own and receive packets with + * destination IP addresses other than their own. If these instances will be + * used as an IP gateway or it will be set as the next-hop in a Route + * resource, specify `true`. If unsure, leave this set to `false`. See the + * https://cloud.google.com/vpc/docs/using-routes#canipforward + * documentation for more information. + * + * Generated from protobuf field optional bool can_ip_forward = 4; + */ + protected $can_ip_forward = null; + /** + * An array of network access configurations for this interface. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.NetworkInterface network_interface = 5; + */ + private $network_interface; + /** + * An array of disks that are associated with the instances that are created + * from these properties. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AttachedDisk disk = 6; + */ + private $disk; + /** + * The metadata key/value pairs to assign to instances that are created from + * these properties. These pairs can consist of custom metadata or predefined + * keys. See https://cloud.google.com/compute/docs/metadata/overview for more + * information. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Metadata metadata = 7; + */ + protected $metadata = null; + /** + * A list of service accounts with specified scopes. Access tokens for these + * service accounts are available to the instances that are created from + * these properties. Use metadata queries to obtain the access tokens for + * these instances. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.ServiceAccount service_account = 8; + */ + private $service_account; + /** + * Specifies the scheduling options for the instances that are created from + * these properties. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling scheduling = 9; + */ + protected $scheduling = null; + /** + * A list of guest accelerator cards' type and count to use for instances + * created from these properties. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerator = 10; + */ + private $guest_accelerator; + /** + * Minimum cpu/platform to be used by instances. The instance may be + * scheduled on the specified or newer cpu/platform. Applicable values are the + * friendly names of CPU platforms, such as + * `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. + * For more information, read + * https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + * + * Generated from protobuf field optional string min_cpu_platform = 11; + */ + protected $min_cpu_platform = null; + /** + * KeyRevocationActionType of the instance. Supported options are "STOP" and + * "NONE". The default value is "NONE" if it is not specified. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12; + */ + protected $key_revocation_action_type = null; + /** + * The source instance used to create this backup. This can be a partial or + * full URL to the resource. For example, the following are valid values: + * -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance + * -projects/project/zones/zone/instances/instance + * + * Generated from protobuf field optional string source_instance = 13; + */ + protected $source_instance = null; + /** + * Labels to apply to instances that are created from these properties. + * + * Generated from protobuf field map labels = 14; + */ + private $labels; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $description + * An optional text description for the instances that are created from these + * properties. + * @type \Google\Cloud\BackupDR\V1\Tags $tags + * A list of tags to apply to the instances that are created from these + * properties. The tags identify valid sources or targets for network + * firewalls. The setTags method can modify this list of tags. Each tag within + * the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). + * @type string $machine_type + * The machine type to use for instances that are created from these + * properties. + * @type bool $can_ip_forward + * Enables instances created based on these properties to send packets with + * source IP addresses other than their own and receive packets with + * destination IP addresses other than their own. If these instances will be + * used as an IP gateway or it will be set as the next-hop in a Route + * resource, specify `true`. If unsure, leave this set to `false`. See the + * https://cloud.google.com/vpc/docs/using-routes#canipforward + * documentation for more information. + * @type array<\Google\Cloud\BackupDR\V1\NetworkInterface>|\Google\Protobuf\Internal\RepeatedField $network_interface + * An array of network access configurations for this interface. + * @type array<\Google\Cloud\BackupDR\V1\AttachedDisk>|\Google\Protobuf\Internal\RepeatedField $disk + * An array of disks that are associated with the instances that are created + * from these properties. + * @type \Google\Cloud\BackupDR\V1\Metadata $metadata + * The metadata key/value pairs to assign to instances that are created from + * these properties. These pairs can consist of custom metadata or predefined + * keys. See https://cloud.google.com/compute/docs/metadata/overview for more + * information. + * @type array<\Google\Cloud\BackupDR\V1\ServiceAccount>|\Google\Protobuf\Internal\RepeatedField $service_account + * A list of service accounts with specified scopes. Access tokens for these + * service accounts are available to the instances that are created from + * these properties. Use metadata queries to obtain the access tokens for + * these instances. + * @type \Google\Cloud\BackupDR\V1\Scheduling $scheduling + * Specifies the scheduling options for the instances that are created from + * these properties. + * @type array<\Google\Cloud\BackupDR\V1\AcceleratorConfig>|\Google\Protobuf\Internal\RepeatedField $guest_accelerator + * A list of guest accelerator cards' type and count to use for instances + * created from these properties. + * @type string $min_cpu_platform + * Minimum cpu/platform to be used by instances. The instance may be + * scheduled on the specified or newer cpu/platform. Applicable values are the + * friendly names of CPU platforms, such as + * `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. + * For more information, read + * https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + * @type int $key_revocation_action_type + * KeyRevocationActionType of the instance. Supported options are "STOP" and + * "NONE". The default value is "NONE" if it is not specified. + * @type string $source_instance + * The source instance used to create this backup. This can be a partial or + * full URL to the resource. For example, the following are valid values: + * -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance + * -projects/project/zones/zone/instances/instance + * @type array|\Google\Protobuf\Internal\MapField $labels + * Labels to apply to instances that are created from these properties. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * An optional text description for the instances that are created from these + * properties. + * + * Generated from protobuf field optional string description = 1; + * @return string + */ + public function getDescription() + { + return isset($this->description) ? $this->description : ''; + } + + public function hasDescription() + { + return isset($this->description); + } + + public function clearDescription() + { + unset($this->description); + } + + /** + * An optional text description for the instances that are created from these + * properties. + * + * Generated from protobuf field optional string description = 1; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * A list of tags to apply to the instances that are created from these + * properties. The tags identify valid sources or targets for network + * firewalls. The setTags method can modify this list of tags. Each tag within + * the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Tags tags = 2; + * @return \Google\Cloud\BackupDR\V1\Tags|null + */ + public function getTags() + { + return $this->tags; + } + + public function hasTags() + { + return isset($this->tags); + } + + public function clearTags() + { + unset($this->tags); + } + + /** + * A list of tags to apply to the instances that are created from these + * properties. The tags identify valid sources or targets for network + * firewalls. The setTags method can modify this list of tags. Each tag within + * the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Tags tags = 2; + * @param \Google\Cloud\BackupDR\V1\Tags $var + * @return $this + */ + public function setTags($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\Tags::class); + $this->tags = $var; + + return $this; + } + + /** + * The machine type to use for instances that are created from these + * properties. + * + * Generated from protobuf field optional string machine_type = 3; + * @return string + */ + public function getMachineType() + { + return isset($this->machine_type) ? $this->machine_type : ''; + } + + public function hasMachineType() + { + return isset($this->machine_type); + } + + public function clearMachineType() + { + unset($this->machine_type); + } + + /** + * The machine type to use for instances that are created from these + * properties. + * + * Generated from protobuf field optional string machine_type = 3; + * @param string $var + * @return $this + */ + public function setMachineType($var) + { + GPBUtil::checkString($var, True); + $this->machine_type = $var; + + return $this; + } + + /** + * Enables instances created based on these properties to send packets with + * source IP addresses other than their own and receive packets with + * destination IP addresses other than their own. If these instances will be + * used as an IP gateway or it will be set as the next-hop in a Route + * resource, specify `true`. If unsure, leave this set to `false`. See the + * https://cloud.google.com/vpc/docs/using-routes#canipforward + * documentation for more information. + * + * Generated from protobuf field optional bool can_ip_forward = 4; + * @return bool + */ + public function getCanIpForward() + { + return isset($this->can_ip_forward) ? $this->can_ip_forward : false; + } + + public function hasCanIpForward() + { + return isset($this->can_ip_forward); + } + + public function clearCanIpForward() + { + unset($this->can_ip_forward); + } + + /** + * Enables instances created based on these properties to send packets with + * source IP addresses other than their own and receive packets with + * destination IP addresses other than their own. If these instances will be + * used as an IP gateway or it will be set as the next-hop in a Route + * resource, specify `true`. If unsure, leave this set to `false`. See the + * https://cloud.google.com/vpc/docs/using-routes#canipforward + * documentation for more information. + * + * Generated from protobuf field optional bool can_ip_forward = 4; + * @param bool $var + * @return $this + */ + public function setCanIpForward($var) + { + GPBUtil::checkBool($var); + $this->can_ip_forward = $var; + + return $this; + } + + /** + * An array of network access configurations for this interface. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.NetworkInterface network_interface = 5; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getNetworkInterface() + { + return $this->network_interface; + } + + /** + * An array of network access configurations for this interface. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.NetworkInterface network_interface = 5; + * @param array<\Google\Cloud\BackupDR\V1\NetworkInterface>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setNetworkInterface($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\NetworkInterface::class); + $this->network_interface = $arr; + + return $this; + } + + /** + * An array of disks that are associated with the instances that are created + * from these properties. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AttachedDisk disk = 6; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDisk() + { + return $this->disk; + } + + /** + * An array of disks that are associated with the instances that are created + * from these properties. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AttachedDisk disk = 6; + * @param array<\Google\Cloud\BackupDR\V1\AttachedDisk>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDisk($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\AttachedDisk::class); + $this->disk = $arr; + + return $this; + } + + /** + * The metadata key/value pairs to assign to instances that are created from + * these properties. These pairs can consist of custom metadata or predefined + * keys. See https://cloud.google.com/compute/docs/metadata/overview for more + * information. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Metadata metadata = 7; + * @return \Google\Cloud\BackupDR\V1\Metadata|null + */ + public function getMetadata() + { + return $this->metadata; + } + + public function hasMetadata() + { + return isset($this->metadata); + } + + public function clearMetadata() + { + unset($this->metadata); + } + + /** + * The metadata key/value pairs to assign to instances that are created from + * these properties. These pairs can consist of custom metadata or predefined + * keys. See https://cloud.google.com/compute/docs/metadata/overview for more + * information. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Metadata metadata = 7; + * @param \Google\Cloud\BackupDR\V1\Metadata $var + * @return $this + */ + public function setMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\Metadata::class); + $this->metadata = $var; + + return $this; + } + + /** + * A list of service accounts with specified scopes. Access tokens for these + * service accounts are available to the instances that are created from + * these properties. Use metadata queries to obtain the access tokens for + * these instances. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.ServiceAccount service_account = 8; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getServiceAccount() + { + return $this->service_account; + } + + /** + * A list of service accounts with specified scopes. Access tokens for these + * service accounts are available to the instances that are created from + * these properties. Use metadata queries to obtain the access tokens for + * these instances. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.ServiceAccount service_account = 8; + * @param array<\Google\Cloud\BackupDR\V1\ServiceAccount>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setServiceAccount($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\ServiceAccount::class); + $this->service_account = $arr; + + return $this; + } + + /** + * Specifies the scheduling options for the instances that are created from + * these properties. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling scheduling = 9; + * @return \Google\Cloud\BackupDR\V1\Scheduling|null + */ + public function getScheduling() + { + return $this->scheduling; + } + + public function hasScheduling() + { + return isset($this->scheduling); + } + + public function clearScheduling() + { + unset($this->scheduling); + } + + /** + * Specifies the scheduling options for the instances that are created from + * these properties. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling scheduling = 9; + * @param \Google\Cloud\BackupDR\V1\Scheduling $var + * @return $this + */ + public function setScheduling($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\Scheduling::class); + $this->scheduling = $var; + + return $this; + } + + /** + * A list of guest accelerator cards' type and count to use for instances + * created from these properties. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerator = 10; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGuestAccelerator() + { + return $this->guest_accelerator; + } + + /** + * A list of guest accelerator cards' type and count to use for instances + * created from these properties. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerator = 10; + * @param array<\Google\Cloud\BackupDR\V1\AcceleratorConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGuestAccelerator($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\AcceleratorConfig::class); + $this->guest_accelerator = $arr; + + return $this; + } + + /** + * Minimum cpu/platform to be used by instances. The instance may be + * scheduled on the specified or newer cpu/platform. Applicable values are the + * friendly names of CPU platforms, such as + * `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. + * For more information, read + * https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + * + * Generated from protobuf field optional string min_cpu_platform = 11; + * @return string + */ + public function getMinCpuPlatform() + { + return isset($this->min_cpu_platform) ? $this->min_cpu_platform : ''; + } + + public function hasMinCpuPlatform() + { + return isset($this->min_cpu_platform); + } + + public function clearMinCpuPlatform() + { + unset($this->min_cpu_platform); + } + + /** + * Minimum cpu/platform to be used by instances. The instance may be + * scheduled on the specified or newer cpu/platform. Applicable values are the + * friendly names of CPU platforms, such as + * `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. + * For more information, read + * https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + * + * Generated from protobuf field optional string min_cpu_platform = 11; + * @param string $var + * @return $this + */ + public function setMinCpuPlatform($var) + { + GPBUtil::checkString($var, True); + $this->min_cpu_platform = $var; + + return $this; + } + + /** + * KeyRevocationActionType of the instance. Supported options are "STOP" and + * "NONE". The default value is "NONE" if it is not specified. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12; + * @return int + */ + public function getKeyRevocationActionType() + { + return isset($this->key_revocation_action_type) ? $this->key_revocation_action_type : 0; + } + + public function hasKeyRevocationActionType() + { + return isset($this->key_revocation_action_type); + } + + public function clearKeyRevocationActionType() + { + unset($this->key_revocation_action_type); + } + + /** + * KeyRevocationActionType of the instance. Supported options are "STOP" and + * "NONE". The default value is "NONE" if it is not specified. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12; + * @param int $var + * @return $this + */ + public function setKeyRevocationActionType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\KeyRevocationActionType::class); + $this->key_revocation_action_type = $var; + + return $this; + } + + /** + * The source instance used to create this backup. This can be a partial or + * full URL to the resource. For example, the following are valid values: + * -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance + * -projects/project/zones/zone/instances/instance + * + * Generated from protobuf field optional string source_instance = 13; + * @return string + */ + public function getSourceInstance() + { + return isset($this->source_instance) ? $this->source_instance : ''; + } + + public function hasSourceInstance() + { + return isset($this->source_instance); + } + + public function clearSourceInstance() + { + unset($this->source_instance); + } + + /** + * The source instance used to create this backup. This can be a partial or + * full URL to the resource. For example, the following are valid values: + * -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance + * -projects/project/zones/zone/instances/instance + * + * Generated from protobuf field optional string source_instance = 13; + * @param string $var + * @return $this + */ + public function setSourceInstance($var) + { + GPBUtil::checkString($var, True); + $this->source_instance = $var; + + return $this; + } + + /** + * Labels to apply to instances that are created from these properties. + * + * Generated from protobuf field map labels = 14; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Labels to apply to instances that are created from these properties. + * + * Generated from protobuf field map labels = 14; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ComputeInstanceDataSourceProperties.php b/BackupDr/src/V1/ComputeInstanceDataSourceProperties.php new file mode 100644 index 000000000000..28fa438fe071 --- /dev/null +++ b/BackupDr/src/V1/ComputeInstanceDataSourceProperties.php @@ -0,0 +1,204 @@ +google.cloud.backupdr.v1.ComputeInstanceDataSourceProperties + */ +class ComputeInstanceDataSourceProperties extends \Google\Protobuf\Internal\Message +{ + /** + * Name of the compute instance backed up by the datasource. + * + * Generated from protobuf field string name = 1; + */ + protected $name = ''; + /** + * The description of the Compute Engine instance. + * + * Generated from protobuf field string description = 2; + */ + protected $description = ''; + /** + * The machine type of the instance. + * + * Generated from protobuf field string machine_type = 3; + */ + protected $machine_type = ''; + /** + * The total number of disks attached to the Instance. + * + * Generated from protobuf field int64 total_disk_count = 4; + */ + protected $total_disk_count = 0; + /** + * The sum of all the disk sizes. + * + * Generated from protobuf field int64 total_disk_size_gb = 5; + */ + protected $total_disk_size_gb = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Name of the compute instance backed up by the datasource. + * @type string $description + * The description of the Compute Engine instance. + * @type string $machine_type + * The machine type of the instance. + * @type int|string $total_disk_count + * The total number of disks attached to the Instance. + * @type int|string $total_disk_size_gb + * The sum of all the disk sizes. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Name of the compute instance backed up by the datasource. + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Name of the compute instance backed up by the datasource. + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * The description of the Compute Engine instance. + * + * Generated from protobuf field string description = 2; + * @return string + */ + public function getDescription() + { + return $this->description; + } + + /** + * The description of the Compute Engine instance. + * + * Generated from protobuf field string description = 2; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * The machine type of the instance. + * + * Generated from protobuf field string machine_type = 3; + * @return string + */ + public function getMachineType() + { + return $this->machine_type; + } + + /** + * The machine type of the instance. + * + * Generated from protobuf field string machine_type = 3; + * @param string $var + * @return $this + */ + public function setMachineType($var) + { + GPBUtil::checkString($var, True); + $this->machine_type = $var; + + return $this; + } + + /** + * The total number of disks attached to the Instance. + * + * Generated from protobuf field int64 total_disk_count = 4; + * @return int|string + */ + public function getTotalDiskCount() + { + return $this->total_disk_count; + } + + /** + * The total number of disks attached to the Instance. + * + * Generated from protobuf field int64 total_disk_count = 4; + * @param int|string $var + * @return $this + */ + public function setTotalDiskCount($var) + { + GPBUtil::checkInt64($var); + $this->total_disk_count = $var; + + return $this; + } + + /** + * The sum of all the disk sizes. + * + * Generated from protobuf field int64 total_disk_size_gb = 5; + * @return int|string + */ + public function getTotalDiskSizeGb() + { + return $this->total_disk_size_gb; + } + + /** + * The sum of all the disk sizes. + * + * Generated from protobuf field int64 total_disk_size_gb = 5; + * @param int|string $var + * @return $this + */ + public function setTotalDiskSizeGb($var) + { + GPBUtil::checkInt64($var); + $this->total_disk_size_gb = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ComputeInstanceRestoreProperties.php b/BackupDr/src/V1/ComputeInstanceRestoreProperties.php new file mode 100644 index 000000000000..b5ed7b1b9feb --- /dev/null +++ b/BackupDr/src/V1/ComputeInstanceRestoreProperties.php @@ -0,0 +1,1150 @@ +google.cloud.backupdr.v1.ComputeInstanceRestoreProperties + */ +class ComputeInstanceRestoreProperties extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the compute instance. + * + * Generated from protobuf field optional string name = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $name = null; + /** + * Optional. Controls for advanced machine-related behavior features. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AdvancedMachineFeatures advanced_machine_features = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $advanced_machine_features = null; + /** + * Optional. Allows this instance to send and receive packets with + * non-matching destination or source IPs. + * + * Generated from protobuf field optional bool can_ip_forward = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $can_ip_forward = null; + /** + * Optional. Controls Confidential compute options on the instance + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.ConfidentialInstanceConfig confidential_instance_config = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $confidential_instance_config = null; + /** + * Optional. Whether the resource should be protected against deletion. + * + * Generated from protobuf field optional bool deletion_protection = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $deletion_protection = null; + /** + * Optional. An optional description of this resource. Provide this property + * when you create the resource. + * + * Generated from protobuf field optional string description = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $description = null; + /** + * Optional. Array of disks associated with this instance. Persistent disks + * must be created before you can assign them. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AttachedDisk disks = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $disks; + /** + * Optional. Enables display device for the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.DisplayDevice display_device = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_device = null; + /** + * Optional. A list of the type and count of accelerator cards attached to the + * instance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerators = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $guest_accelerators; + /** + * Optional. Specifies the hostname of the instance. The specified hostname + * must be RFC1035 compliant. If hostname is not specified, the default + * hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global + * DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal + * DNS. + * + * Generated from protobuf field optional string hostname = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $hostname = null; + /** + * Optional. Encrypts suspended data for an instance with a + * customer-managed encryption key. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.CustomerEncryptionKey instance_encryption_key = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $instance_encryption_key = null; + /** + * Optional. KeyRevocationActionType of the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $key_revocation_action_type = null; + /** + * Optional. Labels to apply to this instance. + * + * Generated from protobuf field map labels = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Optional. Full or partial URL of the machine type resource to use for this + * instance. + * + * Generated from protobuf field optional string machine_type = 14 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $machine_type = null; + /** + * Optional. This includes custom metadata and predefined keys. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Metadata metadata = 15 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $metadata = null; + /** + * Optional. Minimum CPU platform to use for this instance. + * + * Generated from protobuf field optional string min_cpu_platform = 16 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $min_cpu_platform = null; + /** + * Optional. An array of network configurations for this instance. These + * specify how interfaces are configured to interact with other network + * services, such as connecting to the internet. Multiple interfaces are + * supported per instance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.NetworkInterface network_interfaces = 17 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $network_interfaces; + /** + * Optional. Configure network performance such as egress bandwidth tier. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkPerformanceConfig network_performance_config = 18 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $network_performance_config = null; + /** + * Input only. Additional params passed with the request, but not persisted + * as part of resource payload. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.InstanceParams params = 19 [(.google.api.field_behavior) = INPUT_ONLY]; + */ + protected $params = null; + /** + * Optional. The private IPv6 google access type for the VM. + * If not specified, use INHERIT_FROM_SUBNETWORK as default. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.ComputeInstanceRestoreProperties.InstancePrivateIpv6GoogleAccess private_ipv6_google_access = 20 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $private_ipv6_google_access = null; + /** + * Optional. Specifies the reservations that this instance can consume from. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AllocationAffinity allocation_affinity = 21 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allocation_affinity = null; + /** + * Optional. Resource policies applied to this instance. + * + * Generated from protobuf field repeated string resource_policies = 22 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $resource_policies; + /** + * Optional. Sets the scheduling options for this instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling scheduling = 23 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $scheduling = null; + /** + * Optional. A list of service accounts, with their specified scopes, + * authorized for this instance. Only one service account per VM instance is + * supported. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.ServiceAccount service_accounts = 24 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $service_accounts; + /** + * Optional. Tags to apply to this instance. Tags are used to identify valid + * sources or targets for network firewalls and are specified by the client + * during instance creation. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Tags tags = 26 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $tags = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the compute instance. + * @type \Google\Cloud\BackupDR\V1\AdvancedMachineFeatures $advanced_machine_features + * Optional. Controls for advanced machine-related behavior features. + * @type bool $can_ip_forward + * Optional. Allows this instance to send and receive packets with + * non-matching destination or source IPs. + * @type \Google\Cloud\BackupDR\V1\ConfidentialInstanceConfig $confidential_instance_config + * Optional. Controls Confidential compute options on the instance + * @type bool $deletion_protection + * Optional. Whether the resource should be protected against deletion. + * @type string $description + * Optional. An optional description of this resource. Provide this property + * when you create the resource. + * @type array<\Google\Cloud\BackupDR\V1\AttachedDisk>|\Google\Protobuf\Internal\RepeatedField $disks + * Optional. Array of disks associated with this instance. Persistent disks + * must be created before you can assign them. + * @type \Google\Cloud\BackupDR\V1\DisplayDevice $display_device + * Optional. Enables display device for the instance. + * @type array<\Google\Cloud\BackupDR\V1\AcceleratorConfig>|\Google\Protobuf\Internal\RepeatedField $guest_accelerators + * Optional. A list of the type and count of accelerator cards attached to the + * instance. + * @type string $hostname + * Optional. Specifies the hostname of the instance. The specified hostname + * must be RFC1035 compliant. If hostname is not specified, the default + * hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global + * DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal + * DNS. + * @type \Google\Cloud\BackupDR\V1\CustomerEncryptionKey $instance_encryption_key + * Optional. Encrypts suspended data for an instance with a + * customer-managed encryption key. + * @type int $key_revocation_action_type + * Optional. KeyRevocationActionType of the instance. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. Labels to apply to this instance. + * @type string $machine_type + * Optional. Full or partial URL of the machine type resource to use for this + * instance. + * @type \Google\Cloud\BackupDR\V1\Metadata $metadata + * Optional. This includes custom metadata and predefined keys. + * @type string $min_cpu_platform + * Optional. Minimum CPU platform to use for this instance. + * @type array<\Google\Cloud\BackupDR\V1\NetworkInterface>|\Google\Protobuf\Internal\RepeatedField $network_interfaces + * Optional. An array of network configurations for this instance. These + * specify how interfaces are configured to interact with other network + * services, such as connecting to the internet. Multiple interfaces are + * supported per instance. + * @type \Google\Cloud\BackupDR\V1\NetworkPerformanceConfig $network_performance_config + * Optional. Configure network performance such as egress bandwidth tier. + * @type \Google\Cloud\BackupDR\V1\InstanceParams $params + * Input only. Additional params passed with the request, but not persisted + * as part of resource payload. + * @type int $private_ipv6_google_access + * Optional. The private IPv6 google access type for the VM. + * If not specified, use INHERIT_FROM_SUBNETWORK as default. + * @type \Google\Cloud\BackupDR\V1\AllocationAffinity $allocation_affinity + * Optional. Specifies the reservations that this instance can consume from. + * @type array|\Google\Protobuf\Internal\RepeatedField $resource_policies + * Optional. Resource policies applied to this instance. + * @type \Google\Cloud\BackupDR\V1\Scheduling $scheduling + * Optional. Sets the scheduling options for this instance. + * @type array<\Google\Cloud\BackupDR\V1\ServiceAccount>|\Google\Protobuf\Internal\RepeatedField $service_accounts + * Optional. A list of service accounts, with their specified scopes, + * authorized for this instance. Only one service account per VM instance is + * supported. + * @type \Google\Cloud\BackupDR\V1\Tags $tags + * Optional. Tags to apply to this instance. Tags are used to identify valid + * sources or targets for network firewalls and are specified by the client + * during instance creation. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the compute instance. + * + * Generated from protobuf field optional string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getName() + { + return isset($this->name) ? $this->name : ''; + } + + public function hasName() + { + return isset($this->name); + } + + public function clearName() + { + unset($this->name); + } + + /** + * Required. Name of the compute instance. + * + * Generated from protobuf field optional string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. Controls for advanced machine-related behavior features. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AdvancedMachineFeatures advanced_machine_features = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\AdvancedMachineFeatures|null + */ + public function getAdvancedMachineFeatures() + { + return $this->advanced_machine_features; + } + + public function hasAdvancedMachineFeatures() + { + return isset($this->advanced_machine_features); + } + + public function clearAdvancedMachineFeatures() + { + unset($this->advanced_machine_features); + } + + /** + * Optional. Controls for advanced machine-related behavior features. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AdvancedMachineFeatures advanced_machine_features = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\AdvancedMachineFeatures $var + * @return $this + */ + public function setAdvancedMachineFeatures($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\AdvancedMachineFeatures::class); + $this->advanced_machine_features = $var; + + return $this; + } + + /** + * Optional. Allows this instance to send and receive packets with + * non-matching destination or source IPs. + * + * Generated from protobuf field optional bool can_ip_forward = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getCanIpForward() + { + return isset($this->can_ip_forward) ? $this->can_ip_forward : false; + } + + public function hasCanIpForward() + { + return isset($this->can_ip_forward); + } + + public function clearCanIpForward() + { + unset($this->can_ip_forward); + } + + /** + * Optional. Allows this instance to send and receive packets with + * non-matching destination or source IPs. + * + * Generated from protobuf field optional bool can_ip_forward = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setCanIpForward($var) + { + GPBUtil::checkBool($var); + $this->can_ip_forward = $var; + + return $this; + } + + /** + * Optional. Controls Confidential compute options on the instance + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.ConfidentialInstanceConfig confidential_instance_config = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\ConfidentialInstanceConfig|null + */ + public function getConfidentialInstanceConfig() + { + return $this->confidential_instance_config; + } + + public function hasConfidentialInstanceConfig() + { + return isset($this->confidential_instance_config); + } + + public function clearConfidentialInstanceConfig() + { + unset($this->confidential_instance_config); + } + + /** + * Optional. Controls Confidential compute options on the instance + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.ConfidentialInstanceConfig confidential_instance_config = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\ConfidentialInstanceConfig $var + * @return $this + */ + public function setConfidentialInstanceConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\ConfidentialInstanceConfig::class); + $this->confidential_instance_config = $var; + + return $this; + } + + /** + * Optional. Whether the resource should be protected against deletion. + * + * Generated from protobuf field optional bool deletion_protection = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getDeletionProtection() + { + return isset($this->deletion_protection) ? $this->deletion_protection : false; + } + + public function hasDeletionProtection() + { + return isset($this->deletion_protection); + } + + public function clearDeletionProtection() + { + unset($this->deletion_protection); + } + + /** + * Optional. Whether the resource should be protected against deletion. + * + * Generated from protobuf field optional bool deletion_protection = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setDeletionProtection($var) + { + GPBUtil::checkBool($var); + $this->deletion_protection = $var; + + return $this; + } + + /** + * Optional. An optional description of this resource. Provide this property + * when you create the resource. + * + * Generated from protobuf field optional string description = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDescription() + { + return isset($this->description) ? $this->description : ''; + } + + public function hasDescription() + { + return isset($this->description); + } + + public function clearDescription() + { + unset($this->description); + } + + /** + * Optional. An optional description of this resource. Provide this property + * when you create the resource. + * + * Generated from protobuf field optional string description = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Optional. Array of disks associated with this instance. Persistent disks + * must be created before you can assign them. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AttachedDisk disks = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDisks() + { + return $this->disks; + } + + /** + * Optional. Array of disks associated with this instance. Persistent disks + * must be created before you can assign them. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AttachedDisk disks = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\AttachedDisk>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDisks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\AttachedDisk::class); + $this->disks = $arr; + + return $this; + } + + /** + * Optional. Enables display device for the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.DisplayDevice display_device = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\DisplayDevice|null + */ + public function getDisplayDevice() + { + return $this->display_device; + } + + public function hasDisplayDevice() + { + return isset($this->display_device); + } + + public function clearDisplayDevice() + { + unset($this->display_device); + } + + /** + * Optional. Enables display device for the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.DisplayDevice display_device = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\DisplayDevice $var + * @return $this + */ + public function setDisplayDevice($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\DisplayDevice::class); + $this->display_device = $var; + + return $this; + } + + /** + * Optional. A list of the type and count of accelerator cards attached to the + * instance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerators = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGuestAccelerators() + { + return $this->guest_accelerators; + } + + /** + * Optional. A list of the type and count of accelerator cards attached to the + * instance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerators = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\AcceleratorConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGuestAccelerators($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\AcceleratorConfig::class); + $this->guest_accelerators = $arr; + + return $this; + } + + /** + * Optional. Specifies the hostname of the instance. The specified hostname + * must be RFC1035 compliant. If hostname is not specified, the default + * hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global + * DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal + * DNS. + * + * Generated from protobuf field optional string hostname = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getHostname() + { + return isset($this->hostname) ? $this->hostname : ''; + } + + public function hasHostname() + { + return isset($this->hostname); + } + + public function clearHostname() + { + unset($this->hostname); + } + + /** + * Optional. Specifies the hostname of the instance. The specified hostname + * must be RFC1035 compliant. If hostname is not specified, the default + * hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global + * DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal + * DNS. + * + * Generated from protobuf field optional string hostname = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setHostname($var) + { + GPBUtil::checkString($var, True); + $this->hostname = $var; + + return $this; + } + + /** + * Optional. Encrypts suspended data for an instance with a + * customer-managed encryption key. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.CustomerEncryptionKey instance_encryption_key = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\CustomerEncryptionKey|null + */ + public function getInstanceEncryptionKey() + { + return $this->instance_encryption_key; + } + + public function hasInstanceEncryptionKey() + { + return isset($this->instance_encryption_key); + } + + public function clearInstanceEncryptionKey() + { + unset($this->instance_encryption_key); + } + + /** + * Optional. Encrypts suspended data for an instance with a + * customer-managed encryption key. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.CustomerEncryptionKey instance_encryption_key = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\CustomerEncryptionKey $var + * @return $this + */ + public function setInstanceEncryptionKey($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\CustomerEncryptionKey::class); + $this->instance_encryption_key = $var; + + return $this; + } + + /** + * Optional. KeyRevocationActionType of the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getKeyRevocationActionType() + { + return isset($this->key_revocation_action_type) ? $this->key_revocation_action_type : 0; + } + + public function hasKeyRevocationActionType() + { + return isset($this->key_revocation_action_type); + } + + public function clearKeyRevocationActionType() + { + unset($this->key_revocation_action_type); + } + + /** + * Optional. KeyRevocationActionType of the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setKeyRevocationActionType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\KeyRevocationActionType::class); + $this->key_revocation_action_type = $var; + + return $this; + } + + /** + * Optional. Labels to apply to this instance. + * + * Generated from protobuf field map labels = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. Labels to apply to this instance. + * + * Generated from protobuf field map labels = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Optional. Full or partial URL of the machine type resource to use for this + * instance. + * + * Generated from protobuf field optional string machine_type = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getMachineType() + { + return isset($this->machine_type) ? $this->machine_type : ''; + } + + public function hasMachineType() + { + return isset($this->machine_type); + } + + public function clearMachineType() + { + unset($this->machine_type); + } + + /** + * Optional. Full or partial URL of the machine type resource to use for this + * instance. + * + * Generated from protobuf field optional string machine_type = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setMachineType($var) + { + GPBUtil::checkString($var, True); + $this->machine_type = $var; + + return $this; + } + + /** + * Optional. This includes custom metadata and predefined keys. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Metadata metadata = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\Metadata|null + */ + public function getMetadata() + { + return $this->metadata; + } + + public function hasMetadata() + { + return isset($this->metadata); + } + + public function clearMetadata() + { + unset($this->metadata); + } + + /** + * Optional. This includes custom metadata and predefined keys. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Metadata metadata = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\Metadata $var + * @return $this + */ + public function setMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\Metadata::class); + $this->metadata = $var; + + return $this; + } + + /** + * Optional. Minimum CPU platform to use for this instance. + * + * Generated from protobuf field optional string min_cpu_platform = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getMinCpuPlatform() + { + return isset($this->min_cpu_platform) ? $this->min_cpu_platform : ''; + } + + public function hasMinCpuPlatform() + { + return isset($this->min_cpu_platform); + } + + public function clearMinCpuPlatform() + { + unset($this->min_cpu_platform); + } + + /** + * Optional. Minimum CPU platform to use for this instance. + * + * Generated from protobuf field optional string min_cpu_platform = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setMinCpuPlatform($var) + { + GPBUtil::checkString($var, True); + $this->min_cpu_platform = $var; + + return $this; + } + + /** + * Optional. An array of network configurations for this instance. These + * specify how interfaces are configured to interact with other network + * services, such as connecting to the internet. Multiple interfaces are + * supported per instance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.NetworkInterface network_interfaces = 17 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getNetworkInterfaces() + { + return $this->network_interfaces; + } + + /** + * Optional. An array of network configurations for this instance. These + * specify how interfaces are configured to interact with other network + * services, such as connecting to the internet. Multiple interfaces are + * supported per instance. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.NetworkInterface network_interfaces = 17 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\NetworkInterface>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setNetworkInterfaces($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\NetworkInterface::class); + $this->network_interfaces = $arr; + + return $this; + } + + /** + * Optional. Configure network performance such as egress bandwidth tier. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkPerformanceConfig network_performance_config = 18 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\NetworkPerformanceConfig|null + */ + public function getNetworkPerformanceConfig() + { + return $this->network_performance_config; + } + + public function hasNetworkPerformanceConfig() + { + return isset($this->network_performance_config); + } + + public function clearNetworkPerformanceConfig() + { + unset($this->network_performance_config); + } + + /** + * Optional. Configure network performance such as egress bandwidth tier. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkPerformanceConfig network_performance_config = 18 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\NetworkPerformanceConfig $var + * @return $this + */ + public function setNetworkPerformanceConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\NetworkPerformanceConfig::class); + $this->network_performance_config = $var; + + return $this; + } + + /** + * Input only. Additional params passed with the request, but not persisted + * as part of resource payload. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.InstanceParams params = 19 [(.google.api.field_behavior) = INPUT_ONLY]; + * @return \Google\Cloud\BackupDR\V1\InstanceParams|null + */ + public function getParams() + { + return $this->params; + } + + public function hasParams() + { + return isset($this->params); + } + + public function clearParams() + { + unset($this->params); + } + + /** + * Input only. Additional params passed with the request, but not persisted + * as part of resource payload. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.InstanceParams params = 19 [(.google.api.field_behavior) = INPUT_ONLY]; + * @param \Google\Cloud\BackupDR\V1\InstanceParams $var + * @return $this + */ + public function setParams($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\InstanceParams::class); + $this->params = $var; + + return $this; + } + + /** + * Optional. The private IPv6 google access type for the VM. + * If not specified, use INHERIT_FROM_SUBNETWORK as default. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.ComputeInstanceRestoreProperties.InstancePrivateIpv6GoogleAccess private_ipv6_google_access = 20 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPrivateIpv6GoogleAccess() + { + return isset($this->private_ipv6_google_access) ? $this->private_ipv6_google_access : 0; + } + + public function hasPrivateIpv6GoogleAccess() + { + return isset($this->private_ipv6_google_access); + } + + public function clearPrivateIpv6GoogleAccess() + { + unset($this->private_ipv6_google_access); + } + + /** + * Optional. The private IPv6 google access type for the VM. + * If not specified, use INHERIT_FROM_SUBNETWORK as default. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.ComputeInstanceRestoreProperties.InstancePrivateIpv6GoogleAccess private_ipv6_google_access = 20 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPrivateIpv6GoogleAccess($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\ComputeInstanceRestoreProperties\InstancePrivateIpv6GoogleAccess::class); + $this->private_ipv6_google_access = $var; + + return $this; + } + + /** + * Optional. Specifies the reservations that this instance can consume from. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AllocationAffinity allocation_affinity = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\AllocationAffinity|null + */ + public function getAllocationAffinity() + { + return $this->allocation_affinity; + } + + public function hasAllocationAffinity() + { + return isset($this->allocation_affinity); + } + + public function clearAllocationAffinity() + { + unset($this->allocation_affinity); + } + + /** + * Optional. Specifies the reservations that this instance can consume from. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.AllocationAffinity allocation_affinity = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\AllocationAffinity $var + * @return $this + */ + public function setAllocationAffinity($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\AllocationAffinity::class); + $this->allocation_affinity = $var; + + return $this; + } + + /** + * Optional. Resource policies applied to this instance. + * + * Generated from protobuf field repeated string resource_policies = 22 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getResourcePolicies() + { + return $this->resource_policies; + } + + /** + * Optional. Resource policies applied to this instance. + * + * Generated from protobuf field repeated string resource_policies = 22 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setResourcePolicies($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->resource_policies = $arr; + + return $this; + } + + /** + * Optional. Sets the scheduling options for this instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling scheduling = 23 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\Scheduling|null + */ + public function getScheduling() + { + return $this->scheduling; + } + + public function hasScheduling() + { + return isset($this->scheduling); + } + + public function clearScheduling() + { + unset($this->scheduling); + } + + /** + * Optional. Sets the scheduling options for this instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling scheduling = 23 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\Scheduling $var + * @return $this + */ + public function setScheduling($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\Scheduling::class); + $this->scheduling = $var; + + return $this; + } + + /** + * Optional. A list of service accounts, with their specified scopes, + * authorized for this instance. Only one service account per VM instance is + * supported. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.ServiceAccount service_accounts = 24 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getServiceAccounts() + { + return $this->service_accounts; + } + + /** + * Optional. A list of service accounts, with their specified scopes, + * authorized for this instance. Only one service account per VM instance is + * supported. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.ServiceAccount service_accounts = 24 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\ServiceAccount>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setServiceAccounts($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\ServiceAccount::class); + $this->service_accounts = $arr; + + return $this; + } + + /** + * Optional. Tags to apply to this instance. Tags are used to identify valid + * sources or targets for network firewalls and are specified by the client + * during instance creation. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Tags tags = 26 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\Tags|null + */ + public function getTags() + { + return $this->tags; + } + + public function hasTags() + { + return isset($this->tags); + } + + public function clearTags() + { + unset($this->tags); + } + + /** + * Optional. Tags to apply to this instance. Tags are used to identify valid + * sources or targets for network firewalls and are specified by the client + * during instance creation. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Tags tags = 26 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\Tags $var + * @return $this + */ + public function setTags($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\Tags::class); + $this->tags = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ComputeInstanceRestoreProperties/InstancePrivateIpv6GoogleAccess.php b/BackupDr/src/V1/ComputeInstanceRestoreProperties/InstancePrivateIpv6GoogleAccess.php new file mode 100644 index 000000000000..333ed1ee11a8 --- /dev/null +++ b/BackupDr/src/V1/ComputeInstanceRestoreProperties/InstancePrivateIpv6GoogleAccess.php @@ -0,0 +1,76 @@ +google.cloud.backupdr.v1.ComputeInstanceRestoreProperties.InstancePrivateIpv6GoogleAccess + */ +class InstancePrivateIpv6GoogleAccess +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum INSTANCE_PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED = 0; + */ + const INSTANCE_PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED = 0; + /** + * Each network interface inherits PrivateIpv6GoogleAccess from its + * subnetwork. + * + * Generated from protobuf enum INHERIT_FROM_SUBNETWORK = 1; + */ + const INHERIT_FROM_SUBNETWORK = 1; + /** + * Outbound private IPv6 access from VMs in this subnet to Google services. + * If specified, the subnetwork who is attached to the instance's default + * network interface will be assigned an internal IPv6 prefix if it doesn't + * have before. + * + * Generated from protobuf enum ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 2; + */ + const ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 2; + /** + * Bidirectional private IPv6 access to/from Google services. If + * specified, the subnetwork who is attached to the instance's default + * network interface will be assigned an internal IPv6 prefix if it doesn't + * have before. + * + * Generated from protobuf enum ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 3; + */ + const ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 3; + + private static $valueToName = [ + self::INSTANCE_PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED => 'INSTANCE_PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED', + self::INHERIT_FROM_SUBNETWORK => 'INHERIT_FROM_SUBNETWORK', + self::ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE => 'ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE', + self::ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE => 'ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/ComputeInstanceTargetEnvironment.php b/BackupDr/src/V1/ComputeInstanceTargetEnvironment.php new file mode 100644 index 000000000000..6251eea36937 --- /dev/null +++ b/BackupDr/src/V1/ComputeInstanceTargetEnvironment.php @@ -0,0 +1,102 @@ +google.cloud.backupdr.v1.ComputeInstanceTargetEnvironment + */ +class ComputeInstanceTargetEnvironment extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Target project for the Compute Engine instance. + * + * Generated from protobuf field string project = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $project = ''; + /** + * Required. The zone of the Compute Engine instance. + * + * Generated from protobuf field string zone = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $zone = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $project + * Required. Target project for the Compute Engine instance. + * @type string $zone + * Required. The zone of the Compute Engine instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Required. Target project for the Compute Engine instance. + * + * Generated from protobuf field string project = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getProject() + { + return $this->project; + } + + /** + * Required. Target project for the Compute Engine instance. + * + * Generated from protobuf field string project = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setProject($var) + { + GPBUtil::checkString($var, True); + $this->project = $var; + + return $this; + } + + /** + * Required. The zone of the Compute Engine instance. + * + * Generated from protobuf field string zone = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getZone() + { + return $this->zone; + } + + /** + * Required. The zone of the Compute Engine instance. + * + * Generated from protobuf field string zone = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setZone($var) + { + GPBUtil::checkString($var, True); + $this->zone = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ConfidentialInstanceConfig.php b/BackupDr/src/V1/ConfidentialInstanceConfig.php new file mode 100644 index 000000000000..276f5b0eaf46 --- /dev/null +++ b/BackupDr/src/V1/ConfidentialInstanceConfig.php @@ -0,0 +1,81 @@ +google.cloud.backupdr.v1.ConfidentialInstanceConfig + */ +class ConfidentialInstanceConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Defines whether the instance should have confidential compute + * enabled. + * + * Generated from protobuf field optional bool enable_confidential_compute = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_confidential_compute = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enable_confidential_compute + * Optional. Defines whether the instance should have confidential compute + * enabled. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Defines whether the instance should have confidential compute + * enabled. + * + * Generated from protobuf field optional bool enable_confidential_compute = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnableConfidentialCompute() + { + return isset($this->enable_confidential_compute) ? $this->enable_confidential_compute : false; + } + + public function hasEnableConfidentialCompute() + { + return isset($this->enable_confidential_compute); + } + + public function clearEnableConfidentialCompute() + { + unset($this->enable_confidential_compute); + } + + /** + * Optional. Defines whether the instance should have confidential compute + * enabled. + * + * Generated from protobuf field optional bool enable_confidential_compute = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnableConfidentialCompute($var) + { + GPBUtil::checkBool($var); + $this->enable_confidential_compute = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/CreateBackupPlanAssociationRequest.php b/BackupDr/src/V1/CreateBackupPlanAssociationRequest.php new file mode 100644 index 000000000000..9462d6101471 --- /dev/null +++ b/BackupDr/src/V1/CreateBackupPlanAssociationRequest.php @@ -0,0 +1,252 @@ +google.cloud.backupdr.v1.CreateBackupPlanAssociationRequest + */ +class CreateBackupPlanAssociationRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The backup plan association project and location in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The name of the backup plan association to create. The name must + * be unique for the specified project and location. + * + * Generated from protobuf field string backup_plan_association_id = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_plan_association_id = ''; + /** + * Required. The resource being created + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlanAssociation backup_plan_association = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_plan_association = null; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + + /** + * @param string $parent Required. The backup plan association project and location in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. Please see + * {@see BackupDRClient::locationName()} for help formatting this field. + * @param \Google\Cloud\BackupDR\V1\BackupPlanAssociation $backupPlanAssociation Required. The resource being created + * @param string $backupPlanAssociationId Required. The name of the backup plan association to create. The name must + * be unique for the specified project and location. + * + * @return \Google\Cloud\BackupDR\V1\CreateBackupPlanAssociationRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\BackupDR\V1\BackupPlanAssociation $backupPlanAssociation, string $backupPlanAssociationId): self + { + return (new self()) + ->setParent($parent) + ->setBackupPlanAssociation($backupPlanAssociation) + ->setBackupPlanAssociationId($backupPlanAssociationId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The backup plan association project and location in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. + * @type string $backup_plan_association_id + * Required. The name of the backup plan association to create. The name must + * be unique for the specified project and location. + * @type \Google\Cloud\BackupDR\V1\BackupPlanAssociation $backup_plan_association + * Required. The resource being created + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplanassociation::initOnce(); + parent::__construct($data); + } + + /** + * Required. The backup plan association project and location in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The backup plan association project and location in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The name of the backup plan association to create. The name must + * be unique for the specified project and location. + * + * Generated from protobuf field string backup_plan_association_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getBackupPlanAssociationId() + { + return $this->backup_plan_association_id; + } + + /** + * Required. The name of the backup plan association to create. The name must + * be unique for the specified project and location. + * + * Generated from protobuf field string backup_plan_association_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setBackupPlanAssociationId($var) + { + GPBUtil::checkString($var, True); + $this->backup_plan_association_id = $var; + + return $this; + } + + /** + * Required. The resource being created + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlanAssociation backup_plan_association = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\BackupDR\V1\BackupPlanAssociation|null + */ + public function getBackupPlanAssociation() + { + return $this->backup_plan_association; + } + + public function hasBackupPlanAssociation() + { + return isset($this->backup_plan_association); + } + + public function clearBackupPlanAssociation() + { + unset($this->backup_plan_association); + } + + /** + * Required. The resource being created + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlanAssociation backup_plan_association = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\BackupDR\V1\BackupPlanAssociation $var + * @return $this + */ + public function setBackupPlanAssociation($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupPlanAssociation::class); + $this->backup_plan_association = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/CreateBackupPlanRequest.php b/BackupDr/src/V1/CreateBackupPlanRequest.php new file mode 100644 index 000000000000..f4eeb674fb1f --- /dev/null +++ b/BackupDr/src/V1/CreateBackupPlanRequest.php @@ -0,0 +1,262 @@ +google.cloud.backupdr.v1.CreateBackupPlanRequest + */ +class CreateBackupPlanRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The `BackupPlan` project and location in the format + * `projects/{project}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The name of the `BackupPlan` to create. The name must be unique + * for the specified project and location.The name must start with a lowercase + * letter followed by up to 62 lowercase letters, numbers, or hyphens. + * Pattern, /[a-z][a-z0-9-]{,62}/. + * + * Generated from protobuf field string backup_plan_id = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_plan_id = ''; + /** + * Required. The `BackupPlan` resource object to create. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlan backup_plan = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_plan = null; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + + /** + * @param string $parent Required. The `BackupPlan` project and location in the format + * `projects/{project}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. Please see + * {@see BackupDRClient::locationName()} for help formatting this field. + * @param \Google\Cloud\BackupDR\V1\BackupPlan $backupPlan Required. The `BackupPlan` resource object to create. + * @param string $backupPlanId Required. The name of the `BackupPlan` to create. The name must be unique + * for the specified project and location.The name must start with a lowercase + * letter followed by up to 62 lowercase letters, numbers, or hyphens. + * Pattern, /[a-z][a-z0-9-]{,62}/. + * + * @return \Google\Cloud\BackupDR\V1\CreateBackupPlanRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\BackupDR\V1\BackupPlan $backupPlan, string $backupPlanId): self + { + return (new self()) + ->setParent($parent) + ->setBackupPlan($backupPlan) + ->setBackupPlanId($backupPlanId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The `BackupPlan` project and location in the format + * `projects/{project}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. + * @type string $backup_plan_id + * Required. The name of the `BackupPlan` to create. The name must be unique + * for the specified project and location.The name must start with a lowercase + * letter followed by up to 62 lowercase letters, numbers, or hyphens. + * Pattern, /[a-z][a-z0-9-]{,62}/. + * @type \Google\Cloud\BackupDR\V1\BackupPlan $backup_plan + * Required. The `BackupPlan` resource object to create. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Required. The `BackupPlan` project and location in the format + * `projects/{project}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The `BackupPlan` project and location in the format + * `projects/{project}/locations/{location}`. In Cloud BackupDR locations + * map to GCP regions, for example **us-central1**. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The name of the `BackupPlan` to create. The name must be unique + * for the specified project and location.The name must start with a lowercase + * letter followed by up to 62 lowercase letters, numbers, or hyphens. + * Pattern, /[a-z][a-z0-9-]{,62}/. + * + * Generated from protobuf field string backup_plan_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getBackupPlanId() + { + return $this->backup_plan_id; + } + + /** + * Required. The name of the `BackupPlan` to create. The name must be unique + * for the specified project and location.The name must start with a lowercase + * letter followed by up to 62 lowercase letters, numbers, or hyphens. + * Pattern, /[a-z][a-z0-9-]{,62}/. + * + * Generated from protobuf field string backup_plan_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setBackupPlanId($var) + { + GPBUtil::checkString($var, True); + $this->backup_plan_id = $var; + + return $this; + } + + /** + * Required. The `BackupPlan` resource object to create. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlan backup_plan = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\BackupDR\V1\BackupPlan|null + */ + public function getBackupPlan() + { + return $this->backup_plan; + } + + public function hasBackupPlan() + { + return isset($this->backup_plan); + } + + public function clearBackupPlan() + { + unset($this->backup_plan); + } + + /** + * Required. The `BackupPlan` resource object to create. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupPlan backup_plan = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\BackupDR\V1\BackupPlan $var + * @return $this + */ + public function setBackupPlan($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupPlan::class); + $this->backup_plan = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/CreateBackupVaultRequest.php b/BackupDr/src/V1/CreateBackupVaultRequest.php new file mode 100644 index 000000000000..39269b8ee810 --- /dev/null +++ b/BackupDr/src/V1/CreateBackupVaultRequest.php @@ -0,0 +1,285 @@ +google.cloud.backupdr.v1.CreateBackupVaultRequest + */ +class CreateBackupVaultRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Value for parent. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. ID of the requesting object + * If auto-generating ID server-side, remove this field and + * backup_vault_id from the method_signature of Create RPC + * + * Generated from protobuf field string backup_vault_id = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_vault_id = ''; + /** + * Required. The resource being created + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault backup_vault = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_vault = null; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $parent Required. Value for parent. Please see + * {@see BackupDRClient::locationName()} for help formatting this field. + * @param \Google\Cloud\BackupDR\V1\BackupVault $backupVault Required. The resource being created + * @param string $backupVaultId Required. ID of the requesting object + * If auto-generating ID server-side, remove this field and + * backup_vault_id from the method_signature of Create RPC + * + * @return \Google\Cloud\BackupDR\V1\CreateBackupVaultRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\BackupDR\V1\BackupVault $backupVault, string $backupVaultId): self + { + return (new self()) + ->setParent($parent) + ->setBackupVault($backupVault) + ->setBackupVaultId($backupVaultId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. Value for parent. + * @type string $backup_vault_id + * Required. ID of the requesting object + * If auto-generating ID server-side, remove this field and + * backup_vault_id from the method_signature of Create RPC + * @type \Google\Cloud\BackupDR\V1\BackupVault $backup_vault + * Required. The resource being created + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * @type bool $validate_only + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Value for parent. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. Value for parent. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. ID of the requesting object + * If auto-generating ID server-side, remove this field and + * backup_vault_id from the method_signature of Create RPC + * + * Generated from protobuf field string backup_vault_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getBackupVaultId() + { + return $this->backup_vault_id; + } + + /** + * Required. ID of the requesting object + * If auto-generating ID server-side, remove this field and + * backup_vault_id from the method_signature of Create RPC + * + * Generated from protobuf field string backup_vault_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setBackupVaultId($var) + { + GPBUtil::checkString($var, True); + $this->backup_vault_id = $var; + + return $this; + } + + /** + * Required. The resource being created + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault backup_vault = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\BackupDR\V1\BackupVault|null + */ + public function getBackupVault() + { + return $this->backup_vault; + } + + public function hasBackupVault() + { + return isset($this->backup_vault); + } + + public function clearBackupVault() + { + unset($this->backup_vault); + } + + /** + * Required. The resource being created + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault backup_vault = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\BackupDR\V1\BackupVault $var + * @return $this + */ + public function setBackupVault($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupVault::class); + $this->backup_vault = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/CreateManagementServerRequest.php b/BackupDr/src/V1/CreateManagementServerRequest.php index 4f329ab68f27..a1eb23931ba0 100644 --- a/BackupDr/src/V1/CreateManagementServerRequest.php +++ b/BackupDr/src/V1/CreateManagementServerRequest.php @@ -17,8 +17,8 @@ class CreateManagementServerRequest extends \Google\Protobuf\Internal\Message { /** * Required. The management server project and location in the format - * `projects/{project_id}/locations/{location}`. In Cloud Backup and DR - * locations map to GCP regions, for example **us-central1**. + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR + * locations map to Google Cloud regions, for example **us-central1**. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -56,8 +56,8 @@ class CreateManagementServerRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The management server project and location in the format - * `projects/{project_id}/locations/{location}`. In Cloud Backup and DR - * locations map to GCP regions, for example **us-central1**. Please see + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR + * locations map to Google Cloud regions, for example **us-central1**. Please see * {@see BackupDRClient::locationName()} for help formatting this field. * @param \Google\Cloud\BackupDR\V1\ManagementServer $managementServer Required. A [management server * resource][google.cloud.backupdr.v1.ManagementServer] @@ -84,8 +84,8 @@ public static function build(string $parent, \Google\Cloud\BackupDR\V1\Managemen * * @type string $parent * Required. The management server project and location in the format - * `projects/{project_id}/locations/{location}`. In Cloud Backup and DR - * locations map to GCP regions, for example **us-central1**. + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR + * locations map to Google Cloud regions, for example **us-central1**. * @type string $management_server_id * Required. The name of the management server to create. The name must be * unique for the specified project and location. @@ -113,8 +113,8 @@ public function __construct($data = NULL) { /** * Required. The management server project and location in the format - * `projects/{project_id}/locations/{location}`. In Cloud Backup and DR - * locations map to GCP regions, for example **us-central1**. + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR + * locations map to Google Cloud regions, for example **us-central1**. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -126,8 +126,8 @@ public function getParent() /** * Required. The management server project and location in the format - * `projects/{project_id}/locations/{location}`. In Cloud Backup and DR - * locations map to GCP regions, for example **us-central1**. + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR + * locations map to Google Cloud regions, for example **us-central1**. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/BackupDr/src/V1/CustomerEncryptionKey.php b/BackupDr/src/V1/CustomerEncryptionKey.php new file mode 100644 index 000000000000..da28ac0861a8 --- /dev/null +++ b/BackupDr/src/V1/CustomerEncryptionKey.php @@ -0,0 +1,205 @@ +google.cloud.backupdr.v1.CustomerEncryptionKey + */ +class CustomerEncryptionKey extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The service account being used for the encryption request for the + * given KMS key. If absent, the Compute Engine default service account is + * used. + * + * Generated from protobuf field optional string kms_key_service_account = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $kms_key_service_account = null; + protected $key; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $raw_key + * Optional. Specifies a 256-bit customer-supplied + * encryption key. + * @type string $rsa_encrypted_key + * Optional. RSA-wrapped 2048-bit + * customer-supplied encryption key to either encrypt or decrypt this + * resource. + * @type string $kms_key_name + * Optional. The name of the encryption key that is stored in Google Cloud + * KMS. + * @type string $kms_key_service_account + * Optional. The service account being used for the encryption request for the + * given KMS key. If absent, the Compute Engine default service account is + * used. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Specifies a 256-bit customer-supplied + * encryption key. + * + * Generated from protobuf field string raw_key = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getRawKey() + { + return $this->readOneof(1); + } + + public function hasRawKey() + { + return $this->hasOneof(1); + } + + /** + * Optional. Specifies a 256-bit customer-supplied + * encryption key. + * + * Generated from protobuf field string raw_key = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setRawKey($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * Optional. RSA-wrapped 2048-bit + * customer-supplied encryption key to either encrypt or decrypt this + * resource. + * + * Generated from protobuf field string rsa_encrypted_key = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getRsaEncryptedKey() + { + return $this->readOneof(2); + } + + public function hasRsaEncryptedKey() + { + return $this->hasOneof(2); + } + + /** + * Optional. RSA-wrapped 2048-bit + * customer-supplied encryption key to either encrypt or decrypt this + * resource. + * + * Generated from protobuf field string rsa_encrypted_key = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setRsaEncryptedKey($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Optional. The name of the encryption key that is stored in Google Cloud + * KMS. + * + * Generated from protobuf field string kms_key_name = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getKmsKeyName() + { + return $this->readOneof(3); + } + + public function hasKmsKeyName() + { + return $this->hasOneof(3); + } + + /** + * Optional. The name of the encryption key that is stored in Google Cloud + * KMS. + * + * Generated from protobuf field string kms_key_name = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setKmsKeyName($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Optional. The service account being used for the encryption request for the + * given KMS key. If absent, the Compute Engine default service account is + * used. + * + * Generated from protobuf field optional string kms_key_service_account = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getKmsKeyServiceAccount() + { + return isset($this->kms_key_service_account) ? $this->kms_key_service_account : ''; + } + + public function hasKmsKeyServiceAccount() + { + return isset($this->kms_key_service_account); + } + + public function clearKmsKeyServiceAccount() + { + unset($this->kms_key_service_account); + } + + /** + * Optional. The service account being used for the encryption request for the + * given KMS key. If absent, the Compute Engine default service account is + * used. + * + * Generated from protobuf field optional string kms_key_service_account = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setKmsKeyServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->kms_key_service_account = $var; + + return $this; + } + + /** + * @return string + */ + public function getKey() + { + return $this->whichOneof("key"); + } + +} + diff --git a/BackupDr/src/V1/DataSource.php b/BackupDr/src/V1/DataSource.php new file mode 100644 index 000000000000..5522ae4f3952 --- /dev/null +++ b/BackupDr/src/V1/DataSource.php @@ -0,0 +1,543 @@ +google.cloud.backupdr.v1.DataSource + */ +class DataSource extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Identifier. Name of the datasource to create. + * It must have the + * format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. + * `{datasource}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the backup vault. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. The DataSource resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSource.State state = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $state = 0; + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined: + * + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Number of backups in the data source. + * + * Generated from protobuf field optional int64 backup_count = 7; + */ + protected $backup_count = null; + /** + * Server specified ETag for the ManagementServer resource to prevent + * simultaneous updates from overwiting each other. + * + * Generated from protobuf field optional string etag = 14; + */ + protected $etag = null; + /** + * The number of bytes (metadata and data) stored in this datasource. + * + * Generated from protobuf field optional int64 total_stored_bytes = 23; + */ + protected $total_stored_bytes = null; + /** + * Output only. The backup configuration state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigState config_state = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $config_state = 0; + /** + * Output only. Details of how the resource is configured for backup. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigInfo backup_config_info = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $backup_config_info = null; + protected $source_resource; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Output only. Identifier. Name of the datasource to create. + * It must have the + * format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. + * `{datasource}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the backup vault. + * @type int $state + * Output only. The DataSource resource instance state. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined: + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the instance was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the instance was updated. + * @type int|string $backup_count + * Number of backups in the data source. + * @type string $etag + * Server specified ETag for the ManagementServer resource to prevent + * simultaneous updates from overwiting each other. + * @type int|string $total_stored_bytes + * The number of bytes (metadata and data) stored in this datasource. + * @type int $config_state + * Output only. The backup configuration state. + * @type \Google\Cloud\BackupDR\V1\BackupConfigInfo $backup_config_info + * Output only. Details of how the resource is configured for backup. + * @type \Google\Cloud\BackupDR\V1\DataSourceGcpResource $data_source_gcp_resource + * The backed up resource is a Google Cloud resource. + * The word 'DataSource' was included in the names to indicate that this is + * the representation of the Google Cloud resource used within the + * DataSource object. + * @type \Google\Cloud\BackupDR\V1\DataSourceBackupApplianceApplication $data_source_backup_appliance_application + * The backed up resource is a backup appliance application. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Identifier. Name of the datasource to create. + * It must have the + * format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. + * `{datasource}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the backup vault. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Output only. Identifier. Name of the datasource to create. + * It must have the + * format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. + * `{datasource}` cannot be changed after creation. It must be between 3-63 + * characters long and must be unique within the backup vault. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. The DataSource resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSource.State state = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getState() + { + return $this->state; + } + + /** + * Output only. The DataSource resource instance state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSource.State state = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\DataSource\State::class); + $this->state = $var; + + return $this; + } + + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined: + * + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. Resource labels to represent user provided metadata. + * No labels currently defined: + * + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field optional .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field optional .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Number of backups in the data source. + * + * Generated from protobuf field optional int64 backup_count = 7; + * @return int|string + */ + public function getBackupCount() + { + return isset($this->backup_count) ? $this->backup_count : 0; + } + + public function hasBackupCount() + { + return isset($this->backup_count); + } + + public function clearBackupCount() + { + unset($this->backup_count); + } + + /** + * Number of backups in the data source. + * + * Generated from protobuf field optional int64 backup_count = 7; + * @param int|string $var + * @return $this + */ + public function setBackupCount($var) + { + GPBUtil::checkInt64($var); + $this->backup_count = $var; + + return $this; + } + + /** + * Server specified ETag for the ManagementServer resource to prevent + * simultaneous updates from overwiting each other. + * + * Generated from protobuf field optional string etag = 14; + * @return string + */ + public function getEtag() + { + return isset($this->etag) ? $this->etag : ''; + } + + public function hasEtag() + { + return isset($this->etag); + } + + public function clearEtag() + { + unset($this->etag); + } + + /** + * Server specified ETag for the ManagementServer resource to prevent + * simultaneous updates from overwiting each other. + * + * Generated from protobuf field optional string etag = 14; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * The number of bytes (metadata and data) stored in this datasource. + * + * Generated from protobuf field optional int64 total_stored_bytes = 23; + * @return int|string + */ + public function getTotalStoredBytes() + { + return isset($this->total_stored_bytes) ? $this->total_stored_bytes : 0; + } + + public function hasTotalStoredBytes() + { + return isset($this->total_stored_bytes); + } + + public function clearTotalStoredBytes() + { + unset($this->total_stored_bytes); + } + + /** + * The number of bytes (metadata and data) stored in this datasource. + * + * Generated from protobuf field optional int64 total_stored_bytes = 23; + * @param int|string $var + * @return $this + */ + public function setTotalStoredBytes($var) + { + GPBUtil::checkInt64($var); + $this->total_stored_bytes = $var; + + return $this; + } + + /** + * Output only. The backup configuration state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigState config_state = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getConfigState() + { + return $this->config_state; + } + + /** + * Output only. The backup configuration state. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigState config_state = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setConfigState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupConfigState::class); + $this->config_state = $var; + + return $this; + } + + /** + * Output only. Details of how the resource is configured for backup. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigInfo backup_config_info = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\BackupDR\V1\BackupConfigInfo|null + */ + public function getBackupConfigInfo() + { + return $this->backup_config_info; + } + + public function hasBackupConfigInfo() + { + return isset($this->backup_config_info); + } + + public function clearBackupConfigInfo() + { + unset($this->backup_config_info); + } + + /** + * Output only. Details of how the resource is configured for backup. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupConfigInfo backup_config_info = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\BackupDR\V1\BackupConfigInfo $var + * @return $this + */ + public function setBackupConfigInfo($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupConfigInfo::class); + $this->backup_config_info = $var; + + return $this; + } + + /** + * The backed up resource is a Google Cloud resource. + * The word 'DataSource' was included in the names to indicate that this is + * the representation of the Google Cloud resource used within the + * DataSource object. + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSourceGcpResource data_source_gcp_resource = 26; + * @return \Google\Cloud\BackupDR\V1\DataSourceGcpResource|null + */ + public function getDataSourceGcpResource() + { + return $this->readOneof(26); + } + + public function hasDataSourceGcpResource() + { + return $this->hasOneof(26); + } + + /** + * The backed up resource is a Google Cloud resource. + * The word 'DataSource' was included in the names to indicate that this is + * the representation of the Google Cloud resource used within the + * DataSource object. + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSourceGcpResource data_source_gcp_resource = 26; + * @param \Google\Cloud\BackupDR\V1\DataSourceGcpResource $var + * @return $this + */ + public function setDataSourceGcpResource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\DataSourceGcpResource::class); + $this->writeOneof(26, $var); + + return $this; + } + + /** + * The backed up resource is a backup appliance application. + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSourceBackupApplianceApplication data_source_backup_appliance_application = 27; + * @return \Google\Cloud\BackupDR\V1\DataSourceBackupApplianceApplication|null + */ + public function getDataSourceBackupApplianceApplication() + { + return $this->readOneof(27); + } + + public function hasDataSourceBackupApplianceApplication() + { + return $this->hasOneof(27); + } + + /** + * The backed up resource is a backup appliance application. + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSourceBackupApplianceApplication data_source_backup_appliance_application = 27; + * @param \Google\Cloud\BackupDR\V1\DataSourceBackupApplianceApplication $var + * @return $this + */ + public function setDataSourceBackupApplianceApplication($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\DataSourceBackupApplianceApplication::class); + $this->writeOneof(27, $var); + + return $this; + } + + /** + * @return string + */ + public function getSourceResource() + { + return $this->whichOneof("source_resource"); + } + +} + diff --git a/BackupDr/src/V1/DataSource/State.php b/BackupDr/src/V1/DataSource/State.php new file mode 100644 index 000000000000..900f3b1ef95a --- /dev/null +++ b/BackupDr/src/V1/DataSource/State.php @@ -0,0 +1,76 @@ +google.cloud.backupdr.v1.DataSource.State + */ +class State +{ + /** + * State not set. + * + * Generated from protobuf enum STATE_UNSPECIFIED = 0; + */ + const STATE_UNSPECIFIED = 0; + /** + * The data source is being created. + * + * Generated from protobuf enum CREATING = 1; + */ + const CREATING = 1; + /** + * The data source has been created and is fully usable. + * + * Generated from protobuf enum ACTIVE = 2; + */ + const ACTIVE = 2; + /** + * The data source is being deleted. + * + * Generated from protobuf enum DELETING = 3; + */ + const DELETING = 3; + /** + * The data source is experiencing an issue and might be unusable. + * + * Generated from protobuf enum ERROR = 4; + */ + const ERROR = 4; + + private static $valueToName = [ + self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', + self::CREATING => 'CREATING', + self::ACTIVE => 'ACTIVE', + self::DELETING => 'DELETING', + self::ERROR => 'ERROR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/DataSourceBackupApplianceApplication.php b/BackupDr/src/V1/DataSourceBackupApplianceApplication.php new file mode 100644 index 000000000000..07e5a34b90f2 --- /dev/null +++ b/BackupDr/src/V1/DataSourceBackupApplianceApplication.php @@ -0,0 +1,272 @@ +google.cloud.backupdr.v1.DataSourceBackupApplianceApplication + */ +class DataSourceBackupApplianceApplication extends \Google\Protobuf\Internal\Message +{ + /** + * The name of the Application as known to the Backup Appliance. + * + * Generated from protobuf field string application_name = 1; + */ + protected $application_name = ''; + /** + * Appliance name. + * + * Generated from protobuf field string backup_appliance = 2; + */ + protected $backup_appliance = ''; + /** + * Appliance Id of the Backup Appliance. + * + * Generated from protobuf field int64 appliance_id = 3; + */ + protected $appliance_id = 0; + /** + * The type of the application. e.g. VMBackup + * + * Generated from protobuf field string type = 4; + */ + protected $type = ''; + /** + * The appid field of the application within the Backup Appliance. + * + * Generated from protobuf field int64 application_id = 8; + */ + protected $application_id = 0; + /** + * Hostname of the host where the application is running. + * + * Generated from protobuf field string hostname = 6; + */ + protected $hostname = ''; + /** + * Hostid of the application host. + * + * Generated from protobuf field int64 host_id = 7; + */ + protected $host_id = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $application_name + * The name of the Application as known to the Backup Appliance. + * @type string $backup_appliance + * Appliance name. + * @type int|string $appliance_id + * Appliance Id of the Backup Appliance. + * @type string $type + * The type of the application. e.g. VMBackup + * @type int|string $application_id + * The appid field of the application within the Backup Appliance. + * @type string $hostname + * Hostname of the host where the application is running. + * @type int|string $host_id + * Hostid of the application host. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * The name of the Application as known to the Backup Appliance. + * + * Generated from protobuf field string application_name = 1; + * @return string + */ + public function getApplicationName() + { + return $this->application_name; + } + + /** + * The name of the Application as known to the Backup Appliance. + * + * Generated from protobuf field string application_name = 1; + * @param string $var + * @return $this + */ + public function setApplicationName($var) + { + GPBUtil::checkString($var, True); + $this->application_name = $var; + + return $this; + } + + /** + * Appliance name. + * + * Generated from protobuf field string backup_appliance = 2; + * @return string + */ + public function getBackupAppliance() + { + return $this->backup_appliance; + } + + /** + * Appliance name. + * + * Generated from protobuf field string backup_appliance = 2; + * @param string $var + * @return $this + */ + public function setBackupAppliance($var) + { + GPBUtil::checkString($var, True); + $this->backup_appliance = $var; + + return $this; + } + + /** + * Appliance Id of the Backup Appliance. + * + * Generated from protobuf field int64 appliance_id = 3; + * @return int|string + */ + public function getApplianceId() + { + return $this->appliance_id; + } + + /** + * Appliance Id of the Backup Appliance. + * + * Generated from protobuf field int64 appliance_id = 3; + * @param int|string $var + * @return $this + */ + public function setApplianceId($var) + { + GPBUtil::checkInt64($var); + $this->appliance_id = $var; + + return $this; + } + + /** + * The type of the application. e.g. VMBackup + * + * Generated from protobuf field string type = 4; + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * The type of the application. e.g. VMBackup + * + * Generated from protobuf field string type = 4; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + + /** + * The appid field of the application within the Backup Appliance. + * + * Generated from protobuf field int64 application_id = 8; + * @return int|string + */ + public function getApplicationId() + { + return $this->application_id; + } + + /** + * The appid field of the application within the Backup Appliance. + * + * Generated from protobuf field int64 application_id = 8; + * @param int|string $var + * @return $this + */ + public function setApplicationId($var) + { + GPBUtil::checkInt64($var); + $this->application_id = $var; + + return $this; + } + + /** + * Hostname of the host where the application is running. + * + * Generated from protobuf field string hostname = 6; + * @return string + */ + public function getHostname() + { + return $this->hostname; + } + + /** + * Hostname of the host where the application is running. + * + * Generated from protobuf field string hostname = 6; + * @param string $var + * @return $this + */ + public function setHostname($var) + { + GPBUtil::checkString($var, True); + $this->hostname = $var; + + return $this; + } + + /** + * Hostid of the application host. + * + * Generated from protobuf field int64 host_id = 7; + * @return int|string + */ + public function getHostId() + { + return $this->host_id; + } + + /** + * Hostid of the application host. + * + * Generated from protobuf field int64 host_id = 7; + * @param int|string $var + * @return $this + */ + public function setHostId($var) + { + GPBUtil::checkInt64($var); + $this->host_id = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/DataSourceGcpResource.php b/BackupDr/src/V1/DataSourceGcpResource.php new file mode 100644 index 000000000000..dfd4a646d3ee --- /dev/null +++ b/BackupDr/src/V1/DataSourceGcpResource.php @@ -0,0 +1,190 @@ +google.cloud.backupdr.v1.DataSourceGcpResource + */ +class DataSourceGcpResource extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Full resource pathname URL of the source Google Cloud + * resource. + * + * Generated from protobuf field string gcp_resourcename = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $gcp_resourcename = ''; + /** + * Location of the resource: //"global"/"unspecified". + * + * Generated from protobuf field string location = 2; + */ + protected $location = ''; + /** + * The type of the Google Cloud resource. Use the Unified Resource Type, + * eg. compute.googleapis.com/Instance. + * + * Generated from protobuf field string type = 3; + */ + protected $type = ''; + protected $gcp_resource_properties; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $gcp_resourcename + * Output only. Full resource pathname URL of the source Google Cloud + * resource. + * @type string $location + * Location of the resource: //"global"/"unspecified". + * @type string $type + * The type of the Google Cloud resource. Use the Unified Resource Type, + * eg. compute.googleapis.com/Instance. + * @type \Google\Cloud\BackupDR\V1\ComputeInstanceDataSourceProperties $compute_instance_datasource_properties + * ComputeInstanceDataSourceProperties has a subset of Compute Instance + * properties that are useful at the Datasource level. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Full resource pathname URL of the source Google Cloud + * resource. + * + * Generated from protobuf field string gcp_resourcename = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getGcpResourcename() + { + return $this->gcp_resourcename; + } + + /** + * Output only. Full resource pathname URL of the source Google Cloud + * resource. + * + * Generated from protobuf field string gcp_resourcename = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setGcpResourcename($var) + { + GPBUtil::checkString($var, True); + $this->gcp_resourcename = $var; + + return $this; + } + + /** + * Location of the resource: //"global"/"unspecified". + * + * Generated from protobuf field string location = 2; + * @return string + */ + public function getLocation() + { + return $this->location; + } + + /** + * Location of the resource: //"global"/"unspecified". + * + * Generated from protobuf field string location = 2; + * @param string $var + * @return $this + */ + public function setLocation($var) + { + GPBUtil::checkString($var, True); + $this->location = $var; + + return $this; + } + + /** + * The type of the Google Cloud resource. Use the Unified Resource Type, + * eg. compute.googleapis.com/Instance. + * + * Generated from protobuf field string type = 3; + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * The type of the Google Cloud resource. Use the Unified Resource Type, + * eg. compute.googleapis.com/Instance. + * + * Generated from protobuf field string type = 3; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + + /** + * ComputeInstanceDataSourceProperties has a subset of Compute Instance + * properties that are useful at the Datasource level. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ComputeInstanceDataSourceProperties compute_instance_datasource_properties = 4; + * @return \Google\Cloud\BackupDR\V1\ComputeInstanceDataSourceProperties|null + */ + public function getComputeInstanceDatasourceProperties() + { + return $this->readOneof(4); + } + + public function hasComputeInstanceDatasourceProperties() + { + return $this->hasOneof(4); + } + + /** + * ComputeInstanceDataSourceProperties has a subset of Compute Instance + * properties that are useful at the Datasource level. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ComputeInstanceDataSourceProperties compute_instance_datasource_properties = 4; + * @param \Google\Cloud\BackupDR\V1\ComputeInstanceDataSourceProperties $var + * @return $this + */ + public function setComputeInstanceDatasourceProperties($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\ComputeInstanceDataSourceProperties::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * @return string + */ + public function getGcpResourceProperties() + { + return $this->whichOneof("gcp_resource_properties"); + } + +} + diff --git a/BackupDr/src/V1/DeleteBackupPlanAssociationRequest.php b/BackupDr/src/V1/DeleteBackupPlanAssociationRequest.php new file mode 100644 index 000000000000..d89d4149bfa5 --- /dev/null +++ b/BackupDr/src/V1/DeleteBackupPlanAssociationRequest.php @@ -0,0 +1,160 @@ +google.cloud.backupdr.v1.DeleteBackupPlanAssociationRequest + */ +class DeleteBackupPlanAssociationRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + + /** + * @param string $name Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * Please see {@see BackupDRClient::backupPlanAssociationName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\DeleteBackupPlanAssociationRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplanassociation::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/DeleteBackupPlanRequest.php b/BackupDr/src/V1/DeleteBackupPlanRequest.php new file mode 100644 index 000000000000..33d0f577a1de --- /dev/null +++ b/BackupDr/src/V1/DeleteBackupPlanRequest.php @@ -0,0 +1,161 @@ +google.cloud.backupdr.v1.DeleteBackupPlanRequest + */ +class DeleteBackupPlanRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the `BackupPlan` to delete. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + + /** + * @param string $name Required. The resource name of the `BackupPlan` to delete. + * + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * Please see {@see BackupDRClient::backupPlanName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\DeleteBackupPlanRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the `BackupPlan` to delete. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the `BackupPlan` to delete. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the `BackupPlan` to delete. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/DeleteBackupRequest.php b/BackupDr/src/V1/DeleteBackupRequest.php new file mode 100644 index 000000000000..d3b5a8223f9c --- /dev/null +++ b/BackupDr/src/V1/DeleteBackupRequest.php @@ -0,0 +1,155 @@ +google.cloud.backupdr.v1.DeleteBackupRequest + */ +class DeleteBackupRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + + /** + * @param string $name Required. Name of the resource. Please see + * {@see BackupDRClient::backupName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\DeleteBackupRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the resource. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/DeleteBackupVaultRequest.php b/BackupDr/src/V1/DeleteBackupVaultRequest.php new file mode 100644 index 000000000000..2408f02e4d27 --- /dev/null +++ b/BackupDr/src/V1/DeleteBackupVaultRequest.php @@ -0,0 +1,311 @@ +google.cloud.backupdr.v1.DeleteBackupVaultRequest + */ +class DeleteBackupVaultRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + /** + * Optional. If set to true, any data source from this backup vault will also + * be deleted. + * + * Generated from protobuf field bool force = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $force = false; + /** + * The current etag of the backup vault. + * If an etag is provided and does not match the current etag of the + * connection, deletion will be blocked. + * + * Generated from protobuf field string etag = 4; + */ + protected $etag = ''; + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + /** + * Optional. If true and the BackupVault is not found, the request will + * succeed but no action will be taken. + * + * Generated from protobuf field bool allow_missing = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + + /** + * @param string $name Required. Name of the resource. Please see + * {@see BackupDRClient::backupVaultName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\DeleteBackupVaultRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the resource. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * @type bool $force + * Optional. If set to true, any data source from this backup vault will also + * be deleted. + * @type string $etag + * The current etag of the backup vault. + * If an etag is provided and does not match the current etag of the + * connection, deletion will be blocked. + * @type bool $validate_only + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * @type bool $allow_missing + * Optional. If true and the BackupVault is not found, the request will + * succeed but no action will be taken. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + + /** + * Optional. If set to true, any data source from this backup vault will also + * be deleted. + * + * Generated from protobuf field bool force = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getForce() + { + return $this->force; + } + + /** + * Optional. If set to true, any data source from this backup vault will also + * be deleted. + * + * Generated from protobuf field bool force = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setForce($var) + { + GPBUtil::checkBool($var); + $this->force = $var; + + return $this; + } + + /** + * The current etag of the backup vault. + * If an etag is provided and does not match the current etag of the + * connection, deletion will be blocked. + * + * Generated from protobuf field string etag = 4; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * The current etag of the backup vault. + * If an etag is provided and does not match the current etag of the + * connection, deletion will be blocked. + * + * Generated from protobuf field string etag = 4; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + + /** + * Optional. If true and the BackupVault is not found, the request will + * succeed but no action will be taken. + * + * Generated from protobuf field bool allow_missing = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If true and the BackupVault is not found, the request will + * succeed but no action will be taken. + * + * Generated from protobuf field bool allow_missing = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/DisplayDevice.php b/BackupDr/src/V1/DisplayDevice.php new file mode 100644 index 000000000000..fd3d2d33844d --- /dev/null +++ b/BackupDr/src/V1/DisplayDevice.php @@ -0,0 +1,77 @@ +google.cloud.backupdr.v1.DisplayDevice + */ +class DisplayDevice extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Enables display for the Compute Engine VM + * + * Generated from protobuf field optional bool enable_display = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_display = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enable_display + * Optional. Enables display for the Compute Engine VM + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Enables display for the Compute Engine VM + * + * Generated from protobuf field optional bool enable_display = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnableDisplay() + { + return isset($this->enable_display) ? $this->enable_display : false; + } + + public function hasEnableDisplay() + { + return isset($this->enable_display); + } + + public function clearEnableDisplay() + { + unset($this->enable_display); + } + + /** + * Optional. Enables display for the Compute Engine VM + * + * Generated from protobuf field optional bool enable_display = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnableDisplay($var) + { + GPBUtil::checkBool($var); + $this->enable_display = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/Entry.php b/BackupDr/src/V1/Entry.php new file mode 100644 index 000000000000..43f3558be810 --- /dev/null +++ b/BackupDr/src/V1/Entry.php @@ -0,0 +1,133 @@ +google.cloud.backupdr.v1.Entry + */ +class Entry extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Key for the metadata entry. + * + * Generated from protobuf field optional string key = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $key = null; + /** + * Optional. Value for the metadata entry. These are free-form strings, and + * only have meaning as interpreted by the image running in the instance. The + * only restriction placed on values is that their size must be less than + * or equal to 262144 bytes (256 KiB). + * + * Generated from protobuf field optional string value = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $value = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $key + * Optional. Key for the metadata entry. + * @type string $value + * Optional. Value for the metadata entry. These are free-form strings, and + * only have meaning as interpreted by the image running in the instance. The + * only restriction placed on values is that their size must be less than + * or equal to 262144 bytes (256 KiB). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Key for the metadata entry. + * + * Generated from protobuf field optional string key = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getKey() + { + return isset($this->key) ? $this->key : ''; + } + + public function hasKey() + { + return isset($this->key); + } + + public function clearKey() + { + unset($this->key); + } + + /** + * Optional. Key for the metadata entry. + * + * Generated from protobuf field optional string key = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setKey($var) + { + GPBUtil::checkString($var, True); + $this->key = $var; + + return $this; + } + + /** + * Optional. Value for the metadata entry. These are free-form strings, and + * only have meaning as interpreted by the image running in the instance. The + * only restriction placed on values is that their size must be less than + * or equal to 262144 bytes (256 KiB). + * + * Generated from protobuf field optional string value = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getValue() + { + return isset($this->value) ? $this->value : ''; + } + + public function hasValue() + { + return isset($this->value); + } + + public function clearValue() + { + unset($this->value); + } + + /** + * Optional. Value for the metadata entry. These are free-form strings, and + * only have meaning as interpreted by the image running in the instance. The + * only restriction placed on values is that their size must be less than + * or equal to 262144 bytes (256 KiB). + * + * Generated from protobuf field optional string value = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkString($var, True); + $this->value = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/FetchUsableBackupVaultsRequest.php b/BackupDr/src/V1/FetchUsableBackupVaultsRequest.php new file mode 100644 index 000000000000..142606583a7a --- /dev/null +++ b/BackupDr/src/V1/FetchUsableBackupVaultsRequest.php @@ -0,0 +1,246 @@ +google.cloud.backupdr.v1.FetchUsableBackupVaultsRequest + */ +class FetchUsableBackupVaultsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + + /** + * @param string $parent Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. Please see + * {@see BackupDRClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\FetchUsableBackupVaultsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. + * @type int $page_size + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * @type string $page_token + * Optional. A token identifying a page of results the server should return. + * @type string $filter + * Optional. Filtering results. + * @type string $order_by + * Optional. Hint for how to order the results. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/FetchUsableBackupVaultsResponse.php b/BackupDr/src/V1/FetchUsableBackupVaultsResponse.php new file mode 100644 index 000000000000..058334542e91 --- /dev/null +++ b/BackupDr/src/V1/FetchUsableBackupVaultsResponse.php @@ -0,0 +1,159 @@ +google.cloud.backupdr.v1.FetchUsableBackupVaultsResponse + */ +class FetchUsableBackupVaultsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of BackupVault instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup vaults in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupVault backup_vaults = 1; + */ + private $backup_vaults; + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\BackupDR\V1\BackupVault>|\Google\Protobuf\Internal\RepeatedField $backup_vaults + * The list of BackupVault instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup vaults in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * @type string $next_page_token + * A token identifying a page of results the server should return. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Locations that could not be reached. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * The list of BackupVault instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup vaults in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupVault backup_vaults = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBackupVaults() + { + return $this->backup_vaults; + } + + /** + * The list of BackupVault instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup vaults in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupVault backup_vaults = 1; + * @param array<\Google\Cloud\BackupDR\V1\BackupVault>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBackupVaults($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\BackupVault::class); + $this->backup_vaults = $arr; + + return $this; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GcpBackupConfig.php b/BackupDr/src/V1/GcpBackupConfig.php new file mode 100644 index 000000000000..5e8d78bb7496 --- /dev/null +++ b/BackupDr/src/V1/GcpBackupConfig.php @@ -0,0 +1,171 @@ +google.cloud.backupdr.v1.GcpBackupConfig + */ +class GcpBackupConfig extends \Google\Protobuf\Internal\Message +{ + /** + * The name of the backup plan. + * + * Generated from protobuf field string backup_plan = 1 [(.google.api.resource_reference) = { + */ + protected $backup_plan = ''; + /** + * The description of the backup plan. + * + * Generated from protobuf field string backup_plan_description = 2; + */ + protected $backup_plan_description = ''; + /** + * The name of the backup plan association. + * + * Generated from protobuf field string backup_plan_association = 3 [(.google.api.resource_reference) = { + */ + protected $backup_plan_association = ''; + /** + * The names of the backup plan rules which point to this backupvault + * + * Generated from protobuf field repeated string backup_plan_rules = 4; + */ + private $backup_plan_rules; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $backup_plan + * The name of the backup plan. + * @type string $backup_plan_description + * The description of the backup plan. + * @type string $backup_plan_association + * The name of the backup plan association. + * @type array|\Google\Protobuf\Internal\RepeatedField $backup_plan_rules + * The names of the backup plan rules which point to this backupvault + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * The name of the backup plan. + * + * Generated from protobuf field string backup_plan = 1 [(.google.api.resource_reference) = { + * @return string + */ + public function getBackupPlan() + { + return $this->backup_plan; + } + + /** + * The name of the backup plan. + * + * Generated from protobuf field string backup_plan = 1 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setBackupPlan($var) + { + GPBUtil::checkString($var, True); + $this->backup_plan = $var; + + return $this; + } + + /** + * The description of the backup plan. + * + * Generated from protobuf field string backup_plan_description = 2; + * @return string + */ + public function getBackupPlanDescription() + { + return $this->backup_plan_description; + } + + /** + * The description of the backup plan. + * + * Generated from protobuf field string backup_plan_description = 2; + * @param string $var + * @return $this + */ + public function setBackupPlanDescription($var) + { + GPBUtil::checkString($var, True); + $this->backup_plan_description = $var; + + return $this; + } + + /** + * The name of the backup plan association. + * + * Generated from protobuf field string backup_plan_association = 3 [(.google.api.resource_reference) = { + * @return string + */ + public function getBackupPlanAssociation() + { + return $this->backup_plan_association; + } + + /** + * The name of the backup plan association. + * + * Generated from protobuf field string backup_plan_association = 3 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setBackupPlanAssociation($var) + { + GPBUtil::checkString($var, True); + $this->backup_plan_association = $var; + + return $this; + } + + /** + * The names of the backup plan rules which point to this backupvault + * + * Generated from protobuf field repeated string backup_plan_rules = 4; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBackupPlanRules() + { + return $this->backup_plan_rules; + } + + /** + * The names of the backup plan rules which point to this backupvault + * + * Generated from protobuf field repeated string backup_plan_rules = 4; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBackupPlanRules($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->backup_plan_rules = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GcpResource.php b/BackupDr/src/V1/GcpResource.php new file mode 100644 index 000000000000..dd1322beaae1 --- /dev/null +++ b/BackupDr/src/V1/GcpResource.php @@ -0,0 +1,139 @@ +google.cloud.backupdr.v1.GcpResource + */ +class GcpResource extends \Google\Protobuf\Internal\Message +{ + /** + * Name of the Google Cloud resource. + * + * Generated from protobuf field string gcp_resourcename = 1; + */ + protected $gcp_resourcename = ''; + /** + * Location of the resource: //"global"/"unspecified". + * + * Generated from protobuf field string location = 2; + */ + protected $location = ''; + /** + * Type of the resource. Use the Unified Resource Type, + * eg. compute.googleapis.com/Instance. + * + * Generated from protobuf field string type = 3; + */ + protected $type = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $gcp_resourcename + * Name of the Google Cloud resource. + * @type string $location + * Location of the resource: //"global"/"unspecified". + * @type string $type + * Type of the resource. Use the Unified Resource Type, + * eg. compute.googleapis.com/Instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Name of the Google Cloud resource. + * + * Generated from protobuf field string gcp_resourcename = 1; + * @return string + */ + public function getGcpResourcename() + { + return $this->gcp_resourcename; + } + + /** + * Name of the Google Cloud resource. + * + * Generated from protobuf field string gcp_resourcename = 1; + * @param string $var + * @return $this + */ + public function setGcpResourcename($var) + { + GPBUtil::checkString($var, True); + $this->gcp_resourcename = $var; + + return $this; + } + + /** + * Location of the resource: //"global"/"unspecified". + * + * Generated from protobuf field string location = 2; + * @return string + */ + public function getLocation() + { + return $this->location; + } + + /** + * Location of the resource: //"global"/"unspecified". + * + * Generated from protobuf field string location = 2; + * @param string $var + * @return $this + */ + public function setLocation($var) + { + GPBUtil::checkString($var, True); + $this->location = $var; + + return $this; + } + + /** + * Type of the resource. Use the Unified Resource Type, + * eg. compute.googleapis.com/Instance. + * + * Generated from protobuf field string type = 3; + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * Type of the resource. Use the Unified Resource Type, + * eg. compute.googleapis.com/Instance. + * + * Generated from protobuf field string type = 3; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GetBackupPlanAssociationRequest.php b/BackupDr/src/V1/GetBackupPlanAssociationRequest.php new file mode 100644 index 000000000000..e17c8ba0816d --- /dev/null +++ b/BackupDr/src/V1/GetBackupPlanAssociationRequest.php @@ -0,0 +1,86 @@ +google.cloud.backupdr.v1.GetBackupPlanAssociationRequest + */ +class GetBackupPlanAssociationRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * Please see {@see BackupDRClient::backupPlanAssociationName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\GetBackupPlanAssociationRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplanassociation::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GetBackupPlanRequest.php b/BackupDr/src/V1/GetBackupPlanRequest.php new file mode 100644 index 000000000000..5af2986cc0d1 --- /dev/null +++ b/BackupDr/src/V1/GetBackupPlanRequest.php @@ -0,0 +1,87 @@ +google.cloud.backupdr.v1.GetBackupPlanRequest + */ +class GetBackupPlanRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the `BackupPlan` to retrieve. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the `BackupPlan` to retrieve. + * + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * Please see {@see BackupDRClient::backupPlanName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\GetBackupPlanRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the `BackupPlan` to retrieve. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the `BackupPlan` to retrieve. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the `BackupPlan` to retrieve. + * Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GetBackupRequest.php b/BackupDr/src/V1/GetBackupRequest.php new file mode 100644 index 000000000000..cef977871e55 --- /dev/null +++ b/BackupDr/src/V1/GetBackupRequest.php @@ -0,0 +1,124 @@ +google.cloud.backupdr.v1.GetBackupRequest + */ +class GetBackupRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupView view = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $view = 0; + + /** + * @param string $name Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}' + * Please see {@see BackupDRClient::backupName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\GetBackupRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}' + * @type int $view + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * resource. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupView view = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getView() + { + return $this->view; + } + + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupView view = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setView($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupView::class); + $this->view = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GetBackupVaultRequest.php b/BackupDr/src/V1/GetBackupVaultRequest.php new file mode 100644 index 000000000000..de3959298ba2 --- /dev/null +++ b/BackupDr/src/V1/GetBackupVaultRequest.php @@ -0,0 +1,124 @@ +google.cloud.backupdr.v1.GetBackupVaultRequest + */ +class GetBackupVaultRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the backupvault store resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * Vault + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVaultView view = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $view = 0; + + /** + * @param string $name Required. Name of the backupvault store resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}' + * Please see {@see BackupDRClient::backupVaultName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\GetBackupVaultRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the backupvault store resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}' + * @type int $view + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * Vault + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the backupvault store resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the backupvault store resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * Vault + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVaultView view = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getView() + { + return $this->view; + } + + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * Vault + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVaultView view = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setView($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupVaultView::class); + $this->view = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GetDataSourceRequest.php b/BackupDr/src/V1/GetDataSourceRequest.php new file mode 100644 index 000000000000..27f9c86ff9b1 --- /dev/null +++ b/BackupDr/src/V1/GetDataSourceRequest.php @@ -0,0 +1,86 @@ +google.cloud.backupdr.v1.GetDataSourceRequest + */ +class GetDataSourceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}' + * Please see {@see BackupDRClient::dataSourceName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\GetDataSourceRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}' + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the data source resource name, in the format + * 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}' + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GetManagementServerRequest.php b/BackupDr/src/V1/GetManagementServerRequest.php index 4787333aa02d..7c83be3986fc 100644 --- a/BackupDr/src/V1/GetManagementServerRequest.php +++ b/BackupDr/src/V1/GetManagementServerRequest.php @@ -17,7 +17,7 @@ class GetManagementServerRequest extends \Google\Protobuf\Internal\Message { /** * Required. Name of the management server resource name, in the format - * `projects/{project_id}/locations/{location}/managementServers/{resource_name}` + * 'projects/{project_id}/locations/{location}/managementServers/{resource_name}' * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -25,7 +25,7 @@ class GetManagementServerRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. Name of the management server resource name, in the format - * `projects/{project_id}/locations/{location}/managementServers/{resource_name}` + * 'projects/{project_id}/locations/{location}/managementServers/{resource_name}' * Please see {@see BackupDRClient::managementServerName()} for help formatting this field. * * @return \Google\Cloud\BackupDR\V1\GetManagementServerRequest @@ -46,7 +46,7 @@ public static function build(string $name): self * * @type string $name * Required. Name of the management server resource name, in the format - * `projects/{project_id}/locations/{location}/managementServers/{resource_name}` + * 'projects/{project_id}/locations/{location}/managementServers/{resource_name}' * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { /** * Required. Name of the management server resource name, in the format - * `projects/{project_id}/locations/{location}/managementServers/{resource_name}` + * 'projects/{project_id}/locations/{location}/managementServers/{resource_name}' * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -68,7 +68,7 @@ public function getName() /** * Required. Name of the management server resource name, in the format - * `projects/{project_id}/locations/{location}/managementServers/{resource_name}` + * 'projects/{project_id}/locations/{location}/managementServers/{resource_name}' * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/BackupDr/src/V1/GuestOsFeature.php b/BackupDr/src/V1/GuestOsFeature.php new file mode 100644 index 000000000000..93d51da05752 --- /dev/null +++ b/BackupDr/src/V1/GuestOsFeature.php @@ -0,0 +1,77 @@ +google.cloud.backupdr.v1.GuestOsFeature + */ +class GuestOsFeature extends \Google\Protobuf\Internal\Message +{ + /** + * The ID of a supported feature. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.GuestOsFeature.FeatureType type = 1; + */ + protected $type = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $type + * The ID of a supported feature. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * The ID of a supported feature. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.GuestOsFeature.FeatureType type = 1; + * @return int + */ + public function getType() + { + return isset($this->type) ? $this->type : 0; + } + + public function hasType() + { + return isset($this->type); + } + + public function clearType() + { + unset($this->type); + } + + /** + * The ID of a supported feature. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.GuestOsFeature.FeatureType type = 1; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\GuestOsFeature\FeatureType::class); + $this->type = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/GuestOsFeature/FeatureType.php b/BackupDr/src/V1/GuestOsFeature/FeatureType.php new file mode 100644 index 000000000000..dae448e1271f --- /dev/null +++ b/BackupDr/src/V1/GuestOsFeature/FeatureType.php @@ -0,0 +1,146 @@ +google.cloud.backupdr.v1.GuestOsFeature.FeatureType + */ +class FeatureType +{ + /** + * Default value, which is unused. + * + * Generated from protobuf enum FEATURE_TYPE_UNSPECIFIED = 0; + */ + const FEATURE_TYPE_UNSPECIFIED = 0; + /** + * VIRTIO_SCSI_MULTIQUEUE feature type. + * + * Generated from protobuf enum VIRTIO_SCSI_MULTIQUEUE = 1; + */ + const VIRTIO_SCSI_MULTIQUEUE = 1; + /** + * WINDOWS feature type. + * + * Generated from protobuf enum WINDOWS = 2; + */ + const WINDOWS = 2; + /** + * MULTI_IP_SUBNET feature type. + * + * Generated from protobuf enum MULTI_IP_SUBNET = 3; + */ + const MULTI_IP_SUBNET = 3; + /** + * UEFI_COMPATIBLE feature type. + * + * Generated from protobuf enum UEFI_COMPATIBLE = 4; + */ + const UEFI_COMPATIBLE = 4; + /** + * SECURE_BOOT feature type. + * + * Generated from protobuf enum SECURE_BOOT = 5; + */ + const SECURE_BOOT = 5; + /** + * GVNIC feature type. + * + * Generated from protobuf enum GVNIC = 6; + */ + const GVNIC = 6; + /** + * SEV_CAPABLE feature type. + * + * Generated from protobuf enum SEV_CAPABLE = 7; + */ + const SEV_CAPABLE = 7; + /** + * BARE_METAL_LINUX_COMPATIBLE feature type. + * + * Generated from protobuf enum BARE_METAL_LINUX_COMPATIBLE = 8; + */ + const BARE_METAL_LINUX_COMPATIBLE = 8; + /** + * SUSPEND_RESUME_COMPATIBLE feature type. + * + * Generated from protobuf enum SUSPEND_RESUME_COMPATIBLE = 9; + */ + const SUSPEND_RESUME_COMPATIBLE = 9; + /** + * SEV_LIVE_MIGRATABLE feature type. + * + * Generated from protobuf enum SEV_LIVE_MIGRATABLE = 10; + */ + const SEV_LIVE_MIGRATABLE = 10; + /** + * SEV_SNP_CAPABLE feature type. + * + * Generated from protobuf enum SEV_SNP_CAPABLE = 11; + */ + const SEV_SNP_CAPABLE = 11; + /** + * TDX_CAPABLE feature type. + * + * Generated from protobuf enum TDX_CAPABLE = 12; + */ + const TDX_CAPABLE = 12; + /** + * IDPF feature type. + * + * Generated from protobuf enum IDPF = 13; + */ + const IDPF = 13; + /** + * SEV_LIVE_MIGRATABLE_V2 feature type. + * + * Generated from protobuf enum SEV_LIVE_MIGRATABLE_V2 = 14; + */ + const SEV_LIVE_MIGRATABLE_V2 = 14; + + private static $valueToName = [ + self::FEATURE_TYPE_UNSPECIFIED => 'FEATURE_TYPE_UNSPECIFIED', + self::VIRTIO_SCSI_MULTIQUEUE => 'VIRTIO_SCSI_MULTIQUEUE', + self::WINDOWS => 'WINDOWS', + self::MULTI_IP_SUBNET => 'MULTI_IP_SUBNET', + self::UEFI_COMPATIBLE => 'UEFI_COMPATIBLE', + self::SECURE_BOOT => 'SECURE_BOOT', + self::GVNIC => 'GVNIC', + self::SEV_CAPABLE => 'SEV_CAPABLE', + self::BARE_METAL_LINUX_COMPATIBLE => 'BARE_METAL_LINUX_COMPATIBLE', + self::SUSPEND_RESUME_COMPATIBLE => 'SUSPEND_RESUME_COMPATIBLE', + self::SEV_LIVE_MIGRATABLE => 'SEV_LIVE_MIGRATABLE', + self::SEV_SNP_CAPABLE => 'SEV_SNP_CAPABLE', + self::TDX_CAPABLE => 'TDX_CAPABLE', + self::IDPF => 'IDPF', + self::SEV_LIVE_MIGRATABLE_V2 => 'SEV_LIVE_MIGRATABLE_V2', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/InstanceParams.php b/BackupDr/src/V1/InstanceParams.php new file mode 100644 index 000000000000..525d36ec6f3d --- /dev/null +++ b/BackupDr/src/V1/InstanceParams.php @@ -0,0 +1,67 @@ +google.cloud.backupdr.v1.InstanceParams + */ +class InstanceParams extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Resource manager tags to be bound to the instance. + * + * Generated from protobuf field map resource_manager_tags = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $resource_manager_tags; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\MapField $resource_manager_tags + * Optional. Resource manager tags to be bound to the instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Resource manager tags to be bound to the instance. + * + * Generated from protobuf field map resource_manager_tags = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getResourceManagerTags() + { + return $this->resource_manager_tags; + } + + /** + * Optional. Resource manager tags to be bound to the instance. + * + * Generated from protobuf field map resource_manager_tags = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setResourceManagerTags($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->resource_manager_tags = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/KeyRevocationActionType.php b/BackupDr/src/V1/KeyRevocationActionType.php new file mode 100644 index 000000000000..9922c9b37b07 --- /dev/null +++ b/BackupDr/src/V1/KeyRevocationActionType.php @@ -0,0 +1,63 @@ +google.cloud.backupdr.v1.KeyRevocationActionType + */ +class KeyRevocationActionType +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 0; + */ + const KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 0; + /** + * Indicates user chose no operation. + * + * Generated from protobuf enum NONE = 1; + */ + const NONE = 1; + /** + * Indicates user chose to opt for VM shutdown on key revocation. + * + * Generated from protobuf enum STOP = 2; + */ + const STOP = 2; + + private static $valueToName = [ + self::KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED => 'KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED', + self::NONE => 'NONE', + self::STOP => 'STOP', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/BackupDr/src/V1/ListBackupPlanAssociationsRequest.php b/BackupDr/src/V1/ListBackupPlanAssociationsRequest.php new file mode 100644 index 000000000000..1cd640705bf5 --- /dev/null +++ b/BackupDr/src/V1/ListBackupPlanAssociationsRequest.php @@ -0,0 +1,212 @@ +google.cloud.backupdr.v1.ListBackupPlanAssociationsRequest + */ +class ListBackupPlanAssociationsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The project and location for which to retrieve backup Plan + * Associations information, in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations + * map to GCP regions, for example **us-central1**. To retrieve backup plan + * associations for all locations, use "-" for the + * `{location}` value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Filtering results + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + + /** + * @param string $parent Required. The project and location for which to retrieve backup Plan + * Associations information, in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations + * map to GCP regions, for example **us-central1**. To retrieve backup plan + * associations for all locations, use "-" for the + * `{location}` value. Please see + * {@see BackupDRClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\ListBackupPlanAssociationsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The project and location for which to retrieve backup Plan + * Associations information, in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations + * map to GCP regions, for example **us-central1**. To retrieve backup plan + * associations for all locations, use "-" for the + * `{location}` value. + * @type int $page_size + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * @type string $page_token + * Optional. A token identifying a page of results the server should return. + * @type string $filter + * Optional. Filtering results + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplanassociation::initOnce(); + parent::__construct($data); + } + + /** + * Required. The project and location for which to retrieve backup Plan + * Associations information, in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations + * map to GCP regions, for example **us-central1**. To retrieve backup plan + * associations for all locations, use "-" for the + * `{location}` value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The project and location for which to retrieve backup Plan + * Associations information, in the format + * `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations + * map to GCP regions, for example **us-central1**. To retrieve backup plan + * associations for all locations, use "-" for the + * `{location}` value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Filtering results + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filtering results + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListBackupPlanAssociationsResponse.php b/BackupDr/src/V1/ListBackupPlanAssociationsResponse.php new file mode 100644 index 000000000000..a92169b9c6c0 --- /dev/null +++ b/BackupDr/src/V1/ListBackupPlanAssociationsResponse.php @@ -0,0 +1,159 @@ +google.cloud.backupdr.v1.ListBackupPlanAssociationsResponse + */ +class ListBackupPlanAssociationsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of Backup Plan Associations in the project for the specified + * location. + * If the `{location}` value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup plan associations in reachable + * locations and the 'unreachable' field will be populated with a list of + * unreachable locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupPlanAssociation backup_plan_associations = 1; + */ + private $backup_plan_associations; + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\BackupDR\V1\BackupPlanAssociation>|\Google\Protobuf\Internal\RepeatedField $backup_plan_associations + * The list of Backup Plan Associations in the project for the specified + * location. + * If the `{location}` value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup plan associations in reachable + * locations and the 'unreachable' field will be populated with a list of + * unreachable locations. + * @type string $next_page_token + * A token identifying a page of results the server should return. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Locations that could not be reached. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplanassociation::initOnce(); + parent::__construct($data); + } + + /** + * The list of Backup Plan Associations in the project for the specified + * location. + * If the `{location}` value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup plan associations in reachable + * locations and the 'unreachable' field will be populated with a list of + * unreachable locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupPlanAssociation backup_plan_associations = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBackupPlanAssociations() + { + return $this->backup_plan_associations; + } + + /** + * The list of Backup Plan Associations in the project for the specified + * location. + * If the `{location}` value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup plan associations in reachable + * locations and the 'unreachable' field will be populated with a list of + * unreachable locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupPlanAssociation backup_plan_associations = 1; + * @param array<\Google\Cloud\BackupDR\V1\BackupPlanAssociation>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBackupPlanAssociations($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\BackupPlanAssociation::class); + $this->backup_plan_associations = $arr; + + return $this; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListBackupPlansRequest.php b/BackupDr/src/V1/ListBackupPlansRequest.php new file mode 100644 index 000000000000..59cf4b63f0d6 --- /dev/null +++ b/BackupDr/src/V1/ListBackupPlansRequest.php @@ -0,0 +1,277 @@ +google.cloud.backupdr.v1.ListBackupPlansRequest + */ +class ListBackupPlansRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The project and location for which to retrieve `BackupPlans` + * information. Format: `projects/{project}/locations/{location}`. In Cloud + * BackupDR, locations map to GCP regions, for e.g. **us-central1**. To + * retrieve backup plans for all locations, use "-" for the + * `{location}` value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `BackupPlans` to return in a single + * response. If not specified, a default value will be chosen by the service. + * Note that the response may include a partial list and a caller should + * only rely on the response's + * [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] + * to determine if there are more instances left to be queried. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. The value of + * [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] + * received from a previous `ListBackupPlans` call. + * Provide this to retrieve the subsequent page in a multi-page list of + * results. When paginating, all other parameters provided to + * `ListBackupPlans` must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Field match expression used to filter the results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Field by which to sort the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + + /** + * @param string $parent Required. The project and location for which to retrieve `BackupPlans` + * information. Format: `projects/{project}/locations/{location}`. In Cloud + * BackupDR, locations map to GCP regions, for e.g. **us-central1**. To + * retrieve backup plans for all locations, use "-" for the + * `{location}` value. Please see + * {@see BackupDRClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\ListBackupPlansRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The project and location for which to retrieve `BackupPlans` + * information. Format: `projects/{project}/locations/{location}`. In Cloud + * BackupDR, locations map to GCP regions, for e.g. **us-central1**. To + * retrieve backup plans for all locations, use "-" for the + * `{location}` value. + * @type int $page_size + * Optional. The maximum number of `BackupPlans` to return in a single + * response. If not specified, a default value will be chosen by the service. + * Note that the response may include a partial list and a caller should + * only rely on the response's + * [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] + * to determine if there are more instances left to be queried. + * @type string $page_token + * Optional. The value of + * [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] + * received from a previous `ListBackupPlans` call. + * Provide this to retrieve the subsequent page in a multi-page list of + * results. When paginating, all other parameters provided to + * `ListBackupPlans` must match the call that provided the page token. + * @type string $filter + * Optional. Field match expression used to filter the results. + * @type string $order_by + * Optional. Field by which to sort the results. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Required. The project and location for which to retrieve `BackupPlans` + * information. Format: `projects/{project}/locations/{location}`. In Cloud + * BackupDR, locations map to GCP regions, for e.g. **us-central1**. To + * retrieve backup plans for all locations, use "-" for the + * `{location}` value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The project and location for which to retrieve `BackupPlans` + * information. Format: `projects/{project}/locations/{location}`. In Cloud + * BackupDR, locations map to GCP regions, for e.g. **us-central1**. To + * retrieve backup plans for all locations, use "-" for the + * `{location}` value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `BackupPlans` to return in a single + * response. If not specified, a default value will be chosen by the service. + * Note that the response may include a partial list and a caller should + * only rely on the response's + * [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] + * to determine if there are more instances left to be queried. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `BackupPlans` to return in a single + * response. If not specified, a default value will be chosen by the service. + * Note that the response may include a partial list and a caller should + * only rely on the response's + * [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] + * to determine if there are more instances left to be queried. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The value of + * [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] + * received from a previous `ListBackupPlans` call. + * Provide this to retrieve the subsequent page in a multi-page list of + * results. When paginating, all other parameters provided to + * `ListBackupPlans` must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The value of + * [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] + * received from a previous `ListBackupPlans` call. + * Provide this to retrieve the subsequent page in a multi-page list of + * results. When paginating, all other parameters provided to + * `ListBackupPlans` must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Field match expression used to filter the results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Field match expression used to filter the results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Field by which to sort the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Field by which to sort the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListBackupPlansResponse.php b/BackupDr/src/V1/ListBackupPlansResponse.php new file mode 100644 index 000000000000..ff5e2d64a27c --- /dev/null +++ b/BackupDr/src/V1/ListBackupPlansResponse.php @@ -0,0 +1,179 @@ +google.cloud.backupdr.v1.ListBackupPlansResponse + */ +class ListBackupPlansResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of `BackupPlans` in the project for the specified + * location. + * If the `{location}` value in the request is "-", the response contains a + * list of resources from all locations. In case any location is unreachable, + * the response will only return backup plans in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * BackupPlan + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupPlan backup_plans = 1; + */ + private $backup_plans; + /** + * A token which may be sent as + * [page_token][google.cloud.backupdr.v1.ListBackupPlansRequest.page_token] in + * a subsequent `ListBackupPlans` call to retrieve the next page of results. + * If this field is omitted or empty, then there are no more results to + * return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\BackupDR\V1\BackupPlan>|\Google\Protobuf\Internal\RepeatedField $backup_plans + * The list of `BackupPlans` in the project for the specified + * location. + * If the `{location}` value in the request is "-", the response contains a + * list of resources from all locations. In case any location is unreachable, + * the response will only return backup plans in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * BackupPlan + * @type string $next_page_token + * A token which may be sent as + * [page_token][google.cloud.backupdr.v1.ListBackupPlansRequest.page_token] in + * a subsequent `ListBackupPlans` call to retrieve the next page of results. + * If this field is omitted or empty, then there are no more results to + * return. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Locations that could not be reached. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * The list of `BackupPlans` in the project for the specified + * location. + * If the `{location}` value in the request is "-", the response contains a + * list of resources from all locations. In case any location is unreachable, + * the response will only return backup plans in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * BackupPlan + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupPlan backup_plans = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBackupPlans() + { + return $this->backup_plans; + } + + /** + * The list of `BackupPlans` in the project for the specified + * location. + * If the `{location}` value in the request is "-", the response contains a + * list of resources from all locations. In case any location is unreachable, + * the response will only return backup plans in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * BackupPlan + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupPlan backup_plans = 1; + * @param array<\Google\Cloud\BackupDR\V1\BackupPlan>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBackupPlans($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\BackupPlan::class); + $this->backup_plans = $arr; + + return $this; + } + + /** + * A token which may be sent as + * [page_token][google.cloud.backupdr.v1.ListBackupPlansRequest.page_token] in + * a subsequent `ListBackupPlans` call to retrieve the next page of results. + * If this field is omitted or empty, then there are no more results to + * return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token which may be sent as + * [page_token][google.cloud.backupdr.v1.ListBackupPlansRequest.page_token] in + * a subsequent `ListBackupPlans` call to retrieve the next page of results. + * If this field is omitted or empty, then there are no more results to + * return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListBackupVaultsRequest.php b/BackupDr/src/V1/ListBackupVaultsRequest.php new file mode 100644 index 000000000000..3f8755430f7e --- /dev/null +++ b/BackupDr/src/V1/ListBackupVaultsRequest.php @@ -0,0 +1,284 @@ +google.cloud.backupdr.v1.ListBackupVaultsRequest + */ +class ListBackupVaultsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * Vault. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVaultView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $view = 0; + + /** + * @param string $parent Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. Please see + * {@see BackupDRClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\ListBackupVaultsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. + * @type int $page_size + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * @type string $page_token + * Optional. A token identifying a page of results the server should return. + * @type string $filter + * Optional. Filtering results. + * @type string $order_by + * Optional. Hint for how to order the results. + * @type int $view + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * Vault. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The project and location for which to retrieve backupvault stores + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud Backup and DR, locations map to Google Cloud regions, for example + * **us-central1**. + * To retrieve backupvault stores for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * Vault. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVaultView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getView() + { + return $this->view; + } + + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * Vault. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVaultView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setView($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupVaultView::class); + $this->view = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListBackupVaultsResponse.php b/BackupDr/src/V1/ListBackupVaultsResponse.php new file mode 100644 index 000000000000..34988c886256 --- /dev/null +++ b/BackupDr/src/V1/ListBackupVaultsResponse.php @@ -0,0 +1,159 @@ +google.cloud.backupdr.v1.ListBackupVaultsResponse + */ +class ListBackupVaultsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of BackupVault instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup vaults in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupVault backup_vaults = 1; + */ + private $backup_vaults; + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\BackupDR\V1\BackupVault>|\Google\Protobuf\Internal\RepeatedField $backup_vaults + * The list of BackupVault instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup vaults in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * @type string $next_page_token + * A token identifying a page of results the server should return. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Locations that could not be reached. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * The list of BackupVault instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup vaults in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupVault backup_vaults = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBackupVaults() + { + return $this->backup_vaults; + } + + /** + * The list of BackupVault instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return backup vaults in reachable locations and + * the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.BackupVault backup_vaults = 1; + * @param array<\Google\Cloud\BackupDR\V1\BackupVault>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBackupVaults($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\BackupVault::class); + $this->backup_vaults = $arr; + + return $this; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListBackupsRequest.php b/BackupDr/src/V1/ListBackupsRequest.php new file mode 100644 index 000000000000..92b535e1b4f0 --- /dev/null +++ b/BackupDr/src/V1/ListBackupsRequest.php @@ -0,0 +1,284 @@ +google.cloud.backupdr.v1.ListBackupsRequest + */ +class ListBackupsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The project and location for which to retrieve backup + * information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $view = 0; + + /** + * @param string $parent Required. The project and location for which to retrieve backup + * information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. Please see + * {@see BackupDRClient::dataSourceName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\ListBackupsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The project and location for which to retrieve backup + * information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. + * @type int $page_size + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * @type string $page_token + * Optional. A token identifying a page of results the server should return. + * @type string $filter + * Optional. Filtering results. + * @type string $order_by + * Optional. Hint for how to order the results. + * @type int $view + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * resource. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. The project and location for which to retrieve backup + * information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The project and location for which to retrieve backup + * information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getView() + { + return $this->view; + } + + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup + * resource. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setView($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\BackupView::class); + $this->view = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListBackupsResponse.php b/BackupDr/src/V1/ListBackupsResponse.php new file mode 100644 index 000000000000..04479201f61b --- /dev/null +++ b/BackupDr/src/V1/ListBackupsResponse.php @@ -0,0 +1,159 @@ +google.cloud.backupdr.v1.ListBackupsResponse + */ +class ListBackupsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of Backup instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return data sources in reachable locations + * and the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Backup backups = 1; + */ + private $backups; + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\BackupDR\V1\Backup>|\Google\Protobuf\Internal\RepeatedField $backups + * The list of Backup instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return data sources in reachable locations + * and the 'unreachable' field will be populated with a list of unreachable + * locations. + * @type string $next_page_token + * A token identifying a page of results the server should return. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Locations that could not be reached. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * The list of Backup instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return data sources in reachable locations + * and the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Backup backups = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBackups() + { + return $this->backups; + } + + /** + * The list of Backup instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return data sources in reachable locations + * and the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Backup backups = 1; + * @param array<\Google\Cloud\BackupDR\V1\Backup>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBackups($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\Backup::class); + $this->backups = $arr; + + return $this; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListDataSourcesRequest.php b/BackupDr/src/V1/ListDataSourcesRequest.php new file mode 100644 index 000000000000..ef8584fa5ce2 --- /dev/null +++ b/BackupDr/src/V1/ListDataSourcesRequest.php @@ -0,0 +1,246 @@ +google.cloud.backupdr.v1.ListDataSourcesRequest + */ +class ListDataSourcesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The project and location for which to retrieve data + * sources information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + + /** + * @param string $parent Required. The project and location for which to retrieve data + * sources information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. Please see + * {@see BackupDRClient::backupVaultName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\ListDataSourcesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The project and location for which to retrieve data + * sources information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. + * @type int $page_size + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * @type string $page_token + * Optional. A token identifying a page of results the server should return. + * @type string $filter + * Optional. Filtering results. + * @type string $order_by + * Optional. Hint for how to order the results. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. The project and location for which to retrieve data + * sources information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The project and location for which to retrieve data + * sources information, in the format + * 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, + * locations map to Google Cloud regions, for example **us-central1**. + * To retrieve data sources for all locations, use "-" for the + * '{location}' value. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListDataSourcesResponse.php b/BackupDr/src/V1/ListDataSourcesResponse.php new file mode 100644 index 000000000000..ef509a105897 --- /dev/null +++ b/BackupDr/src/V1/ListDataSourcesResponse.php @@ -0,0 +1,159 @@ +google.cloud.backupdr.v1.ListDataSourcesResponse + */ +class ListDataSourcesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of DataSource instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return data sources in reachable locations + * and the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.DataSource data_sources = 1; + */ + private $data_sources; + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\BackupDR\V1\DataSource>|\Google\Protobuf\Internal\RepeatedField $data_sources + * The list of DataSource instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return data sources in reachable locations + * and the 'unreachable' field will be populated with a list of unreachable + * locations. + * @type string $next_page_token + * A token identifying a page of results the server should return. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Locations that could not be reached. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * The list of DataSource instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return data sources in reachable locations + * and the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.DataSource data_sources = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDataSources() + { + return $this->data_sources; + } + + /** + * The list of DataSource instances in the project for the specified + * location. + * If the '{location}' value in the request is "-", the response contains a + * list of instances from all locations. In case any location is unreachable, + * the response will only return data sources in reachable locations + * and the 'unreachable' field will be populated with a list of unreachable + * locations. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.DataSource data_sources = 1; + * @param array<\Google\Cloud\BackupDR\V1\DataSource>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDataSources($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\DataSource::class); + $this->data_sources = $arr; + + return $this; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ListManagementServersRequest.php b/BackupDr/src/V1/ListManagementServersRequest.php index 37886b801be4..963e2af63f5e 100644 --- a/BackupDr/src/V1/ListManagementServersRequest.php +++ b/BackupDr/src/V1/ListManagementServersRequest.php @@ -17,10 +17,11 @@ class ListManagementServersRequest extends \Google\Protobuf\Internal\Message { /** * Required. The project and location for which to retrieve management servers - * information, in the format `projects/{project_id}/locations/{location}`. In - * Cloud BackupDR, locations map to GCP regions, for example **us-central1**. - * To retrieve management servers for all locations, use "-" for the - * `{location}` value. + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud BackupDR, locations map to Google Cloud regions, for example + * **us-central1**. To retrieve management servers for all locations, use "-" + * for the + * '{location}' value. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -53,10 +54,11 @@ class ListManagementServersRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The project and location for which to retrieve management servers - * information, in the format `projects/{project_id}/locations/{location}`. In - * Cloud BackupDR, locations map to GCP regions, for example **us-central1**. - * To retrieve management servers for all locations, use "-" for the - * `{location}` value. Please see + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud BackupDR, locations map to Google Cloud regions, for example + * **us-central1**. To retrieve management servers for all locations, use "-" + * for the + * '{location}' value. Please see * {@see BackupDRClient::locationName()} for help formatting this field. * * @return \Google\Cloud\BackupDR\V1\ListManagementServersRequest @@ -77,10 +79,11 @@ public static function build(string $parent): self * * @type string $parent * Required. The project and location for which to retrieve management servers - * information, in the format `projects/{project_id}/locations/{location}`. In - * Cloud BackupDR, locations map to GCP regions, for example **us-central1**. - * To retrieve management servers for all locations, use "-" for the - * `{location}` value. + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud BackupDR, locations map to Google Cloud regions, for example + * **us-central1**. To retrieve management servers for all locations, use "-" + * for the + * '{location}' value. * @type int $page_size * Optional. Requested page size. Server may return fewer items than * requested. If unspecified, server will pick an appropriate default. @@ -99,10 +102,11 @@ public function __construct($data = NULL) { /** * Required. The project and location for which to retrieve management servers - * information, in the format `projects/{project_id}/locations/{location}`. In - * Cloud BackupDR, locations map to GCP regions, for example **us-central1**. - * To retrieve management servers for all locations, use "-" for the - * `{location}` value. + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud BackupDR, locations map to Google Cloud regions, for example + * **us-central1**. To retrieve management servers for all locations, use "-" + * for the + * '{location}' value. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -114,10 +118,11 @@ public function getParent() /** * Required. The project and location for which to retrieve management servers - * information, in the format `projects/{project_id}/locations/{location}`. In - * Cloud BackupDR, locations map to GCP regions, for example **us-central1**. - * To retrieve management servers for all locations, use "-" for the - * `{location}` value. + * information, in the format 'projects/{project_id}/locations/{location}'. In + * Cloud BackupDR, locations map to Google Cloud regions, for example + * **us-central1**. To retrieve management servers for all locations, use "-" + * for the + * '{location}' value. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/BackupDr/src/V1/ListManagementServersResponse.php b/BackupDr/src/V1/ListManagementServersResponse.php index fa2d796a5d0e..84bd573686db 100644 --- a/BackupDr/src/V1/ListManagementServersResponse.php +++ b/BackupDr/src/V1/ListManagementServersResponse.php @@ -18,7 +18,7 @@ class ListManagementServersResponse extends \Google\Protobuf\Internal\Message /** * The list of ManagementServer instances in the project for the specified * location. - * If the `{location}` value in the request is "-", the response contains a + * If the '{location}' value in the request is "-", the response contains a * list of instances from all locations. In case any location is unreachable, * the response will only return management servers in reachable locations and * the 'unreachable' field will be populated with a list of unreachable @@ -49,7 +49,7 @@ class ListManagementServersResponse extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\BackupDR\V1\ManagementServer>|\Google\Protobuf\Internal\RepeatedField $management_servers * The list of ManagementServer instances in the project for the specified * location. - * If the `{location}` value in the request is "-", the response contains a + * If the '{location}' value in the request is "-", the response contains a * list of instances from all locations. In case any location is unreachable, * the response will only return management servers in reachable locations and * the 'unreachable' field will be populated with a list of unreachable @@ -68,7 +68,7 @@ public function __construct($data = NULL) { /** * The list of ManagementServer instances in the project for the specified * location. - * If the `{location}` value in the request is "-", the response contains a + * If the '{location}' value in the request is "-", the response contains a * list of instances from all locations. In case any location is unreachable, * the response will only return management servers in reachable locations and * the 'unreachable' field will be populated with a list of unreachable @@ -85,7 +85,7 @@ public function getManagementServers() /** * The list of ManagementServer instances in the project for the specified * location. - * If the `{location}` value in the request is "-", the response contains a + * If the '{location}' value in the request is "-", the response contains a * list of instances from all locations. In case any location is unreachable, * the response will only return management servers in reachable locations and * the 'unreachable' field will be populated with a list of unreachable diff --git a/BackupDr/src/V1/ManagementServer.php b/BackupDr/src/V1/ManagementServer.php index 47545858a697..70295addc1c0 100644 --- a/BackupDr/src/V1/ManagementServer.php +++ b/BackupDr/src/V1/ManagementServer.php @@ -92,7 +92,7 @@ class ManagementServer extends \Google\Protobuf\Internal\Message /** * Output only. The OAuth 2.0 client id is required to make API calls to the * BackupDR instance API of this ManagementServer. This is the value that - * should be provided in the ‘aud’ field of the OIDC ID Token (see openid + * should be provided in the 'aud' field of the OIDC ID Token (see openid * specification * https://openid.net/specs/openid-connect-core-1_0.html#IDToken). * @@ -164,7 +164,7 @@ class ManagementServer extends \Google\Protobuf\Internal\Message * @type string $oauth2_client_id * Output only. The OAuth 2.0 client id is required to make API calls to the * BackupDR instance API of this ManagementServer. This is the value that - * should be provided in the ‘aud’ field of the OIDC ID Token (see openid + * should be provided in the 'aud' field of the OIDC ID Token (see openid * specification * https://openid.net/specs/openid-connect-core-1_0.html#IDToken). * @type \Google\Cloud\BackupDR\V1\WorkforceIdentityBasedOAuth2ClientID $workforce_identity_based_oauth2_client_id @@ -528,7 +528,7 @@ public function setEtag($var) /** * Output only. The OAuth 2.0 client id is required to make API calls to the * BackupDR instance API of this ManagementServer. This is the value that - * should be provided in the ‘aud’ field of the OIDC ID Token (see openid + * should be provided in the 'aud' field of the OIDC ID Token (see openid * specification * https://openid.net/specs/openid-connect-core-1_0.html#IDToken). * @@ -543,7 +543,7 @@ public function getOauth2ClientId() /** * Output only. The OAuth 2.0 client id is required to make API calls to the * BackupDR instance API of this ManagementServer. This is the value that - * should be provided in the ‘aud’ field of the OIDC ID Token (see openid + * should be provided in the 'aud' field of the OIDC ID Token (see openid * specification * https://openid.net/specs/openid-connect-core-1_0.html#IDToken). * diff --git a/BackupDr/src/V1/Metadata.php b/BackupDr/src/V1/Metadata.php new file mode 100644 index 000000000000..a47c48d30479 --- /dev/null +++ b/BackupDr/src/V1/Metadata.php @@ -0,0 +1,71 @@ +google.cloud.backupdr.v1.Metadata + */ +class Metadata extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Array of key/value pairs. The total size of all keys and values + * must be less than 512 KB. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Entry items = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $items; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\BackupDR\V1\Entry>|\Google\Protobuf\Internal\RepeatedField $items + * Optional. Array of key/value pairs. The total size of all keys and values + * must be less than 512 KB. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Array of key/value pairs. The total size of all keys and values + * must be less than 512 KB. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Entry items = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getItems() + { + return $this->items; + } + + /** + * Optional. Array of key/value pairs. The total size of all keys and values + * must be less than 512 KB. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Entry items = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\Entry>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setItems($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\Entry::class); + $this->items = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/NetworkInterface.php b/BackupDr/src/V1/NetworkInterface.php new file mode 100644 index 000000000000..f814b5bc7885 --- /dev/null +++ b/BackupDr/src/V1/NetworkInterface.php @@ -0,0 +1,700 @@ +google.cloud.backupdr.v1.NetworkInterface + */ +class NetworkInterface extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. URL of the VPC network resource for this instance. + * + * Generated from protobuf field optional string network = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $network = null; + /** + * Optional. The URL of the Subnetwork resource for this instance. + * + * Generated from protobuf field optional string subnetwork = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $subnetwork = null; + /** + * Optional. An IPv4 internal IP address to assign to the instance for this + * network interface. If not specified by the user, an unused internal IP is + * assigned by the system. + * + * Generated from protobuf field optional string ip_address = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $ip_address = null; + /** + * Optional. An IPv6 internal network address for this network interface. To + * use a static internal IP address, it must be unused and in the same region + * as the instance's zone. If not specified, Google Cloud will automatically + * assign an internal IPv6 address from the instance's subnetwork. + * + * Generated from protobuf field optional string ipv6_address = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $ipv6_address = null; + /** + * Optional. The prefix length of the primary internal IPv6 range. + * + * Generated from protobuf field optional int32 internal_ipv6_prefix_length = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $internal_ipv6_prefix_length = null; + /** + * Output only. [Output Only] The name of the network interface, which is + * generated by the server. + * + * Generated from protobuf field optional string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $name = null; + /** + * Optional. An array of configurations for this interface. Currently, only + * one access config,ONE_TO_ONE_NAT is supported. If there are no + * accessConfigs specified, then this instance will have + * no external internet access. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AccessConfig access_configs = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $access_configs; + /** + * Optional. An array of IPv6 access configurations for this interface. + * Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there + * is no ipv6AccessConfig specified, then this instance will + * have no external IPv6 Internet access. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AccessConfig ipv6_access_configs = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $ipv6_access_configs; + /** + * Optional. An array of alias IP ranges for this network interface. + * You can only specify this field for network interfaces in VPC networks. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AliasIpRange alias_ip_ranges = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $alias_ip_ranges; + /** + * The stack type for this network interface. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.StackType stack_type = 10; + */ + protected $stack_type = null; + /** + * Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the + * IP can be accessed from the Internet. This field is always inherited from + * its subnetwork. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.Ipv6AccessType ipv6_access_type = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $ipv6_access_type = null; + /** + * Optional. The networking queue count that's specified by users for the + * network interface. Both Rx and Tx queues will be set to this number. It'll + * be empty if not specified by the users. + * + * Generated from protobuf field optional int32 queue_count = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $queue_count = null; + /** + * Optional. The type of vNIC to be used on this interface. This may be gVNIC + * or VirtioNet. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.NicType nic_type = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $nic_type = null; + /** + * Optional. The URL of the network attachment that this interface should + * connect to in the following format: + * projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. + * + * Generated from protobuf field optional string network_attachment = 14 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $network_attachment = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $network + * Optional. URL of the VPC network resource for this instance. + * @type string $subnetwork + * Optional. The URL of the Subnetwork resource for this instance. + * @type string $ip_address + * Optional. An IPv4 internal IP address to assign to the instance for this + * network interface. If not specified by the user, an unused internal IP is + * assigned by the system. + * @type string $ipv6_address + * Optional. An IPv6 internal network address for this network interface. To + * use a static internal IP address, it must be unused and in the same region + * as the instance's zone. If not specified, Google Cloud will automatically + * assign an internal IPv6 address from the instance's subnetwork. + * @type int $internal_ipv6_prefix_length + * Optional. The prefix length of the primary internal IPv6 range. + * @type string $name + * Output only. [Output Only] The name of the network interface, which is + * generated by the server. + * @type array<\Google\Cloud\BackupDR\V1\AccessConfig>|\Google\Protobuf\Internal\RepeatedField $access_configs + * Optional. An array of configurations for this interface. Currently, only + * one access config,ONE_TO_ONE_NAT is supported. If there are no + * accessConfigs specified, then this instance will have + * no external internet access. + * @type array<\Google\Cloud\BackupDR\V1\AccessConfig>|\Google\Protobuf\Internal\RepeatedField $ipv6_access_configs + * Optional. An array of IPv6 access configurations for this interface. + * Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there + * is no ipv6AccessConfig specified, then this instance will + * have no external IPv6 Internet access. + * @type array<\Google\Cloud\BackupDR\V1\AliasIpRange>|\Google\Protobuf\Internal\RepeatedField $alias_ip_ranges + * Optional. An array of alias IP ranges for this network interface. + * You can only specify this field for network interfaces in VPC networks. + * @type int $stack_type + * The stack type for this network interface. + * @type int $ipv6_access_type + * Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the + * IP can be accessed from the Internet. This field is always inherited from + * its subnetwork. + * @type int $queue_count + * Optional. The networking queue count that's specified by users for the + * network interface. Both Rx and Tx queues will be set to this number. It'll + * be empty if not specified by the users. + * @type int $nic_type + * Optional. The type of vNIC to be used on this interface. This may be gVNIC + * or VirtioNet. + * @type string $network_attachment + * Optional. The URL of the network attachment that this interface should + * connect to in the following format: + * projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. URL of the VPC network resource for this instance. + * + * Generated from protobuf field optional string network = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getNetwork() + { + return isset($this->network) ? $this->network : ''; + } + + public function hasNetwork() + { + return isset($this->network); + } + + public function clearNetwork() + { + unset($this->network); + } + + /** + * Optional. URL of the VPC network resource for this instance. + * + * Generated from protobuf field optional string network = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setNetwork($var) + { + GPBUtil::checkString($var, True); + $this->network = $var; + + return $this; + } + + /** + * Optional. The URL of the Subnetwork resource for this instance. + * + * Generated from protobuf field optional string subnetwork = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSubnetwork() + { + return isset($this->subnetwork) ? $this->subnetwork : ''; + } + + public function hasSubnetwork() + { + return isset($this->subnetwork); + } + + public function clearSubnetwork() + { + unset($this->subnetwork); + } + + /** + * Optional. The URL of the Subnetwork resource for this instance. + * + * Generated from protobuf field optional string subnetwork = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSubnetwork($var) + { + GPBUtil::checkString($var, True); + $this->subnetwork = $var; + + return $this; + } + + /** + * Optional. An IPv4 internal IP address to assign to the instance for this + * network interface. If not specified by the user, an unused internal IP is + * assigned by the system. + * + * Generated from protobuf field optional string ip_address = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getIpAddress() + { + return isset($this->ip_address) ? $this->ip_address : ''; + } + + public function hasIpAddress() + { + return isset($this->ip_address); + } + + public function clearIpAddress() + { + unset($this->ip_address); + } + + /** + * Optional. An IPv4 internal IP address to assign to the instance for this + * network interface. If not specified by the user, an unused internal IP is + * assigned by the system. + * + * Generated from protobuf field optional string ip_address = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setIpAddress($var) + { + GPBUtil::checkString($var, True); + $this->ip_address = $var; + + return $this; + } + + /** + * Optional. An IPv6 internal network address for this network interface. To + * use a static internal IP address, it must be unused and in the same region + * as the instance's zone. If not specified, Google Cloud will automatically + * assign an internal IPv6 address from the instance's subnetwork. + * + * Generated from protobuf field optional string ipv6_address = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getIpv6Address() + { + return isset($this->ipv6_address) ? $this->ipv6_address : ''; + } + + public function hasIpv6Address() + { + return isset($this->ipv6_address); + } + + public function clearIpv6Address() + { + unset($this->ipv6_address); + } + + /** + * Optional. An IPv6 internal network address for this network interface. To + * use a static internal IP address, it must be unused and in the same region + * as the instance's zone. If not specified, Google Cloud will automatically + * assign an internal IPv6 address from the instance's subnetwork. + * + * Generated from protobuf field optional string ipv6_address = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setIpv6Address($var) + { + GPBUtil::checkString($var, True); + $this->ipv6_address = $var; + + return $this; + } + + /** + * Optional. The prefix length of the primary internal IPv6 range. + * + * Generated from protobuf field optional int32 internal_ipv6_prefix_length = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getInternalIpv6PrefixLength() + { + return isset($this->internal_ipv6_prefix_length) ? $this->internal_ipv6_prefix_length : 0; + } + + public function hasInternalIpv6PrefixLength() + { + return isset($this->internal_ipv6_prefix_length); + } + + public function clearInternalIpv6PrefixLength() + { + unset($this->internal_ipv6_prefix_length); + } + + /** + * Optional. The prefix length of the primary internal IPv6 range. + * + * Generated from protobuf field optional int32 internal_ipv6_prefix_length = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setInternalIpv6PrefixLength($var) + { + GPBUtil::checkInt32($var); + $this->internal_ipv6_prefix_length = $var; + + return $this; + } + + /** + * Output only. [Output Only] The name of the network interface, which is + * generated by the server. + * + * Generated from protobuf field optional string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getName() + { + return isset($this->name) ? $this->name : ''; + } + + public function hasName() + { + return isset($this->name); + } + + public function clearName() + { + unset($this->name); + } + + /** + * Output only. [Output Only] The name of the network interface, which is + * generated by the server. + * + * Generated from protobuf field optional string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An array of configurations for this interface. Currently, only + * one access config,ONE_TO_ONE_NAT is supported. If there are no + * accessConfigs specified, then this instance will have + * no external internet access. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AccessConfig access_configs = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAccessConfigs() + { + return $this->access_configs; + } + + /** + * Optional. An array of configurations for this interface. Currently, only + * one access config,ONE_TO_ONE_NAT is supported. If there are no + * accessConfigs specified, then this instance will have + * no external internet access. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AccessConfig access_configs = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\AccessConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAccessConfigs($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\AccessConfig::class); + $this->access_configs = $arr; + + return $this; + } + + /** + * Optional. An array of IPv6 access configurations for this interface. + * Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there + * is no ipv6AccessConfig specified, then this instance will + * have no external IPv6 Internet access. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AccessConfig ipv6_access_configs = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getIpv6AccessConfigs() + { + return $this->ipv6_access_configs; + } + + /** + * Optional. An array of IPv6 access configurations for this interface. + * Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there + * is no ipv6AccessConfig specified, then this instance will + * have no external IPv6 Internet access. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AccessConfig ipv6_access_configs = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\AccessConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setIpv6AccessConfigs($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\AccessConfig::class); + $this->ipv6_access_configs = $arr; + + return $this; + } + + /** + * Optional. An array of alias IP ranges for this network interface. + * You can only specify this field for network interfaces in VPC networks. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AliasIpRange alias_ip_ranges = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAliasIpRanges() + { + return $this->alias_ip_ranges; + } + + /** + * Optional. An array of alias IP ranges for this network interface. + * You can only specify this field for network interfaces in VPC networks. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.AliasIpRange alias_ip_ranges = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\AliasIpRange>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAliasIpRanges($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\AliasIpRange::class); + $this->alias_ip_ranges = $arr; + + return $this; + } + + /** + * The stack type for this network interface. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.StackType stack_type = 10; + * @return int + */ + public function getStackType() + { + return isset($this->stack_type) ? $this->stack_type : 0; + } + + public function hasStackType() + { + return isset($this->stack_type); + } + + public function clearStackType() + { + unset($this->stack_type); + } + + /** + * The stack type for this network interface. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.StackType stack_type = 10; + * @param int $var + * @return $this + */ + public function setStackType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\NetworkInterface\StackType::class); + $this->stack_type = $var; + + return $this; + } + + /** + * Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the + * IP can be accessed from the Internet. This field is always inherited from + * its subnetwork. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.Ipv6AccessType ipv6_access_type = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getIpv6AccessType() + { + return isset($this->ipv6_access_type) ? $this->ipv6_access_type : 0; + } + + public function hasIpv6AccessType() + { + return isset($this->ipv6_access_type); + } + + public function clearIpv6AccessType() + { + unset($this->ipv6_access_type); + } + + /** + * Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the + * IP can be accessed from the Internet. This field is always inherited from + * its subnetwork. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.Ipv6AccessType ipv6_access_type = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setIpv6AccessType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\NetworkInterface\Ipv6AccessType::class); + $this->ipv6_access_type = $var; + + return $this; + } + + /** + * Optional. The networking queue count that's specified by users for the + * network interface. Both Rx and Tx queues will be set to this number. It'll + * be empty if not specified by the users. + * + * Generated from protobuf field optional int32 queue_count = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getQueueCount() + { + return isset($this->queue_count) ? $this->queue_count : 0; + } + + public function hasQueueCount() + { + return isset($this->queue_count); + } + + public function clearQueueCount() + { + unset($this->queue_count); + } + + /** + * Optional. The networking queue count that's specified by users for the + * network interface. Both Rx and Tx queues will be set to this number. It'll + * be empty if not specified by the users. + * + * Generated from protobuf field optional int32 queue_count = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setQueueCount($var) + { + GPBUtil::checkInt32($var); + $this->queue_count = $var; + + return $this; + } + + /** + * Optional. The type of vNIC to be used on this interface. This may be gVNIC + * or VirtioNet. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.NicType nic_type = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getNicType() + { + return isset($this->nic_type) ? $this->nic_type : 0; + } + + public function hasNicType() + { + return isset($this->nic_type); + } + + public function clearNicType() + { + unset($this->nic_type); + } + + /** + * Optional. The type of vNIC to be used on this interface. This may be gVNIC + * or VirtioNet. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkInterface.NicType nic_type = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setNicType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\NetworkInterface\NicType::class); + $this->nic_type = $var; + + return $this; + } + + /** + * Optional. The URL of the network attachment that this interface should + * connect to in the following format: + * projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. + * + * Generated from protobuf field optional string network_attachment = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getNetworkAttachment() + { + return isset($this->network_attachment) ? $this->network_attachment : ''; + } + + public function hasNetworkAttachment() + { + return isset($this->network_attachment); + } + + public function clearNetworkAttachment() + { + unset($this->network_attachment); + } + + /** + * Optional. The URL of the network attachment that this interface should + * connect to in the following format: + * projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. + * + * Generated from protobuf field optional string network_attachment = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setNetworkAttachment($var) + { + GPBUtil::checkString($var, True); + $this->network_attachment = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/NetworkInterface/Ipv6AccessType.php b/BackupDr/src/V1/NetworkInterface/Ipv6AccessType.php new file mode 100644 index 000000000000..0e693955e272 --- /dev/null +++ b/BackupDr/src/V1/NetworkInterface/Ipv6AccessType.php @@ -0,0 +1,63 @@ +google.cloud.backupdr.v1.NetworkInterface.Ipv6AccessType + */ +class Ipv6AccessType +{ + /** + * IPv6 access type not set. Means this network interface hasn't been + * turned on IPv6 yet. + * + * Generated from protobuf enum UNSPECIFIED_IPV6_ACCESS_TYPE = 0; + */ + const UNSPECIFIED_IPV6_ACCESS_TYPE = 0; + /** + * This network interface can have internal IPv6. + * + * Generated from protobuf enum INTERNAL = 1; + */ + const INTERNAL = 1; + /** + * This network interface can have external IPv6. + * + * Generated from protobuf enum EXTERNAL = 2; + */ + const EXTERNAL = 2; + + private static $valueToName = [ + self::UNSPECIFIED_IPV6_ACCESS_TYPE => 'UNSPECIFIED_IPV6_ACCESS_TYPE', + self::INTERNAL => 'INTERNAL', + self::EXTERNAL => 'EXTERNAL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/NetworkInterface/NicType.php b/BackupDr/src/V1/NetworkInterface/NicType.php new file mode 100644 index 000000000000..68e6feafb6d2 --- /dev/null +++ b/BackupDr/src/V1/NetworkInterface/NicType.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.NetworkInterface.NicType + */ +class NicType +{ + /** + * Default should be NIC_TYPE_UNSPECIFIED. + * + * Generated from protobuf enum NIC_TYPE_UNSPECIFIED = 0; + */ + const NIC_TYPE_UNSPECIFIED = 0; + /** + * VIRTIO + * + * Generated from protobuf enum VIRTIO_NET = 1; + */ + const VIRTIO_NET = 1; + /** + * GVNIC + * + * Generated from protobuf enum GVNIC = 2; + */ + const GVNIC = 2; + + private static $valueToName = [ + self::NIC_TYPE_UNSPECIFIED => 'NIC_TYPE_UNSPECIFIED', + self::VIRTIO_NET => 'VIRTIO_NET', + self::GVNIC => 'GVNIC', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/NetworkInterface/StackType.php b/BackupDr/src/V1/NetworkInterface/StackType.php new file mode 100644 index 000000000000..3fa4b59c862e --- /dev/null +++ b/BackupDr/src/V1/NetworkInterface/StackType.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.NetworkInterface.StackType + */ +class StackType +{ + /** + * Default should be STACK_TYPE_UNSPECIFIED. + * + * Generated from protobuf enum STACK_TYPE_UNSPECIFIED = 0; + */ + const STACK_TYPE_UNSPECIFIED = 0; + /** + * The network interface will be assigned IPv4 address. + * + * Generated from protobuf enum IPV4_ONLY = 1; + */ + const IPV4_ONLY = 1; + /** + * The network interface can have both IPv4 and IPv6 addresses. + * + * Generated from protobuf enum IPV4_IPV6 = 2; + */ + const IPV4_IPV6 = 2; + + private static $valueToName = [ + self::STACK_TYPE_UNSPECIFIED => 'STACK_TYPE_UNSPECIFIED', + self::IPV4_ONLY => 'IPV4_ONLY', + self::IPV4_IPV6 => 'IPV4_IPV6', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/NetworkPerformanceConfig.php b/BackupDr/src/V1/NetworkPerformanceConfig.php new file mode 100644 index 000000000000..9104b7f0e842 --- /dev/null +++ b/BackupDr/src/V1/NetworkPerformanceConfig.php @@ -0,0 +1,77 @@ +google.cloud.backupdr.v1.NetworkPerformanceConfig + */ +class NetworkPerformanceConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The tier of the total egress bandwidth. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkPerformanceConfig.Tier total_egress_bandwidth_tier = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $total_egress_bandwidth_tier = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $total_egress_bandwidth_tier + * Optional. The tier of the total egress bandwidth. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The tier of the total egress bandwidth. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkPerformanceConfig.Tier total_egress_bandwidth_tier = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getTotalEgressBandwidthTier() + { + return isset($this->total_egress_bandwidth_tier) ? $this->total_egress_bandwidth_tier : 0; + } + + public function hasTotalEgressBandwidthTier() + { + return isset($this->total_egress_bandwidth_tier); + } + + public function clearTotalEgressBandwidthTier() + { + unset($this->total_egress_bandwidth_tier); + } + + /** + * Optional. The tier of the total egress bandwidth. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.NetworkPerformanceConfig.Tier total_egress_bandwidth_tier = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setTotalEgressBandwidthTier($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\NetworkPerformanceConfig\Tier::class); + $this->total_egress_bandwidth_tier = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/NetworkPerformanceConfig/Tier.php b/BackupDr/src/V1/NetworkPerformanceConfig/Tier.php new file mode 100644 index 000000000000..e53e32fa05fb --- /dev/null +++ b/BackupDr/src/V1/NetworkPerformanceConfig/Tier.php @@ -0,0 +1,66 @@ +google.cloud.backupdr.v1.NetworkPerformanceConfig.Tier + */ +class Tier +{ + /** + * This value is unused. + * + * Generated from protobuf enum TIER_UNSPECIFIED = 0; + */ + const TIER_UNSPECIFIED = 0; + /** + * Default network performance config. + * + * Generated from protobuf enum DEFAULT = 1; + */ + const PBDEFAULT = 1; + /** + * Tier 1 network performance config. + * + * Generated from protobuf enum TIER_1 = 2; + */ + const TIER_1 = 2; + + private static $valueToName = [ + self::TIER_UNSPECIFIED => 'TIER_UNSPECIFIED', + self::PBDEFAULT => 'DEFAULT', + self::TIER_1 => 'TIER_1', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + $pbconst = __CLASS__. '::PB' . strtoupper($name); + if (!defined($pbconst)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($pbconst); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/OperationMetadata.php b/BackupDr/src/V1/OperationMetadata.php index 822d7b9a09a9..e880bbc7986d 100644 --- a/BackupDr/src/V1/OperationMetadata.php +++ b/BackupDr/src/V1/OperationMetadata.php @@ -50,7 +50,7 @@ class OperationMetadata extends \Google\Protobuf\Internal\Message * of the operation. Operations that have successfully been cancelled * have [Operation.error][] value with a * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to - * `Code.CANCELLED`. + * 'Code.CANCELLED'. * * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -90,7 +90,7 @@ class OperationMetadata extends \Google\Protobuf\Internal\Message * of the operation. Operations that have successfully been cancelled * have [Operation.error][] value with a * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to - * `Code.CANCELLED`. + * 'Code.CANCELLED'. * @type string $api_version * Output only. API version used to start the operation. * @type array|\Google\Protobuf\Internal\MapField $additional_info @@ -258,7 +258,7 @@ public function setStatusMessage($var) * of the operation. Operations that have successfully been cancelled * have [Operation.error][] value with a * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to - * `Code.CANCELLED`. + * 'Code.CANCELLED'. * * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return bool @@ -273,7 +273,7 @@ public function getRequestedCancellation() * of the operation. Operations that have successfully been cancelled * have [Operation.error][] value with a * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to - * `Code.CANCELLED`. + * 'Code.CANCELLED'. * * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param bool $var diff --git a/BackupDr/src/V1/RestoreBackupRequest.php b/BackupDr/src/V1/RestoreBackupRequest.php new file mode 100644 index 000000000000..57cda39c282c --- /dev/null +++ b/BackupDr/src/V1/RestoreBackupRequest.php @@ -0,0 +1,244 @@ +google.cloud.backupdr.v1.RestoreBackupRequest + */ +class RestoreBackupRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the Backup instance, in the format + * 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + protected $target_environment; + protected $instance_properties; + + /** + * @param string $name Required. The resource name of the Backup instance, in the format + * 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'. Please see + * {@see BackupDRClient::backupName()} for help formatting this field. + * + * @return \Google\Cloud\BackupDR\V1\RestoreBackupRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the Backup instance, in the format + * 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * @type \Google\Cloud\BackupDR\V1\ComputeInstanceTargetEnvironment $compute_instance_target_environment + * Compute Engine target environment to be used during restore. + * @type \Google\Cloud\BackupDR\V1\ComputeInstanceRestoreProperties $compute_instance_restore_properties + * Compute Engine instance properties to be overridden during restore. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the Backup instance, in the format + * 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the Backup instance, in the format + * 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + + /** + * Compute Engine target environment to be used during restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ComputeInstanceTargetEnvironment compute_instance_target_environment = 3; + * @return \Google\Cloud\BackupDR\V1\ComputeInstanceTargetEnvironment|null + */ + public function getComputeInstanceTargetEnvironment() + { + return $this->readOneof(3); + } + + public function hasComputeInstanceTargetEnvironment() + { + return $this->hasOneof(3); + } + + /** + * Compute Engine target environment to be used during restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ComputeInstanceTargetEnvironment compute_instance_target_environment = 3; + * @param \Google\Cloud\BackupDR\V1\ComputeInstanceTargetEnvironment $var + * @return $this + */ + public function setComputeInstanceTargetEnvironment($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\ComputeInstanceTargetEnvironment::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Compute Engine instance properties to be overridden during restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ComputeInstanceRestoreProperties compute_instance_restore_properties = 4; + * @return \Google\Cloud\BackupDR\V1\ComputeInstanceRestoreProperties|null + */ + public function getComputeInstanceRestoreProperties() + { + return $this->readOneof(4); + } + + public function hasComputeInstanceRestoreProperties() + { + return $this->hasOneof(4); + } + + /** + * Compute Engine instance properties to be overridden during restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.ComputeInstanceRestoreProperties compute_instance_restore_properties = 4; + * @param \Google\Cloud\BackupDR\V1\ComputeInstanceRestoreProperties $var + * @return $this + */ + public function setComputeInstanceRestoreProperties($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\ComputeInstanceRestoreProperties::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * @return string + */ + public function getTargetEnvironment() + { + return $this->whichOneof("target_environment"); + } + + /** + * @return string + */ + public function getInstanceProperties() + { + return $this->whichOneof("instance_properties"); + } + +} + diff --git a/BackupDr/src/V1/RestoreBackupResponse.php b/BackupDr/src/V1/RestoreBackupResponse.php new file mode 100644 index 000000000000..27614255363f --- /dev/null +++ b/BackupDr/src/V1/RestoreBackupResponse.php @@ -0,0 +1,77 @@ +google.cloud.backupdr.v1.RestoreBackupResponse + */ +class RestoreBackupResponse extends \Google\Protobuf\Internal\Message +{ + /** + * Details of the target resource created/modified as part of restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.TargetResource target_resource = 1; + */ + protected $target_resource = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\BackupDR\V1\TargetResource $target_resource + * Details of the target resource created/modified as part of restore. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Details of the target resource created/modified as part of restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.TargetResource target_resource = 1; + * @return \Google\Cloud\BackupDR\V1\TargetResource|null + */ + public function getTargetResource() + { + return $this->target_resource; + } + + public function hasTargetResource() + { + return isset($this->target_resource); + } + + public function clearTargetResource() + { + unset($this->target_resource); + } + + /** + * Details of the target resource created/modified as part of restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.TargetResource target_resource = 1; + * @param \Google\Cloud\BackupDR\V1\TargetResource $var + * @return $this + */ + public function setTargetResource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\TargetResource::class); + $this->target_resource = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/RuleConfigInfo.php b/BackupDr/src/V1/RuleConfigInfo.php new file mode 100644 index 000000000000..710f042a26d9 --- /dev/null +++ b/BackupDr/src/V1/RuleConfigInfo.php @@ -0,0 +1,201 @@ +google.cloud.backupdr.v1.RuleConfigInfo + */ +class RuleConfigInfo extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Output Only. + * Backup Rule id fetched from backup plan. + * + * Generated from protobuf field string rule_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $rule_id = ''; + /** + * Output only. The last backup state for rule. + * + * Generated from protobuf field .google.cloud.backupdr.v1.RuleConfigInfo.LastBackupState last_backup_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $last_backup_state = 0; + /** + * Output only. Output Only. + * google.rpc.Status object to store the last backup error. + * + * Generated from protobuf field .google.rpc.Status last_backup_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $last_backup_error = null; + /** + * Output only. The point in time when the last successful backup was captured + * from the source. + * + * Generated from protobuf field .google.protobuf.Timestamp last_successful_backup_consistency_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $last_successful_backup_consistency_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $rule_id + * Output only. Output Only. + * Backup Rule id fetched from backup plan. + * @type int $last_backup_state + * Output only. The last backup state for rule. + * @type \Google\Rpc\Status $last_backup_error + * Output only. Output Only. + * google.rpc.Status object to store the last backup error. + * @type \Google\Protobuf\Timestamp $last_successful_backup_consistency_time + * Output only. The point in time when the last successful backup was captured + * from the source. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplanassociation::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Output Only. + * Backup Rule id fetched from backup plan. + * + * Generated from protobuf field string rule_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getRuleId() + { + return $this->rule_id; + } + + /** + * Output only. Output Only. + * Backup Rule id fetched from backup plan. + * + * Generated from protobuf field string rule_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setRuleId($var) + { + GPBUtil::checkString($var, True); + $this->rule_id = $var; + + return $this; + } + + /** + * Output only. The last backup state for rule. + * + * Generated from protobuf field .google.cloud.backupdr.v1.RuleConfigInfo.LastBackupState last_backup_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getLastBackupState() + { + return $this->last_backup_state; + } + + /** + * Output only. The last backup state for rule. + * + * Generated from protobuf field .google.cloud.backupdr.v1.RuleConfigInfo.LastBackupState last_backup_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setLastBackupState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\RuleConfigInfo\LastBackupState::class); + $this->last_backup_state = $var; + + return $this; + } + + /** + * Output only. Output Only. + * google.rpc.Status object to store the last backup error. + * + * Generated from protobuf field .google.rpc.Status last_backup_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Rpc\Status|null + */ + public function getLastBackupError() + { + return $this->last_backup_error; + } + + public function hasLastBackupError() + { + return isset($this->last_backup_error); + } + + public function clearLastBackupError() + { + unset($this->last_backup_error); + } + + /** + * Output only. Output Only. + * google.rpc.Status object to store the last backup error. + * + * Generated from protobuf field .google.rpc.Status last_backup_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Rpc\Status $var + * @return $this + */ + public function setLastBackupError($var) + { + GPBUtil::checkMessage($var, \Google\Rpc\Status::class); + $this->last_backup_error = $var; + + return $this; + } + + /** + * Output only. The point in time when the last successful backup was captured + * from the source. + * + * Generated from protobuf field .google.protobuf.Timestamp last_successful_backup_consistency_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getLastSuccessfulBackupConsistencyTime() + { + return $this->last_successful_backup_consistency_time; + } + + public function hasLastSuccessfulBackupConsistencyTime() + { + return isset($this->last_successful_backup_consistency_time); + } + + public function clearLastSuccessfulBackupConsistencyTime() + { + unset($this->last_successful_backup_consistency_time); + } + + /** + * Output only. The point in time when the last successful backup was captured + * from the source. + * + * Generated from protobuf field .google.protobuf.Timestamp last_successful_backup_consistency_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setLastSuccessfulBackupConsistencyTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->last_successful_backup_consistency_time = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/RuleConfigInfo/LastBackupState.php b/BackupDr/src/V1/RuleConfigInfo/LastBackupState.php new file mode 100644 index 000000000000..b8df1c268358 --- /dev/null +++ b/BackupDr/src/V1/RuleConfigInfo/LastBackupState.php @@ -0,0 +1,77 @@ +google.cloud.backupdr.v1.RuleConfigInfo.LastBackupState + */ +class LastBackupState +{ + /** + * State not set. + * + * Generated from protobuf enum LAST_BACKUP_STATE_UNSPECIFIED = 0; + */ + const LAST_BACKUP_STATE_UNSPECIFIED = 0; + /** + * The first backup is pending. + * + * Generated from protobuf enum FIRST_BACKUP_PENDING = 1; + */ + const FIRST_BACKUP_PENDING = 1; + /** + * The most recent backup could not be run/failed because of the lack of + * permissions. + * + * Generated from protobuf enum PERMISSION_DENIED = 2; + */ + const PERMISSION_DENIED = 2; + /** + * The last backup operation succeeded. + * + * Generated from protobuf enum SUCCEEDED = 3; + */ + const SUCCEEDED = 3; + /** + * The last backup operation failed. + * + * Generated from protobuf enum FAILED = 4; + */ + const FAILED = 4; + + private static $valueToName = [ + self::LAST_BACKUP_STATE_UNSPECIFIED => 'LAST_BACKUP_STATE_UNSPECIFIED', + self::FIRST_BACKUP_PENDING => 'FIRST_BACKUP_PENDING', + self::PERMISSION_DENIED => 'PERMISSION_DENIED', + self::SUCCEEDED => 'SUCCEEDED', + self::FAILED => 'FAILED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/Scheduling.php b/BackupDr/src/V1/Scheduling.php new file mode 100644 index 000000000000..fceb736acfde --- /dev/null +++ b/BackupDr/src/V1/Scheduling.php @@ -0,0 +1,399 @@ +google.cloud.backupdr.v1.Scheduling + */ +class Scheduling extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Defines the maintenance behavior for this instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.OnHostMaintenance on_host_maintenance = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $on_host_maintenance = null; + /** + * Optional. Specifies whether the instance should be automatically restarted + * if it is terminated by Compute Engine (not terminated by a user). + * + * Generated from protobuf field optional bool automatic_restart = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $automatic_restart = null; + /** + * Optional. Defines whether the instance is preemptible. + * + * Generated from protobuf field optional bool preemptible = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $preemptible = null; + /** + * Optional. A set of node affinity and anti-affinity configurations. + * Overrides reservationAffinity. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Scheduling.NodeAffinity node_affinities = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $node_affinities; + /** + * Optional. The minimum number of virtual CPUs this instance will consume + * when running on a sole-tenant node. + * + * Generated from protobuf field optional int32 min_node_cpus = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $min_node_cpus = null; + /** + * Optional. Specifies the provisioning model of the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.ProvisioningModel provisioning_model = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $provisioning_model = null; + /** + * Optional. Specifies the termination action for the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.InstanceTerminationAction instance_termination_action = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $instance_termination_action = null; + /** + * Optional. Specifies the maximum amount of time a Local Ssd Vm should wait + * while recovery of the Local Ssd state is attempted. Its value should be in + * between 0 and 168 hours with hour granularity and the default value being 1 + * hour. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.SchedulingDuration local_ssd_recovery_timeout = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $local_ssd_recovery_timeout = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $on_host_maintenance + * Optional. Defines the maintenance behavior for this instance. + * @type bool $automatic_restart + * Optional. Specifies whether the instance should be automatically restarted + * if it is terminated by Compute Engine (not terminated by a user). + * @type bool $preemptible + * Optional. Defines whether the instance is preemptible. + * @type array<\Google\Cloud\BackupDR\V1\Scheduling\NodeAffinity>|\Google\Protobuf\Internal\RepeatedField $node_affinities + * Optional. A set of node affinity and anti-affinity configurations. + * Overrides reservationAffinity. + * @type int $min_node_cpus + * Optional. The minimum number of virtual CPUs this instance will consume + * when running on a sole-tenant node. + * @type int $provisioning_model + * Optional. Specifies the provisioning model of the instance. + * @type int $instance_termination_action + * Optional. Specifies the termination action for the instance. + * @type \Google\Cloud\BackupDR\V1\SchedulingDuration $local_ssd_recovery_timeout + * Optional. Specifies the maximum amount of time a Local Ssd Vm should wait + * while recovery of the Local Ssd state is attempted. Its value should be in + * between 0 and 168 hours with hour granularity and the default value being 1 + * hour. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Defines the maintenance behavior for this instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.OnHostMaintenance on_host_maintenance = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getOnHostMaintenance() + { + return isset($this->on_host_maintenance) ? $this->on_host_maintenance : 0; + } + + public function hasOnHostMaintenance() + { + return isset($this->on_host_maintenance); + } + + public function clearOnHostMaintenance() + { + unset($this->on_host_maintenance); + } + + /** + * Optional. Defines the maintenance behavior for this instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.OnHostMaintenance on_host_maintenance = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setOnHostMaintenance($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\Scheduling\OnHostMaintenance::class); + $this->on_host_maintenance = $var; + + return $this; + } + + /** + * Optional. Specifies whether the instance should be automatically restarted + * if it is terminated by Compute Engine (not terminated by a user). + * + * Generated from protobuf field optional bool automatic_restart = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAutomaticRestart() + { + return isset($this->automatic_restart) ? $this->automatic_restart : false; + } + + public function hasAutomaticRestart() + { + return isset($this->automatic_restart); + } + + public function clearAutomaticRestart() + { + unset($this->automatic_restart); + } + + /** + * Optional. Specifies whether the instance should be automatically restarted + * if it is terminated by Compute Engine (not terminated by a user). + * + * Generated from protobuf field optional bool automatic_restart = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAutomaticRestart($var) + { + GPBUtil::checkBool($var); + $this->automatic_restart = $var; + + return $this; + } + + /** + * Optional. Defines whether the instance is preemptible. + * + * Generated from protobuf field optional bool preemptible = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getPreemptible() + { + return isset($this->preemptible) ? $this->preemptible : false; + } + + public function hasPreemptible() + { + return isset($this->preemptible); + } + + public function clearPreemptible() + { + unset($this->preemptible); + } + + /** + * Optional. Defines whether the instance is preemptible. + * + * Generated from protobuf field optional bool preemptible = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setPreemptible($var) + { + GPBUtil::checkBool($var); + $this->preemptible = $var; + + return $this; + } + + /** + * Optional. A set of node affinity and anti-affinity configurations. + * Overrides reservationAffinity. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Scheduling.NodeAffinity node_affinities = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getNodeAffinities() + { + return $this->node_affinities; + } + + /** + * Optional. A set of node affinity and anti-affinity configurations. + * Overrides reservationAffinity. + * + * Generated from protobuf field repeated .google.cloud.backupdr.v1.Scheduling.NodeAffinity node_affinities = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\BackupDR\V1\Scheduling\NodeAffinity>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setNodeAffinities($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BackupDR\V1\Scheduling\NodeAffinity::class); + $this->node_affinities = $arr; + + return $this; + } + + /** + * Optional. The minimum number of virtual CPUs this instance will consume + * when running on a sole-tenant node. + * + * Generated from protobuf field optional int32 min_node_cpus = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getMinNodeCpus() + { + return isset($this->min_node_cpus) ? $this->min_node_cpus : 0; + } + + public function hasMinNodeCpus() + { + return isset($this->min_node_cpus); + } + + public function clearMinNodeCpus() + { + unset($this->min_node_cpus); + } + + /** + * Optional. The minimum number of virtual CPUs this instance will consume + * when running on a sole-tenant node. + * + * Generated from protobuf field optional int32 min_node_cpus = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setMinNodeCpus($var) + { + GPBUtil::checkInt32($var); + $this->min_node_cpus = $var; + + return $this; + } + + /** + * Optional. Specifies the provisioning model of the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.ProvisioningModel provisioning_model = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getProvisioningModel() + { + return isset($this->provisioning_model) ? $this->provisioning_model : 0; + } + + public function hasProvisioningModel() + { + return isset($this->provisioning_model); + } + + public function clearProvisioningModel() + { + unset($this->provisioning_model); + } + + /** + * Optional. Specifies the provisioning model of the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.ProvisioningModel provisioning_model = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setProvisioningModel($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\Scheduling\ProvisioningModel::class); + $this->provisioning_model = $var; + + return $this; + } + + /** + * Optional. Specifies the termination action for the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.InstanceTerminationAction instance_termination_action = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getInstanceTerminationAction() + { + return isset($this->instance_termination_action) ? $this->instance_termination_action : 0; + } + + public function hasInstanceTerminationAction() + { + return isset($this->instance_termination_action); + } + + public function clearInstanceTerminationAction() + { + unset($this->instance_termination_action); + } + + /** + * Optional. Specifies the termination action for the instance. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.InstanceTerminationAction instance_termination_action = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setInstanceTerminationAction($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\Scheduling\InstanceTerminationAction::class); + $this->instance_termination_action = $var; + + return $this; + } + + /** + * Optional. Specifies the maximum amount of time a Local Ssd Vm should wait + * while recovery of the Local Ssd state is attempted. Its value should be in + * between 0 and 168 hours with hour granularity and the default value being 1 + * hour. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.SchedulingDuration local_ssd_recovery_timeout = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\SchedulingDuration|null + */ + public function getLocalSsdRecoveryTimeout() + { + return $this->local_ssd_recovery_timeout; + } + + public function hasLocalSsdRecoveryTimeout() + { + return isset($this->local_ssd_recovery_timeout); + } + + public function clearLocalSsdRecoveryTimeout() + { + unset($this->local_ssd_recovery_timeout); + } + + /** + * Optional. Specifies the maximum amount of time a Local Ssd Vm should wait + * while recovery of the Local Ssd state is attempted. Its value should be in + * between 0 and 168 hours with hour granularity and the default value being 1 + * hour. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.SchedulingDuration local_ssd_recovery_timeout = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\SchedulingDuration $var + * @return $this + */ + public function setLocalSsdRecoveryTimeout($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\SchedulingDuration::class); + $this->local_ssd_recovery_timeout = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/Scheduling/InstanceTerminationAction.php b/BackupDr/src/V1/Scheduling/InstanceTerminationAction.php new file mode 100644 index 000000000000..cd01151b99d2 --- /dev/null +++ b/BackupDr/src/V1/Scheduling/InstanceTerminationAction.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.Scheduling.InstanceTerminationAction + */ +class InstanceTerminationAction +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 0; + */ + const INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 0; + /** + * Delete the VM. + * + * Generated from protobuf enum DELETE = 1; + */ + const DELETE = 1; + /** + * Stop the VM without storing in-memory content. default action. + * + * Generated from protobuf enum STOP = 2; + */ + const STOP = 2; + + private static $valueToName = [ + self::INSTANCE_TERMINATION_ACTION_UNSPECIFIED => 'INSTANCE_TERMINATION_ACTION_UNSPECIFIED', + self::DELETE => 'DELETE', + self::STOP => 'STOP', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/Scheduling/NodeAffinity.php b/BackupDr/src/V1/Scheduling/NodeAffinity.php new file mode 100644 index 000000000000..9068885d9fa7 --- /dev/null +++ b/BackupDr/src/V1/Scheduling/NodeAffinity.php @@ -0,0 +1,157 @@ +google.cloud.backupdr.v1.Scheduling.NodeAffinity + */ +class NodeAffinity extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Corresponds to the label key of Node resource. + * + * Generated from protobuf field optional string key = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $key = null; + /** + * Optional. Defines the operation of node selection. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.NodeAffinity.Operator operator = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $operator = null; + /** + * Optional. Corresponds to the label values of Node resource. + * + * Generated from protobuf field repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $values; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $key + * Optional. Corresponds to the label key of Node resource. + * @type int $operator + * Optional. Defines the operation of node selection. + * @type array|\Google\Protobuf\Internal\RepeatedField $values + * Optional. Corresponds to the label values of Node resource. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Corresponds to the label key of Node resource. + * + * Generated from protobuf field optional string key = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getKey() + { + return isset($this->key) ? $this->key : ''; + } + + public function hasKey() + { + return isset($this->key); + } + + public function clearKey() + { + unset($this->key); + } + + /** + * Optional. Corresponds to the label key of Node resource. + * + * Generated from protobuf field optional string key = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setKey($var) + { + GPBUtil::checkString($var, True); + $this->key = $var; + + return $this; + } + + /** + * Optional. Defines the operation of node selection. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.NodeAffinity.Operator operator = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getOperator() + { + return isset($this->operator) ? $this->operator : 0; + } + + public function hasOperator() + { + return isset($this->operator); + } + + public function clearOperator() + { + unset($this->operator); + } + + /** + * Optional. Defines the operation of node selection. + * + * Generated from protobuf field optional .google.cloud.backupdr.v1.Scheduling.NodeAffinity.Operator operator = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setOperator($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\Scheduling\NodeAffinity\Operator::class); + $this->operator = $var; + + return $this; + } + + /** + * Optional. Corresponds to the label values of Node resource. + * + * Generated from protobuf field repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getValues() + { + return $this->values; + } + + /** + * Optional. Corresponds to the label values of Node resource. + * + * Generated from protobuf field repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->values = $arr; + + return $this; + } + +} + + diff --git a/BackupDr/src/V1/Scheduling/NodeAffinity/Operator.php b/BackupDr/src/V1/Scheduling/NodeAffinity/Operator.php new file mode 100644 index 000000000000..3117fed94931 --- /dev/null +++ b/BackupDr/src/V1/Scheduling/NodeAffinity/Operator.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.Scheduling.NodeAffinity.Operator + */ +class Operator +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum OPERATOR_UNSPECIFIED = 0; + */ + const OPERATOR_UNSPECIFIED = 0; + /** + * Requires Compute Engine to seek for matched nodes. + * + * Generated from protobuf enum IN = 1; + */ + const IN = 1; + /** + * Requires Compute Engine to avoid certain nodes. + * + * Generated from protobuf enum NOT_IN = 2; + */ + const NOT_IN = 2; + + private static $valueToName = [ + self::OPERATOR_UNSPECIFIED => 'OPERATOR_UNSPECIFIED', + self::IN => 'IN', + self::NOT_IN => 'NOT_IN', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/Scheduling/OnHostMaintenance.php b/BackupDr/src/V1/Scheduling/OnHostMaintenance.php new file mode 100644 index 000000000000..9a388fd66a95 --- /dev/null +++ b/BackupDr/src/V1/Scheduling/OnHostMaintenance.php @@ -0,0 +1,64 @@ +google.cloud.backupdr.v1.Scheduling.OnHostMaintenance + */ +class OnHostMaintenance +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum ON_HOST_MAINTENANCE_UNSPECIFIED = 0; + */ + const ON_HOST_MAINTENANCE_UNSPECIFIED = 0; + /** + * Tells Compute Engine to terminate and (optionally) restart the instance + * away from the maintenance activity. + * + * Generated from protobuf enum TERMINATE = 1; + */ + const TERMINATE = 1; + /** + * Default, Allows Compute Engine to automatically migrate instances + * out of the way of maintenance events. + * + * Generated from protobuf enum MIGRATE = 1000; + */ + const MIGRATE = 1000; + + private static $valueToName = [ + self::ON_HOST_MAINTENANCE_UNSPECIFIED => 'ON_HOST_MAINTENANCE_UNSPECIFIED', + self::TERMINATE => 'TERMINATE', + self::MIGRATE => 'MIGRATE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/Scheduling/ProvisioningModel.php b/BackupDr/src/V1/Scheduling/ProvisioningModel.php new file mode 100644 index 000000000000..50d92477518f --- /dev/null +++ b/BackupDr/src/V1/Scheduling/ProvisioningModel.php @@ -0,0 +1,62 @@ +google.cloud.backupdr.v1.Scheduling.ProvisioningModel + */ +class ProvisioningModel +{ + /** + * Default value. This value is not used. + * + * Generated from protobuf enum PROVISIONING_MODEL_UNSPECIFIED = 0; + */ + const PROVISIONING_MODEL_UNSPECIFIED = 0; + /** + * Standard provisioning with user controlled runtime, no discounts. + * + * Generated from protobuf enum STANDARD = 1; + */ + const STANDARD = 1; + /** + * Heavily discounted, no guaranteed runtime. + * + * Generated from protobuf enum SPOT = 2; + */ + const SPOT = 2; + + private static $valueToName = [ + self::PROVISIONING_MODEL_UNSPECIFIED => 'PROVISIONING_MODEL_UNSPECIFIED', + self::STANDARD => 'STANDARD', + self::SPOT => 'SPOT', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/SchedulingDuration.php b/BackupDr/src/V1/SchedulingDuration.php new file mode 100644 index 000000000000..cc3c3abf8a1a --- /dev/null +++ b/BackupDr/src/V1/SchedulingDuration.php @@ -0,0 +1,128 @@ +google.cloud.backupdr.v1.SchedulingDuration + */ +class SchedulingDuration extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Span of time at a resolution of a second. + * + * Generated from protobuf field optional int64 seconds = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $seconds = null; + /** + * Optional. Span of time that's a fraction of a second at nanosecond + * resolution. + * + * Generated from protobuf field optional int32 nanos = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $nanos = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $seconds + * Optional. Span of time at a resolution of a second. + * @type int $nanos + * Optional. Span of time that's a fraction of a second at nanosecond + * resolution. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Span of time at a resolution of a second. + * + * Generated from protobuf field optional int64 seconds = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getSeconds() + { + return isset($this->seconds) ? $this->seconds : 0; + } + + public function hasSeconds() + { + return isset($this->seconds); + } + + public function clearSeconds() + { + unset($this->seconds); + } + + /** + * Optional. Span of time at a resolution of a second. + * + * Generated from protobuf field optional int64 seconds = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setSeconds($var) + { + GPBUtil::checkInt64($var); + $this->seconds = $var; + + return $this; + } + + /** + * Optional. Span of time that's a fraction of a second at nanosecond + * resolution. + * + * Generated from protobuf field optional int32 nanos = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getNanos() + { + return isset($this->nanos) ? $this->nanos : 0; + } + + public function hasNanos() + { + return isset($this->nanos); + } + + public function clearNanos() + { + unset($this->nanos); + } + + /** + * Optional. Span of time that's a fraction of a second at nanosecond + * resolution. + * + * Generated from protobuf field optional int32 nanos = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setNanos($var) + { + GPBUtil::checkInt32($var); + $this->nanos = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ServiceAccount.php b/BackupDr/src/V1/ServiceAccount.php new file mode 100644 index 000000000000..2555e69a2e1d --- /dev/null +++ b/BackupDr/src/V1/ServiceAccount.php @@ -0,0 +1,111 @@ +google.cloud.backupdr.v1.ServiceAccount + */ +class ServiceAccount extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Email address of the service account. + * + * Generated from protobuf field optional string email = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $email = null; + /** + * Optional. The list of scopes to be made available for this service account. + * + * Generated from protobuf field repeated string scopes = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $scopes; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $email + * Optional. Email address of the service account. + * @type array|\Google\Protobuf\Internal\RepeatedField $scopes + * Optional. The list of scopes to be made available for this service account. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Email address of the service account. + * + * Generated from protobuf field optional string email = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEmail() + { + return isset($this->email) ? $this->email : ''; + } + + public function hasEmail() + { + return isset($this->email); + } + + public function clearEmail() + { + unset($this->email); + } + + /** + * Optional. Email address of the service account. + * + * Generated from protobuf field optional string email = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEmail($var) + { + GPBUtil::checkString($var, True); + $this->email = $var; + + return $this; + } + + /** + * Optional. The list of scopes to be made available for this service account. + * + * Generated from protobuf field repeated string scopes = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getScopes() + { + return $this->scopes; + } + + /** + * Optional. The list of scopes to be made available for this service account. + * + * Generated from protobuf field repeated string scopes = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setScopes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->scopes = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/ServiceLockInfo.php b/BackupDr/src/V1/ServiceLockInfo.php new file mode 100644 index 000000000000..1191b4e15201 --- /dev/null +++ b/BackupDr/src/V1/ServiceLockInfo.php @@ -0,0 +1,72 @@ +google.cloud.backupdr.v1.ServiceLockInfo + */ +class ServiceLockInfo extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The name of the operation that created this lock. + * The lock will automatically be released when the operation completes. + * + * Generated from protobuf field string operation = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $operation = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $operation + * Output only. The name of the operation that created this lock. + * The lock will automatically be released when the operation completes. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The name of the operation that created this lock. + * The lock will automatically be released when the operation completes. + * + * Generated from protobuf field string operation = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getOperation() + { + return $this->operation; + } + + /** + * Output only. The name of the operation that created this lock. + * The lock will automatically be released when the operation completes. + * + * Generated from protobuf field string operation = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setOperation($var) + { + GPBUtil::checkString($var, True); + $this->operation = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/StandardSchedule.php b/BackupDr/src/V1/StandardSchedule.php new file mode 100644 index 000000000000..a6936ec9b05d --- /dev/null +++ b/BackupDr/src/V1/StandardSchedule.php @@ -0,0 +1,447 @@ +google.cloud.backupdr.v1.StandardSchedule + */ +class StandardSchedule extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Specifies the `RecurrenceType` for the schedule. + * + * Generated from protobuf field .google.cloud.backupdr.v1.StandardSchedule.RecurrenceType recurrence_type = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $recurrence_type = 0; + /** + * Optional. Specifies frequency for hourly backups. A hourly frequency of 2 + * means jobs will run every 2 hours from start time till end time defined. + * This is required for `recurrence_type`, `HOURLY` and is not applicable + * otherwise. A validation error will occur if a value is supplied and + * `recurrence_type` is not `HOURLY`. + * Value of hourly frequency should be between 6 and 23. + * Reason for limit : We found that there is bandwidth limitation of 3GB/S for + * GMI while taking a backup and 5GB/S while doing a restore. Given the amount + * of parallel backups and restore we are targeting, this will potentially + * take the backup time to mins and hours (in worst case scenario). + * + * Generated from protobuf field int32 hourly_frequency = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $hourly_frequency = 0; + /** + * Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs + * will run. + * This is required for `recurrence_type`, `WEEKLY` and is not applicable + * otherwise. A validation error will occur if a value is supplied and + * `recurrence_type` is not `WEEKLY`. + * + * Generated from protobuf field repeated .google.type.DayOfWeek days_of_week = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $days_of_week; + /** + * Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. + * Values for `days_of_month` are only applicable for `recurrence_type`, + * `MONTHLY` and `YEARLY`. A validation error will occur if other values are + * supplied. + * + * Generated from protobuf field repeated int32 days_of_month = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $days_of_month; + /** + * Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST + * MONDAY, on which jobs will run. This will be specified by two fields in + * `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, + * e.g. `LAST`. + * This field is only applicable for `recurrence_type`, `MONTHLY` and + * `YEARLY`. A validation error will occur if other values are supplied. + * + * Generated from protobuf field .google.cloud.backupdr.v1.WeekDayOfMonth week_day_of_month = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $week_day_of_month = null; + /** + * Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on + * which jobs will run. + * This field is only applicable when `recurrence_type` is `YEARLY`. A + * validation error will occur if other values are supplied. + * + * Generated from protobuf field repeated .google.type.Month months = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $months; + /** + * Required. A BackupWindow defines the window of day during which backup jobs + * will run. Jobs are queued at the beginning of the window and will be marked + * as `NOT_RUN` if they do not start by the end of the window. + * Note: running jobs will not be cancelled at the end of the window. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupWindow backup_window = 7 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_window = null; + /** + * Required. The time zone to be used when interpreting the schedule. + * The value of this field must be a time zone name from the IANA tz database. + * See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the + * list of valid timezone names. For e.g., Europe/Paris. + * + * Generated from protobuf field string time_zone = 8 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $time_zone = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $recurrence_type + * Required. Specifies the `RecurrenceType` for the schedule. + * @type int $hourly_frequency + * Optional. Specifies frequency for hourly backups. A hourly frequency of 2 + * means jobs will run every 2 hours from start time till end time defined. + * This is required for `recurrence_type`, `HOURLY` and is not applicable + * otherwise. A validation error will occur if a value is supplied and + * `recurrence_type` is not `HOURLY`. + * Value of hourly frequency should be between 6 and 23. + * Reason for limit : We found that there is bandwidth limitation of 3GB/S for + * GMI while taking a backup and 5GB/S while doing a restore. Given the amount + * of parallel backups and restore we are targeting, this will potentially + * take the backup time to mins and hours (in worst case scenario). + * @type array|\Google\Protobuf\Internal\RepeatedField $days_of_week + * Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs + * will run. + * This is required for `recurrence_type`, `WEEKLY` and is not applicable + * otherwise. A validation error will occur if a value is supplied and + * `recurrence_type` is not `WEEKLY`. + * @type array|\Google\Protobuf\Internal\RepeatedField $days_of_month + * Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. + * Values for `days_of_month` are only applicable for `recurrence_type`, + * `MONTHLY` and `YEARLY`. A validation error will occur if other values are + * supplied. + * @type \Google\Cloud\BackupDR\V1\WeekDayOfMonth $week_day_of_month + * Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST + * MONDAY, on which jobs will run. This will be specified by two fields in + * `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, + * e.g. `LAST`. + * This field is only applicable for `recurrence_type`, `MONTHLY` and + * `YEARLY`. A validation error will occur if other values are supplied. + * @type array|\Google\Protobuf\Internal\RepeatedField $months + * Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on + * which jobs will run. + * This field is only applicable when `recurrence_type` is `YEARLY`. A + * validation error will occur if other values are supplied. + * @type \Google\Cloud\BackupDR\V1\BackupWindow $backup_window + * Required. A BackupWindow defines the window of day during which backup jobs + * will run. Jobs are queued at the beginning of the window and will be marked + * as `NOT_RUN` if they do not start by the end of the window. + * Note: running jobs will not be cancelled at the end of the window. + * @type string $time_zone + * Required. The time zone to be used when interpreting the schedule. + * The value of this field must be a time zone name from the IANA tz database. + * See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the + * list of valid timezone names. For e.g., Europe/Paris. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Required. Specifies the `RecurrenceType` for the schedule. + * + * Generated from protobuf field .google.cloud.backupdr.v1.StandardSchedule.RecurrenceType recurrence_type = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getRecurrenceType() + { + return $this->recurrence_type; + } + + /** + * Required. Specifies the `RecurrenceType` for the schedule. + * + * Generated from protobuf field .google.cloud.backupdr.v1.StandardSchedule.RecurrenceType recurrence_type = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setRecurrenceType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\StandardSchedule\RecurrenceType::class); + $this->recurrence_type = $var; + + return $this; + } + + /** + * Optional. Specifies frequency for hourly backups. A hourly frequency of 2 + * means jobs will run every 2 hours from start time till end time defined. + * This is required for `recurrence_type`, `HOURLY` and is not applicable + * otherwise. A validation error will occur if a value is supplied and + * `recurrence_type` is not `HOURLY`. + * Value of hourly frequency should be between 6 and 23. + * Reason for limit : We found that there is bandwidth limitation of 3GB/S for + * GMI while taking a backup and 5GB/S while doing a restore. Given the amount + * of parallel backups and restore we are targeting, this will potentially + * take the backup time to mins and hours (in worst case scenario). + * + * Generated from protobuf field int32 hourly_frequency = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getHourlyFrequency() + { + return $this->hourly_frequency; + } + + /** + * Optional. Specifies frequency for hourly backups. A hourly frequency of 2 + * means jobs will run every 2 hours from start time till end time defined. + * This is required for `recurrence_type`, `HOURLY` and is not applicable + * otherwise. A validation error will occur if a value is supplied and + * `recurrence_type` is not `HOURLY`. + * Value of hourly frequency should be between 6 and 23. + * Reason for limit : We found that there is bandwidth limitation of 3GB/S for + * GMI while taking a backup and 5GB/S while doing a restore. Given the amount + * of parallel backups and restore we are targeting, this will potentially + * take the backup time to mins and hours (in worst case scenario). + * + * Generated from protobuf field int32 hourly_frequency = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setHourlyFrequency($var) + { + GPBUtil::checkInt32($var); + $this->hourly_frequency = $var; + + return $this; + } + + /** + * Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs + * will run. + * This is required for `recurrence_type`, `WEEKLY` and is not applicable + * otherwise. A validation error will occur if a value is supplied and + * `recurrence_type` is not `WEEKLY`. + * + * Generated from protobuf field repeated .google.type.DayOfWeek days_of_week = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDaysOfWeek() + { + return $this->days_of_week; + } + + /** + * Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs + * will run. + * This is required for `recurrence_type`, `WEEKLY` and is not applicable + * otherwise. A validation error will occur if a value is supplied and + * `recurrence_type` is not `WEEKLY`. + * + * Generated from protobuf field repeated .google.type.DayOfWeek days_of_week = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDaysOfWeek($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Type\DayOfWeek::class); + $this->days_of_week = $arr; + + return $this; + } + + /** + * Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. + * Values for `days_of_month` are only applicable for `recurrence_type`, + * `MONTHLY` and `YEARLY`. A validation error will occur if other values are + * supplied. + * + * Generated from protobuf field repeated int32 days_of_month = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDaysOfMonth() + { + return $this->days_of_month; + } + + /** + * Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. + * Values for `days_of_month` are only applicable for `recurrence_type`, + * `MONTHLY` and `YEARLY`. A validation error will occur if other values are + * supplied. + * + * Generated from protobuf field repeated int32 days_of_month = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDaysOfMonth($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32); + $this->days_of_month = $arr; + + return $this; + } + + /** + * Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST + * MONDAY, on which jobs will run. This will be specified by two fields in + * `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, + * e.g. `LAST`. + * This field is only applicable for `recurrence_type`, `MONTHLY` and + * `YEARLY`. A validation error will occur if other values are supplied. + * + * Generated from protobuf field .google.cloud.backupdr.v1.WeekDayOfMonth week_day_of_month = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\BackupDR\V1\WeekDayOfMonth|null + */ + public function getWeekDayOfMonth() + { + return $this->week_day_of_month; + } + + public function hasWeekDayOfMonth() + { + return isset($this->week_day_of_month); + } + + public function clearWeekDayOfMonth() + { + unset($this->week_day_of_month); + } + + /** + * Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST + * MONDAY, on which jobs will run. This will be specified by two fields in + * `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, + * e.g. `LAST`. + * This field is only applicable for `recurrence_type`, `MONTHLY` and + * `YEARLY`. A validation error will occur if other values are supplied. + * + * Generated from protobuf field .google.cloud.backupdr.v1.WeekDayOfMonth week_day_of_month = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\BackupDR\V1\WeekDayOfMonth $var + * @return $this + */ + public function setWeekDayOfMonth($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\WeekDayOfMonth::class); + $this->week_day_of_month = $var; + + return $this; + } + + /** + * Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on + * which jobs will run. + * This field is only applicable when `recurrence_type` is `YEARLY`. A + * validation error will occur if other values are supplied. + * + * Generated from protobuf field repeated .google.type.Month months = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMonths() + { + return $this->months; + } + + /** + * Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on + * which jobs will run. + * This field is only applicable when `recurrence_type` is `YEARLY`. A + * validation error will occur if other values are supplied. + * + * Generated from protobuf field repeated .google.type.Month months = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMonths($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Type\Month::class); + $this->months = $arr; + + return $this; + } + + /** + * Required. A BackupWindow defines the window of day during which backup jobs + * will run. Jobs are queued at the beginning of the window and will be marked + * as `NOT_RUN` if they do not start by the end of the window. + * Note: running jobs will not be cancelled at the end of the window. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupWindow backup_window = 7 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\BackupDR\V1\BackupWindow|null + */ + public function getBackupWindow() + { + return $this->backup_window; + } + + public function hasBackupWindow() + { + return isset($this->backup_window); + } + + public function clearBackupWindow() + { + unset($this->backup_window); + } + + /** + * Required. A BackupWindow defines the window of day during which backup jobs + * will run. Jobs are queued at the beginning of the window and will be marked + * as `NOT_RUN` if they do not start by the end of the window. + * Note: running jobs will not be cancelled at the end of the window. + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupWindow backup_window = 7 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\BackupDR\V1\BackupWindow $var + * @return $this + */ + public function setBackupWindow($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupWindow::class); + $this->backup_window = $var; + + return $this; + } + + /** + * Required. The time zone to be used when interpreting the schedule. + * The value of this field must be a time zone name from the IANA tz database. + * See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the + * list of valid timezone names. For e.g., Europe/Paris. + * + * Generated from protobuf field string time_zone = 8 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getTimeZone() + { + return $this->time_zone; + } + + /** + * Required. The time zone to be used when interpreting the schedule. + * The value of this field must be a time zone name from the IANA tz database. + * See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the + * list of valid timezone names. For e.g., Europe/Paris. + * + * Generated from protobuf field string time_zone = 8 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setTimeZone($var) + { + GPBUtil::checkString($var, True); + $this->time_zone = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/StandardSchedule/RecurrenceType.php b/BackupDr/src/V1/StandardSchedule/RecurrenceType.php new file mode 100644 index 000000000000..4ee2035fcff1 --- /dev/null +++ b/BackupDr/src/V1/StandardSchedule/RecurrenceType.php @@ -0,0 +1,83 @@ +google.cloud.backupdr.v1.StandardSchedule.RecurrenceType + */ +class RecurrenceType +{ + /** + * recurrence type not set + * + * Generated from protobuf enum RECURRENCE_TYPE_UNSPECIFIED = 0; + */ + const RECURRENCE_TYPE_UNSPECIFIED = 0; + /** + * The `BackupRule` is to be applied hourly. + * + * Generated from protobuf enum HOURLY = 1; + */ + const HOURLY = 1; + /** + * The `BackupRule` is to be applied daily. + * + * Generated from protobuf enum DAILY = 2; + */ + const DAILY = 2; + /** + * The `BackupRule` is to be applied weekly. + * + * Generated from protobuf enum WEEKLY = 3; + */ + const WEEKLY = 3; + /** + * The `BackupRule` is to be applied monthly. + * + * Generated from protobuf enum MONTHLY = 4; + */ + const MONTHLY = 4; + /** + * The `BackupRule` is to be applied yearly. + * + * Generated from protobuf enum YEARLY = 5; + */ + const YEARLY = 5; + + private static $valueToName = [ + self::RECURRENCE_TYPE_UNSPECIFIED => 'RECURRENCE_TYPE_UNSPECIFIED', + self::HOURLY => 'HOURLY', + self::DAILY => 'DAILY', + self::WEEKLY => 'WEEKLY', + self::MONTHLY => 'MONTHLY', + self::YEARLY => 'YEARLY', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/Tags.php b/BackupDr/src/V1/Tags.php new file mode 100644 index 000000000000..5c7e2cc19aff --- /dev/null +++ b/BackupDr/src/V1/Tags.php @@ -0,0 +1,71 @@ +google.cloud.backupdr.v1.Tags + */ +class Tags extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. An array of tags. Each tag must be 1-63 characters long, and + * comply with RFC1035. + * + * Generated from protobuf field repeated string items = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $items; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $items + * Optional. An array of tags. Each tag must be 1-63 characters long, and + * comply with RFC1035. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\BackupvaultGce::initOnce(); + parent::__construct($data); + } + + /** + * Optional. An array of tags. Each tag must be 1-63 characters long, and + * comply with RFC1035. + * + * Generated from protobuf field repeated string items = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getItems() + { + return $this->items; + } + + /** + * Optional. An array of tags. Each tag must be 1-63 characters long, and + * comply with RFC1035. + * + * Generated from protobuf field repeated string items = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setItems($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->items = $arr; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/TargetResource.php b/BackupDr/src/V1/TargetResource.php new file mode 100644 index 000000000000..2b664c8ac0b2 --- /dev/null +++ b/BackupDr/src/V1/TargetResource.php @@ -0,0 +1,75 @@ +google.cloud.backupdr.v1.TargetResource + */ +class TargetResource extends \Google\Protobuf\Internal\Message +{ + protected $target_resource_info; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\BackupDR\V1\GcpResource $gcp_resource + * Details of the native Google Cloud resource created as part of restore. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Details of the native Google Cloud resource created as part of restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.GcpResource gcp_resource = 1; + * @return \Google\Cloud\BackupDR\V1\GcpResource|null + */ + public function getGcpResource() + { + return $this->readOneof(1); + } + + public function hasGcpResource() + { + return $this->hasOneof(1); + } + + /** + * Details of the native Google Cloud resource created as part of restore. + * + * Generated from protobuf field .google.cloud.backupdr.v1.GcpResource gcp_resource = 1; + * @param \Google\Cloud\BackupDR\V1\GcpResource $var + * @return $this + */ + public function setGcpResource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\GcpResource::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * @return string + */ + public function getTargetResourceInfo() + { + return $this->whichOneof("target_resource_info"); + } + +} + diff --git a/BackupDr/src/V1/TriggerBackupRequest.php b/BackupDr/src/V1/TriggerBackupRequest.php new file mode 100644 index 000000000000..c83aa7eafd80 --- /dev/null +++ b/BackupDr/src/V1/TriggerBackupRequest.php @@ -0,0 +1,196 @@ +google.cloud.backupdr.v1.TriggerBackupRequest + */ +class TriggerBackupRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Required. backup rule_id for which a backup needs to be triggered. + * + * Generated from protobuf field string rule_id = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $rule_id = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + + /** + * @param string $name Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * Please see {@see BackupDRClient::backupPlanAssociationName()} for help formatting this field. + * @param string $ruleId Required. backup rule_id for which a backup needs to be triggered. + * + * @return \Google\Cloud\BackupDR\V1\TriggerBackupRequest + * + * @experimental + */ + public static function build(string $name, string $ruleId): self + { + return (new self()) + ->setName($name) + ->setRuleId($ruleId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * @type string $rule_id + * Required. backup rule_id for which a backup needs to be triggered. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplanassociation::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the backup plan association resource, in the format + * `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Required. backup rule_id for which a backup needs to be triggered. + * + * Generated from protobuf field string rule_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getRuleId() + { + return $this->rule_id; + } + + /** + * Required. backup rule_id for which a backup needs to be triggered. + * + * Generated from protobuf field string rule_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setRuleId($var) + { + GPBUtil::checkString($var, True); + $this->rule_id = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/UpdateBackupRequest.php b/BackupDr/src/V1/UpdateBackupRequest.php new file mode 100644 index 000000000000..45590b90791f --- /dev/null +++ b/BackupDr/src/V1/UpdateBackupRequest.php @@ -0,0 +1,230 @@ +google.cloud.backupdr.v1.UpdateBackupRequest + */ +class UpdateBackupRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * Backup resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup = null; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + + /** + * @param \Google\Cloud\BackupDR\V1\Backup $backup Required. The resource being updated + * @param \Google\Protobuf\FieldMask $updateMask Required. Field mask is used to specify the fields to be overwritten in the + * Backup resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * @return \Google\Cloud\BackupDR\V1\UpdateBackupRequest + * + * @experimental + */ + public static function build(\Google\Cloud\BackupDR\V1\Backup $backup, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setBackup($backup) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\FieldMask $update_mask + * Required. Field mask is used to specify the fields to be overwritten in the + * Backup resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * @type \Google\Cloud\BackupDR\V1\Backup $backup + * Required. The resource being updated + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * Backup resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * Backup resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\BackupDR\V1\Backup|null + */ + public function getBackup() + { + return $this->backup; + } + + public function hasBackup() + { + return isset($this->backup); + } + + public function clearBackup() + { + unset($this->backup); + } + + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\BackupDR\V1\Backup $var + * @return $this + */ + public function setBackup($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\Backup::class); + $this->backup = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/UpdateBackupVaultRequest.php b/BackupDr/src/V1/UpdateBackupVaultRequest.php new file mode 100644 index 000000000000..4a985422b43f --- /dev/null +++ b/BackupDr/src/V1/UpdateBackupVaultRequest.php @@ -0,0 +1,306 @@ +google.cloud.backupdr.v1.UpdateBackupVaultRequest + */ +class UpdateBackupVaultRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * BackupVault resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault backup_vault = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $backup_vault = null; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + /** + * Optional. If set to true, will not check plan duration against backup vault + * enforcement duration. + * + * Generated from protobuf field bool force = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $force = false; + + /** + * @param \Google\Cloud\BackupDR\V1\BackupVault $backupVault Required. The resource being updated + * @param \Google\Protobuf\FieldMask $updateMask Required. Field mask is used to specify the fields to be overwritten in the + * BackupVault resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * @return \Google\Cloud\BackupDR\V1\UpdateBackupVaultRequest + * + * @experimental + */ + public static function build(\Google\Cloud\BackupDR\V1\BackupVault $backupVault, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setBackupVault($backupVault) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\FieldMask $update_mask + * Required. Field mask is used to specify the fields to be overwritten in the + * BackupVault resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * @type \Google\Cloud\BackupDR\V1\BackupVault $backup_vault + * Required. The resource being updated + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * @type bool $validate_only + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * @type bool $force + * Optional. If set to true, will not check plan duration against backup vault + * enforcement duration. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * BackupVault resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * BackupVault resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault backup_vault = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\BackupDR\V1\BackupVault|null + */ + public function getBackupVault() + { + return $this->backup_vault; + } + + public function hasBackupVault() + { + return isset($this->backup_vault); + } + + public function clearBackupVault() + { + unset($this->backup_vault); + } + + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.BackupVault backup_vault = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\BackupDR\V1\BackupVault $var + * @return $this + */ + public function setBackupVault($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\BackupVault::class); + $this->backup_vault = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. Only validate the request, but do not perform mutations. + * The default is 'false'. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + + /** + * Optional. If set to true, will not check plan duration against backup vault + * enforcement duration. + * + * Generated from protobuf field bool force = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getForce() + { + return $this->force; + } + + /** + * Optional. If set to true, will not check plan duration against backup vault + * enforcement duration. + * + * Generated from protobuf field bool force = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setForce($var) + { + GPBUtil::checkBool($var); + $this->force = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/UpdateDataSourceRequest.php b/BackupDr/src/V1/UpdateDataSourceRequest.php new file mode 100644 index 000000000000..86e234620cef --- /dev/null +++ b/BackupDr/src/V1/UpdateDataSourceRequest.php @@ -0,0 +1,264 @@ +google.cloud.backupdr.v1.UpdateDataSourceRequest + */ +class UpdateDataSourceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * DataSource resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSource data_source = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $data_source = null; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + /** + * Optional. Enable upsert. + * + * Generated from protobuf field bool allow_missing = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + + /** + * @param \Google\Cloud\BackupDR\V1\DataSource $dataSource Required. The resource being updated + * @param \Google\Protobuf\FieldMask $updateMask Required. Field mask is used to specify the fields to be overwritten in the + * DataSource resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * @return \Google\Cloud\BackupDR\V1\UpdateDataSourceRequest + * + * @experimental + */ + public static function build(\Google\Cloud\BackupDR\V1\DataSource $dataSource, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setDataSource($dataSource) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\FieldMask $update_mask + * Required. Field mask is used to specify the fields to be overwritten in the + * DataSource resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * @type \Google\Cloud\BackupDR\V1\DataSource $data_source + * Required. The resource being updated + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * @type bool $allow_missing + * Optional. Enable upsert. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupvault::initOnce(); + parent::__construct($data); + } + + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * DataSource resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * DataSource resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then the request will fail. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSource data_source = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\BackupDR\V1\DataSource|null + */ + public function getDataSource() + { + return $this->data_source; + } + + public function hasDataSource() + { + return isset($this->data_source); + } + + public function clearDataSource() + { + unset($this->data_source); + } + + /** + * Required. The resource being updated + * + * Generated from protobuf field .google.cloud.backupdr.v1.DataSource data_source = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\BackupDR\V1\DataSource $var + * @return $this + */ + public function setDataSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BackupDR\V1\DataSource::class); + $this->data_source = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + + /** + * Optional. Enable upsert. + * + * Generated from protobuf field bool allow_missing = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. Enable upsert. + * + * Generated from protobuf field bool allow_missing = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/WeekDayOfMonth.php b/BackupDr/src/V1/WeekDayOfMonth.php new file mode 100644 index 000000000000..31a37263235e --- /dev/null +++ b/BackupDr/src/V1/WeekDayOfMonth.php @@ -0,0 +1,103 @@ +google.cloud.backupdr.v1.WeekDayOfMonth + */ +class WeekDayOfMonth extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Specifies the week of the month. + * + * Generated from protobuf field .google.cloud.backupdr.v1.WeekDayOfMonth.WeekOfMonth week_of_month = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $week_of_month = 0; + /** + * Required. Specifies the day of the week. + * + * Generated from protobuf field .google.type.DayOfWeek day_of_week = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $day_of_week = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $week_of_month + * Required. Specifies the week of the month. + * @type int $day_of_week + * Required. Specifies the day of the week. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Backupdr\V1\Backupplan::initOnce(); + parent::__construct($data); + } + + /** + * Required. Specifies the week of the month. + * + * Generated from protobuf field .google.cloud.backupdr.v1.WeekDayOfMonth.WeekOfMonth week_of_month = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getWeekOfMonth() + { + return $this->week_of_month; + } + + /** + * Required. Specifies the week of the month. + * + * Generated from protobuf field .google.cloud.backupdr.v1.WeekDayOfMonth.WeekOfMonth week_of_month = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setWeekOfMonth($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\BackupDR\V1\WeekDayOfMonth\WeekOfMonth::class); + $this->week_of_month = $var; + + return $this; + } + + /** + * Required. Specifies the day of the week. + * + * Generated from protobuf field .google.type.DayOfWeek day_of_week = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getDayOfWeek() + { + return $this->day_of_week; + } + + /** + * Required. Specifies the day of the week. + * + * Generated from protobuf field .google.type.DayOfWeek day_of_week = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setDayOfWeek($var) + { + GPBUtil::checkEnum($var, \Google\Type\DayOfWeek::class); + $this->day_of_week = $var; + + return $this; + } + +} + diff --git a/BackupDr/src/V1/WeekDayOfMonth/WeekOfMonth.php b/BackupDr/src/V1/WeekDayOfMonth/WeekOfMonth.php new file mode 100644 index 000000000000..261806c3b318 --- /dev/null +++ b/BackupDr/src/V1/WeekDayOfMonth/WeekOfMonth.php @@ -0,0 +1,84 @@ +google.cloud.backupdr.v1.WeekDayOfMonth.WeekOfMonth + */ +class WeekOfMonth +{ + /** + * The zero value. Do not use. + * + * Generated from protobuf enum WEEK_OF_MONTH_UNSPECIFIED = 0; + */ + const WEEK_OF_MONTH_UNSPECIFIED = 0; + /** + * The first week of the month. + * + * Generated from protobuf enum FIRST = 1; + */ + const FIRST = 1; + /** + * The second week of the month. + * + * Generated from protobuf enum SECOND = 2; + */ + const SECOND = 2; + /** + * The third week of the month. + * + * Generated from protobuf enum THIRD = 3; + */ + const THIRD = 3; + /** + * The fourth week of the month. + * + * Generated from protobuf enum FOURTH = 4; + */ + const FOURTH = 4; + /** + * The last week of the month. + * + * Generated from protobuf enum LAST = 5; + */ + const LAST = 5; + + private static $valueToName = [ + self::WEEK_OF_MONTH_UNSPECIFIED => 'WEEK_OF_MONTH_UNSPECIFIED', + self::FIRST => 'FIRST', + self::SECOND => 'SECOND', + self::THIRD => 'THIRD', + self::FOURTH => 'FOURTH', + self::LAST => 'LAST', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/BackupDr/src/V1/gapic_metadata.json b/BackupDr/src/V1/gapic_metadata.json index 37b3567fa87d..130c7f38a667 100644 --- a/BackupDr/src/V1/gapic_metadata.json +++ b/BackupDr/src/V1/gapic_metadata.json @@ -10,26 +10,141 @@ "grpc": { "libraryClient": "BackupDRGapicClient", "rpcs": { + "CreateBackupPlan": { + "methods": [ + "createBackupPlan" + ] + }, + "CreateBackupPlanAssociation": { + "methods": [ + "createBackupPlanAssociation" + ] + }, + "CreateBackupVault": { + "methods": [ + "createBackupVault" + ] + }, "CreateManagementServer": { "methods": [ "createManagementServer" ] }, + "DeleteBackup": { + "methods": [ + "deleteBackup" + ] + }, + "DeleteBackupPlan": { + "methods": [ + "deleteBackupPlan" + ] + }, + "DeleteBackupPlanAssociation": { + "methods": [ + "deleteBackupPlanAssociation" + ] + }, + "DeleteBackupVault": { + "methods": [ + "deleteBackupVault" + ] + }, "DeleteManagementServer": { "methods": [ "deleteManagementServer" ] }, + "FetchUsableBackupVaults": { + "methods": [ + "fetchUsableBackupVaults" + ] + }, + "GetBackup": { + "methods": [ + "getBackup" + ] + }, + "GetBackupPlan": { + "methods": [ + "getBackupPlan" + ] + }, + "GetBackupPlanAssociation": { + "methods": [ + "getBackupPlanAssociation" + ] + }, + "GetBackupVault": { + "methods": [ + "getBackupVault" + ] + }, + "GetDataSource": { + "methods": [ + "getDataSource" + ] + }, "GetManagementServer": { "methods": [ "getManagementServer" ] }, + "ListBackupPlanAssociations": { + "methods": [ + "listBackupPlanAssociations" + ] + }, + "ListBackupPlans": { + "methods": [ + "listBackupPlans" + ] + }, + "ListBackupVaults": { + "methods": [ + "listBackupVaults" + ] + }, + "ListBackups": { + "methods": [ + "listBackups" + ] + }, + "ListDataSources": { + "methods": [ + "listDataSources" + ] + }, "ListManagementServers": { "methods": [ "listManagementServers" ] }, + "RestoreBackup": { + "methods": [ + "restoreBackup" + ] + }, + "TriggerBackup": { + "methods": [ + "triggerBackup" + ] + }, + "UpdateBackup": { + "methods": [ + "updateBackup" + ] + }, + "UpdateBackupVault": { + "methods": [ + "updateBackupVault" + ] + }, + "UpdateDataSource": { + "methods": [ + "updateDataSource" + ] + }, "GetLocation": { "methods": [ "getLocation" diff --git a/BackupDr/src/V1/resources/backup_dr_client_config.json b/BackupDr/src/V1/resources/backup_dr_client_config.json index 5c162679d6d7..c505f44b1add 100644 --- a/BackupDr/src/V1/resources/backup_dr_client_config.json +++ b/BackupDr/src/V1/resources/backup_dr_client_config.json @@ -38,26 +38,141 @@ } }, "methods": { + "CreateBackupPlan": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "CreateBackupPlanAssociation": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "CreateBackupVault": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, "CreateManagementServer": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "DeleteBackup": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "DeleteBackupPlan": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "DeleteBackupPlanAssociation": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "DeleteBackupVault": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, "DeleteManagementServer": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "FetchUsableBackupVaults": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "GetBackup": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "GetBackupPlan": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "GetBackupPlanAssociation": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "GetBackupVault": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "GetDataSource": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, "GetManagementServer": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "ListBackupPlanAssociations": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListBackupPlans": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListBackupVaults": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "ListBackups": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "ListDataSources": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, "ListManagementServers": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "RestoreBackup": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "TriggerBackup": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "UpdateBackup": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "UpdateBackupVault": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "UpdateDataSource": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "GetLocation": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", diff --git a/BackupDr/src/V1/resources/backup_dr_descriptor_config.php b/BackupDr/src/V1/resources/backup_dr_descriptor_config.php index 44417b94b54a..669fa4bd998c 100644 --- a/BackupDr/src/V1/resources/backup_dr_descriptor_config.php +++ b/BackupDr/src/V1/resources/backup_dr_descriptor_config.php @@ -23,6 +23,63 @@ return [ 'interfaces' => [ 'google.cloud.backupdr.v1.BackupDR' => [ + 'CreateBackupPlan' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\BackupPlan', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'CreateBackupPlanAssociation' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\BackupPlanAssociation', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'CreateBackupVault' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\BackupVault', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'CreateManagementServer' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\BackupDR\V1\ManagementServer', @@ -42,6 +99,82 @@ ], ], ], + 'DeleteBackup' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\Backup', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'DeleteBackupPlan' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Protobuf\GPBEmpty', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'DeleteBackupPlanAssociation' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Protobuf\GPBEmpty', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'DeleteBackupVault' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Protobuf\GPBEmpty', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'DeleteManagementServer' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Protobuf\GPBEmpty', @@ -61,6 +194,184 @@ ], ], ], + 'RestoreBackup' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\RestoreBackupResponse', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'TriggerBackup' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\BackupPlanAssociation', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'UpdateBackup' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\Backup', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'backup.name', + 'fieldAccessors' => [ + 'getBackup', + 'getName', + ], + ], + ], + ], + 'UpdateBackupVault' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\BackupVault', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'backup_vault.name', + 'fieldAccessors' => [ + 'getBackupVault', + 'getName', + ], + ], + ], + ], + 'UpdateDataSource' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\BackupDR\V1\DataSource', + 'metadataReturnType' => '\Google\Cloud\BackupDR\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'data_source.name', + 'fieldAccessors' => [ + 'getDataSource', + 'getName', + ], + ], + ], + ], + 'FetchUsableBackupVaults' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getBackupVaults', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\FetchUsableBackupVaultsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'GetBackup' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\Backup', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'GetBackupPlan' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\BackupPlan', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'GetBackupPlanAssociation' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\BackupPlanAssociation', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'GetBackupVault' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\BackupVault', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'GetDataSource' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\DataSource', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'GetManagementServer' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\BackupDR\V1\ManagementServer', @@ -73,6 +384,106 @@ ], ], ], + 'ListBackupPlanAssociations' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getBackupPlanAssociations', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\ListBackupPlanAssociationsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListBackupPlans' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getBackupPlans', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\ListBackupPlansResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListBackupVaults' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getBackupVaults', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\ListBackupVaultsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListBackups' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getBackups', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\ListBackupsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListDataSources' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getDataSources', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\BackupDR\V1\ListDataSourcesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'ListManagementServers' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', @@ -167,6 +578,11 @@ 'interfaceOverride' => 'google.iam.v1.IAMPolicy', ], 'templateMap' => [ + 'backup' => 'projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup}', + 'backupPlan' => 'projects/{project}/locations/{location}/backupPlans/{backup_plan}', + 'backupPlanAssociation' => 'projects/{project}/locations/{location}/backupPlanAssociations/{backup_plan_association}', + 'backupVault' => 'projects/{project}/locations/{location}/backupVaults/{backupvault}', + 'dataSource' => 'projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}', 'location' => 'projects/{project}/locations/{location}', 'managementServer' => 'projects/{project}/locations/{location}/managementServers/{managementserver}', ], diff --git a/BackupDr/src/V1/resources/backup_dr_rest_client_config.php b/BackupDr/src/V1/resources/backup_dr_rest_client_config.php index 41f4e3a9cf92..072b35af529f 100644 --- a/BackupDr/src/V1/resources/backup_dr_rest_client_config.php +++ b/BackupDr/src/V1/resources/backup_dr_rest_client_config.php @@ -23,6 +23,51 @@ return [ 'interfaces' => [ 'google.cloud.backupdr.v1.BackupDR' => [ + 'CreateBackupPlan' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/backupPlans', + 'body' => 'backup_plan', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'backup_plan_id', + ], + ], + 'CreateBackupPlanAssociation' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/backupPlanAssociations', + 'body' => 'backup_plan_association', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'backup_plan_association_id', + ], + ], + 'CreateBackupVault' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/backupVaults', + 'body' => 'backup_vault', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'backup_vault_id', + ], + ], 'CreateManagementServer' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/managementServers', @@ -38,6 +83,50 @@ 'management_server_id', ], ], + 'DeleteBackup' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupVaults/*/dataSources/*/backups/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'DeleteBackupPlan' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupPlans/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'DeleteBackupPlanAssociation' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupPlanAssociations/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'DeleteBackupVault' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupVaults/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'DeleteManagementServer' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/managementServers/*}', @@ -49,6 +138,72 @@ ], ], ], + 'FetchUsableBackupVaults' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/backupVaults:fetchUsable', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'GetBackup' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupVaults/*/dataSources/*/backups/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetBackupPlan' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupPlans/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetBackupPlanAssociation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupPlanAssociations/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetBackupVault' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupVaults/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetDataSource' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupVaults/*/dataSources/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetManagementServer' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/managementServers/*}', @@ -60,6 +215,61 @@ ], ], ], + 'ListBackupPlanAssociations' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/backupPlanAssociations', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListBackupPlans' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/backupPlans', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListBackupVaults' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/backupVaults', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListBackups' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/backupVaults/*/dataSources/*}/backups', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListDataSources' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/backupVaults/*}/dataSources', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'ListManagementServers' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/managementServers', @@ -71,6 +281,78 @@ ], ], ], + 'RestoreBackup' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupVaults/*/dataSources/*/backups/*}:restore', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'TriggerBackup' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/backupPlanAssociations/*}:triggerBackup', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'UpdateBackup' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{backup.name=projects/*/locations/*/backupVaults/*/dataSources/*/backups/*}', + 'body' => 'backup', + 'placeholders' => [ + 'backup.name' => [ + 'getters' => [ + 'getBackup', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], + 'UpdateBackupVault' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{backup_vault.name=projects/*/locations/*/backupVaults/*}', + 'body' => 'backup_vault', + 'placeholders' => [ + 'backup_vault.name' => [ + 'getters' => [ + 'getBackupVault', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], + 'UpdateDataSource' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{data_source.name=projects/*/locations/*/backupVaults/*/dataSources/*}', + 'body' => 'data_source', + 'placeholders' => [ + 'data_source.name' => [ + 'getters' => [ + 'getDataSource', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], ], 'google.cloud.location.Locations' => [ 'GetLocation' => [ diff --git a/BackupDr/tests/Unit/V1/Client/BackupDRClientTest.php b/BackupDr/tests/Unit/V1/Client/BackupDRClientTest.php index 899c1b728151..f836c6098019 100644 --- a/BackupDr/tests/Unit/V1/Client/BackupDRClientTest.php +++ b/BackupDr/tests/Unit/V1/Client/BackupDRClientTest.php @@ -26,13 +26,48 @@ use Google\ApiCore\CredentialsWrapper; use Google\ApiCore\Testing\GeneratedTest; use Google\ApiCore\Testing\MockTransport; +use Google\Cloud\BackupDR\V1\Backup; +use Google\Cloud\BackupDR\V1\BackupPlan; +use Google\Cloud\BackupDR\V1\BackupPlanAssociation; +use Google\Cloud\BackupDR\V1\BackupVault; use Google\Cloud\BackupDR\V1\Client\BackupDRClient; +use Google\Cloud\BackupDR\V1\CreateBackupPlanAssociationRequest; +use Google\Cloud\BackupDR\V1\CreateBackupPlanRequest; +use Google\Cloud\BackupDR\V1\CreateBackupVaultRequest; use Google\Cloud\BackupDR\V1\CreateManagementServerRequest; +use Google\Cloud\BackupDR\V1\DataSource; +use Google\Cloud\BackupDR\V1\DeleteBackupPlanAssociationRequest; +use Google\Cloud\BackupDR\V1\DeleteBackupPlanRequest; +use Google\Cloud\BackupDR\V1\DeleteBackupRequest; +use Google\Cloud\BackupDR\V1\DeleteBackupVaultRequest; use Google\Cloud\BackupDR\V1\DeleteManagementServerRequest; +use Google\Cloud\BackupDR\V1\FetchUsableBackupVaultsRequest; +use Google\Cloud\BackupDR\V1\FetchUsableBackupVaultsResponse; +use Google\Cloud\BackupDR\V1\GetBackupPlanAssociationRequest; +use Google\Cloud\BackupDR\V1\GetBackupPlanRequest; +use Google\Cloud\BackupDR\V1\GetBackupRequest; +use Google\Cloud\BackupDR\V1\GetBackupVaultRequest; +use Google\Cloud\BackupDR\V1\GetDataSourceRequest; use Google\Cloud\BackupDR\V1\GetManagementServerRequest; +use Google\Cloud\BackupDR\V1\ListBackupPlanAssociationsRequest; +use Google\Cloud\BackupDR\V1\ListBackupPlanAssociationsResponse; +use Google\Cloud\BackupDR\V1\ListBackupPlansRequest; +use Google\Cloud\BackupDR\V1\ListBackupPlansResponse; +use Google\Cloud\BackupDR\V1\ListBackupVaultsRequest; +use Google\Cloud\BackupDR\V1\ListBackupVaultsResponse; +use Google\Cloud\BackupDR\V1\ListBackupsRequest; +use Google\Cloud\BackupDR\V1\ListBackupsResponse; +use Google\Cloud\BackupDR\V1\ListDataSourcesRequest; +use Google\Cloud\BackupDR\V1\ListDataSourcesResponse; use Google\Cloud\BackupDR\V1\ListManagementServersRequest; use Google\Cloud\BackupDR\V1\ListManagementServersResponse; use Google\Cloud\BackupDR\V1\ManagementServer; +use Google\Cloud\BackupDR\V1\RestoreBackupRequest; +use Google\Cloud\BackupDR\V1\RestoreBackupResponse; +use Google\Cloud\BackupDR\V1\TriggerBackupRequest; +use Google\Cloud\BackupDR\V1\UpdateBackupRequest; +use Google\Cloud\BackupDR\V1\UpdateBackupVaultRequest; +use Google\Cloud\BackupDR\V1\UpdateDataSourceRequest; use Google\Cloud\Iam\V1\GetIamPolicyRequest; use Google\Cloud\Iam\V1\Policy; use Google\Cloud\Iam\V1\SetIamPolicyRequest; @@ -46,6 +81,8 @@ use Google\LongRunning\GetOperationRequest; use Google\LongRunning\Operation; use Google\Protobuf\Any; +use Google\Protobuf\Duration; +use Google\Protobuf\FieldMask; use Google\Protobuf\GPBEmpty; use Google\Rpc\Code; use stdClass; @@ -81,7 +118,7 @@ private function createClient(array $options = []) } /** @test */ - public function createManagementServerTest() + public function createBackupPlanTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -98,38 +135,2387 @@ public function createManagementServerTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/createManagementServerTest'); + $incompleteOperation->setName('operations/createBackupPlanTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $name = 'name3373707'; $description = 'description-1724546052'; + $resourceType = 'resourceType979623115'; $etag = 'etag3123477'; - $oauth2ClientId = 'oauth2ClientId-1833466037'; - $satisfiesPzi = false; - $expectedResponse = new ManagementServer(); + $backupVault = 'backupVault353808757'; + $backupVaultServiceAccount = 'backupVaultServiceAccount-1170477095'; + $expectedResponse = new BackupPlan(); $expectedResponse->setName($name); $expectedResponse->setDescription($description); + $expectedResponse->setResourceType($resourceType); $expectedResponse->setEtag($etag); - $expectedResponse->setOauth2ClientId($oauth2ClientId); - $expectedResponse->setSatisfiesPzi($satisfiesPzi); + $expectedResponse->setBackupVault($backupVault); + $expectedResponse->setBackupVaultServiceAccount($backupVaultServiceAccount); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/createManagementServerTest'); + $completeOperation->setName('operations/createBackupPlanTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $managementServerId = 'managementServerId1884787355'; - $managementServer = new ManagementServer(); - $managementServerNetworks = []; - $managementServer->setNetworks($managementServerNetworks); - $request = (new CreateManagementServerRequest()) + $backupPlanId = 'backupPlanId-25762700'; + $backupPlan = new BackupPlan(); + $backupPlanBackupRules = []; + $backupPlan->setBackupRules($backupPlanBackupRules); + $backupPlanResourceType = 'backupPlanResourceType1515155475'; + $backupPlan->setResourceType($backupPlanResourceType); + $backupPlanBackupVault = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $backupPlan->setBackupVault($backupPlanBackupVault); + $request = (new CreateBackupPlanRequest()) ->setParent($formattedParent) - ->setManagementServerId($managementServerId) - ->setManagementServer($managementServer); - $response = $gapicClient->createManagementServer($request); + ->setBackupPlanId($backupPlanId) + ->setBackupPlan($backupPlan); + $response = $gapicClient->createBackupPlan($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/CreateBackupPlan', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getBackupPlanId(); + $this->assertProtobufEquals($backupPlanId, $actualValue); + $actualValue = $actualApiRequestObject->getBackupPlan(); + $this->assertProtobufEquals($backupPlan, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createBackupPlanTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createBackupPlanExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createBackupPlanTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $backupPlanId = 'backupPlanId-25762700'; + $backupPlan = new BackupPlan(); + $backupPlanBackupRules = []; + $backupPlan->setBackupRules($backupPlanBackupRules); + $backupPlanResourceType = 'backupPlanResourceType1515155475'; + $backupPlan->setResourceType($backupPlanResourceType); + $backupPlanBackupVault = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $backupPlan->setBackupVault($backupPlanBackupVault); + $request = (new CreateBackupPlanRequest()) + ->setParent($formattedParent) + ->setBackupPlanId($backupPlanId) + ->setBackupPlan($backupPlan); + $response = $gapicClient->createBackupPlan($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createBackupPlanTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createBackupPlanAssociationTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createBackupPlanAssociationTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $resourceType = 'resourceType979623115'; + $resource = 'resource-341064690'; + $backupPlan = 'backupPlan1119623046'; + $dataSource = 'dataSource-1333894576'; + $expectedResponse = new BackupPlanAssociation(); + $expectedResponse->setName($name); + $expectedResponse->setResourceType($resourceType); + $expectedResponse->setResource($resource); + $expectedResponse->setBackupPlan($backupPlan); + $expectedResponse->setDataSource($dataSource); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createBackupPlanAssociationTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $backupPlanAssociationId = 'backupPlanAssociationId133124978'; + $backupPlanAssociation = new BackupPlanAssociation(); + $backupPlanAssociationResource = 'backupPlanAssociationResource1527164324'; + $backupPlanAssociation->setResource($backupPlanAssociationResource); + $backupPlanAssociationBackupPlan = $gapicClient->backupPlanName('[PROJECT]', '[LOCATION]', '[BACKUP_PLAN]'); + $backupPlanAssociation->setBackupPlan($backupPlanAssociationBackupPlan); + $request = (new CreateBackupPlanAssociationRequest()) + ->setParent($formattedParent) + ->setBackupPlanAssociationId($backupPlanAssociationId) + ->setBackupPlanAssociation($backupPlanAssociation); + $response = $gapicClient->createBackupPlanAssociation($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/CreateBackupPlanAssociation', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getBackupPlanAssociationId(); + $this->assertProtobufEquals($backupPlanAssociationId, $actualValue); + $actualValue = $actualApiRequestObject->getBackupPlanAssociation(); + $this->assertProtobufEquals($backupPlanAssociation, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createBackupPlanAssociationTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createBackupPlanAssociationExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createBackupPlanAssociationTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $backupPlanAssociationId = 'backupPlanAssociationId133124978'; + $backupPlanAssociation = new BackupPlanAssociation(); + $backupPlanAssociationResource = 'backupPlanAssociationResource1527164324'; + $backupPlanAssociation->setResource($backupPlanAssociationResource); + $backupPlanAssociationBackupPlan = $gapicClient->backupPlanName('[PROJECT]', '[LOCATION]', '[BACKUP_PLAN]'); + $backupPlanAssociation->setBackupPlan($backupPlanAssociationBackupPlan); + $request = (new CreateBackupPlanAssociationRequest()) + ->setParent($formattedParent) + ->setBackupPlanAssociationId($backupPlanAssociationId) + ->setBackupPlanAssociation($backupPlanAssociation); + $response = $gapicClient->createBackupPlanAssociation($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createBackupPlanAssociationTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createBackupVaultTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createBackupVaultTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $description = 'description-1724546052'; + $deletable = true; + $etag = 'etag3123477'; + $backupCount = 336678994; + $serviceAccount = 'serviceAccount-1948028253'; + $totalStoredBytes = 1181597162; + $uid = 'uid115792'; + $expectedResponse = new BackupVault(); + $expectedResponse->setName($name); + $expectedResponse->setDescription($description); + $expectedResponse->setDeletable($deletable); + $expectedResponse->setEtag($etag); + $expectedResponse->setBackupCount($backupCount); + $expectedResponse->setServiceAccount($serviceAccount); + $expectedResponse->setTotalStoredBytes($totalStoredBytes); + $expectedResponse->setUid($uid); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createBackupVaultTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $backupVaultId = 'backupVaultId467030053'; + $backupVault = new BackupVault(); + $backupVaultBackupMinimumEnforcedRetentionDuration = new Duration(); + $backupVault->setBackupMinimumEnforcedRetentionDuration($backupVaultBackupMinimumEnforcedRetentionDuration); + $request = (new CreateBackupVaultRequest()) + ->setParent($formattedParent) + ->setBackupVaultId($backupVaultId) + ->setBackupVault($backupVault); + $response = $gapicClient->createBackupVault($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/CreateBackupVault', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getBackupVaultId(); + $this->assertProtobufEquals($backupVaultId, $actualValue); + $actualValue = $actualApiRequestObject->getBackupVault(); + $this->assertProtobufEquals($backupVault, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createBackupVaultTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createBackupVaultExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createBackupVaultTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $backupVaultId = 'backupVaultId467030053'; + $backupVault = new BackupVault(); + $backupVaultBackupMinimumEnforcedRetentionDuration = new Duration(); + $backupVault->setBackupMinimumEnforcedRetentionDuration($backupVaultBackupMinimumEnforcedRetentionDuration); + $request = (new CreateBackupVaultRequest()) + ->setParent($formattedParent) + ->setBackupVaultId($backupVaultId) + ->setBackupVault($backupVault); + $response = $gapicClient->createBackupVault($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createBackupVaultTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createManagementServerTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createManagementServerTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $description = 'description-1724546052'; + $etag = 'etag3123477'; + $oauth2ClientId = 'oauth2ClientId-1833466037'; + $satisfiesPzi = false; + $expectedResponse = new ManagementServer(); + $expectedResponse->setName($name); + $expectedResponse->setDescription($description); + $expectedResponse->setEtag($etag); + $expectedResponse->setOauth2ClientId($oauth2ClientId); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createManagementServerTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $managementServerId = 'managementServerId1884787355'; + $managementServer = new ManagementServer(); + $managementServerNetworks = []; + $managementServer->setNetworks($managementServerNetworks); + $request = (new CreateManagementServerRequest()) + ->setParent($formattedParent) + ->setManagementServerId($managementServerId) + ->setManagementServer($managementServer); + $response = $gapicClient->createManagementServer($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/CreateManagementServer', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getManagementServerId(); + $this->assertProtobufEquals($managementServerId, $actualValue); + $actualValue = $actualApiRequestObject->getManagementServer(); + $this->assertProtobufEquals($managementServer, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createManagementServerTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createManagementServerExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createManagementServerTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $managementServerId = 'managementServerId1884787355'; + $managementServer = new ManagementServer(); + $managementServerNetworks = []; + $managementServer->setNetworks($managementServerNetworks); + $request = (new CreateManagementServerRequest()) + ->setParent($formattedParent) + ->setManagementServerId($managementServerId) + ->setManagementServer($managementServer); + $response = $gapicClient->createManagementServer($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createManagementServerTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBackupTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBackupTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $description = 'description-1724546052'; + $etag = 'etag3123477'; + $resourceSizeBytes = 275424386; + $expectedResponse = new Backup(); + $expectedResponse->setName($name2); + $expectedResponse->setDescription($description); + $expectedResponse->setEtag($etag); + $expectedResponse->setResourceSizeBytes($resourceSizeBytes); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteBackupTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + $request = (new DeleteBackupRequest())->setName($formattedName); + $response = $gapicClient->deleteBackup($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/DeleteBackup', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBackupTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBackupExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBackupTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + $request = (new DeleteBackupRequest())->setName($formattedName); + $response = $gapicClient->deleteBackup($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBackupTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBackupPlanTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBackupPlanTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteBackupPlanTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->backupPlanName('[PROJECT]', '[LOCATION]', '[BACKUP_PLAN]'); + $request = (new DeleteBackupPlanRequest())->setName($formattedName); + $response = $gapicClient->deleteBackupPlan($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/DeleteBackupPlan', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBackupPlanTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBackupPlanExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBackupPlanTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupPlanName('[PROJECT]', '[LOCATION]', '[BACKUP_PLAN]'); + $request = (new DeleteBackupPlanRequest())->setName($formattedName); + $response = $gapicClient->deleteBackupPlan($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBackupPlanTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBackupPlanAssociationTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBackupPlanAssociationTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteBackupPlanAssociationTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + $request = (new DeleteBackupPlanAssociationRequest())->setName($formattedName); + $response = $gapicClient->deleteBackupPlanAssociation($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/DeleteBackupPlanAssociation', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBackupPlanAssociationTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBackupPlanAssociationExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBackupPlanAssociationTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + $request = (new DeleteBackupPlanAssociationRequest())->setName($formattedName); + $response = $gapicClient->deleteBackupPlanAssociation($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBackupPlanAssociationTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBackupVaultTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBackupVaultTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteBackupVaultTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $request = (new DeleteBackupVaultRequest())->setName($formattedName); + $response = $gapicClient->deleteBackupVault($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/DeleteBackupVault', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBackupVaultTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBackupVaultExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBackupVaultTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $request = (new DeleteBackupVaultRequest())->setName($formattedName); + $response = $gapicClient->deleteBackupVault($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBackupVaultTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteManagementServerTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteManagementServerTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteManagementServerTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->managementServerName('[PROJECT]', '[LOCATION]', '[MANAGEMENTSERVER]'); + $request = (new DeleteManagementServerRequest())->setName($formattedName); + $response = $gapicClient->deleteManagementServer($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/DeleteManagementServer', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteManagementServerTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteManagementServerExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteManagementServerTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->managementServerName('[PROJECT]', '[LOCATION]', '[MANAGEMENTSERVER]'); + $request = (new DeleteManagementServerRequest())->setName($formattedName); + $response = $gapicClient->deleteManagementServer($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteManagementServerTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function fetchUsableBackupVaultsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $backupVaultsElement = new BackupVault(); + $backupVaults = [$backupVaultsElement]; + $expectedResponse = new FetchUsableBackupVaultsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setBackupVaults($backupVaults); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new FetchUsableBackupVaultsRequest())->setParent($formattedParent); + $response = $gapicClient->fetchUsableBackupVaults($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getBackupVaults()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/FetchUsableBackupVaults', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function fetchUsableBackupVaultsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new FetchUsableBackupVaultsRequest())->setParent($formattedParent); + try { + $gapicClient->fetchUsableBackupVaults($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBackupTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $description = 'description-1724546052'; + $etag = 'etag3123477'; + $resourceSizeBytes = 275424386; + $expectedResponse = new Backup(); + $expectedResponse->setName($name2); + $expectedResponse->setDescription($description); + $expectedResponse->setEtag($etag); + $expectedResponse->setResourceSizeBytes($resourceSizeBytes); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + $request = (new GetBackupRequest())->setName($formattedName); + $response = $gapicClient->getBackup($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/GetBackup', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBackupExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + $request = (new GetBackupRequest())->setName($formattedName); + try { + $gapicClient->getBackup($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBackupPlanTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $description = 'description-1724546052'; + $resourceType = 'resourceType979623115'; + $etag = 'etag3123477'; + $backupVault = 'backupVault353808757'; + $backupVaultServiceAccount = 'backupVaultServiceAccount-1170477095'; + $expectedResponse = new BackupPlan(); + $expectedResponse->setName($name2); + $expectedResponse->setDescription($description); + $expectedResponse->setResourceType($resourceType); + $expectedResponse->setEtag($etag); + $expectedResponse->setBackupVault($backupVault); + $expectedResponse->setBackupVaultServiceAccount($backupVaultServiceAccount); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->backupPlanName('[PROJECT]', '[LOCATION]', '[BACKUP_PLAN]'); + $request = (new GetBackupPlanRequest())->setName($formattedName); + $response = $gapicClient->getBackupPlan($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/GetBackupPlan', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBackupPlanExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupPlanName('[PROJECT]', '[LOCATION]', '[BACKUP_PLAN]'); + $request = (new GetBackupPlanRequest())->setName($formattedName); + try { + $gapicClient->getBackupPlan($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBackupPlanAssociationTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $resourceType = 'resourceType979623115'; + $resource = 'resource-341064690'; + $backupPlan = 'backupPlan1119623046'; + $dataSource = 'dataSource-1333894576'; + $expectedResponse = new BackupPlanAssociation(); + $expectedResponse->setName($name2); + $expectedResponse->setResourceType($resourceType); + $expectedResponse->setResource($resource); + $expectedResponse->setBackupPlan($backupPlan); + $expectedResponse->setDataSource($dataSource); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + $request = (new GetBackupPlanAssociationRequest())->setName($formattedName); + $response = $gapicClient->getBackupPlanAssociation($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/GetBackupPlanAssociation', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBackupPlanAssociationExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + $request = (new GetBackupPlanAssociationRequest())->setName($formattedName); + try { + $gapicClient->getBackupPlanAssociation($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBackupVaultTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $description = 'description-1724546052'; + $deletable = true; + $etag = 'etag3123477'; + $backupCount = 336678994; + $serviceAccount = 'serviceAccount-1948028253'; + $totalStoredBytes = 1181597162; + $uid = 'uid115792'; + $expectedResponse = new BackupVault(); + $expectedResponse->setName($name2); + $expectedResponse->setDescription($description); + $expectedResponse->setDeletable($deletable); + $expectedResponse->setEtag($etag); + $expectedResponse->setBackupCount($backupCount); + $expectedResponse->setServiceAccount($serviceAccount); + $expectedResponse->setTotalStoredBytes($totalStoredBytes); + $expectedResponse->setUid($uid); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $request = (new GetBackupVaultRequest())->setName($formattedName); + $response = $gapicClient->getBackupVault($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/GetBackupVault', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBackupVaultExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $request = (new GetBackupVaultRequest())->setName($formattedName); + try { + $gapicClient->getBackupVault($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getDataSourceTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $backupCount = 336678994; + $etag = 'etag3123477'; + $totalStoredBytes = 1181597162; + $expectedResponse = new DataSource(); + $expectedResponse->setName($name2); + $expectedResponse->setBackupCount($backupCount); + $expectedResponse->setEtag($etag); + $expectedResponse->setTotalStoredBytes($totalStoredBytes); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->dataSourceName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]', '[DATASOURCE]'); + $request = (new GetDataSourceRequest())->setName($formattedName); + $response = $gapicClient->getDataSource($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/GetDataSource', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getDataSourceExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->dataSourceName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]', '[DATASOURCE]'); + $request = (new GetDataSourceRequest())->setName($formattedName); + try { + $gapicClient->getDataSource($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getManagementServerTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $description = 'description-1724546052'; + $etag = 'etag3123477'; + $oauth2ClientId = 'oauth2ClientId-1833466037'; + $satisfiesPzi = false; + $expectedResponse = new ManagementServer(); + $expectedResponse->setName($name2); + $expectedResponse->setDescription($description); + $expectedResponse->setEtag($etag); + $expectedResponse->setOauth2ClientId($oauth2ClientId); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->managementServerName('[PROJECT]', '[LOCATION]', '[MANAGEMENTSERVER]'); + $request = (new GetManagementServerRequest())->setName($formattedName); + $response = $gapicClient->getManagementServer($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/GetManagementServer', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getManagementServerExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->managementServerName('[PROJECT]', '[LOCATION]', '[MANAGEMENTSERVER]'); + $request = (new GetManagementServerRequest())->setName($formattedName); + try { + $gapicClient->getManagementServer($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBackupPlanAssociationsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $backupPlanAssociationsElement = new BackupPlanAssociation(); + $backupPlanAssociations = [$backupPlanAssociationsElement]; + $expectedResponse = new ListBackupPlanAssociationsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setBackupPlanAssociations($backupPlanAssociations); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListBackupPlanAssociationsRequest())->setParent($formattedParent); + $response = $gapicClient->listBackupPlanAssociations($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getBackupPlanAssociations()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/ListBackupPlanAssociations', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBackupPlanAssociationsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListBackupPlanAssociationsRequest())->setParent($formattedParent); + try { + $gapicClient->listBackupPlanAssociations($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBackupPlansTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $backupPlansElement = new BackupPlan(); + $backupPlans = [$backupPlansElement]; + $expectedResponse = new ListBackupPlansResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setBackupPlans($backupPlans); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListBackupPlansRequest())->setParent($formattedParent); + $response = $gapicClient->listBackupPlans($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getBackupPlans()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/ListBackupPlans', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBackupPlansExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListBackupPlansRequest())->setParent($formattedParent); + try { + $gapicClient->listBackupPlans($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBackupVaultsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $backupVaultsElement = new BackupVault(); + $backupVaults = [$backupVaultsElement]; + $expectedResponse = new ListBackupVaultsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setBackupVaults($backupVaults); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListBackupVaultsRequest())->setParent($formattedParent); + $response = $gapicClient->listBackupVaults($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getBackupVaults()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/ListBackupVaults', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBackupVaultsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListBackupVaultsRequest())->setParent($formattedParent); + try { + $gapicClient->listBackupVaults($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBackupsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $backupsElement = new Backup(); + $backups = [$backupsElement]; + $expectedResponse = new ListBackupsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setBackups($backups); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->dataSourceName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]', '[DATASOURCE]'); + $request = (new ListBackupsRequest())->setParent($formattedParent); + $response = $gapicClient->listBackups($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getBackups()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/ListBackups', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBackupsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->dataSourceName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]', '[DATASOURCE]'); + $request = (new ListBackupsRequest())->setParent($formattedParent); + try { + $gapicClient->listBackups($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listDataSourcesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $dataSourcesElement = new DataSource(); + $dataSources = [$dataSourcesElement]; + $expectedResponse = new ListDataSourcesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setDataSources($dataSources); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $request = (new ListDataSourcesRequest())->setParent($formattedParent); + $response = $gapicClient->listDataSources($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getDataSources()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/ListDataSources', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listDataSourcesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $request = (new ListDataSourcesRequest())->setParent($formattedParent); + try { + $gapicClient->listDataSources($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listManagementServersTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $managementServersElement = new ManagementServer(); + $managementServers = [$managementServersElement]; + $expectedResponse = new ListManagementServersResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setManagementServers($managementServers); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListManagementServersRequest())->setParent($formattedParent); + $response = $gapicClient->listManagementServers($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getManagementServers()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/ListManagementServers', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listManagementServersExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListManagementServersRequest())->setParent($formattedParent); + try { + $gapicClient->listManagementServers($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function restoreBackupTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/restoreBackupTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new RestoreBackupResponse(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/restoreBackupTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + $request = (new RestoreBackupRequest())->setName($formattedName); + $response = $gapicClient->restoreBackup($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/RestoreBackup', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/restoreBackupTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function restoreBackupExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/restoreBackupTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->backupName( + '[PROJECT]', + '[LOCATION]', + '[BACKUPVAULT]', + '[DATASOURCE]', + '[BACKUP]' + ); + $request = (new RestoreBackupRequest())->setName($formattedName); + $response = $gapicClient->restoreBackup($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/restoreBackupTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function triggerBackupTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/triggerBackupTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $resourceType = 'resourceType979623115'; + $resource = 'resource-341064690'; + $backupPlan = 'backupPlan1119623046'; + $dataSource = 'dataSource-1333894576'; + $expectedResponse = new BackupPlanAssociation(); + $expectedResponse->setName($name2); + $expectedResponse->setResourceType($resourceType); + $expectedResponse->setResource($resource); + $expectedResponse->setBackupPlan($backupPlan); + $expectedResponse->setDataSource($dataSource); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/triggerBackupTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + $ruleId = 'ruleId1548659006'; + $request = (new TriggerBackupRequest())->setName($formattedName)->setRuleId($ruleId); + $response = $gapicClient->triggerBackup($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -138,15 +2524,13 @@ public function createManagementServerTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.backupdr.v1.BackupDR/CreateManagementServer', $actualApiFuncCall); - $actualValue = $actualApiRequestObject->getParent(); - $this->assertProtobufEquals($formattedParent, $actualValue); - $actualValue = $actualApiRequestObject->getManagementServerId(); - $this->assertProtobufEquals($managementServerId, $actualValue); - $actualValue = $actualApiRequestObject->getManagementServer(); - $this->assertProtobufEquals($managementServer, $actualValue); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/TriggerBackup', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $actualValue = $actualApiRequestObject->getRuleId(); + $this->assertProtobufEquals($ruleId, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/createManagementServerTest'); + $expectedOperationsRequestObject->setName('operations/triggerBackupTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); @@ -165,7 +2549,7 @@ public function createManagementServerTest() } /** @test */ - public function createManagementServerExceptionTest() + public function triggerBackupExceptionTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -182,7 +2566,7 @@ public function createManagementServerExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/createManagementServerTest'); + $incompleteOperation->setName('operations/triggerBackupTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $status = new stdClass(); @@ -199,20 +2583,18 @@ public function createManagementServerExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $managementServerId = 'managementServerId1884787355'; - $managementServer = new ManagementServer(); - $managementServerNetworks = []; - $managementServer->setNetworks($managementServerNetworks); - $request = (new CreateManagementServerRequest()) - ->setParent($formattedParent) - ->setManagementServerId($managementServerId) - ->setManagementServer($managementServer); - $response = $gapicClient->createManagementServer($request); + $formattedName = $gapicClient->backupPlanAssociationName( + '[PROJECT]', + '[LOCATION]', + '[BACKUP_PLAN_ASSOCIATION]' + ); + $ruleId = 'ruleId1548659006'; + $request = (new TriggerBackupRequest())->setName($formattedName)->setRuleId($ruleId); + $response = $gapicClient->triggerBackup($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/createManagementServerTest'); + $expectedOperationsRequestObject->setName('operations/triggerBackupTest'); try { $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, @@ -231,7 +2613,7 @@ public function createManagementServerExceptionTest() } /** @test */ - public function deleteManagementServerTest() + public function updateBackupTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -248,21 +2630,30 @@ public function deleteManagementServerTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/deleteManagementServerTest'); + $incompleteOperation->setName('operations/updateBackupTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); - $expectedResponse = new GPBEmpty(); + $name = 'name3373707'; + $description = 'description-1724546052'; + $etag = 'etag3123477'; + $resourceSizeBytes = 275424386; + $expectedResponse = new Backup(); + $expectedResponse->setName($name); + $expectedResponse->setDescription($description); + $expectedResponse->setEtag($etag); + $expectedResponse->setResourceSizeBytes($resourceSizeBytes); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/deleteManagementServerTest'); + $completeOperation->setName('operations/updateBackupTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $formattedName = $gapicClient->managementServerName('[PROJECT]', '[LOCATION]', '[MANAGEMENTSERVER]'); - $request = (new DeleteManagementServerRequest())->setName($formattedName); - $response = $gapicClient->deleteManagementServer($request); + $updateMask = new FieldMask(); + $backup = new Backup(); + $request = (new UpdateBackupRequest())->setUpdateMask($updateMask)->setBackup($backup); + $response = $gapicClient->updateBackup($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -271,11 +2662,13 @@ public function deleteManagementServerTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.backupdr.v1.BackupDR/DeleteManagementServer', $actualApiFuncCall); - $actualValue = $actualApiRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/UpdateBackup', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $actualValue = $actualApiRequestObject->getBackup(); + $this->assertProtobufEquals($backup, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteManagementServerTest'); + $expectedOperationsRequestObject->setName('operations/updateBackupTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); @@ -294,7 +2687,7 @@ public function deleteManagementServerTest() } /** @test */ - public function deleteManagementServerExceptionTest() + public function updateBackupExceptionTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -311,7 +2704,7 @@ public function deleteManagementServerExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/deleteManagementServerTest'); + $incompleteOperation->setName('operations/updateBackupTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $status = new stdClass(); @@ -328,13 +2721,14 @@ public function deleteManagementServerExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->managementServerName('[PROJECT]', '[LOCATION]', '[MANAGEMENTSERVER]'); - $request = (new DeleteManagementServerRequest())->setName($formattedName); - $response = $gapicClient->deleteManagementServer($request); + $updateMask = new FieldMask(); + $backup = new Backup(); + $request = (new UpdateBackupRequest())->setUpdateMask($updateMask)->setBackup($backup); + $response = $gapicClient->updateBackup($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteManagementServerTest'); + $expectedOperationsRequestObject->setName('operations/updateBackupTest'); try { $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, @@ -353,49 +2747,110 @@ public function deleteManagementServerExceptionTest() } /** @test */ - public function getManagementServerTest() + public function updateBackupVaultTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); // Mock response - $name2 = 'name2-1052831874'; + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateBackupVaultTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; $description = 'description-1724546052'; + $deletable = true; $etag = 'etag3123477'; - $oauth2ClientId = 'oauth2ClientId-1833466037'; - $satisfiesPzi = false; - $expectedResponse = new ManagementServer(); - $expectedResponse->setName($name2); + $backupCount = 336678994; + $serviceAccount = 'serviceAccount-1948028253'; + $totalStoredBytes = 1181597162; + $uid = 'uid115792'; + $expectedResponse = new BackupVault(); + $expectedResponse->setName($name); $expectedResponse->setDescription($description); + $expectedResponse->setDeletable($deletable); $expectedResponse->setEtag($etag); - $expectedResponse->setOauth2ClientId($oauth2ClientId); - $expectedResponse->setSatisfiesPzi($satisfiesPzi); - $transport->addResponse($expectedResponse); + $expectedResponse->setBackupCount($backupCount); + $expectedResponse->setServiceAccount($serviceAccount); + $expectedResponse->setTotalStoredBytes($totalStoredBytes); + $expectedResponse->setUid($uid); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/updateBackupVaultTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); // Mock request - $formattedName = $gapicClient->managementServerName('[PROJECT]', '[LOCATION]', '[MANAGEMENTSERVER]'); - $request = (new GetManagementServerRequest())->setName($formattedName); - $response = $gapicClient->getManagementServer($request); - $this->assertEquals($expectedResponse, $response); - $actualRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($actualRequests)); - $actualFuncCall = $actualRequests[0]->getFuncCall(); - $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.backupdr.v1.BackupDR/GetManagementServer', $actualFuncCall); - $actualValue = $actualRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); + $updateMask = new FieldMask(); + $backupVault = new BackupVault(); + $backupVaultBackupMinimumEnforcedRetentionDuration = new Duration(); + $backupVault->setBackupMinimumEnforcedRetentionDuration($backupVaultBackupMinimumEnforcedRetentionDuration); + $request = (new UpdateBackupVaultRequest())->setUpdateMask($updateMask)->setBackupVault($backupVault); + $response = $gapicClient->updateBackupVault($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/UpdateBackupVault', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $actualValue = $actualApiRequestObject->getBackupVault(); + $this->assertProtobufEquals($backupVault, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateBackupVaultTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function getManagementServerExceptionTest() + public function updateBackupVaultExceptionTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateBackupVaultTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); $status = new stdClass(); $status->code = Code::DATA_LOSS; $status->details = 'internal error'; @@ -408,65 +2863,130 @@ public function getManagementServerExceptionTest() ], JSON_PRETTY_PRINT ); - $transport->addResponse(null, $status); + $operationsTransport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->managementServerName('[PROJECT]', '[LOCATION]', '[MANAGEMENTSERVER]'); - $request = (new GetManagementServerRequest())->setName($formattedName); + $updateMask = new FieldMask(); + $backupVault = new BackupVault(); + $backupVaultBackupMinimumEnforcedRetentionDuration = new Duration(); + $backupVault->setBackupMinimumEnforcedRetentionDuration($backupVaultBackupMinimumEnforcedRetentionDuration); + $request = (new UpdateBackupVaultRequest())->setUpdateMask($updateMask)->setBackupVault($backupVault); + $response = $gapicClient->updateBackupVault($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateBackupVaultTest'); try { - $gapicClient->getManagementServer($request); - // If the $gapicClient method call did not throw, fail the test + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { $this->assertEquals($status->code, $ex->getCode()); $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); } - // Call popReceivedCalls to ensure the stub is exhausted + // Call popReceivedCalls to ensure the stubs are exhausted $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function listManagementServersTest() + public function updateDataSourceTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); // Mock response - $nextPageToken = ''; - $managementServersElement = new ManagementServer(); - $managementServers = [$managementServersElement]; - $expectedResponse = new ListManagementServersResponse(); - $expectedResponse->setNextPageToken($nextPageToken); - $expectedResponse->setManagementServers($managementServers); - $transport->addResponse($expectedResponse); + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateDataSourceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $backupCount = 336678994; + $etag = 'etag3123477'; + $totalStoredBytes = 1181597162; + $expectedResponse = new DataSource(); + $expectedResponse->setName($name); + $expectedResponse->setBackupCount($backupCount); + $expectedResponse->setEtag($etag); + $expectedResponse->setTotalStoredBytes($totalStoredBytes); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/updateDataSourceTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListManagementServersRequest())->setParent($formattedParent); - $response = $gapicClient->listManagementServers($request); - $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); - $resources = iterator_to_array($response->iterateAllElements()); - $this->assertSame(1, count($resources)); - $this->assertEquals($expectedResponse->getManagementServers()[0], $resources[0]); - $actualRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($actualRequests)); - $actualFuncCall = $actualRequests[0]->getFuncCall(); - $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.backupdr.v1.BackupDR/ListManagementServers', $actualFuncCall); - $actualValue = $actualRequestObject->getParent(); - $this->assertProtobufEquals($formattedParent, $actualValue); + $updateMask = new FieldMask(); + $dataSource = new DataSource(); + $request = (new UpdateDataSourceRequest())->setUpdateMask($updateMask)->setDataSource($dataSource); + $response = $gapicClient->updateDataSource($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/UpdateDataSource', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $actualValue = $actualApiRequestObject->getDataSource(); + $this->assertProtobufEquals($dataSource, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateDataSourceTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function listManagementServersExceptionTest() + public function updateDataSourceExceptionTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateDataSourceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); $status = new stdClass(); $status->code = Code::DATA_LOSS; $status->details = 'internal error'; @@ -479,21 +2999,31 @@ public function listManagementServersExceptionTest() ], JSON_PRETTY_PRINT ); - $transport->addResponse(null, $status); + $operationsTransport->addResponse(null, $status); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListManagementServersRequest())->setParent($formattedParent); + $updateMask = new FieldMask(); + $dataSource = new DataSource(); + $request = (new UpdateDataSourceRequest())->setUpdateMask($updateMask)->setDataSource($dataSource); + $response = $gapicClient->updateDataSource($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateDataSourceTest'); try { - $gapicClient->listManagementServers($request); - // If the $gapicClient method call did not throw, fail the test + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { $this->assertEquals($status->code, $ex->getCode()); $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); } - // Call popReceivedCalls to ensure the stub is exhausted + // Call popReceivedCalls to ensure the stubs are exhausted $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ @@ -830,7 +3360,7 @@ public function testIamPermissionsExceptionTest() } /** @test */ - public function createManagementServerAsyncTest() + public function createBackupPlanAsyncTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -847,38 +3377,44 @@ public function createManagementServerAsyncTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/createManagementServerTest'); + $incompleteOperation->setName('operations/createBackupPlanTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $name = 'name3373707'; $description = 'description-1724546052'; + $resourceType = 'resourceType979623115'; $etag = 'etag3123477'; - $oauth2ClientId = 'oauth2ClientId-1833466037'; - $satisfiesPzi = false; - $expectedResponse = new ManagementServer(); + $backupVault = 'backupVault353808757'; + $backupVaultServiceAccount = 'backupVaultServiceAccount-1170477095'; + $expectedResponse = new BackupPlan(); $expectedResponse->setName($name); $expectedResponse->setDescription($description); + $expectedResponse->setResourceType($resourceType); $expectedResponse->setEtag($etag); - $expectedResponse->setOauth2ClientId($oauth2ClientId); - $expectedResponse->setSatisfiesPzi($satisfiesPzi); + $expectedResponse->setBackupVault($backupVault); + $expectedResponse->setBackupVaultServiceAccount($backupVaultServiceAccount); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/createManagementServerTest'); + $completeOperation->setName('operations/createBackupPlanTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $managementServerId = 'managementServerId1884787355'; - $managementServer = new ManagementServer(); - $managementServerNetworks = []; - $managementServer->setNetworks($managementServerNetworks); - $request = (new CreateManagementServerRequest()) + $backupPlanId = 'backupPlanId-25762700'; + $backupPlan = new BackupPlan(); + $backupPlanBackupRules = []; + $backupPlan->setBackupRules($backupPlanBackupRules); + $backupPlanResourceType = 'backupPlanResourceType1515155475'; + $backupPlan->setResourceType($backupPlanResourceType); + $backupPlanBackupVault = $gapicClient->backupVaultName('[PROJECT]', '[LOCATION]', '[BACKUPVAULT]'); + $backupPlan->setBackupVault($backupPlanBackupVault); + $request = (new CreateBackupPlanRequest()) ->setParent($formattedParent) - ->setManagementServerId($managementServerId) - ->setManagementServer($managementServer); - $response = $gapicClient->createManagementServerAsync($request)->wait(); + ->setBackupPlanId($backupPlanId) + ->setBackupPlan($backupPlan); + $response = $gapicClient->createBackupPlanAsync($request)->wait(); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -887,15 +3423,15 @@ public function createManagementServerAsyncTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.backupdr.v1.BackupDR/CreateManagementServer', $actualApiFuncCall); + $this->assertSame('/google.cloud.backupdr.v1.BackupDR/CreateBackupPlan', $actualApiFuncCall); $actualValue = $actualApiRequestObject->getParent(); $this->assertProtobufEquals($formattedParent, $actualValue); - $actualValue = $actualApiRequestObject->getManagementServerId(); - $this->assertProtobufEquals($managementServerId, $actualValue); - $actualValue = $actualApiRequestObject->getManagementServer(); - $this->assertProtobufEquals($managementServer, $actualValue); + $actualValue = $actualApiRequestObject->getBackupPlanId(); + $this->assertProtobufEquals($backupPlanId, $actualValue); + $actualValue = $actualApiRequestObject->getBackupPlan(); + $this->assertProtobufEquals($backupPlan, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/createManagementServerTest'); + $expectedOperationsRequestObject->setName('operations/createBackupPlanTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); From b3466e9c20759b3fc88c13e587c3175b5ef2455f Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Fri, 11 Oct 2024 12:23:00 -0700 Subject: [PATCH 024/157] chore(main): release 0.263.0 (#7741) --- BackupDr/VERSION | 2 +- CHANGELOG.md | 162 ++++++++++++++++++++++++++++ CommerceConsumerProcurement/VERSION | 2 +- ContactCenterInsights/VERSION | 2 +- Container/VERSION | 2 +- Datastore/VERSION | 2 +- Datastore/src/DatastoreClient.php | 2 +- DiscoveryEngine/VERSION | 2 +- PubSub/VERSION | 2 +- PubSub/src/PubSubClient.php | 2 +- Retail/VERSION | 2 +- Spanner/VERSION | 2 +- Spanner/src/SpannerClient.php | 2 +- TextToSpeech/VERSION | 2 +- composer.json | 20 ++-- 15 files changed, 185 insertions(+), 23 deletions(-) diff --git a/BackupDr/VERSION b/BackupDr/VERSION index 0d91a54c7d43..1d0ba9ea182b 100644 --- a/BackupDr/VERSION +++ b/BackupDr/VERSION @@ -1 +1 @@ -0.3.0 +0.4.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index 212fce24d2e8..a4dc7d395b82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,167 @@ # Changelog +## 0.263.0 + +
google/cloud-backupdr 0.4.0 + + + +### Features + +* Add backupplan proto ([764bb32](https://github.com/googleapis/google-cloud-php/commit/764bb32bb2c092828be889c3f951234f605b16ad)) +* Add backupplan proto ([#7732](https://github.com/googleapis/google-cloud-php/issues/7732)) ([764bb32](https://github.com/googleapis/google-cloud-php/commit/764bb32bb2c092828be889c3f951234f605b16ad)) +* Add backupplanassociation proto ([764bb32](https://github.com/googleapis/google-cloud-php/commit/764bb32bb2c092828be889c3f951234f605b16ad)) +* Add backupvault_ba proto ([764bb32](https://github.com/googleapis/google-cloud-php/commit/764bb32bb2c092828be889c3f951234f605b16ad)) +* Add backupvault_gce proto ([764bb32](https://github.com/googleapis/google-cloud-php/commit/764bb32bb2c092828be889c3f951234f605b16ad)) + +
+ +
google/cloud-commerce-consumer-procurement 1.1.0 + + + +### Features + +* Add Order modification RPCs and License Management Service ([#7729](https://github.com/googleapis/google-cloud-php/issues/7729)) ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) + + +### Documentation + +* A comment for enum value `LINE_ITEM_CHANGE_STATE_ABANDONED` in enum `LineItemChangeState` is changed ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) +* A comment for enum value `LINE_ITEM_CHANGE_STATE_ACTIVATING` in enum `LineItemChangeState` is changed ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) +* A comment for enum value `LINE_ITEM_CHANGE_STATE_APPROVED` in enum `LineItemChangeState` is changed ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) +* A comment for enum value `LINE_ITEM_CHANGE_STATE_COMPLETED` in enum `LineItemChangeState` is changed ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) +* A comment for enum value `LINE_ITEM_CHANGE_STATE_PENDING_APPROVAL` in enum `LineItemChangeState` is changed ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) +* A comment for enum value `LINE_ITEM_CHANGE_STATE_REJECTED` in enum `LineItemChangeState` is changed ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) +* A comment for field `filter` in message `.google.cloud.commerce.consumer.procurement.v1.ListOrdersRequest` is changed ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) +* A comment for field `request_id` in message `.google.cloud.commerce.consumer.procurement.v1.PlaceOrderRequest` is changed ([3252d24](https://github.com/googleapis/google-cloud-php/commit/3252d24783823082ea5e0af837be3cbd84854639)) + +
+ +
google/cloud-contact-center-insights 2.1.0 + + + +### Features + +* Add CMEK InitializeLroSpec ([534f367](https://github.com/googleapis/google-cloud-php/commit/534f3670edc86f7407c0224da4c4a48ea69d18fc)) +* Add import / export IssueModel ([#7731](https://github.com/googleapis/google-cloud-php/issues/7731)) ([534f367](https://github.com/googleapis/google-cloud-php/commit/534f3670edc86f7407c0224da4c4a48ea69d18fc)) +* Add metadata import to IngestConversations ([534f367](https://github.com/googleapis/google-cloud-php/commit/534f3670edc86f7407c0224da4c4a48ea69d18fc)) +* Add sampling to IngestConversations ([534f367](https://github.com/googleapis/google-cloud-php/commit/534f3670edc86f7407c0224da4c4a48ea69d18fc)) + + +### Documentation + +* Add a comment for valid `order_by` values in ListConversations ([534f367](https://github.com/googleapis/google-cloud-php/commit/534f3670edc86f7407c0224da4c4a48ea69d18fc)) +* Add a comment for valid `update_mask` values in UpdateConversation ([534f367](https://github.com/googleapis/google-cloud-php/commit/534f3670edc86f7407c0224da4c4a48ea69d18fc)) + +
+ +
google/cloud-container 2.2.0 + + + +### Features + +* Add an effective_cgroup_mode field in node config ([#7737](https://github.com/googleapis/google-cloud-php/issues/7737)) ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) +* Add API to enable/disable secret manager csi component on GKE clusters ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) +* Add CompliancePosture field for configuration of GKE Compliance Posture product ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) +* Add CompliancePosture field for configuration of GKE Compliance Posture product ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) +* Add KCP_SSHD and KCP_CONNECTION to the supported values for the --logging flag for the create and update cluster commands ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) +* Add RBACBindingConfig to API ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) +* Add storage pools field to NodePool API ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) +* Added support for Parallelstore CSI Driver ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) +* Surface upgrade_target_version in GetServerConfig for all supported release channels ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) + + +### Documentation + +* Minor documentation updates ([bb22cee](https://github.com/googleapis/google-cloud-php/commit/bb22cee327bb8a5a438bde0d39e6e48ae1d51b72)) + +
+ +
google/cloud-datastore 1.31.0 + + + +### Features + +* Support for field update operators in the Datastore API and resolution strategies when there is a conflict at write time ([#7733](https://github.com/googleapis/google-cloud-php/issues/7733)) ([c4a0d8d](https://github.com/googleapis/google-cloud-php/commit/c4a0d8d12ac9210d8b6a767133edb5bce1a0e20a)) + +
+ +
google/cloud-discoveryengine 1.2.0 + + + +### Features + +* Add BillingEstimation in data store ([a93ec74](https://github.com/googleapis/google-cloud-php/commit/a93ec74d89b046e5fd0f751c17eca18b840ac74a)) +* Add GroundedGenerationService API ([a93ec74](https://github.com/googleapis/google-cloud-php/commit/a93ec74d89b046e5fd0f751c17eca18b840ac74a)) +* Add one_box_page_size on search ([a93ec74](https://github.com/googleapis/google-cloud-php/commit/a93ec74d89b046e5fd0f751c17eca18b840ac74a)) +* Add site_credential for site search config ([a93ec74](https://github.com/googleapis/google-cloud-php/commit/a93ec74d89b046e5fd0f751c17eca18b840ac74a)) +* Support advanced boost search ([a93ec74](https://github.com/googleapis/google-cloud-php/commit/a93ec74d89b046e5fd0f751c17eca18b840ac74a)) +* Support Google Workspace search ([a93ec74](https://github.com/googleapis/google-cloud-php/commit/a93ec74d89b046e5fd0f751c17eca18b840ac74a)) + + +### Bug Fixes + +* Location type annotation ([#7739](https://github.com/googleapis/google-cloud-php/issues/7739)) ([a93ec74](https://github.com/googleapis/google-cloud-php/commit/a93ec74d89b046e5fd0f751c17eca18b840ac74a)) + + +### Documentation + +* Update documentation ([a93ec74](https://github.com/googleapis/google-cloud-php/commit/a93ec74d89b046e5fd0f751c17eca18b840ac74a)) + +
+ +
google/cloud-pubsub 2.8.0 + + + +### Features + +* Add IngestionFailureEvent to the external proto ([#7738](https://github.com/googleapis/google-cloud-php/issues/7738)) ([438b3e8](https://github.com/googleapis/google-cloud-php/commit/438b3e8a540f8b95e24eb10abcb061c90b5dec48)) + +
+ +
google/cloud-retail 2.1.0 + + + +### Features + +* Add conversational search ([#7734](https://github.com/googleapis/google-cloud-php/issues/7734)) ([7c553c2](https://github.com/googleapis/google-cloud-php/commit/7c553c279fdd3eee3eb07c062007f9b4f1aa6e20)) +* Add tile navigation ([7c553c2](https://github.com/googleapis/google-cloud-php/commit/7c553c279fdd3eee3eb07c062007f9b4f1aa6e20)) + + +### Documentation + +* Keep the API doc up-to-date with recent changes ([7c553c2](https://github.com/googleapis/google-cloud-php/commit/7c553c279fdd3eee3eb07c062007f9b4f1aa6e20)) + +
+ +
google/cloud-spanner 1.87.0 + + + +### Features + +* Protos for R/W transaction support on multiplexed sessions ([#7736](https://github.com/googleapis/google-cloud-php/issues/7736)) ([dd48f72](https://github.com/googleapis/google-cloud-php/commit/dd48f72f8ca75bb3d038fc717338a5a39d24c977)) + +
+ +
google/cloud-text-to-speech 1.10.0 + + + +### Features + +* Add CustomPronunciationParams for upcoming feature work ([ce39c2e](https://github.com/googleapis/google-cloud-php/commit/ce39c2ef70b75bda13fde63335fd6810480d606d)) +* Add low latency journey option to proto ([#7740](https://github.com/googleapis/google-cloud-php/issues/7740)) ([ce39c2e](https://github.com/googleapis/google-cloud-php/commit/ce39c2ef70b75bda13fde63335fd6810480d606d)) + +
+ ## 0.262.0
google/cloud-ai-platform 1.8.0 diff --git a/CommerceConsumerProcurement/VERSION b/CommerceConsumerProcurement/VERSION index 3eefcb9dd5b3..9084fa2f716a 100644 --- a/CommerceConsumerProcurement/VERSION +++ b/CommerceConsumerProcurement/VERSION @@ -1 +1 @@ -1.0.0 +1.1.0 diff --git a/ContactCenterInsights/VERSION b/ContactCenterInsights/VERSION index 38f77a65b301..7ec1d6db4087 100644 --- a/ContactCenterInsights/VERSION +++ b/ContactCenterInsights/VERSION @@ -1 +1 @@ -2.0.1 +2.1.0 diff --git a/Container/VERSION b/Container/VERSION index 7ec1d6db4087..ccbccc3dc626 100644 --- a/Container/VERSION +++ b/Container/VERSION @@ -1 +1 @@ -2.1.0 +2.2.0 diff --git a/Datastore/VERSION b/Datastore/VERSION index 034552a83eeb..34aae156b192 100644 --- a/Datastore/VERSION +++ b/Datastore/VERSION @@ -1 +1 @@ -1.30.0 +1.31.0 diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index 4db0b68e9b46..d4ef798e4417 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -92,7 +92,7 @@ class DatastoreClient use ClientTrait; use DatastoreTrait; - const VERSION = '1.30.0'; + const VERSION = '1.31.0'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/datastore'; diff --git a/DiscoveryEngine/VERSION b/DiscoveryEngine/VERSION index 9084fa2f716a..26aaba0e8663 100644 --- a/DiscoveryEngine/VERSION +++ b/DiscoveryEngine/VERSION @@ -1 +1 @@ -1.1.0 +1.2.0 diff --git a/PubSub/VERSION b/PubSub/VERSION index 24ba9a38de68..834f26295383 100644 --- a/PubSub/VERSION +++ b/PubSub/VERSION @@ -1 +1 @@ -2.7.0 +2.8.0 diff --git a/PubSub/src/PubSubClient.php b/PubSub/src/PubSubClient.php index 938d05cfc093..1711371f87d3 100644 --- a/PubSub/src/PubSubClient.php +++ b/PubSub/src/PubSubClient.php @@ -99,7 +99,7 @@ class PubSubClient use ApiHelperTrait; use ClientOptionsTrait; - const VERSION = '2.7.0'; + const VERSION = '2.8.0'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/pubsub'; diff --git a/Retail/VERSION b/Retail/VERSION index 227cea215648..7ec1d6db4087 100644 --- a/Retail/VERSION +++ b/Retail/VERSION @@ -1 +1 @@ -2.0.0 +2.1.0 diff --git a/Spanner/VERSION b/Spanner/VERSION index b7844a6ffdcb..f6342716723f 100644 --- a/Spanner/VERSION +++ b/Spanner/VERSION @@ -1 +1 @@ -1.86.0 +1.87.0 diff --git a/Spanner/src/SpannerClient.php b/Spanner/src/SpannerClient.php index 64ad7f2c1c6c..7c379c418cfa 100644 --- a/Spanner/src/SpannerClient.php +++ b/Spanner/src/SpannerClient.php @@ -120,7 +120,7 @@ class SpannerClient use LROTrait; use ValidateTrait; - const VERSION = '1.86.0'; + const VERSION = '1.87.0'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/spanner.data'; const ADMIN_SCOPE = 'https://www.googleapis.com/auth/spanner.admin'; diff --git a/TextToSpeech/VERSION b/TextToSpeech/VERSION index 9ab8337f3962..81c871de46b3 100644 --- a/TextToSpeech/VERSION +++ b/TextToSpeech/VERSION @@ -1 +1 @@ -1.9.1 +1.10.0 diff --git a/composer.json b/composer.json index cef449693376..a853a691adae 100644 --- a/composer.json +++ b/composer.json @@ -89,7 +89,7 @@ "google/cloud-asset": "2.1.0", "google/cloud-assured-workloads": "1.0.0", "google/cloud-automl": "2.0.0", - "google/cloud-backupdr": "0.3.0", + "google/cloud-backupdr": "0.4.0", "google/cloud-bare-metal-solution": "1.0.0", "google/cloud-batch": "1.1.1", "google/cloud-beyondcorp-appconnections": "1.0.0", @@ -114,13 +114,13 @@ "google/cloud-certificate-manager": "1.0.0", "google/cloud-channel": "2.1.0", "google/cloud-cloudcontrolspartner": "0.2.0", - "google/cloud-commerce-consumer-procurement": "1.0.0", + "google/cloud-commerce-consumer-procurement": "1.1.0", "google/cloud-common-protos": "0.6.0", "google/cloud-compute": "1.19.0", "google/cloud-confidentialcomputing": "1.1.0", "google/cloud-config": "1.0.0", - "google/cloud-contact-center-insights": "2.0.1", - "google/cloud-container": "2.1.0", + "google/cloud-contact-center-insights": "2.1.0", + "google/cloud-container": "2.2.0", "google/cloud-container-analysis": "1.0.1", "google/cloud-core": "1.60.0", "google/cloud-data-catalog": "2.0.1", @@ -132,7 +132,7 @@ "google/cloud-dataplex": "1.0.0", "google/cloud-dataproc": "2.1.0", "google/cloud-dataproc-metastore": "1.0.0", - "google/cloud-datastore": "1.30.0", + "google/cloud-datastore": "1.31.0", "google/cloud-datastore-admin": "1.0.0", "google/cloud-datastream": "2.0.0", "google/cloud-debugger": "1.9.0", @@ -140,7 +140,7 @@ "google/cloud-developerconnect": "0.1.1", "google/cloud-dialogflow": "1.15.0", "google/cloud-dialogflow-cx": "0.4.0", - "google/cloud-discoveryengine": "1.1.0", + "google/cloud-discoveryengine": "1.2.0", "google/cloud-dlp": "2.1.0", "google/cloud-dms": "2.0.1", "google/cloud-document-ai": "2.0.0", @@ -192,7 +192,7 @@ "google/cloud-private-catalog": "0.4.4", "google/cloud-privilegedaccessmanager": "0.1.0", "google/cloud-profiler": "2.0.0", - "google/cloud-pubsub": "2.7.0", + "google/cloud-pubsub": "2.8.0", "google/cloud-quotas": "1.0.0", "google/cloud-rapidmigrationassessment": "1.0.0", "google/cloud-recaptcha-enterprise": "1.15.0", @@ -202,7 +202,7 @@ "google/cloud-redis-cluster": "0.3.0", "google/cloud-resource-manager": "1.0.0", "google/cloud-resource-settings": "2.0.1", - "google/cloud-retail": "2.0.0", + "google/cloud-retail": "2.1.0", "google/cloud-run": "1.2.0", "google/cloud-scheduler": "2.0.0", "google/cloud-secret-manager": "1.15.2", @@ -217,7 +217,7 @@ "google/cloud-service-usage": "2.0.0", "google/cloud-servicehealth": "0.1.6", "google/cloud-shell": "2.0.1", - "google/cloud-spanner": "1.86.0", + "google/cloud-spanner": "1.87.0", "google/cloud-speech": "1.19.0", "google/cloud-sql-admin": "1.2.0", "google/cloud-storage": "1.43.1", @@ -228,7 +228,7 @@ "google/cloud-talent": "2.0.0", "google/cloud-tasks": "1.15.0", "google/cloud-telcoautomation": "1.0.0", - "google/cloud-text-to-speech": "1.9.1", + "google/cloud-text-to-speech": "1.10.0", "google/cloud-tpu": "1.4.5", "google/cloud-trace": "1.8.6", "google/cloud-translate": "1.19.0", From 129458ae6916e651a3165e4bc0b23a3edbf5cd09 Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Fri, 11 Oct 2024 13:34:49 -0600 Subject: [PATCH 025/157] fix(ci): ref in backwards-compatibility-checks (#7728) --- .github/workflows/backwards-compatibility-checks.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/backwards-compatibility-checks.yaml b/.github/workflows/backwards-compatibility-checks.yaml index d70fede112d9..284f12f30e9e 100644 --- a/.github/workflows/backwards-compatibility-checks.yaml +++ b/.github/workflows/backwards-compatibility-checks.yaml @@ -69,7 +69,7 @@ jobs: # OwlBot PRs which are not labelled feat should not add new files or methods run: | ~/.composer/vendor/bin/roave-backward-compatibility-check \ - --from=${{ github.ref_name }} \ + --from=${{ github.head_ref || github.ref_name }} \ --to=origin/main --format=github-actions - name: "Print the action item" run: | From 6865827d0c14684460a2565b0f6ecc1610c1ee3a Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:38:00 -0400 Subject: [PATCH 026/157] feat: add experimental ArrowData type and arrow_data field within AppendRowsRequest (#7743) PiperOrigin-RevId: 684900949 Source-Link: https://github.com/googleapis/googleapis/commit/b49a983820806fc0d903370c0e75129fe7ae3c7b Source-Link: https://github.com/googleapis/googleapis-gen/commit/34ddd0399386aeb1d4ab5d397a6dcce5908a16f0 Copy-Tag: eyJwIjoiQmlnUXVlcnlTdG9yYWdlLy5Pd2xCb3QueWFtbCIsImgiOiIzNGRkZDAzOTkzODZhZWIxZDRhYjVkMzk3YTZkY2NlNTkwOGExNmYwIn0= --- BigQueryStorage/metadata/V1/Storage.php | Bin 8676 -> 8911 bytes BigQueryStorage/src/V1/AppendRowsRequest.php | 36 +++++ .../src/V1/AppendRowsRequest/ArrowData.php | 124 ++++++++++++++++++ 3 files changed, 160 insertions(+) create mode 100644 BigQueryStorage/src/V1/AppendRowsRequest/ArrowData.php diff --git a/BigQueryStorage/metadata/V1/Storage.php b/BigQueryStorage/metadata/V1/Storage.php index 4799af5a28cb4ea7e53d82bd6eab129f860c58b0..b6dc4a5859a8ae18fcbcc9fa6638ee7200c7b512 100644 GIT binary patch delta 126 zcmaFjeBO1#BNmoL)?9j%ds!7H=J0M7Vcp5j^n+vad7cNN!CYL4MMe4L@jzTG!K%Qh z!EIza*^x_m@_GSo?!wa4;u1Yakb=!Cc%>LQCo^(!g1M7V^Vv^c$Hgrmhtq&p-N@)%| diff --git a/BigQueryStorage/src/V1/AppendRowsRequest.php b/BigQueryStorage/src/V1/AppendRowsRequest.php index a28d688b2ddb..0b1e665e3d46 100644 --- a/BigQueryStorage/src/V1/AppendRowsRequest.php +++ b/BigQueryStorage/src/V1/AppendRowsRequest.php @@ -174,6 +174,9 @@ public static function build(string $writeStream): self * when calling AppendRows for the '_default' stream. * @type \Google\Cloud\BigQuery\Storage\V1\AppendRowsRequest\ProtoData $proto_rows * Rows in proto format. + * @type \Google\Cloud\BigQuery\Storage\V1\AppendRowsRequest\ArrowData $arrow_rows + * Rows in arrow format. This is an experimental feature only selected for + * allowlisted customers. * @type string $trace_id * Id set by client to annotate its identity. Only initial request setting is * respected. @@ -377,6 +380,39 @@ public function setProtoRows($var) return $this; } + /** + * Rows in arrow format. This is an experimental feature only selected for + * allowlisted customers. + * + * Generated from protobuf field .google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5; + * @return \Google\Cloud\BigQuery\Storage\V1\AppendRowsRequest\ArrowData|null + */ + public function getArrowRows() + { + return $this->readOneof(5); + } + + public function hasArrowRows() + { + return $this->hasOneof(5); + } + + /** + * Rows in arrow format. This is an experimental feature only selected for + * allowlisted customers. + * + * Generated from protobuf field .google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5; + * @param \Google\Cloud\BigQuery\Storage\V1\AppendRowsRequest\ArrowData $var + * @return $this + */ + public function setArrowRows($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\Storage\V1\AppendRowsRequest\ArrowData::class); + $this->writeOneof(5, $var); + + return $this; + } + /** * Id set by client to annotate its identity. Only initial request setting is * respected. diff --git a/BigQueryStorage/src/V1/AppendRowsRequest/ArrowData.php b/BigQueryStorage/src/V1/AppendRowsRequest/ArrowData.php new file mode 100644 index 000000000000..cc96f42dad0f --- /dev/null +++ b/BigQueryStorage/src/V1/AppendRowsRequest/ArrowData.php @@ -0,0 +1,124 @@ +google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData + */ +class ArrowData extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Arrow Schema used to serialize the data. + * + * Generated from protobuf field .google.cloud.bigquery.storage.v1.ArrowSchema writer_schema = 1; + */ + protected $writer_schema = null; + /** + * Required. Serialized row data in Arrow format. + * + * Generated from protobuf field .google.cloud.bigquery.storage.v1.ArrowRecordBatch rows = 2; + */ + protected $rows = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\BigQuery\Storage\V1\ArrowSchema $writer_schema + * Optional. Arrow Schema used to serialize the data. + * @type \Google\Cloud\BigQuery\Storage\V1\ArrowRecordBatch $rows + * Required. Serialized row data in Arrow format. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Bigquery\Storage\V1\Storage::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Arrow Schema used to serialize the data. + * + * Generated from protobuf field .google.cloud.bigquery.storage.v1.ArrowSchema writer_schema = 1; + * @return \Google\Cloud\BigQuery\Storage\V1\ArrowSchema|null + */ + public function getWriterSchema() + { + return $this->writer_schema; + } + + public function hasWriterSchema() + { + return isset($this->writer_schema); + } + + public function clearWriterSchema() + { + unset($this->writer_schema); + } + + /** + * Optional. Arrow Schema used to serialize the data. + * + * Generated from protobuf field .google.cloud.bigquery.storage.v1.ArrowSchema writer_schema = 1; + * @param \Google\Cloud\BigQuery\Storage\V1\ArrowSchema $var + * @return $this + */ + public function setWriterSchema($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\Storage\V1\ArrowSchema::class); + $this->writer_schema = $var; + + return $this; + } + + /** + * Required. Serialized row data in Arrow format. + * + * Generated from protobuf field .google.cloud.bigquery.storage.v1.ArrowRecordBatch rows = 2; + * @return \Google\Cloud\BigQuery\Storage\V1\ArrowRecordBatch|null + */ + public function getRows() + { + return $this->rows; + } + + public function hasRows() + { + return isset($this->rows); + } + + public function clearRows() + { + unset($this->rows); + } + + /** + * Required. Serialized row data in Arrow format. + * + * Generated from protobuf field .google.cloud.bigquery.storage.v1.ArrowRecordBatch rows = 2; + * @param \Google\Cloud\BigQuery\Storage\V1\ArrowRecordBatch $var + * @return $this + */ + public function setRows($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\Storage\V1\ArrowRecordBatch::class); + $this->rows = $var; + + return $this; + } + +} + + From 327de673ae8bcb59533d906237ce5c73416293c4 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:44:50 -0400 Subject: [PATCH 027/157] feat: Add FindNearest API to the stable branch (#7744) PiperOrigin-RevId: 684905940 Source-Link: https://github.com/googleapis/googleapis/commit/2196d4843a22befdc7bc3b7b676eeb392c31b3cf Source-Link: https://github.com/googleapis/googleapis-gen/commit/05df6fa16ab93bd9da17b56edd379b43963de167 Copy-Tag: eyJwIjoiRGF0YXN0b3JlLy5Pd2xCb3QueWFtbCIsImgiOiIwNWRmNmZhMTZhYjkzYmQ5ZGExN2I1NmVkZDM3OWI0Mzk2M2RlMTY3In0= --- Datastore/metadata/V1/Query.php | Bin 4366 -> 4897 bytes Datastore/src/V1/FindNearest.php | 390 ++++++++++++++++++ .../src/V1/FindNearest/DistanceMeasure.php | 82 ++++ Datastore/src/V1/Query.php | 60 +++ 4 files changed, 532 insertions(+) create mode 100644 Datastore/src/V1/FindNearest.php create mode 100644 Datastore/src/V1/FindNearest/DistanceMeasure.php diff --git a/Datastore/metadata/V1/Query.php b/Datastore/metadata/V1/Query.php index 04f68361a258e850ff80a5bdba11974d64b91292..a42f6011f29891340783c73ac1e44cf2d3b47cc8 100644 GIT binary patch delta 441 zcmZ9H&r8B!7{}Y@1m9_n7lI)MOGtuXl~9-Hu(nqi9!2Y5={ zkj$x6l9>acAumq~J7O~l%xr$i{isa*&EMxMUmOrN5~zdnE$P!B#7jXq+f7Lpo`T{{ zM8XBmB8gpTE2*}A?fMbPFbjwSZ%*B5pWq2`=TS%`ETaaYxbrz*fd(f+N8D z-o&F)Zu!aY-DSglAg!&*Q;|>cEDUBOqzj2p?1dC#;01tdjE)m<9QXq%ziL`lMnN$0 ziIObRpcf4lJ&1ZfS$Ah@7?l52f-M#7ZX#b%;r5z>lm3nF>TIaDPr6#&DO%Uxs-1W3jofc3wrgoogle.datastore.v1.FindNearest + */ +class FindNearest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. An indexed vector property to search upon. Only documents which + * contain vectors whose dimensionality match the query_vector can be + * returned. + * + * Generated from protobuf field .google.datastore.v1.PropertyReference vector_property = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $vector_property = null; + /** + * Required. The query vector that we are searching on. Must be a vector of no + * more than 2048 dimensions. + * + * Generated from protobuf field .google.datastore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $query_vector = null; + /** + * Required. The Distance Measure to use, required. + * + * Generated from protobuf field .google.datastore.v1.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + private $distance_measure = 0; + /** + * Required. The number of nearest neighbors to return. Must be a positive + * integer of no more than 100. + * + * Generated from protobuf field .google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED]; + */ + private $limit = null; + /** + * Optional. Optional name of the field to output the result of the vector + * distance calculation. Must conform to [entity + * property][google.datastore.v1.Entity.properties] limitations. + * + * Generated from protobuf field string distance_result_property = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $distance_result_property = ''; + /** + * Optional. Option to specify a threshold for which no less similar documents + * will be returned. The behavior of the specified `distance_measure` will + * affect the meaning of the distance threshold. Since DOT_PRODUCT distances + * increase when the vectors are more similar, the comparison is inverted. + * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold + * For DOT_PRODUCT: WHERE distance >= distance_threshold + * + * Generated from protobuf field .google.protobuf.DoubleValue distance_threshold = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $distance_threshold = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Datastore\V1\PropertyReference $vector_property + * Required. An indexed vector property to search upon. Only documents which + * contain vectors whose dimensionality match the query_vector can be + * returned. + * @type \Google\Cloud\Datastore\V1\Value $query_vector + * Required. The query vector that we are searching on. Must be a vector of no + * more than 2048 dimensions. + * @type int $distance_measure + * Required. The Distance Measure to use, required. + * @type \Google\Protobuf\Int32Value $limit + * Required. The number of nearest neighbors to return. Must be a positive + * integer of no more than 100. + * @type string $distance_result_property + * Optional. Optional name of the field to output the result of the vector + * distance calculation. Must conform to [entity + * property][google.datastore.v1.Entity.properties] limitations. + * @type \Google\Protobuf\DoubleValue $distance_threshold + * Optional. Option to specify a threshold for which no less similar documents + * will be returned. The behavior of the specified `distance_measure` will + * affect the meaning of the distance threshold. Since DOT_PRODUCT distances + * increase when the vectors are more similar, the comparison is inverted. + * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold + * For DOT_PRODUCT: WHERE distance >= distance_threshold + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Datastore\V1\Query::initOnce(); + parent::__construct($data); + } + + /** + * Required. An indexed vector property to search upon. Only documents which + * contain vectors whose dimensionality match the query_vector can be + * returned. + * + * Generated from protobuf field .google.datastore.v1.PropertyReference vector_property = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Datastore\V1\PropertyReference|null + */ + public function getVectorProperty() + { + return $this->vector_property; + } + + public function hasVectorProperty() + { + return isset($this->vector_property); + } + + public function clearVectorProperty() + { + unset($this->vector_property); + } + + /** + * Required. An indexed vector property to search upon. Only documents which + * contain vectors whose dimensionality match the query_vector can be + * returned. + * + * Generated from protobuf field .google.datastore.v1.PropertyReference vector_property = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Datastore\V1\PropertyReference $var + * @return $this + */ + public function setVectorProperty($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Datastore\V1\PropertyReference::class); + $this->vector_property = $var; + + return $this; + } + + /** + * Required. The query vector that we are searching on. Must be a vector of no + * more than 2048 dimensions. + * + * Generated from protobuf field .google.datastore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Datastore\V1\Value|null + */ + public function getQueryVector() + { + return $this->query_vector; + } + + public function hasQueryVector() + { + return isset($this->query_vector); + } + + public function clearQueryVector() + { + unset($this->query_vector); + } + + /** + * Required. The query vector that we are searching on. Must be a vector of no + * more than 2048 dimensions. + * + * Generated from protobuf field .google.datastore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Datastore\V1\Value $var + * @return $this + */ + public function setQueryVector($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Datastore\V1\Value::class); + $this->query_vector = $var; + + return $this; + } + + /** + * Required. The Distance Measure to use, required. + * + * Generated from protobuf field .google.datastore.v1.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getDistanceMeasure() + { + return $this->distance_measure; + } + + /** + * Required. The Distance Measure to use, required. + * + * Generated from protobuf field .google.datastore.v1.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setDistanceMeasure($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Datastore\V1\FindNearest\DistanceMeasure::class); + $this->distance_measure = $var; + + return $this; + } + + /** + * Required. The number of nearest neighbors to return. Must be a positive + * integer of no more than 100. + * + * Generated from protobuf field .google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Int32Value|null + */ + public function getLimit() + { + return $this->limit; + } + + public function hasLimit() + { + return isset($this->limit); + } + + public function clearLimit() + { + unset($this->limit); + } + + /** + * Returns the unboxed value from getLimit() + + * Required. The number of nearest neighbors to return. Must be a positive + * integer of no more than 100. + * + * Generated from protobuf field .google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED]; + * @return int|null + */ + public function getLimitValue() + { + return $this->readWrapperValue("limit"); + } + + /** + * Required. The number of nearest neighbors to return. Must be a positive + * integer of no more than 100. + * + * Generated from protobuf field .google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\Int32Value $var + * @return $this + */ + public function setLimit($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Int32Value::class); + $this->limit = $var; + + return $this; + } + + /** + * Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object. + + * Required. The number of nearest neighbors to return. Must be a positive + * integer of no more than 100. + * + * Generated from protobuf field .google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED]; + * @param int|null $var + * @return $this + */ + public function setLimitValue($var) + { + $this->writeWrapperValue("limit", $var); + return $this;} + + /** + * Optional. Optional name of the field to output the result of the vector + * distance calculation. Must conform to [entity + * property][google.datastore.v1.Entity.properties] limitations. + * + * Generated from protobuf field string distance_result_property = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDistanceResultProperty() + { + return $this->distance_result_property; + } + + /** + * Optional. Optional name of the field to output the result of the vector + * distance calculation. Must conform to [entity + * property][google.datastore.v1.Entity.properties] limitations. + * + * Generated from protobuf field string distance_result_property = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDistanceResultProperty($var) + { + GPBUtil::checkString($var, True); + $this->distance_result_property = $var; + + return $this; + } + + /** + * Optional. Option to specify a threshold for which no less similar documents + * will be returned. The behavior of the specified `distance_measure` will + * affect the meaning of the distance threshold. Since DOT_PRODUCT distances + * increase when the vectors are more similar, the comparison is inverted. + * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold + * For DOT_PRODUCT: WHERE distance >= distance_threshold + * + * Generated from protobuf field .google.protobuf.DoubleValue distance_threshold = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\DoubleValue|null + */ + public function getDistanceThreshold() + { + return $this->distance_threshold; + } + + public function hasDistanceThreshold() + { + return isset($this->distance_threshold); + } + + public function clearDistanceThreshold() + { + unset($this->distance_threshold); + } + + /** + * Returns the unboxed value from getDistanceThreshold() + + * Optional. Option to specify a threshold for which no less similar documents + * will be returned. The behavior of the specified `distance_measure` will + * affect the meaning of the distance threshold. Since DOT_PRODUCT distances + * increase when the vectors are more similar, the comparison is inverted. + * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold + * For DOT_PRODUCT: WHERE distance >= distance_threshold + * + * Generated from protobuf field .google.protobuf.DoubleValue distance_threshold = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return float|null + */ + public function getDistanceThresholdValue() + { + return $this->readWrapperValue("distance_threshold"); + } + + /** + * Optional. Option to specify a threshold for which no less similar documents + * will be returned. The behavior of the specified `distance_measure` will + * affect the meaning of the distance threshold. Since DOT_PRODUCT distances + * increase when the vectors are more similar, the comparison is inverted. + * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold + * For DOT_PRODUCT: WHERE distance >= distance_threshold + * + * Generated from protobuf field .google.protobuf.DoubleValue distance_threshold = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\DoubleValue $var + * @return $this + */ + public function setDistanceThreshold($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\DoubleValue::class); + $this->distance_threshold = $var; + + return $this; + } + + /** + * Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object. + + * Optional. Option to specify a threshold for which no less similar documents + * will be returned. The behavior of the specified `distance_measure` will + * affect the meaning of the distance threshold. Since DOT_PRODUCT distances + * increase when the vectors are more similar, the comparison is inverted. + * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold + * For DOT_PRODUCT: WHERE distance >= distance_threshold + * + * Generated from protobuf field .google.protobuf.DoubleValue distance_threshold = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param float|null $var + * @return $this + */ + public function setDistanceThresholdValue($var) + { + $this->writeWrapperValue("distance_threshold", $var); + return $this;} + +} + diff --git a/Datastore/src/V1/FindNearest/DistanceMeasure.php b/Datastore/src/V1/FindNearest/DistanceMeasure.php new file mode 100644 index 000000000000..5eb0ccc00196 --- /dev/null +++ b/Datastore/src/V1/FindNearest/DistanceMeasure.php @@ -0,0 +1,82 @@ +google.datastore.v1.FindNearest.DistanceMeasure + */ +class DistanceMeasure +{ + /** + * Should not be set. + * + * Generated from protobuf enum DISTANCE_MEASURE_UNSPECIFIED = 0; + */ + const DISTANCE_MEASURE_UNSPECIFIED = 0; + /** + * Measures the EUCLIDEAN distance between the vectors. See + * [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn + * more. The resulting distance decreases the more similar two vectors are. + * + * Generated from protobuf enum EUCLIDEAN = 1; + */ + const EUCLIDEAN = 1; + /** + * COSINE distance compares vectors based on the angle between them, which + * allows you to measure similarity that isn't based on the vectors + * magnitude. We recommend using DOT_PRODUCT with unit normalized vectors + * instead of COSINE distance, which is mathematically equivalent with + * better performance. See [Cosine + * Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn + * more about COSINE similarity and COSINE distance. The resulting COSINE + * distance decreases the more similar two vectors are. + * + * Generated from protobuf enum COSINE = 2; + */ + const COSINE = 2; + /** + * Similar to cosine but is affected by the magnitude of the vectors. See + * [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more. + * The resulting distance increases the more similar two vectors are. + * + * Generated from protobuf enum DOT_PRODUCT = 3; + */ + const DOT_PRODUCT = 3; + + private static $valueToName = [ + self::DISTANCE_MEASURE_UNSPECIFIED => 'DISTANCE_MEASURE_UNSPECIFIED', + self::EUCLIDEAN => 'EUCLIDEAN', + self::COSINE => 'COSINE', + self::DOT_PRODUCT => 'DOT_PRODUCT', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(DistanceMeasure::class, \Google\Cloud\Datastore\V1\FindNearest_DistanceMeasure::class); + diff --git a/Datastore/src/V1/Query.php b/Datastore/src/V1/Query.php index 0c752662bf17..e89908155e7d 100644 --- a/Datastore/src/V1/Query.php +++ b/Datastore/src/V1/Query.php @@ -10,6 +10,14 @@ /** * A query for entities. + * The query stages are executed in the following order: + * 1. kind + * 2. filter + * 3. projection + * 4. order + start_cursor + end_cursor + * 5. offset + * 6. limit + * 7. find_nearest * * Generated from protobuf message google.datastore.v1.Query */ @@ -85,6 +93,14 @@ class Query extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Int32Value limit = 12; */ private $limit = null; + /** + * Optional. A potential Nearest Neighbors Search. + * Applies after all other filters and ordering. + * Finds the closest vector embeddings to the given query vector. + * + * Generated from protobuf field .google.datastore.v1.FindNearest find_nearest = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $find_nearest = null; /** * Constructor. @@ -126,6 +142,10 @@ class Query extends \Google\Protobuf\Internal\Message * constraints. Optional. * Unspecified is interpreted as no limit. * Must be >= 0 if specified. + * @type \Google\Cloud\Datastore\V1\FindNearest $find_nearest + * Optional. A potential Nearest Neighbors Search. + * Applies after all other filters and ordering. + * Finds the closest vector embeddings to the given query vector. * } */ public function __construct($data = NULL) { @@ -452,5 +472,45 @@ public function setLimitValue($var) $this->writeWrapperValue("limit", $var); return $this;} + /** + * Optional. A potential Nearest Neighbors Search. + * Applies after all other filters and ordering. + * Finds the closest vector embeddings to the given query vector. + * + * Generated from protobuf field .google.datastore.v1.FindNearest find_nearest = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Datastore\V1\FindNearest|null + */ + public function getFindNearest() + { + return $this->find_nearest; + } + + public function hasFindNearest() + { + return isset($this->find_nearest); + } + + public function clearFindNearest() + { + unset($this->find_nearest); + } + + /** + * Optional. A potential Nearest Neighbors Search. + * Applies after all other filters and ordering. + * Finds the closest vector embeddings to the given query vector. + * + * Generated from protobuf field .google.datastore.v1.FindNearest find_nearest = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Datastore\V1\FindNearest $var + * @return $this + */ + public function setFindNearest($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Datastore\V1\FindNearest::class); + $this->find_nearest = $var; + + return $this; + } + } From 72df650c65a54e473aeb0e186901295c40d0c7e8 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:46:55 -0400 Subject: [PATCH 028/157] feat: add messages and fields related to Redis Instances (#7748) feat: add messages and fields related to Redis Clusters feat: add PSC network attachment URI to the InstanceInfo proto feat: add subnet URI and region name to the NetworkInfo proto feat: add firewall policy URI to the FirewallInfo proto feat: add fields related to advertised routes to the RouteInfo proto feat: add region name field to the RouteInfo proto feat: add region name to the ForwardingRuleInfo proto feat: add load balancer name to the ForwardingRuleInfo proto feat: add PSC target fields to the ForwardingRuleInfo proto feat: add more detailed abort and drop causes to corresponding enums chore: update Google API field annotations format docs: update outdated comments in the FirewallInfo proto PiperOrigin-RevId: 686129238 Source-Link: https://github.com/googleapis/googleapis/commit/cab65d56577608266888c9800ba42c2bf4704805 Source-Link: https://github.com/googleapis/googleapis-gen/commit/cd5b0a24acc4c2824dcb0db4e969c3551a9470cf Copy-Tag: eyJwIjoiTmV0d29ya01hbmFnZW1lbnQvLk93bEJvdC55YW1sIiwiaCI6ImNkNWIwYTI0YWNjNGMyODI0ZGNiMGRiNGU5NjljMzU1MWE5NDcwY2YifQ== --- .../metadata/V1/ConnectivityTest.php | Bin 4760 -> 4807 bytes .../metadata/V1/Reachability.php | 33 ++- NetworkManagement/metadata/V1/Trace.php | Bin 15054 -> 17412 bytes .../create_connectivity_test.php | 36 ++- .../delete_connectivity_test.php | 13 +- .../get_connectivity_test.php | 13 +- .../list_connectivity_tests.php | 13 +- .../rerun_connectivity_test.php | 13 +- .../update_connectivity_test.php | 28 +- NetworkManagement/src/V1/AbortInfo/Cause.php | 31 +++ .../V1/Client/ReachabilityServiceClient.php | 18 +- NetworkManagement/src/V1/ConnectivityTest.php | 14 +- .../src/V1/CreateConnectivityTestRequest.php | 7 +- .../src/V1/DeleteConnectivityTestRequest.php | 7 +- NetworkManagement/src/V1/DeliverInfo.php | 72 +++++ .../src/V1/DeliverInfo/Target.php | 23 +- NetworkManagement/src/V1/DropInfo/Cause.php | 184 +++++++++++++ NetworkManagement/src/V1/Endpoint.php | 76 ++++++ NetworkManagement/src/V1/FirewallInfo.php | 104 ++++++-- .../src/V1/ForwardingRuleInfo.php | 184 +++++++++++-- .../src/V1/GetConnectivityTestRequest.php | 7 +- NetworkManagement/src/V1/InstanceInfo.php | 34 +++ .../src/V1/ListConnectivityTestsRequest.php | 7 +- NetworkManagement/src/V1/NetworkInfo.php | 77 +++++- NetworkManagement/src/V1/RedisClusterInfo.php | 249 ++++++++++++++++++ .../src/V1/RedisInstanceInfo.php | 237 +++++++++++++++++ .../src/V1/RerunConnectivityTestRequest.php | 6 +- NetworkManagement/src/V1/RouteInfo.php | 158 +++++++++-- .../src/V1/RouteInfo/RouteType.php | 8 + .../src/V1/ServerlessNegInfo.php | 68 +++++ NetworkManagement/src/V1/Step.php | 102 +++++++ NetworkManagement/src/V1/Step/State.php | 25 ++ ...reachability_service_descriptor_config.php | 1 + .../Client/ReachabilityServiceClientTest.php | 66 ++--- 34 files changed, 1703 insertions(+), 211 deletions(-) create mode 100644 NetworkManagement/src/V1/RedisClusterInfo.php create mode 100644 NetworkManagement/src/V1/RedisInstanceInfo.php create mode 100644 NetworkManagement/src/V1/ServerlessNegInfo.php diff --git a/NetworkManagement/metadata/V1/ConnectivityTest.php b/NetworkManagement/metadata/V1/ConnectivityTest.php index 841f6d992685d1dc82ed3c21740516097179786f..840c90b792b3d775859ed7d5c2706aea0d0adabf 100644 GIT binary patch delta 76 zcmbQCdR%pbCNtxu&05S{jEo$cO<6>k8BcEZVy|J;664}4N=?Zuj?c_1E=kNwPL&W; cVAS9g66NBBh$rWi7MG+JNeFE|$Z?$$05~fabpQYW delta 33 pcmX@EIzx4XCNtyW&05S{jEqd1O<6>k8E0+wVy|J`{FUPpCjg;;3BmvX diff --git a/NetworkManagement/metadata/V1/Reachability.php b/NetworkManagement/metadata/V1/Reachability.php index dbd733b1ad58..20446620128e 100644 --- a/NetworkManagement/metadata/V1/Reachability.php +++ b/NetworkManagement/metadata/V1/Reachability.php @@ -25,10 +25,11 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -Ý -4google/cloud/networkmanagement/v1/reachability.proto!google.cloud.networkmanagement.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto9google/cloud/networkmanagement/v1/connectivity_test.proto#google/longrunning/operations.protogoogle/protobuf/empty.proto google/protobuf/field_mask.protogoogle/protobuf/timestamp.proto"| -ListConnectivityTestsRequest -parent ( BàA +à +4google/cloud/networkmanagement/v1/reachability.proto!google.cloud.networkmanagement.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto9google/cloud/networkmanagement/v1/connectivity_test.proto#google/longrunning/operations.protogoogle/protobuf/empty.proto google/protobuf/field_mask.protogoogle/protobuf/timestamp.proto"¬ +ListConnectivityTestsRequestC +parent ( B3àAúA- ++cloudresourcemanager.googleapis.com/Project page_size ( page_token (  @@ -37,20 +38,24 @@ public static function initOnce() { ListConnectivityTestsResponseF resources ( 23.google.cloud.networkmanagement.v1.ConnectivityTest next_page_token (  - unreachable ( "/ -GetConnectivityTestRequest -name ( BàA"– -CreateConnectivityTestRequest -parent ( BàA + unreachable ( "e +GetConnectivityTestRequestG +name ( B9àAúA3 +1networkmanagement.googleapis.com/ConnectivityTest"Æ +CreateConnectivityTestRequestC +parent ( B3àAúA- ++cloudresourcemanager.googleapis.com/Project test_id ( BàAJ resource ( 23.google.cloud.networkmanagement.v1.ConnectivityTestBàA"¡ UpdateConnectivityTestRequest4 update_mask ( 2.google.protobuf.FieldMaskBàAJ -resource ( 23.google.cloud.networkmanagement.v1.ConnectivityTestBàA"2 -DeleteConnectivityTestRequest -name ( BàA"1 -RerunConnectivityTestRequest -name ( BàA"Ö +resource ( 23.google.cloud.networkmanagement.v1.ConnectivityTestBàA"h +DeleteConnectivityTestRequestG +name ( B9àAúA3 +1networkmanagement.googleapis.com/ConnectivityTest"g +RerunConnectivityTestRequestG +name ( B9àAúA3 +1networkmanagement.googleapis.com/ConnectivityTest"Ö OperationMetadata/ create_time ( 2.google.protobuf.Timestamp, end_time ( 2.google.protobuf.Timestamp diff --git a/NetworkManagement/metadata/V1/Trace.php b/NetworkManagement/metadata/V1/Trace.php index 738b6a5c755c5e209e43bebf8d52dfab781cbae7..58bcbc14658afb5e5b020ac99439c482959152eb 100644 GIT binary patch delta 2151 zcmZuyQEb~}5XNrWwSU^i`MY%{Ytl4HyKY_AZitC#u#wtsV&dAF?R0D~{Yn$lMN5;) zNd^-_)zBpN00`}WLokF85@HA;jF8{~A>Po$03ifINKCxI<9M0`L*nctEJ^p4_`bXQ z?(X~VZZ@5Iom3hYNS-D)$^5t#YgDP!F>mG_oLkU zCRd)RrXRox8fjt+p@)-WrN77VJ1~U;-Yv0@$g$W$+E7kkfvEsa)v4C z+!X!Ve?1aL4|X67Nne$8MKTPcN-1vAsSV#^e7`Vgm~JdC(w9ar&)^seZPp4vsQzr# zK2P%XdcJUO!>ZIt!!GedP}ETD0v!n)+8si8BVR9^vx=nFSOW(S(NB*CB4cK3V08+O5J{;|C%K{r8~y}~efKMHSis94X{$+_yLhs7SY53sT8^tZ7$I3S9W zB6P)+4N2rI=lPwVGSbpCij!@TwxwQ*qR4hwJE1c_o?_TnS$bjjTht#8x(zE=^F^|j zFS}y0NhQBw@k2CmB+ek3J`!R4PLO|X!2g*K`9-T-g3@UvdX#=X;HS4E$9Cdz5KX;m z=hrQ=)+n5}>b%eO8|?Rbe21mCqf?GHImY;K2#wS4=EnDN0gTaTk90U3L?hjL2|8=h zD#QMa=nqrxu^$dOFT@rY`psNuIHzV*?UYL7EElEM<8RY&f*%(YEhiFP%YoL2psCAp z%HR@CCUK2X5-4hDIbD#tB}sCsk;`T^-GoNR@HCq0LbY|>1&h-^r{7^;57Ad zgEM!6+Vf}59ze6JS)s$;@q$b}xx6e3WJ%G440t?>52F3u=(Lnn%rp_wl8_<2_{W?Z z^Yct1jwZ8);96BfHsw{>Jniw#>RL9LO1iyzoZdNjcMR`C(;|G#N}{_1WKkmSfVa5g zu0_$3B3Vi*?q<;82T)R7+-g#hMR@JzDNWCCNq8YMZKGR@3`0_rD-hD1i){J1n&25*>Wo42S#e@#)j7#IgsAoSyF-?6EQ=^ySyS8LJg~B~i0V6#L5>}In ztM4bgntL!^^mNVC1Wn;oJc|-N<7oP|7BFd7oPm`Z0n-+=uWjoJ3619z41(M5cE;}VmODxLzv5wk8U@B_15FIEDR)iGJKj4~_%lif4>ldU)Tv-~+72eUsx F#RAU*T}J=_ diff --git a/NetworkManagement/samples/V1/ReachabilityServiceClient/create_connectivity_test.php b/NetworkManagement/samples/V1/ReachabilityServiceClient/create_connectivity_test.php index b2032d2d9485..42fa394cc492 100644 --- a/NetworkManagement/samples/V1/ReachabilityServiceClient/create_connectivity_test.php +++ b/NetworkManagement/samples/V1/ReachabilityServiceClient/create_connectivity_test.php @@ -46,24 +46,20 @@ * AMBIGUOUS. For more information, * see the Connectivity Test documentation. * - * @param string $parent The parent resource of the Connectivity Test to create: - * `projects/{project_id}/locations/global` - * @param string $testId The logical name of the Connectivity Test in your project - * with the following restrictions: + * @param string $formattedParent The parent resource of the Connectivity Test to create: + * `projects/{project_id}/locations/global` + * Please see {@see ReachabilityServiceClient::projectName()} for help formatting this field. + * @param string $testId The logical name of the Connectivity Test in your project + * with the following restrictions: * - * * Must contain only lowercase letters, numbers, and hyphens. - * * Must start with a letter. - * * Must be between 1-40 characters. - * * Must end with a number or a letter. - * * Must be unique within the customer project - * @param string $resourceName Unique name of the resource using the form: - * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * * Must contain only lowercase letters, numbers, and hyphens. + * * Must start with a letter. + * * Must be between 1-40 characters. + * * Must end with a number or a letter. + * * Must be unique within the customer project */ -function create_connectivity_test_sample( - string $parent, - string $testId, - string $resourceName -): void { +function create_connectivity_test_sample(string $formattedParent, string $testId): void +{ // Create a client. $reachabilityServiceClient = new ReachabilityServiceClient(); @@ -71,11 +67,10 @@ function create_connectivity_test_sample( $resourceSource = new Endpoint(); $resourceDestination = new Endpoint(); $resource = (new ConnectivityTest()) - ->setName($resourceName) ->setSource($resourceSource) ->setDestination($resourceDestination); $request = (new CreateConnectivityTestRequest()) - ->setParent($parent) + ->setParent($formattedParent) ->setTestId($testId) ->setResource($resource); @@ -110,10 +105,9 @@ function create_connectivity_test_sample( */ function callSample(): void { - $parent = '[PARENT]'; + $formattedParent = ReachabilityServiceClient::projectName('[PROJECT]'); $testId = '[TEST_ID]'; - $resourceName = '[NAME]'; - create_connectivity_test_sample($parent, $testId, $resourceName); + create_connectivity_test_sample($formattedParent, $testId); } // [END networkmanagement_v1_generated_ReachabilityService_CreateConnectivityTest_sync] diff --git a/NetworkManagement/samples/V1/ReachabilityServiceClient/delete_connectivity_test.php b/NetworkManagement/samples/V1/ReachabilityServiceClient/delete_connectivity_test.php index bf2f5342673a..cbc34275e1c0 100644 --- a/NetworkManagement/samples/V1/ReachabilityServiceClient/delete_connectivity_test.php +++ b/NetworkManagement/samples/V1/ReachabilityServiceClient/delete_connectivity_test.php @@ -32,17 +32,18 @@ /** * Deletes a specific `ConnectivityTest`. * - * @param string $name Connectivity Test resource name using the form: - * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * @param string $formattedName Connectivity Test resource name using the form: + * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * Please see {@see ReachabilityServiceClient::connectivityTestName()} for help formatting this field. */ -function delete_connectivity_test_sample(string $name): void +function delete_connectivity_test_sample(string $formattedName): void { // Create a client. $reachabilityServiceClient = new ReachabilityServiceClient(); // Prepare the request message. $request = (new DeleteConnectivityTestRequest()) - ->setName($name); + ->setName($formattedName); // Call the API and handle any network failures. try { @@ -73,8 +74,8 @@ function delete_connectivity_test_sample(string $name): void */ function callSample(): void { - $name = '[NAME]'; + $formattedName = ReachabilityServiceClient::connectivityTestName('[PROJECT]', '[TEST]'); - delete_connectivity_test_sample($name); + delete_connectivity_test_sample($formattedName); } // [END networkmanagement_v1_generated_ReachabilityService_DeleteConnectivityTest_sync] diff --git a/NetworkManagement/samples/V1/ReachabilityServiceClient/get_connectivity_test.php b/NetworkManagement/samples/V1/ReachabilityServiceClient/get_connectivity_test.php index 5fa1ba48f793..d54ff9897940 100644 --- a/NetworkManagement/samples/V1/ReachabilityServiceClient/get_connectivity_test.php +++ b/NetworkManagement/samples/V1/ReachabilityServiceClient/get_connectivity_test.php @@ -31,17 +31,18 @@ /** * Gets the details of a specific Connectivity Test. * - * @param string $name `ConnectivityTest` resource name using the form: - * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * @param string $formattedName `ConnectivityTest` resource name using the form: + * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * Please see {@see ReachabilityServiceClient::connectivityTestName()} for help formatting this field. */ -function get_connectivity_test_sample(string $name): void +function get_connectivity_test_sample(string $formattedName): void { // Create a client. $reachabilityServiceClient = new ReachabilityServiceClient(); // Prepare the request message. $request = (new GetConnectivityTestRequest()) - ->setName($name); + ->setName($formattedName); // Call the API and handle any network failures. try { @@ -64,8 +65,8 @@ function get_connectivity_test_sample(string $name): void */ function callSample(): void { - $name = '[NAME]'; + $formattedName = ReachabilityServiceClient::connectivityTestName('[PROJECT]', '[TEST]'); - get_connectivity_test_sample($name); + get_connectivity_test_sample($formattedName); } // [END networkmanagement_v1_generated_ReachabilityService_GetConnectivityTest_sync] diff --git a/NetworkManagement/samples/V1/ReachabilityServiceClient/list_connectivity_tests.php b/NetworkManagement/samples/V1/ReachabilityServiceClient/list_connectivity_tests.php index aa81aa5d1534..3282f4a1ee6a 100644 --- a/NetworkManagement/samples/V1/ReachabilityServiceClient/list_connectivity_tests.php +++ b/NetworkManagement/samples/V1/ReachabilityServiceClient/list_connectivity_tests.php @@ -32,17 +32,18 @@ /** * Lists all Connectivity Tests owned by a project. * - * @param string $parent The parent resource of the Connectivity Tests: - * `projects/{project_id}/locations/global` + * @param string $formattedParent The parent resource of the Connectivity Tests: + * `projects/{project_id}/locations/global` + * Please see {@see ReachabilityServiceClient::projectName()} for help formatting this field. */ -function list_connectivity_tests_sample(string $parent): void +function list_connectivity_tests_sample(string $formattedParent): void { // Create a client. $reachabilityServiceClient = new ReachabilityServiceClient(); // Prepare the request message. $request = (new ListConnectivityTestsRequest()) - ->setParent($parent); + ->setParent($formattedParent); // Call the API and handle any network failures. try { @@ -69,8 +70,8 @@ function list_connectivity_tests_sample(string $parent): void */ function callSample(): void { - $parent = '[PARENT]'; + $formattedParent = ReachabilityServiceClient::projectName('[PROJECT]'); - list_connectivity_tests_sample($parent); + list_connectivity_tests_sample($formattedParent); } // [END networkmanagement_v1_generated_ReachabilityService_ListConnectivityTests_sync] diff --git a/NetworkManagement/samples/V1/ReachabilityServiceClient/rerun_connectivity_test.php b/NetworkManagement/samples/V1/ReachabilityServiceClient/rerun_connectivity_test.php index 5beebc05a823..b60c00cc5640 100644 --- a/NetworkManagement/samples/V1/ReachabilityServiceClient/rerun_connectivity_test.php +++ b/NetworkManagement/samples/V1/ReachabilityServiceClient/rerun_connectivity_test.php @@ -44,17 +44,18 @@ * read permissions to the network configurations of listed projects), then * the reachability result returns a value of `UNKNOWN`. * - * @param string $name Connectivity Test resource name using the form: - * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * @param string $formattedName Connectivity Test resource name using the form: + * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * Please see {@see ReachabilityServiceClient::connectivityTestName()} for help formatting this field. */ -function rerun_connectivity_test_sample(string $name): void +function rerun_connectivity_test_sample(string $formattedName): void { // Create a client. $reachabilityServiceClient = new ReachabilityServiceClient(); // Prepare the request message. $request = (new RerunConnectivityTestRequest()) - ->setName($name); + ->setName($formattedName); // Call the API and handle any network failures. try { @@ -87,8 +88,8 @@ function rerun_connectivity_test_sample(string $name): void */ function callSample(): void { - $name = '[NAME]'; + $formattedName = ReachabilityServiceClient::connectivityTestName('[PROJECT]', '[TEST]'); - rerun_connectivity_test_sample($name); + rerun_connectivity_test_sample($formattedName); } // [END networkmanagement_v1_generated_ReachabilityService_RerunConnectivityTest_sync] diff --git a/NetworkManagement/samples/V1/ReachabilityServiceClient/update_connectivity_test.php b/NetworkManagement/samples/V1/ReachabilityServiceClient/update_connectivity_test.php index 03bd16e73d41..23379ee02d96 100644 --- a/NetworkManagement/samples/V1/ReachabilityServiceClient/update_connectivity_test.php +++ b/NetworkManagement/samples/V1/ReachabilityServiceClient/update_connectivity_test.php @@ -46,12 +46,15 @@ * * If the endpoint specifications in `ConnectivityTest` are incomplete, the * reachability result returns a value of `AMBIGUOUS`. See the documentation - * in `ConnectivityTest` for for more details. + * in `ConnectivityTest` for more details. * - * @param string $resourceName Unique name of the resource using the form: - * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * 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 update_connectivity_test_sample(string $resourceName): void +function update_connectivity_test_sample(): void { // Create a client. $reachabilityServiceClient = new ReachabilityServiceClient(); @@ -61,7 +64,6 @@ function update_connectivity_test_sample(string $resourceName): void $resourceSource = new Endpoint(); $resourceDestination = new Endpoint(); $resource = (new ConnectivityTest()) - ->setName($resourceName) ->setSource($resourceSource) ->setDestination($resourceDestination); $request = (new UpdateConnectivityTestRequest()) @@ -87,20 +89,4 @@ function update_connectivity_test_sample(string $resourceName): void 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 -{ - $resourceName = '[NAME]'; - - update_connectivity_test_sample($resourceName); -} // [END networkmanagement_v1_generated_ReachabilityService_UpdateConnectivityTest_sync] diff --git a/NetworkManagement/src/V1/AbortInfo/Cause.php b/NetworkManagement/src/V1/AbortInfo/Cause.php index 4ad6af599b68..83139256a8e3 100644 --- a/NetworkManagement/src/V1/AbortInfo/Cause.php +++ b/NetworkManagement/src/V1/AbortInfo/Cause.php @@ -82,6 +82,13 @@ class Cause * Generated from protobuf enum UNKNOWN_IP = 2; */ const UNKNOWN_IP = 2; + /** + * Aborted because no endpoint with the packet's destination IP is found in + * the Google-managed project. + * + * Generated from protobuf enum GOOGLE_MANAGED_SERVICE_UNKNOWN_IP = 32; + */ + const GOOGLE_MANAGED_SERVICE_UNKNOWN_IP = 32; /** * Aborted because the source IP address doesn't belong to any of the * subnets of the source VPC network. @@ -110,6 +117,13 @@ class Cause * Generated from protobuf enum PERMISSION_DENIED_NO_NEG_ENDPOINT_CONFIGS = 29; */ const PERMISSION_DENIED_NO_NEG_ENDPOINT_CONFIGS = 29; + /** + * Aborted because user lacks permission to access Cloud Router configs + * required to run the test. + * + * Generated from protobuf enum PERMISSION_DENIED_NO_CLOUD_ROUTER_CONFIGS = 36; + */ + const PERMISSION_DENIED_NO_CLOUD_ROUTER_CONFIGS = 36; /** * Aborted because no valid source or destination endpoint is derived from * the input test request. @@ -207,6 +221,19 @@ class Cause * Generated from protobuf enum SOURCE_PSC_CLOUD_SQL_UNSUPPORTED = 20; */ const SOURCE_PSC_CLOUD_SQL_UNSUPPORTED = 20; + /** + * Aborted because tests with a Redis Cluster as a source are not supported. + * + * Generated from protobuf enum SOURCE_REDIS_CLUSTER_UNSUPPORTED = 34; + */ + const SOURCE_REDIS_CLUSTER_UNSUPPORTED = 34; + /** + * Aborted because tests with a Redis Instance as a source are not + * supported. + * + * Generated from protobuf enum SOURCE_REDIS_INSTANCE_UNSUPPORTED = 35; + */ + const SOURCE_REDIS_INSTANCE_UNSUPPORTED = 35; /** * Aborted because tests with a forwarding rule as a source are not * supported. @@ -246,10 +273,12 @@ class Cause self::DESTINATION_ENDPOINT_NOT_FOUND => 'DESTINATION_ENDPOINT_NOT_FOUND', self::MISMATCHED_DESTINATION_NETWORK => 'MISMATCHED_DESTINATION_NETWORK', self::UNKNOWN_IP => 'UNKNOWN_IP', + self::GOOGLE_MANAGED_SERVICE_UNKNOWN_IP => 'GOOGLE_MANAGED_SERVICE_UNKNOWN_IP', self::SOURCE_IP_ADDRESS_NOT_IN_SOURCE_NETWORK => 'SOURCE_IP_ADDRESS_NOT_IN_SOURCE_NETWORK', self::PERMISSION_DENIED => 'PERMISSION_DENIED', self::PERMISSION_DENIED_NO_CLOUD_NAT_CONFIGS => 'PERMISSION_DENIED_NO_CLOUD_NAT_CONFIGS', self::PERMISSION_DENIED_NO_NEG_ENDPOINT_CONFIGS => 'PERMISSION_DENIED_NO_NEG_ENDPOINT_CONFIGS', + self::PERMISSION_DENIED_NO_CLOUD_ROUTER_CONFIGS => 'PERMISSION_DENIED_NO_CLOUD_ROUTER_CONFIGS', self::NO_SOURCE_LOCATION => 'NO_SOURCE_LOCATION', self::INVALID_ARGUMENT => 'INVALID_ARGUMENT', self::TRACE_TOO_LONG => 'TRACE_TOO_LONG', @@ -264,6 +293,8 @@ class Cause self::ROUTE_CONFIG_NOT_FOUND => 'ROUTE_CONFIG_NOT_FOUND', self::GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT => 'GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT', self::SOURCE_PSC_CLOUD_SQL_UNSUPPORTED => 'SOURCE_PSC_CLOUD_SQL_UNSUPPORTED', + self::SOURCE_REDIS_CLUSTER_UNSUPPORTED => 'SOURCE_REDIS_CLUSTER_UNSUPPORTED', + self::SOURCE_REDIS_INSTANCE_UNSUPPORTED => 'SOURCE_REDIS_INSTANCE_UNSUPPORTED', self::SOURCE_FORWARDING_RULE_UNSUPPORTED => 'SOURCE_FORWARDING_RULE_UNSUPPORTED', self::NON_ROUTABLE_IP_ADDRESS => 'NON_ROUTABLE_IP_ADDRESS', self::UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT => 'UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT', diff --git a/NetworkManagement/src/V1/Client/ReachabilityServiceClient.php b/NetworkManagement/src/V1/Client/ReachabilityServiceClient.php index 488d77ce1be7..8996957f5fdb 100644 --- a/NetworkManagement/src/V1/Client/ReachabilityServiceClient.php +++ b/NetworkManagement/src/V1/Client/ReachabilityServiceClient.php @@ -198,11 +198,27 @@ public static function connectivityTestName(string $project, string $test): stri ]); } + /** + * Formats a string containing the fully-qualified path to represent a project + * resource. + * + * @param string $project + * + * @return string The formatted project resource. + */ + public static function projectName(string $project): string + { + return self::getPathTemplate('project')->render([ + 'project' => $project, + ]); + } + /** * Parses a formatted name string and returns an associative array of the components in the name. * The following name formats are supported: * Template: Pattern * - connectivityTest: projects/{project}/locations/global/connectivityTests/{test} + * - project: projects/{project} * * The optional $template argument can be supplied to specify a particular pattern, * and must match one of the templates listed above. If no $template argument is @@ -474,7 +490,7 @@ public function rerunConnectivityTest( * * If the endpoint specifications in `ConnectivityTest` are incomplete, the * reachability result returns a value of `AMBIGUOUS`. See the documentation - * in `ConnectivityTest` for for more details. + * in `ConnectivityTest` for more details. * * The async variant is * {@see ReachabilityServiceClient::updateConnectivityTestAsync()} . diff --git a/NetworkManagement/src/V1/ConnectivityTest.php b/NetworkManagement/src/V1/ConnectivityTest.php index d2eb35c0ac04..d6a8f62740fe 100644 --- a/NetworkManagement/src/V1/ConnectivityTest.php +++ b/NetworkManagement/src/V1/ConnectivityTest.php @@ -16,10 +16,10 @@ class ConnectivityTest extends \Google\Protobuf\Internal\Message { /** - * Required. Unique name of the resource using the form: + * Identifier. Unique name of the resource using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** @@ -139,7 +139,7 @@ class ConnectivityTest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Required. Unique name of the resource using the form: + * Identifier. Unique name of the resource using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * @type string $description * The user-supplied description of the Connectivity Test. @@ -210,10 +210,10 @@ public function __construct($data = NULL) { } /** - * Required. Unique name of the resource using the form: + * Identifier. Unique name of the resource using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string */ public function getName() @@ -222,10 +222,10 @@ public function getName() } /** - * Required. Unique name of the resource using the form: + * Identifier. Unique name of the resource using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var * @return $this */ diff --git a/NetworkManagement/src/V1/CreateConnectivityTestRequest.php b/NetworkManagement/src/V1/CreateConnectivityTestRequest.php index 04926c31350f..1fdd275480d8 100644 --- a/NetworkManagement/src/V1/CreateConnectivityTestRequest.php +++ b/NetworkManagement/src/V1/CreateConnectivityTestRequest.php @@ -19,7 +19,7 @@ class CreateConnectivityTestRequest extends \Google\Protobuf\Internal\Message * Required. The parent resource of the Connectivity Test to create: * `projects/{project_id}/locations/global` * - * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** @@ -44,6 +44,7 @@ class CreateConnectivityTestRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The parent resource of the Connectivity Test to create: * `projects/{project_id}/locations/global` + * Please see {@see ReachabilityServiceClient::projectName()} for help formatting this field. * @param string $testId Required. The logical name of the Connectivity Test in your project * with the following restrictions: * @@ -96,7 +97,7 @@ public function __construct($data = NULL) { * Required. The parent resource of the Connectivity Test to create: * `projects/{project_id}/locations/global` * - * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getParent() @@ -108,7 +109,7 @@ public function getParent() * Required. The parent resource of the Connectivity Test to create: * `projects/{project_id}/locations/global` * - * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ diff --git a/NetworkManagement/src/V1/DeleteConnectivityTestRequest.php b/NetworkManagement/src/V1/DeleteConnectivityTestRequest.php index e5318082aa1f..32c0612f03aa 100644 --- a/NetworkManagement/src/V1/DeleteConnectivityTestRequest.php +++ b/NetworkManagement/src/V1/DeleteConnectivityTestRequest.php @@ -19,13 +19,14 @@ class DeleteConnectivityTestRequest extends \Google\Protobuf\Internal\Message * Required. Connectivity Test resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** * @param string $name Required. Connectivity Test resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * Please see {@see ReachabilityServiceClient::connectivityTestName()} for help formatting this field. * * @return \Google\Cloud\NetworkManagement\V1\DeleteConnectivityTestRequest * @@ -57,7 +58,7 @@ public function __construct($data = NULL) { * Required. Connectivity Test resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getName() @@ -69,7 +70,7 @@ public function getName() * Required. Connectivity Test resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ diff --git a/NetworkManagement/src/V1/DeliverInfo.php b/NetworkManagement/src/V1/DeliverInfo.php index 89bf7090122b..c21cb8450cb3 100644 --- a/NetworkManagement/src/V1/DeliverInfo.php +++ b/NetworkManagement/src/V1/DeliverInfo.php @@ -33,6 +33,19 @@ class DeliverInfo extends \Google\Protobuf\Internal\Message * Generated from protobuf field string ip_address = 3 [(.google.api.field_info) = { */ protected $ip_address = ''; + /** + * Name of the Cloud Storage Bucket the packet is delivered to (if + * applicable). + * + * Generated from protobuf field string storage_bucket = 4; + */ + protected $storage_bucket = ''; + /** + * PSC Google API target the packet is delivered to (if applicable). + * + * Generated from protobuf field string psc_google_api_target = 5; + */ + protected $psc_google_api_target = ''; /** * Constructor. @@ -46,6 +59,11 @@ class DeliverInfo extends \Google\Protobuf\Internal\Message * URI of the resource that the packet is delivered to. * @type string $ip_address * IP address of the target (if applicable). + * @type string $storage_bucket + * Name of the Cloud Storage Bucket the packet is delivered to (if + * applicable). + * @type string $psc_google_api_target + * PSC Google API target the packet is delivered to (if applicable). * } */ public function __construct($data = NULL) { @@ -131,5 +149,59 @@ public function setIpAddress($var) return $this; } + /** + * Name of the Cloud Storage Bucket the packet is delivered to (if + * applicable). + * + * Generated from protobuf field string storage_bucket = 4; + * @return string + */ + public function getStorageBucket() + { + return $this->storage_bucket; + } + + /** + * Name of the Cloud Storage Bucket the packet is delivered to (if + * applicable). + * + * Generated from protobuf field string storage_bucket = 4; + * @param string $var + * @return $this + */ + public function setStorageBucket($var) + { + GPBUtil::checkString($var, True); + $this->storage_bucket = $var; + + return $this; + } + + /** + * PSC Google API target the packet is delivered to (if applicable). + * + * Generated from protobuf field string psc_google_api_target = 5; + * @return string + */ + public function getPscGoogleApiTarget() + { + return $this->psc_google_api_target; + } + + /** + * PSC Google API target the packet is delivered to (if applicable). + * + * Generated from protobuf field string psc_google_api_target = 5; + * @param string $var + * @return $this + */ + public function setPscGoogleApiTarget($var) + { + GPBUtil::checkString($var, True); + $this->psc_google_api_target = $var; + + return $this; + } + } diff --git a/NetworkManagement/src/V1/DeliverInfo/Target.php b/NetworkManagement/src/V1/DeliverInfo/Target.php index 9f2f8e775efb..5b7310f647e0 100644 --- a/NetworkManagement/src/V1/DeliverInfo/Target.php +++ b/NetworkManagement/src/V1/DeliverInfo/Target.php @@ -57,7 +57,7 @@ class Target */ const PSC_PUBLISHED_SERVICE = 6; /** - * Target is all Google APIs that use [Private Service + * Target is Google APIs that use [Private Service * Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-apis). * * Generated from protobuf enum PSC_GOOGLE_API = 7; @@ -106,6 +106,24 @@ class Target * Generated from protobuf enum CLOUD_RUN_REVISION = 14; */ const CLOUD_RUN_REVISION = 14; + /** + * Target is a Google-managed service. Used only for return traces. + * + * Generated from protobuf enum GOOGLE_MANAGED_SERVICE = 15; + */ + const GOOGLE_MANAGED_SERVICE = 15; + /** + * Target is a Redis Instance. + * + * Generated from protobuf enum REDIS_INSTANCE = 16; + */ + const REDIS_INSTANCE = 16; + /** + * Target is a Redis Cluster. + * + * Generated from protobuf enum REDIS_CLUSTER = 17; + */ + const REDIS_CLUSTER = 17; private static $valueToName = [ self::TARGET_UNSPECIFIED => 'TARGET_UNSPECIFIED', @@ -123,6 +141,9 @@ class Target self::CLOUD_FUNCTION => 'CLOUD_FUNCTION', self::APP_ENGINE_VERSION => 'APP_ENGINE_VERSION', self::CLOUD_RUN_REVISION => 'CLOUD_RUN_REVISION', + self::GOOGLE_MANAGED_SERVICE => 'GOOGLE_MANAGED_SERVICE', + self::REDIS_INSTANCE => 'REDIS_INSTANCE', + self::REDIS_CLUSTER => 'REDIS_CLUSTER', ]; public static function name($value) diff --git a/NetworkManagement/src/V1/DropInfo/Cause.php b/NetworkManagement/src/V1/DropInfo/Cause.php index ea2af29e0c9d..226a8444f9d8 100644 --- a/NetworkManagement/src/V1/DropInfo/Cause.php +++ b/NetworkManagement/src/V1/DropInfo/Cause.php @@ -201,6 +201,18 @@ class Cause * Generated from protobuf enum CLOUD_SQL_INSTANCE_NOT_RUNNING = 28; */ const CLOUD_SQL_INSTANCE_NOT_RUNNING = 28; + /** + * Packet sent from or to a Redis Instance that is not in running state. + * + * Generated from protobuf enum REDIS_INSTANCE_NOT_RUNNING = 68; + */ + const REDIS_INSTANCE_NOT_RUNNING = 68; + /** + * Packet sent from or to a Redis Cluster that is not in running state. + * + * Generated from protobuf enum REDIS_CLUSTER_NOT_RUNNING = 69; + */ + const REDIS_CLUSTER_NOT_RUNNING = 69; /** * The type of traffic is blocked and the user cannot configure a firewall * rule to enable it. See [Always blocked @@ -311,6 +323,14 @@ class Cause * Generated from protobuf enum CLOUD_SQL_INSTANCE_NO_ROUTE = 35; */ const CLOUD_SQL_INSTANCE_NO_ROUTE = 35; + /** + * Packet was dropped because the Cloud SQL instance requires all + * connections to use Cloud SQL connectors and to target the Cloud SQL proxy + * port (3307). + * + * Generated from protobuf enum CLOUD_SQL_CONNECTOR_REQUIRED = 63; + */ + const CLOUD_SQL_CONNECTOR_REQUIRED = 63; /** * Packet could be dropped because the Cloud Function is not in an active * status. @@ -331,6 +351,20 @@ class Cause * Generated from protobuf enum VPC_CONNECTOR_NOT_RUNNING = 24; */ const VPC_CONNECTOR_NOT_RUNNING = 24; + /** + * Packet could be dropped because the traffic from the serverless service + * to the VPC connector is not allowed. + * + * Generated from protobuf enum VPC_CONNECTOR_SERVERLESS_TRAFFIC_BLOCKED = 60; + */ + const VPC_CONNECTOR_SERVERLESS_TRAFFIC_BLOCKED = 60; + /** + * Packet could be dropped because the health check traffic to the VPC + * connector is not allowed. + * + * Generated from protobuf enum VPC_CONNECTOR_HEALTH_CHECK_TRAFFIC_BLOCKED = 61; + */ + const VPC_CONNECTOR_HEALTH_CHECK_TRAFFIC_BLOCKED = 61; /** * Packet could be dropped because it was sent from a different region * to a regional forwarding without global access. @@ -383,6 +417,13 @@ class Cause * Generated from protobuf enum NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT = 57; */ const NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT = 57; + /** + * PSC endpoint is accessed via NCC, but PSC transitivity configuration is + * not yet propagated. + * + * Generated from protobuf enum PSC_TRANSITIVITY_NOT_PROPAGATED = 64; + */ + const PSC_TRANSITIVITY_NOT_PROPAGATED = 64; /** * The packet sent from the hybrid NEG proxy matches a non-dynamic route, * but such a configuration is not supported. @@ -429,6 +470,126 @@ class Cause * Generated from protobuf enum ROUTING_LOOP = 59; */ const ROUTING_LOOP = 59; + /** + * Packet is dropped inside a Google-managed service due to being delivered + * in return trace to an endpoint that doesn't match the endpoint the packet + * was sent from in forward trace. Used only for return traces. + * + * Generated from protobuf enum DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE = 62; + */ + const DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE = 62; + /** + * Packet is dropped due to a load balancer backend instance not having a + * network interface in the network expected by the load balancer. + * + * Generated from protobuf enum LOAD_BALANCER_BACKEND_INVALID_NETWORK = 65; + */ + const LOAD_BALANCER_BACKEND_INVALID_NETWORK = 65; + /** + * Packet is dropped due to a backend service named port not being defined + * on the instance group level. + * + * Generated from protobuf enum BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED = 66; + */ + const BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED = 66; + /** + * Packet is dropped due to a destination IP range being part of a Private + * NAT IP range. + * + * Generated from protobuf enum DESTINATION_IS_PRIVATE_NAT_IP_RANGE = 67; + */ + const DESTINATION_IS_PRIVATE_NAT_IP_RANGE = 67; + /** + * Generic drop cause for a packet being dropped inside a Redis Instance + * service project. + * + * Generated from protobuf enum DROPPED_INSIDE_REDIS_INSTANCE_SERVICE = 70; + */ + const DROPPED_INSIDE_REDIS_INSTANCE_SERVICE = 70; + /** + * Packet is dropped due to an unsupported port being used to connect to a + * Redis Instance. Port 6379 should be used to connect to a Redis Instance. + * + * Generated from protobuf enum REDIS_INSTANCE_UNSUPPORTED_PORT = 71; + */ + const REDIS_INSTANCE_UNSUPPORTED_PORT = 71; + /** + * Packet is dropped due to connecting from PUPI address to a PSA based + * Redis Instance. + * + * Generated from protobuf enum REDIS_INSTANCE_CONNECTING_FROM_PUPI_ADDRESS = 72; + */ + const REDIS_INSTANCE_CONNECTING_FROM_PUPI_ADDRESS = 72; + /** + * Packet is dropped due to no route to the destination network. + * + * Generated from protobuf enum REDIS_INSTANCE_NO_ROUTE_TO_DESTINATION_NETWORK = 73; + */ + const REDIS_INSTANCE_NO_ROUTE_TO_DESTINATION_NETWORK = 73; + /** + * Redis Instance does not have an external IP address. + * + * Generated from protobuf enum REDIS_INSTANCE_NO_EXTERNAL_IP = 74; + */ + const REDIS_INSTANCE_NO_EXTERNAL_IP = 74; + /** + * Packet is dropped due to an unsupported protocol being used to connect to + * a Redis Instance. Only TCP connections are accepted by a Redis Instance. + * + * Generated from protobuf enum REDIS_INSTANCE_UNSUPPORTED_PROTOCOL = 78; + */ + const REDIS_INSTANCE_UNSUPPORTED_PROTOCOL = 78; + /** + * Generic drop cause for a packet being dropped inside a Redis Cluster + * service project. + * + * Generated from protobuf enum DROPPED_INSIDE_REDIS_CLUSTER_SERVICE = 75; + */ + const DROPPED_INSIDE_REDIS_CLUSTER_SERVICE = 75; + /** + * Packet is dropped due to an unsupported port being used to connect to a + * Redis Cluster. Ports 6379 and 11000 to 13047 should be used to connect to + * a Redis Cluster. + * + * Generated from protobuf enum REDIS_CLUSTER_UNSUPPORTED_PORT = 76; + */ + const REDIS_CLUSTER_UNSUPPORTED_PORT = 76; + /** + * Redis Cluster does not have an external IP address. + * + * Generated from protobuf enum REDIS_CLUSTER_NO_EXTERNAL_IP = 77; + */ + const REDIS_CLUSTER_NO_EXTERNAL_IP = 77; + /** + * Packet is dropped due to an unsupported protocol being used to connect to + * a Redis Cluster. Only TCP connections are accepted by a Redis Cluster. + * + * Generated from protobuf enum REDIS_CLUSTER_UNSUPPORTED_PROTOCOL = 79; + */ + const REDIS_CLUSTER_UNSUPPORTED_PROTOCOL = 79; + /** + * Packet from the non-GCP (on-prem) or unknown GCP network is dropped due + * to the destination IP address not belonging to any IP prefix advertised + * via BGP by the Cloud Router. + * + * Generated from protobuf enum NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION = 80; + */ + const NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION = 80; + /** + * Packet from the non-GCP (on-prem) or unknown GCP network is dropped due + * to the destination IP address not belonging to any IP prefix included to + * the local traffic selector of the VPN tunnel. + * + * Generated from protobuf enum NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION = 81; + */ + const NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION = 81; + /** + * Packet from the unknown peered network is dropped due to no known route + * from the source network to the destination IP address. + * + * Generated from protobuf enum NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION = 82; + */ + const NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION = 82; private static $valueToName = [ self::CAUSE_UNSPECIFIED => 'CAUSE_UNSPECIFIED', @@ -459,6 +620,8 @@ class Cause self::INSTANCE_NOT_RUNNING => 'INSTANCE_NOT_RUNNING', self::GKE_CLUSTER_NOT_RUNNING => 'GKE_CLUSTER_NOT_RUNNING', self::CLOUD_SQL_INSTANCE_NOT_RUNNING => 'CLOUD_SQL_INSTANCE_NOT_RUNNING', + self::REDIS_INSTANCE_NOT_RUNNING => 'REDIS_INSTANCE_NOT_RUNNING', + self::REDIS_CLUSTER_NOT_RUNNING => 'REDIS_CLUSTER_NOT_RUNNING', self::TRAFFIC_TYPE_BLOCKED => 'TRAFFIC_TYPE_BLOCKED', self::GKE_MASTER_UNAUTHORIZED_ACCESS => 'GKE_MASTER_UNAUTHORIZED_ACCESS', self::CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS => 'CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS', @@ -474,9 +637,12 @@ class Cause self::CLOUD_SQL_INSTANCE_NOT_CONFIGURED_FOR_EXTERNAL_TRAFFIC => 'CLOUD_SQL_INSTANCE_NOT_CONFIGURED_FOR_EXTERNAL_TRAFFIC', self::PUBLIC_CLOUD_SQL_INSTANCE_TO_PRIVATE_DESTINATION => 'PUBLIC_CLOUD_SQL_INSTANCE_TO_PRIVATE_DESTINATION', self::CLOUD_SQL_INSTANCE_NO_ROUTE => 'CLOUD_SQL_INSTANCE_NO_ROUTE', + self::CLOUD_SQL_CONNECTOR_REQUIRED => 'CLOUD_SQL_CONNECTOR_REQUIRED', self::CLOUD_FUNCTION_NOT_ACTIVE => 'CLOUD_FUNCTION_NOT_ACTIVE', self::VPC_CONNECTOR_NOT_SET => 'VPC_CONNECTOR_NOT_SET', self::VPC_CONNECTOR_NOT_RUNNING => 'VPC_CONNECTOR_NOT_RUNNING', + self::VPC_CONNECTOR_SERVERLESS_TRAFFIC_BLOCKED => 'VPC_CONNECTOR_SERVERLESS_TRAFFIC_BLOCKED', + self::VPC_CONNECTOR_HEALTH_CHECK_TRAFFIC_BLOCKED => 'VPC_CONNECTOR_HEALTH_CHECK_TRAFFIC_BLOCKED', self::FORWARDING_RULE_REGION_MISMATCH => 'FORWARDING_RULE_REGION_MISMATCH', self::PSC_CONNECTION_NOT_ACCEPTED => 'PSC_CONNECTION_NOT_ACCEPTED', self::PSC_ENDPOINT_ACCESSED_FROM_PEERED_NETWORK => 'PSC_ENDPOINT_ACCESSED_FROM_PEERED_NETWORK', @@ -484,6 +650,7 @@ class Cause self::PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS => 'PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS', self::CLOUD_SQL_PSC_NEG_UNSUPPORTED => 'CLOUD_SQL_PSC_NEG_UNSUPPORTED', self::NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT => 'NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT', + self::PSC_TRANSITIVITY_NOT_PROPAGATED => 'PSC_TRANSITIVITY_NOT_PROPAGATED', self::HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED => 'HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED', self::HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED => 'HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED', self::CLOUD_RUN_REVISION_NOT_READY => 'CLOUD_RUN_REVISION_NOT_READY', @@ -491,6 +658,23 @@ class Cause self::LOAD_BALANCER_HAS_NO_PROXY_SUBNET => 'LOAD_BALANCER_HAS_NO_PROXY_SUBNET', self::CLOUD_NAT_NO_ADDRESSES => 'CLOUD_NAT_NO_ADDRESSES', self::ROUTING_LOOP => 'ROUTING_LOOP', + self::DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE => 'DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE', + self::LOAD_BALANCER_BACKEND_INVALID_NETWORK => 'LOAD_BALANCER_BACKEND_INVALID_NETWORK', + self::BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED => 'BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED', + self::DESTINATION_IS_PRIVATE_NAT_IP_RANGE => 'DESTINATION_IS_PRIVATE_NAT_IP_RANGE', + self::DROPPED_INSIDE_REDIS_INSTANCE_SERVICE => 'DROPPED_INSIDE_REDIS_INSTANCE_SERVICE', + self::REDIS_INSTANCE_UNSUPPORTED_PORT => 'REDIS_INSTANCE_UNSUPPORTED_PORT', + self::REDIS_INSTANCE_CONNECTING_FROM_PUPI_ADDRESS => 'REDIS_INSTANCE_CONNECTING_FROM_PUPI_ADDRESS', + self::REDIS_INSTANCE_NO_ROUTE_TO_DESTINATION_NETWORK => 'REDIS_INSTANCE_NO_ROUTE_TO_DESTINATION_NETWORK', + self::REDIS_INSTANCE_NO_EXTERNAL_IP => 'REDIS_INSTANCE_NO_EXTERNAL_IP', + self::REDIS_INSTANCE_UNSUPPORTED_PROTOCOL => 'REDIS_INSTANCE_UNSUPPORTED_PROTOCOL', + self::DROPPED_INSIDE_REDIS_CLUSTER_SERVICE => 'DROPPED_INSIDE_REDIS_CLUSTER_SERVICE', + self::REDIS_CLUSTER_UNSUPPORTED_PORT => 'REDIS_CLUSTER_UNSUPPORTED_PORT', + self::REDIS_CLUSTER_NO_EXTERNAL_IP => 'REDIS_CLUSTER_NO_EXTERNAL_IP', + self::REDIS_CLUSTER_UNSUPPORTED_PROTOCOL => 'REDIS_CLUSTER_UNSUPPORTED_PROTOCOL', + self::NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION => 'NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION', + self::NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION => 'NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION', + self::NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION => 'NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION', ]; public static function name($value) diff --git a/NetworkManagement/src/V1/Endpoint.php b/NetworkManagement/src/V1/Endpoint.php index 882249111f50..1ea2ffa0a266 100644 --- a/NetworkManagement/src/V1/Endpoint.php +++ b/NetworkManagement/src/V1/Endpoint.php @@ -77,6 +77,20 @@ class Endpoint extends \Google\Protobuf\Internal\Message * Generated from protobuf field string cloud_sql_instance = 8; */ protected $cloud_sql_instance = ''; + /** + * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) + * URI. + * + * Generated from protobuf field string redis_instance = 17; + */ + protected $redis_instance = ''; + /** + * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) + * URI. + * + * Generated from protobuf field string redis_cluster = 18; + */ + protected $redis_cluster = ''; /** * A [Cloud Function](https://cloud.google.com/functions). * @@ -158,6 +172,12 @@ class Endpoint extends \Google\Protobuf\Internal\Message * master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). * @type string $cloud_sql_instance * A [Cloud SQL](https://cloud.google.com/sql) instance URI. + * @type string $redis_instance + * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) + * URI. + * @type string $redis_cluster + * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) + * URI. * @type \Google\Cloud\NetworkManagement\V1\Endpoint\CloudFunctionEndpoint $cloud_function * A [Cloud Function](https://cloud.google.com/functions). * @type \Google\Cloud\NetworkManagement\V1\Endpoint\AppEngineVersionEndpoint $app_engine_version @@ -469,6 +489,62 @@ public function setCloudSqlInstance($var) return $this; } + /** + * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) + * URI. + * + * Generated from protobuf field string redis_instance = 17; + * @return string + */ + public function getRedisInstance() + { + return $this->redis_instance; + } + + /** + * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) + * URI. + * + * Generated from protobuf field string redis_instance = 17; + * @param string $var + * @return $this + */ + public function setRedisInstance($var) + { + GPBUtil::checkString($var, True); + $this->redis_instance = $var; + + return $this; + } + + /** + * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) + * URI. + * + * Generated from protobuf field string redis_cluster = 18; + * @return string + */ + public function getRedisCluster() + { + return $this->redis_cluster; + } + + /** + * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) + * URI. + * + * Generated from protobuf field string redis_cluster = 18; + * @param string $var + * @return $this + */ + public function setRedisCluster($var) + { + GPBUtil::checkString($var, True); + $this->redis_cluster = $var; + + return $this; + } + /** * A [Cloud Function](https://cloud.google.com/functions). * diff --git a/NetworkManagement/src/V1/FirewallInfo.php b/NetworkManagement/src/V1/FirewallInfo.php index 116158a17d76..7f3337c1308b 100644 --- a/NetworkManagement/src/V1/FirewallInfo.php +++ b/NetworkManagement/src/V1/FirewallInfo.php @@ -10,22 +10,22 @@ /** * For display only. Metadata associated with a VPC firewall rule, an implied - * VPC firewall rule, or a hierarchical firewall policy rule. + * VPC firewall rule, or a firewall policy rule. * * Generated from protobuf message google.cloud.networkmanagement.v1.FirewallInfo */ class FirewallInfo extends \Google\Protobuf\Internal\Message { /** - * The display name of the VPC firewall rule. This field is not applicable - * to hierarchical firewall policy rules. + * The display name of the firewall rule. This field might be empty for + * firewall policy rules. * * Generated from protobuf field string display_name = 1; */ protected $display_name = ''; /** - * The URI of the VPC firewall rule. This field is not applicable to - * implied firewall rules or hierarchical firewall policy rules. + * The URI of the firewall rule. This field is not applicable to implied + * VPC firewall rules. * * Generated from protobuf field string uri = 2; */ @@ -57,7 +57,7 @@ class FirewallInfo extends \Google\Protobuf\Internal\Message protected $network_uri = ''; /** * The target tags defined by the VPC firewall rule. This field is not - * applicable to hierarchical firewall policy rules. + * applicable to firewall policy rules. * * Generated from protobuf field repeated string target_tags = 7; */ @@ -69,12 +69,21 @@ class FirewallInfo extends \Google\Protobuf\Internal\Message */ private $target_service_accounts; /** - * The hierarchical firewall policy that this rule is associated with. - * This field is not applicable to VPC firewall rules. + * The name of the firewall policy that this rule is associated with. + * This field is not applicable to VPC firewall rules and implied VPC firewall + * rules. * * Generated from protobuf field string policy = 9; */ protected $policy = ''; + /** + * The URI of the firewall policy that this rule is associated with. + * This field is not applicable to VPC firewall rules and implied VPC firewall + * rules. + * + * Generated from protobuf field string policy_uri = 11; + */ + protected $policy_uri = ''; /** * The firewall rule's type. * @@ -89,11 +98,11 @@ class FirewallInfo extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $display_name - * The display name of the VPC firewall rule. This field is not applicable - * to hierarchical firewall policy rules. + * The display name of the firewall rule. This field might be empty for + * firewall policy rules. * @type string $uri - * The URI of the VPC firewall rule. This field is not applicable to - * implied firewall rules or hierarchical firewall policy rules. + * The URI of the firewall rule. This field is not applicable to implied + * VPC firewall rules. * @type string $direction * Possible values: INGRESS, EGRESS * @type string $action @@ -105,12 +114,17 @@ class FirewallInfo extends \Google\Protobuf\Internal\Message * This field is not applicable to hierarchical firewall policy rules. * @type array|\Google\Protobuf\Internal\RepeatedField $target_tags * The target tags defined by the VPC firewall rule. This field is not - * applicable to hierarchical firewall policy rules. + * applicable to firewall policy rules. * @type array|\Google\Protobuf\Internal\RepeatedField $target_service_accounts * The target service accounts specified by the firewall rule. * @type string $policy - * The hierarchical firewall policy that this rule is associated with. - * This field is not applicable to VPC firewall rules. + * The name of the firewall policy that this rule is associated with. + * This field is not applicable to VPC firewall rules and implied VPC firewall + * rules. + * @type string $policy_uri + * The URI of the firewall policy that this rule is associated with. + * This field is not applicable to VPC firewall rules and implied VPC firewall + * rules. * @type int $firewall_rule_type * The firewall rule's type. * } @@ -121,8 +135,8 @@ public function __construct($data = NULL) { } /** - * The display name of the VPC firewall rule. This field is not applicable - * to hierarchical firewall policy rules. + * The display name of the firewall rule. This field might be empty for + * firewall policy rules. * * Generated from protobuf field string display_name = 1; * @return string @@ -133,8 +147,8 @@ public function getDisplayName() } /** - * The display name of the VPC firewall rule. This field is not applicable - * to hierarchical firewall policy rules. + * The display name of the firewall rule. This field might be empty for + * firewall policy rules. * * Generated from protobuf field string display_name = 1; * @param string $var @@ -149,8 +163,8 @@ public function setDisplayName($var) } /** - * The URI of the VPC firewall rule. This field is not applicable to - * implied firewall rules or hierarchical firewall policy rules. + * The URI of the firewall rule. This field is not applicable to implied + * VPC firewall rules. * * Generated from protobuf field string uri = 2; * @return string @@ -161,8 +175,8 @@ public function getUri() } /** - * The URI of the VPC firewall rule. This field is not applicable to - * implied firewall rules or hierarchical firewall policy rules. + * The URI of the firewall rule. This field is not applicable to implied + * VPC firewall rules. * * Generated from protobuf field string uri = 2; * @param string $var @@ -284,7 +298,7 @@ public function setNetworkUri($var) /** * The target tags defined by the VPC firewall rule. This field is not - * applicable to hierarchical firewall policy rules. + * applicable to firewall policy rules. * * Generated from protobuf field repeated string target_tags = 7; * @return \Google\Protobuf\Internal\RepeatedField @@ -296,7 +310,7 @@ public function getTargetTags() /** * The target tags defined by the VPC firewall rule. This field is not - * applicable to hierarchical firewall policy rules. + * applicable to firewall policy rules. * * Generated from protobuf field repeated string target_tags = 7; * @param array|\Google\Protobuf\Internal\RepeatedField $var @@ -337,8 +351,9 @@ public function setTargetServiceAccounts($var) } /** - * The hierarchical firewall policy that this rule is associated with. - * This field is not applicable to VPC firewall rules. + * The name of the firewall policy that this rule is associated with. + * This field is not applicable to VPC firewall rules and implied VPC firewall + * rules. * * Generated from protobuf field string policy = 9; * @return string @@ -349,8 +364,9 @@ public function getPolicy() } /** - * The hierarchical firewall policy that this rule is associated with. - * This field is not applicable to VPC firewall rules. + * The name of the firewall policy that this rule is associated with. + * This field is not applicable to VPC firewall rules and implied VPC firewall + * rules. * * Generated from protobuf field string policy = 9; * @param string $var @@ -364,6 +380,36 @@ public function setPolicy($var) return $this; } + /** + * The URI of the firewall policy that this rule is associated with. + * This field is not applicable to VPC firewall rules and implied VPC firewall + * rules. + * + * Generated from protobuf field string policy_uri = 11; + * @return string + */ + public function getPolicyUri() + { + return $this->policy_uri; + } + + /** + * The URI of the firewall policy that this rule is associated with. + * This field is not applicable to VPC firewall rules and implied VPC firewall + * rules. + * + * Generated from protobuf field string policy_uri = 11; + * @param string $var + * @return $this + */ + public function setPolicyUri($var) + { + GPBUtil::checkString($var, True); + $this->policy_uri = $var; + + return $this; + } + /** * The firewall rule's type. * diff --git a/NetworkManagement/src/V1/ForwardingRuleInfo.php b/NetworkManagement/src/V1/ForwardingRuleInfo.php index 14cffe6e3ef0..831116bed4ee 100644 --- a/NetworkManagement/src/V1/ForwardingRuleInfo.php +++ b/NetworkManagement/src/V1/ForwardingRuleInfo.php @@ -16,25 +16,25 @@ class ForwardingRuleInfo extends \Google\Protobuf\Internal\Message { /** - * Name of a Compute Engine forwarding rule. + * Name of the forwarding rule. * * Generated from protobuf field string display_name = 1; */ protected $display_name = ''; /** - * URI of a Compute Engine forwarding rule. + * URI of the forwarding rule. * * Generated from protobuf field string uri = 2; */ protected $uri = ''; /** - * Protocol defined in the forwarding rule that matches the test. + * Protocol defined in the forwarding rule that matches the packet. * * Generated from protobuf field string matched_protocol = 3; */ protected $matched_protocol = ''; /** - * Port range defined in the forwarding rule that matches the test. + * Port range defined in the forwarding rule that matches the packet. * * Generated from protobuf field string matched_port_range = 6; */ @@ -52,11 +52,37 @@ class ForwardingRuleInfo extends \Google\Protobuf\Internal\Message */ protected $target = ''; /** - * Network URI. Only valid for Internal Load Balancer. + * Network URI. * * Generated from protobuf field string network_uri = 7; */ protected $network_uri = ''; + /** + * Region of the forwarding rule. Set only for regional forwarding rules. + * + * Generated from protobuf field string region = 8; + */ + protected $region = ''; + /** + * Name of the load balancer the forwarding rule belongs to. Empty for + * forwarding rules not related to load balancers (like PSC forwarding rules). + * + * Generated from protobuf field string load_balancer_name = 9; + */ + protected $load_balancer_name = ''; + /** + * URI of the PSC service attachment this forwarding rule targets (if + * applicable). + * + * Generated from protobuf field string psc_service_attachment_uri = 10; + */ + protected $psc_service_attachment_uri = ''; + /** + * PSC Google API target this forwarding rule targets (if applicable). + * + * Generated from protobuf field string psc_google_api_target = 11; + */ + protected $psc_google_api_target = ''; /** * Constructor. @@ -65,19 +91,29 @@ class ForwardingRuleInfo extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $display_name - * Name of a Compute Engine forwarding rule. + * Name of the forwarding rule. * @type string $uri - * URI of a Compute Engine forwarding rule. + * URI of the forwarding rule. * @type string $matched_protocol - * Protocol defined in the forwarding rule that matches the test. + * Protocol defined in the forwarding rule that matches the packet. * @type string $matched_port_range - * Port range defined in the forwarding rule that matches the test. + * Port range defined in the forwarding rule that matches the packet. * @type string $vip * VIP of the forwarding rule. * @type string $target * Target type of the forwarding rule. * @type string $network_uri - * Network URI. Only valid for Internal Load Balancer. + * Network URI. + * @type string $region + * Region of the forwarding rule. Set only for regional forwarding rules. + * @type string $load_balancer_name + * Name of the load balancer the forwarding rule belongs to. Empty for + * forwarding rules not related to load balancers (like PSC forwarding rules). + * @type string $psc_service_attachment_uri + * URI of the PSC service attachment this forwarding rule targets (if + * applicable). + * @type string $psc_google_api_target + * PSC Google API target this forwarding rule targets (if applicable). * } */ public function __construct($data = NULL) { @@ -86,7 +122,7 @@ public function __construct($data = NULL) { } /** - * Name of a Compute Engine forwarding rule. + * Name of the forwarding rule. * * Generated from protobuf field string display_name = 1; * @return string @@ -97,7 +133,7 @@ public function getDisplayName() } /** - * Name of a Compute Engine forwarding rule. + * Name of the forwarding rule. * * Generated from protobuf field string display_name = 1; * @param string $var @@ -112,7 +148,7 @@ public function setDisplayName($var) } /** - * URI of a Compute Engine forwarding rule. + * URI of the forwarding rule. * * Generated from protobuf field string uri = 2; * @return string @@ -123,7 +159,7 @@ public function getUri() } /** - * URI of a Compute Engine forwarding rule. + * URI of the forwarding rule. * * Generated from protobuf field string uri = 2; * @param string $var @@ -138,7 +174,7 @@ public function setUri($var) } /** - * Protocol defined in the forwarding rule that matches the test. + * Protocol defined in the forwarding rule that matches the packet. * * Generated from protobuf field string matched_protocol = 3; * @return string @@ -149,7 +185,7 @@ public function getMatchedProtocol() } /** - * Protocol defined in the forwarding rule that matches the test. + * Protocol defined in the forwarding rule that matches the packet. * * Generated from protobuf field string matched_protocol = 3; * @param string $var @@ -164,7 +200,7 @@ public function setMatchedProtocol($var) } /** - * Port range defined in the forwarding rule that matches the test. + * Port range defined in the forwarding rule that matches the packet. * * Generated from protobuf field string matched_port_range = 6; * @return string @@ -175,7 +211,7 @@ public function getMatchedPortRange() } /** - * Port range defined in the forwarding rule that matches the test. + * Port range defined in the forwarding rule that matches the packet. * * Generated from protobuf field string matched_port_range = 6; * @param string $var @@ -242,7 +278,7 @@ public function setTarget($var) } /** - * Network URI. Only valid for Internal Load Balancer. + * Network URI. * * Generated from protobuf field string network_uri = 7; * @return string @@ -253,7 +289,7 @@ public function getNetworkUri() } /** - * Network URI. Only valid for Internal Load Balancer. + * Network URI. * * Generated from protobuf field string network_uri = 7; * @param string $var @@ -267,5 +303,113 @@ public function setNetworkUri($var) return $this; } + /** + * Region of the forwarding rule. Set only for regional forwarding rules. + * + * Generated from protobuf field string region = 8; + * @return string + */ + public function getRegion() + { + return $this->region; + } + + /** + * Region of the forwarding rule. Set only for regional forwarding rules. + * + * Generated from protobuf field string region = 8; + * @param string $var + * @return $this + */ + public function setRegion($var) + { + GPBUtil::checkString($var, True); + $this->region = $var; + + return $this; + } + + /** + * Name of the load balancer the forwarding rule belongs to. Empty for + * forwarding rules not related to load balancers (like PSC forwarding rules). + * + * Generated from protobuf field string load_balancer_name = 9; + * @return string + */ + public function getLoadBalancerName() + { + return $this->load_balancer_name; + } + + /** + * Name of the load balancer the forwarding rule belongs to. Empty for + * forwarding rules not related to load balancers (like PSC forwarding rules). + * + * Generated from protobuf field string load_balancer_name = 9; + * @param string $var + * @return $this + */ + public function setLoadBalancerName($var) + { + GPBUtil::checkString($var, True); + $this->load_balancer_name = $var; + + return $this; + } + + /** + * URI of the PSC service attachment this forwarding rule targets (if + * applicable). + * + * Generated from protobuf field string psc_service_attachment_uri = 10; + * @return string + */ + public function getPscServiceAttachmentUri() + { + return $this->psc_service_attachment_uri; + } + + /** + * URI of the PSC service attachment this forwarding rule targets (if + * applicable). + * + * Generated from protobuf field string psc_service_attachment_uri = 10; + * @param string $var + * @return $this + */ + public function setPscServiceAttachmentUri($var) + { + GPBUtil::checkString($var, True); + $this->psc_service_attachment_uri = $var; + + return $this; + } + + /** + * PSC Google API target this forwarding rule targets (if applicable). + * + * Generated from protobuf field string psc_google_api_target = 11; + * @return string + */ + public function getPscGoogleApiTarget() + { + return $this->psc_google_api_target; + } + + /** + * PSC Google API target this forwarding rule targets (if applicable). + * + * Generated from protobuf field string psc_google_api_target = 11; + * @param string $var + * @return $this + */ + public function setPscGoogleApiTarget($var) + { + GPBUtil::checkString($var, True); + $this->psc_google_api_target = $var; + + return $this; + } + } diff --git a/NetworkManagement/src/V1/GetConnectivityTestRequest.php b/NetworkManagement/src/V1/GetConnectivityTestRequest.php index d85b7ebb7475..dcd27f465a8a 100644 --- a/NetworkManagement/src/V1/GetConnectivityTestRequest.php +++ b/NetworkManagement/src/V1/GetConnectivityTestRequest.php @@ -19,13 +19,14 @@ class GetConnectivityTestRequest extends \Google\Protobuf\Internal\Message * Required. `ConnectivityTest` resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** * @param string $name Required. `ConnectivityTest` resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` + * Please see {@see ReachabilityServiceClient::connectivityTestName()} for help formatting this field. * * @return \Google\Cloud\NetworkManagement\V1\GetConnectivityTestRequest * @@ -57,7 +58,7 @@ public function __construct($data = NULL) { * Required. `ConnectivityTest` resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getName() @@ -69,7 +70,7 @@ public function getName() * Required. `ConnectivityTest` resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ diff --git a/NetworkManagement/src/V1/InstanceInfo.php b/NetworkManagement/src/V1/InstanceInfo.php index 0dab4eebffcc..a4e9c57509fd 100644 --- a/NetworkManagement/src/V1/InstanceInfo.php +++ b/NetworkManagement/src/V1/InstanceInfo.php @@ -64,6 +64,12 @@ class InstanceInfo extends \Google\Protobuf\Internal\Message * @deprecated */ protected $service_account = ''; + /** + * URI of the PSC network attachment the NIC is attached to (if relevant). + * + * Generated from protobuf field string psc_network_attachment_uri = 9; + */ + protected $psc_network_attachment_uri = ''; /** * Constructor. @@ -87,6 +93,8 @@ class InstanceInfo extends \Google\Protobuf\Internal\Message * Network tags configured on the instance. * @type string $service_account * Service account authorized for the instance. + * @type string $psc_network_attachment_uri + * URI of the PSC network attachment the NIC is attached to (if relevant). * } */ public function __construct($data = NULL) { @@ -306,5 +314,31 @@ public function setServiceAccount($var) return $this; } + /** + * URI of the PSC network attachment the NIC is attached to (if relevant). + * + * Generated from protobuf field string psc_network_attachment_uri = 9; + * @return string + */ + public function getPscNetworkAttachmentUri() + { + return $this->psc_network_attachment_uri; + } + + /** + * URI of the PSC network attachment the NIC is attached to (if relevant). + * + * Generated from protobuf field string psc_network_attachment_uri = 9; + * @param string $var + * @return $this + */ + public function setPscNetworkAttachmentUri($var) + { + GPBUtil::checkString($var, True); + $this->psc_network_attachment_uri = $var; + + return $this; + } + } diff --git a/NetworkManagement/src/V1/ListConnectivityTestsRequest.php b/NetworkManagement/src/V1/ListConnectivityTestsRequest.php index caa5de5fb4f7..60845fff13b3 100644 --- a/NetworkManagement/src/V1/ListConnectivityTestsRequest.php +++ b/NetworkManagement/src/V1/ListConnectivityTestsRequest.php @@ -19,7 +19,7 @@ class ListConnectivityTestsRequest extends \Google\Protobuf\Internal\Message * Required. The parent resource of the Connectivity Tests: * `projects/{project_id}/locations/global` * - * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** @@ -65,6 +65,7 @@ class ListConnectivityTestsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The parent resource of the Connectivity Tests: * `projects/{project_id}/locations/global` + * Please see {@see ReachabilityServiceClient::projectName()} for help formatting this field. * * @return \Google\Cloud\NetworkManagement\V1\ListConnectivityTestsRequest * @@ -119,7 +120,7 @@ public function __construct($data = NULL) { * Required. The parent resource of the Connectivity Tests: * `projects/{project_id}/locations/global` * - * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getParent() @@ -131,7 +132,7 @@ public function getParent() * Required. The parent resource of the Connectivity Tests: * `projects/{project_id}/locations/global` * - * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ diff --git a/NetworkManagement/src/V1/NetworkInfo.php b/NetworkManagement/src/V1/NetworkInfo.php index 55f66ee49157..d148d0ea4fcb 100644 --- a/NetworkManagement/src/V1/NetworkInfo.php +++ b/NetworkManagement/src/V1/NetworkInfo.php @@ -10,6 +10,7 @@ /** * For display only. Metadata associated with a Compute Engine network. + * Next ID: 7 * * Generated from protobuf message google.cloud.networkmanagement.v1.NetworkInfo */ @@ -28,11 +29,23 @@ class NetworkInfo extends \Google\Protobuf\Internal\Message */ protected $uri = ''; /** - * The IP range that matches the test. + * URI of the subnet matching the source IP address of the test. + * + * Generated from protobuf field string matched_subnet_uri = 5; + */ + protected $matched_subnet_uri = ''; + /** + * The IP range of the subnet matching the source IP address of the test. * * Generated from protobuf field string matched_ip_range = 4; */ protected $matched_ip_range = ''; + /** + * The region of the subnet matching the source IP address of the test. + * + * Generated from protobuf field string region = 6; + */ + protected $region = ''; /** * Constructor. @@ -44,8 +57,12 @@ class NetworkInfo extends \Google\Protobuf\Internal\Message * Name of a Compute Engine network. * @type string $uri * URI of a Compute Engine network. + * @type string $matched_subnet_uri + * URI of the subnet matching the source IP address of the test. * @type string $matched_ip_range - * The IP range that matches the test. + * The IP range of the subnet matching the source IP address of the test. + * @type string $region + * The region of the subnet matching the source IP address of the test. * } */ public function __construct($data = NULL) { @@ -106,7 +123,33 @@ public function setUri($var) } /** - * The IP range that matches the test. + * URI of the subnet matching the source IP address of the test. + * + * Generated from protobuf field string matched_subnet_uri = 5; + * @return string + */ + public function getMatchedSubnetUri() + { + return $this->matched_subnet_uri; + } + + /** + * URI of the subnet matching the source IP address of the test. + * + * Generated from protobuf field string matched_subnet_uri = 5; + * @param string $var + * @return $this + */ + public function setMatchedSubnetUri($var) + { + GPBUtil::checkString($var, True); + $this->matched_subnet_uri = $var; + + return $this; + } + + /** + * The IP range of the subnet matching the source IP address of the test. * * Generated from protobuf field string matched_ip_range = 4; * @return string @@ -117,7 +160,7 @@ public function getMatchedIpRange() } /** - * The IP range that matches the test. + * The IP range of the subnet matching the source IP address of the test. * * Generated from protobuf field string matched_ip_range = 4; * @param string $var @@ -131,5 +174,31 @@ public function setMatchedIpRange($var) return $this; } + /** + * The region of the subnet matching the source IP address of the test. + * + * Generated from protobuf field string region = 6; + * @return string + */ + public function getRegion() + { + return $this->region; + } + + /** + * The region of the subnet matching the source IP address of the test. + * + * Generated from protobuf field string region = 6; + * @param string $var + * @return $this + */ + public function setRegion($var) + { + GPBUtil::checkString($var, True); + $this->region = $var; + + return $this; + } + } diff --git a/NetworkManagement/src/V1/RedisClusterInfo.php b/NetworkManagement/src/V1/RedisClusterInfo.php new file mode 100644 index 000000000000..f0d07036a9fe --- /dev/null +++ b/NetworkManagement/src/V1/RedisClusterInfo.php @@ -0,0 +1,249 @@ +google.cloud.networkmanagement.v1.RedisClusterInfo + */ +class RedisClusterInfo extends \Google\Protobuf\Internal\Message +{ + /** + * Name of a Redis Cluster. + * + * Generated from protobuf field string display_name = 1; + */ + protected $display_name = ''; + /** + * URI of a Redis Cluster in format + * "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + * + * Generated from protobuf field string uri = 2; + */ + protected $uri = ''; + /** + * URI of a Redis Cluster network in format + * "projects/{project_id}/global/networks/{network_id}". + * + * Generated from protobuf field string network_uri = 3; + */ + protected $network_uri = ''; + /** + * Discovery endpoint IP address of a Redis Cluster. + * + * Generated from protobuf field string discovery_endpoint_ip_address = 4 [(.google.api.field_info) = { + */ + protected $discovery_endpoint_ip_address = ''; + /** + * Secondary endpoint IP address of a Redis Cluster. + * + * Generated from protobuf field string secondary_endpoint_ip_address = 5 [(.google.api.field_info) = { + */ + protected $secondary_endpoint_ip_address = ''; + /** + * Name of the region in which the Redis Cluster is defined. For example, + * "us-central1". + * + * Generated from protobuf field string location = 6; + */ + protected $location = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $display_name + * Name of a Redis Cluster. + * @type string $uri + * URI of a Redis Cluster in format + * "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + * @type string $network_uri + * URI of a Redis Cluster network in format + * "projects/{project_id}/global/networks/{network_id}". + * @type string $discovery_endpoint_ip_address + * Discovery endpoint IP address of a Redis Cluster. + * @type string $secondary_endpoint_ip_address + * Secondary endpoint IP address of a Redis Cluster. + * @type string $location + * Name of the region in which the Redis Cluster is defined. For example, + * "us-central1". + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Networkmanagement\V1\Trace::initOnce(); + parent::__construct($data); + } + + /** + * Name of a Redis Cluster. + * + * Generated from protobuf field string display_name = 1; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Name of a Redis Cluster. + * + * Generated from protobuf field string display_name = 1; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * URI of a Redis Cluster in format + * "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + * + * Generated from protobuf field string uri = 2; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * URI of a Redis Cluster in format + * "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + * + * Generated from protobuf field string uri = 2; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + + /** + * URI of a Redis Cluster network in format + * "projects/{project_id}/global/networks/{network_id}". + * + * Generated from protobuf field string network_uri = 3; + * @return string + */ + public function getNetworkUri() + { + return $this->network_uri; + } + + /** + * URI of a Redis Cluster network in format + * "projects/{project_id}/global/networks/{network_id}". + * + * Generated from protobuf field string network_uri = 3; + * @param string $var + * @return $this + */ + public function setNetworkUri($var) + { + GPBUtil::checkString($var, True); + $this->network_uri = $var; + + return $this; + } + + /** + * Discovery endpoint IP address of a Redis Cluster. + * + * Generated from protobuf field string discovery_endpoint_ip_address = 4 [(.google.api.field_info) = { + * @return string + */ + public function getDiscoveryEndpointIpAddress() + { + return $this->discovery_endpoint_ip_address; + } + + /** + * Discovery endpoint IP address of a Redis Cluster. + * + * Generated from protobuf field string discovery_endpoint_ip_address = 4 [(.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setDiscoveryEndpointIpAddress($var) + { + GPBUtil::checkString($var, True); + $this->discovery_endpoint_ip_address = $var; + + return $this; + } + + /** + * Secondary endpoint IP address of a Redis Cluster. + * + * Generated from protobuf field string secondary_endpoint_ip_address = 5 [(.google.api.field_info) = { + * @return string + */ + public function getSecondaryEndpointIpAddress() + { + return $this->secondary_endpoint_ip_address; + } + + /** + * Secondary endpoint IP address of a Redis Cluster. + * + * Generated from protobuf field string secondary_endpoint_ip_address = 5 [(.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setSecondaryEndpointIpAddress($var) + { + GPBUtil::checkString($var, True); + $this->secondary_endpoint_ip_address = $var; + + return $this; + } + + /** + * Name of the region in which the Redis Cluster is defined. For example, + * "us-central1". + * + * Generated from protobuf field string location = 6; + * @return string + */ + public function getLocation() + { + return $this->location; + } + + /** + * Name of the region in which the Redis Cluster is defined. For example, + * "us-central1". + * + * Generated from protobuf field string location = 6; + * @param string $var + * @return $this + */ + public function setLocation($var) + { + GPBUtil::checkString($var, True); + $this->location = $var; + + return $this; + } + +} + diff --git a/NetworkManagement/src/V1/RedisInstanceInfo.php b/NetworkManagement/src/V1/RedisInstanceInfo.php new file mode 100644 index 000000000000..7e8a8f9bf987 --- /dev/null +++ b/NetworkManagement/src/V1/RedisInstanceInfo.php @@ -0,0 +1,237 @@ +google.cloud.networkmanagement.v1.RedisInstanceInfo + */ +class RedisInstanceInfo extends \Google\Protobuf\Internal\Message +{ + /** + * Name of a Cloud Redis Instance. + * + * Generated from protobuf field string display_name = 1; + */ + protected $display_name = ''; + /** + * URI of a Cloud Redis Instance. + * + * Generated from protobuf field string uri = 2; + */ + protected $uri = ''; + /** + * URI of a Cloud Redis Instance network. + * + * Generated from protobuf field string network_uri = 3; + */ + protected $network_uri = ''; + /** + * Primary endpoint IP address of a Cloud Redis Instance. + * + * Generated from protobuf field string primary_endpoint_ip = 4; + */ + protected $primary_endpoint_ip = ''; + /** + * Read endpoint IP address of a Cloud Redis Instance (if applicable). + * + * Generated from protobuf field string read_endpoint_ip = 5; + */ + protected $read_endpoint_ip = ''; + /** + * Region in which the Cloud Redis Instance is defined. + * + * Generated from protobuf field string region = 6; + */ + protected $region = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $display_name + * Name of a Cloud Redis Instance. + * @type string $uri + * URI of a Cloud Redis Instance. + * @type string $network_uri + * URI of a Cloud Redis Instance network. + * @type string $primary_endpoint_ip + * Primary endpoint IP address of a Cloud Redis Instance. + * @type string $read_endpoint_ip + * Read endpoint IP address of a Cloud Redis Instance (if applicable). + * @type string $region + * Region in which the Cloud Redis Instance is defined. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Networkmanagement\V1\Trace::initOnce(); + parent::__construct($data); + } + + /** + * Name of a Cloud Redis Instance. + * + * Generated from protobuf field string display_name = 1; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Name of a Cloud Redis Instance. + * + * Generated from protobuf field string display_name = 1; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * URI of a Cloud Redis Instance. + * + * Generated from protobuf field string uri = 2; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * URI of a Cloud Redis Instance. + * + * Generated from protobuf field string uri = 2; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + + /** + * URI of a Cloud Redis Instance network. + * + * Generated from protobuf field string network_uri = 3; + * @return string + */ + public function getNetworkUri() + { + return $this->network_uri; + } + + /** + * URI of a Cloud Redis Instance network. + * + * Generated from protobuf field string network_uri = 3; + * @param string $var + * @return $this + */ + public function setNetworkUri($var) + { + GPBUtil::checkString($var, True); + $this->network_uri = $var; + + return $this; + } + + /** + * Primary endpoint IP address of a Cloud Redis Instance. + * + * Generated from protobuf field string primary_endpoint_ip = 4; + * @return string + */ + public function getPrimaryEndpointIp() + { + return $this->primary_endpoint_ip; + } + + /** + * Primary endpoint IP address of a Cloud Redis Instance. + * + * Generated from protobuf field string primary_endpoint_ip = 4; + * @param string $var + * @return $this + */ + public function setPrimaryEndpointIp($var) + { + GPBUtil::checkString($var, True); + $this->primary_endpoint_ip = $var; + + return $this; + } + + /** + * Read endpoint IP address of a Cloud Redis Instance (if applicable). + * + * Generated from protobuf field string read_endpoint_ip = 5; + * @return string + */ + public function getReadEndpointIp() + { + return $this->read_endpoint_ip; + } + + /** + * Read endpoint IP address of a Cloud Redis Instance (if applicable). + * + * Generated from protobuf field string read_endpoint_ip = 5; + * @param string $var + * @return $this + */ + public function setReadEndpointIp($var) + { + GPBUtil::checkString($var, True); + $this->read_endpoint_ip = $var; + + return $this; + } + + /** + * Region in which the Cloud Redis Instance is defined. + * + * Generated from protobuf field string region = 6; + * @return string + */ + public function getRegion() + { + return $this->region; + } + + /** + * Region in which the Cloud Redis Instance is defined. + * + * Generated from protobuf field string region = 6; + * @param string $var + * @return $this + */ + public function setRegion($var) + { + GPBUtil::checkString($var, True); + $this->region = $var; + + return $this; + } + +} + diff --git a/NetworkManagement/src/V1/RerunConnectivityTestRequest.php b/NetworkManagement/src/V1/RerunConnectivityTestRequest.php index fa21f9b7053f..6a28cefac964 100644 --- a/NetworkManagement/src/V1/RerunConnectivityTestRequest.php +++ b/NetworkManagement/src/V1/RerunConnectivityTestRequest.php @@ -19,7 +19,7 @@ class RerunConnectivityTestRequest extends \Google\Protobuf\Internal\Message * Required. Connectivity Test resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; @@ -43,7 +43,7 @@ public function __construct($data = NULL) { * Required. Connectivity Test resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getName() @@ -55,7 +55,7 @@ public function getName() * Required. Connectivity Test resource name using the form: * `projects/{project_id}/locations/global/connectivityTests/{test_id}` * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ diff --git a/NetworkManagement/src/V1/RouteInfo.php b/NetworkManagement/src/V1/RouteInfo.php index adbf221856b8..e457ff0ffe52 100644 --- a/NetworkManagement/src/V1/RouteInfo.php +++ b/NetworkManagement/src/V1/RouteInfo.php @@ -40,14 +40,17 @@ class RouteInfo extends \Google\Protobuf\Internal\Message */ protected $display_name = ''; /** - * URI of a route. - * Dynamic, peering static and peering dynamic routes do not have an URI. - * Advertised route from Google Cloud VPC to on-premises network also does - * not have an URI. + * URI of a route (if applicable). * * Generated from protobuf field string uri = 2; */ protected $uri = ''; + /** + * Region of the route (if applicable). + * + * Generated from protobuf field string region = 19; + */ + protected $region = ''; /** * Destination IP range of the route. * @@ -114,6 +117,22 @@ class RouteInfo extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string ncc_spoke_uri = 16; */ protected $ncc_spoke_uri = null; + /** + * For advertised dynamic routes, the URI of the Cloud Router that advertised + * the corresponding IP prefix. + * + * Generated from protobuf field optional string advertised_route_source_router_uri = 17; + */ + protected $advertised_route_source_router_uri = null; + /** + * For advertised routes, the URI of their next hop, i.e. the URI of the + * hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) + * the advertised prefix is advertised through, or URI of the source peered + * network. + * + * Generated from protobuf field optional string advertised_route_next_hop_uri = 18; + */ + protected $advertised_route_next_hop_uri = null; /** * Constructor. @@ -130,10 +149,9 @@ class RouteInfo extends \Google\Protobuf\Internal\Message * @type string $display_name * Name of a route. * @type string $uri - * URI of a route. - * Dynamic, peering static and peering dynamic routes do not have an URI. - * Advertised route from Google Cloud VPC to on-premises network also does - * not have an URI. + * URI of a route (if applicable). + * @type string $region + * Region of the route (if applicable). * @type string $dest_ip_range * Destination IP range of the route. * @type string $next_hop @@ -156,6 +174,14 @@ class RouteInfo extends \Google\Protobuf\Internal\Message * URI of a NCC Hub. NCC_HUB routes only. * @type string $ncc_spoke_uri * URI of a NCC Spoke. NCC_HUB routes only. + * @type string $advertised_route_source_router_uri + * For advertised dynamic routes, the URI of the Cloud Router that advertised + * the corresponding IP prefix. + * @type string $advertised_route_next_hop_uri + * For advertised routes, the URI of their next hop, i.e. the URI of the + * hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) + * the advertised prefix is advertised through, or URI of the source peered + * network. * } */ public function __construct($data = NULL) { @@ -268,10 +294,7 @@ public function setDisplayName($var) } /** - * URI of a route. - * Dynamic, peering static and peering dynamic routes do not have an URI. - * Advertised route from Google Cloud VPC to on-premises network also does - * not have an URI. + * URI of a route (if applicable). * * Generated from protobuf field string uri = 2; * @return string @@ -282,10 +305,7 @@ public function getUri() } /** - * URI of a route. - * Dynamic, peering static and peering dynamic routes do not have an URI. - * Advertised route from Google Cloud VPC to on-premises network also does - * not have an URI. + * URI of a route (if applicable). * * Generated from protobuf field string uri = 2; * @param string $var @@ -299,6 +319,32 @@ public function setUri($var) return $this; } + /** + * Region of the route (if applicable). + * + * Generated from protobuf field string region = 19; + * @return string + */ + public function getRegion() + { + return $this->region; + } + + /** + * Region of the route (if applicable). + * + * Generated from protobuf field string region = 19; + * @param string $var + * @return $this + */ + public function setRegion($var) + { + GPBUtil::checkString($var, True); + $this->region = $var; + + return $this; + } + /** * Destination IP range of the route. * @@ -605,5 +651,85 @@ public function setNccSpokeUri($var) return $this; } + /** + * For advertised dynamic routes, the URI of the Cloud Router that advertised + * the corresponding IP prefix. + * + * Generated from protobuf field optional string advertised_route_source_router_uri = 17; + * @return string + */ + public function getAdvertisedRouteSourceRouterUri() + { + return isset($this->advertised_route_source_router_uri) ? $this->advertised_route_source_router_uri : ''; + } + + public function hasAdvertisedRouteSourceRouterUri() + { + return isset($this->advertised_route_source_router_uri); + } + + public function clearAdvertisedRouteSourceRouterUri() + { + unset($this->advertised_route_source_router_uri); + } + + /** + * For advertised dynamic routes, the URI of the Cloud Router that advertised + * the corresponding IP prefix. + * + * Generated from protobuf field optional string advertised_route_source_router_uri = 17; + * @param string $var + * @return $this + */ + public function setAdvertisedRouteSourceRouterUri($var) + { + GPBUtil::checkString($var, True); + $this->advertised_route_source_router_uri = $var; + + return $this; + } + + /** + * For advertised routes, the URI of their next hop, i.e. the URI of the + * hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) + * the advertised prefix is advertised through, or URI of the source peered + * network. + * + * Generated from protobuf field optional string advertised_route_next_hop_uri = 18; + * @return string + */ + public function getAdvertisedRouteNextHopUri() + { + return isset($this->advertised_route_next_hop_uri) ? $this->advertised_route_next_hop_uri : ''; + } + + public function hasAdvertisedRouteNextHopUri() + { + return isset($this->advertised_route_next_hop_uri); + } + + public function clearAdvertisedRouteNextHopUri() + { + unset($this->advertised_route_next_hop_uri); + } + + /** + * For advertised routes, the URI of their next hop, i.e. the URI of the + * hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) + * the advertised prefix is advertised through, or URI of the source peered + * network. + * + * Generated from protobuf field optional string advertised_route_next_hop_uri = 18; + * @param string $var + * @return $this + */ + public function setAdvertisedRouteNextHopUri($var) + { + GPBUtil::checkString($var, True); + $this->advertised_route_next_hop_uri = $var; + + return $this; + } + } diff --git a/NetworkManagement/src/V1/RouteInfo/RouteType.php b/NetworkManagement/src/V1/RouteInfo/RouteType.php index 985c5887280a..522e8c65676b 100644 --- a/NetworkManagement/src/V1/RouteInfo/RouteType.php +++ b/NetworkManagement/src/V1/RouteInfo/RouteType.php @@ -62,6 +62,13 @@ class RouteType * Generated from protobuf enum POLICY_BASED = 7; */ const POLICY_BASED = 7; + /** + * Advertised route. Synthetic route which is used to transition from the + * StartFromPrivateNetwork state in Connectivity tests. + * + * Generated from protobuf enum ADVERTISED = 101; + */ + const ADVERTISED = 101; private static $valueToName = [ self::ROUTE_TYPE_UNSPECIFIED => 'ROUTE_TYPE_UNSPECIFIED', @@ -72,6 +79,7 @@ class RouteType self::PEERING_STATIC => 'PEERING_STATIC', self::PEERING_DYNAMIC => 'PEERING_DYNAMIC', self::POLICY_BASED => 'POLICY_BASED', + self::ADVERTISED => 'ADVERTISED', ]; public static function name($value) diff --git a/NetworkManagement/src/V1/ServerlessNegInfo.php b/NetworkManagement/src/V1/ServerlessNegInfo.php new file mode 100644 index 000000000000..582fd758a26c --- /dev/null +++ b/NetworkManagement/src/V1/ServerlessNegInfo.php @@ -0,0 +1,68 @@ +google.cloud.networkmanagement.v1.ServerlessNegInfo + */ +class ServerlessNegInfo extends \Google\Protobuf\Internal\Message +{ + /** + * URI of the serverless network endpoint group. + * + * Generated from protobuf field string neg_uri = 1; + */ + protected $neg_uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $neg_uri + * URI of the serverless network endpoint group. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Networkmanagement\V1\Trace::initOnce(); + parent::__construct($data); + } + + /** + * URI of the serverless network endpoint group. + * + * Generated from protobuf field string neg_uri = 1; + * @return string + */ + public function getNegUri() + { + return $this->neg_uri; + } + + /** + * URI of the serverless network endpoint group. + * + * Generated from protobuf field string neg_uri = 1; + * @param string $var + * @return $this + */ + public function setNegUri($var) + { + GPBUtil::checkString($var, True); + $this->neg_uri = $var; + + return $this; + } + +} + diff --git a/NetworkManagement/src/V1/Step.php b/NetworkManagement/src/V1/Step.php index 84600bb5a6e7..80fb590eea88 100644 --- a/NetworkManagement/src/V1/Step.php +++ b/NetworkManagement/src/V1/Step.php @@ -94,6 +94,10 @@ class Step extends \Google\Protobuf\Internal\Message * Display information of a Google Kubernetes Engine cluster master. * @type \Google\Cloud\NetworkManagement\V1\CloudSQLInstanceInfo $cloud_sql_instance * Display information of a Cloud SQL instance. + * @type \Google\Cloud\NetworkManagement\V1\RedisInstanceInfo $redis_instance + * Display information of a Redis Instance. + * @type \Google\Cloud\NetworkManagement\V1\RedisClusterInfo $redis_cluster + * Display information of a Redis Cluster. * @type \Google\Cloud\NetworkManagement\V1\CloudFunctionInfo $cloud_function * Display information of a Cloud Function. * @type \Google\Cloud\NetworkManagement\V1\AppEngineVersionInfo $app_engine_version @@ -108,6 +112,9 @@ class Step extends \Google\Protobuf\Internal\Message * Display information of a specific load balancer backend. * @type \Google\Cloud\NetworkManagement\V1\StorageBucketInfo $storage_bucket * Display information of a Storage Bucket. Used only for return traces. + * @type \Google\Cloud\NetworkManagement\V1\ServerlessNegInfo $serverless_neg + * Display information of a Serverless network endpoint group backend. Used + * only for return traces. * } */ public function __construct($data = NULL) { @@ -759,6 +766,68 @@ public function setCloudSqlInstance($var) return $this; } + /** + * Display information of a Redis Instance. + * + * Generated from protobuf field .google.cloud.networkmanagement.v1.RedisInstanceInfo redis_instance = 30; + * @return \Google\Cloud\NetworkManagement\V1\RedisInstanceInfo|null + */ + public function getRedisInstance() + { + return $this->readOneof(30); + } + + public function hasRedisInstance() + { + return $this->hasOneof(30); + } + + /** + * Display information of a Redis Instance. + * + * Generated from protobuf field .google.cloud.networkmanagement.v1.RedisInstanceInfo redis_instance = 30; + * @param \Google\Cloud\NetworkManagement\V1\RedisInstanceInfo $var + * @return $this + */ + public function setRedisInstance($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\NetworkManagement\V1\RedisInstanceInfo::class); + $this->writeOneof(30, $var); + + return $this; + } + + /** + * Display information of a Redis Cluster. + * + * Generated from protobuf field .google.cloud.networkmanagement.v1.RedisClusterInfo redis_cluster = 31; + * @return \Google\Cloud\NetworkManagement\V1\RedisClusterInfo|null + */ + public function getRedisCluster() + { + return $this->readOneof(31); + } + + public function hasRedisCluster() + { + return $this->hasOneof(31); + } + + /** + * Display information of a Redis Cluster. + * + * Generated from protobuf field .google.cloud.networkmanagement.v1.RedisClusterInfo redis_cluster = 31; + * @param \Google\Cloud\NetworkManagement\V1\RedisClusterInfo $var + * @return $this + */ + public function setRedisCluster($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\NetworkManagement\V1\RedisClusterInfo::class); + $this->writeOneof(31, $var); + + return $this; + } + /** * Display information of a Cloud Function. * @@ -976,6 +1045,39 @@ public function setStorageBucket($var) return $this; } + /** + * Display information of a Serverless network endpoint group backend. Used + * only for return traces. + * + * Generated from protobuf field .google.cloud.networkmanagement.v1.ServerlessNegInfo serverless_neg = 29; + * @return \Google\Cloud\NetworkManagement\V1\ServerlessNegInfo|null + */ + public function getServerlessNeg() + { + return $this->readOneof(29); + } + + public function hasServerlessNeg() + { + return $this->hasOneof(29); + } + + /** + * Display information of a Serverless network endpoint group backend. Used + * only for return traces. + * + * Generated from protobuf field .google.cloud.networkmanagement.v1.ServerlessNegInfo serverless_neg = 29; + * @param \Google\Cloud\NetworkManagement\V1\ServerlessNegInfo $var + * @return $this + */ + public function setServerlessNeg($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\NetworkManagement\V1\ServerlessNegInfo::class); + $this->writeOneof(29, $var); + + return $this; + } + /** * @return string */ diff --git a/NetworkManagement/src/V1/Step/State.php b/NetworkManagement/src/V1/Step/State.php index 83e44e0a16e2..92cb3840938c 100644 --- a/NetworkManagement/src/V1/Step/State.php +++ b/NetworkManagement/src/V1/Step/State.php @@ -64,6 +64,20 @@ class State * Generated from protobuf enum START_FROM_CLOUD_SQL_INSTANCE = 22; */ const START_FROM_CLOUD_SQL_INSTANCE = 22; + /** + * Initial state: packet originating from a Redis instance. + * A RedisInstanceInfo is populated with starting instance information. + * + * Generated from protobuf enum START_FROM_REDIS_INSTANCE = 32; + */ + const START_FROM_REDIS_INSTANCE = 32; + /** + * Initial state: packet originating from a Redis Cluster. + * A RedisClusterInfo is populated with starting Cluster information. + * + * Generated from protobuf enum START_FROM_REDIS_CLUSTER = 33; + */ + const START_FROM_REDIS_CLUSTER = 33; /** * Initial state: packet originating from a Cloud Function. * A CloudFunctionInfo is populated with starting function information. @@ -100,6 +114,14 @@ class State * Generated from protobuf enum START_FROM_PSC_PUBLISHED_SERVICE = 30; */ const START_FROM_PSC_PUBLISHED_SERVICE = 30; + /** + * Initial state: packet originating from a serverless network endpoint + * group backend. Used only for return traces. + * The serverless_neg information is populated. + * + * Generated from protobuf enum START_FROM_SERVERLESS_NEG = 31; + */ + const START_FROM_SERVERLESS_NEG = 31; /** * Config checking state: verify ingress firewall rule. * @@ -227,11 +249,14 @@ class State self::START_FROM_PRIVATE_NETWORK => 'START_FROM_PRIVATE_NETWORK', self::START_FROM_GKE_MASTER => 'START_FROM_GKE_MASTER', self::START_FROM_CLOUD_SQL_INSTANCE => 'START_FROM_CLOUD_SQL_INSTANCE', + self::START_FROM_REDIS_INSTANCE => 'START_FROM_REDIS_INSTANCE', + self::START_FROM_REDIS_CLUSTER => 'START_FROM_REDIS_CLUSTER', self::START_FROM_CLOUD_FUNCTION => 'START_FROM_CLOUD_FUNCTION', self::START_FROM_APP_ENGINE_VERSION => 'START_FROM_APP_ENGINE_VERSION', self::START_FROM_CLOUD_RUN_REVISION => 'START_FROM_CLOUD_RUN_REVISION', self::START_FROM_STORAGE_BUCKET => 'START_FROM_STORAGE_BUCKET', self::START_FROM_PSC_PUBLISHED_SERVICE => 'START_FROM_PSC_PUBLISHED_SERVICE', + self::START_FROM_SERVERLESS_NEG => 'START_FROM_SERVERLESS_NEG', self::APPLY_INGRESS_FIREWALL_RULE => 'APPLY_INGRESS_FIREWALL_RULE', self::APPLY_EGRESS_FIREWALL_RULE => 'APPLY_EGRESS_FIREWALL_RULE', self::APPLY_ROUTE => 'APPLY_ROUTE', diff --git a/NetworkManagement/src/V1/resources/reachability_service_descriptor_config.php b/NetworkManagement/src/V1/resources/reachability_service_descriptor_config.php index 2026717dc44c..5e5df79c8de4 100644 --- a/NetworkManagement/src/V1/resources/reachability_service_descriptor_config.php +++ b/NetworkManagement/src/V1/resources/reachability_service_descriptor_config.php @@ -207,6 +207,7 @@ ], 'templateMap' => [ 'connectivityTest' => 'projects/{project}/locations/global/connectivityTests/{test}', + 'project' => 'projects/{project}', ], ], ], diff --git a/NetworkManagement/tests/Unit/V1/Client/ReachabilityServiceClientTest.php b/NetworkManagement/tests/Unit/V1/Client/ReachabilityServiceClientTest.php index e059b6463d73..343ead7ede47 100644 --- a/NetworkManagement/tests/Unit/V1/Client/ReachabilityServiceClientTest.php +++ b/NetworkManagement/tests/Unit/V1/Client/ReachabilityServiceClientTest.php @@ -124,17 +124,15 @@ public function createConnectivityTestTest() $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $parent = 'parent-995424086'; + $formattedParent = $gapicClient->projectName('[PROJECT]'); $testId = 'testId-1422455832'; $resource = new ConnectivityTest(); - $resourceName = 'resourceName-384566343'; - $resource->setName($resourceName); $resourceSource = new Endpoint(); $resource->setSource($resourceSource); $resourceDestination = new Endpoint(); $resource->setDestination($resourceDestination); $request = (new CreateConnectivityTestRequest()) - ->setParent($parent) + ->setParent($formattedParent) ->setTestId($testId) ->setResource($resource); $response = $gapicClient->createConnectivityTest($request); @@ -151,7 +149,7 @@ public function createConnectivityTestTest() $actualApiFuncCall ); $actualValue = $actualApiRequestObject->getParent(); - $this->assertProtobufEquals($parent, $actualValue); + $this->assertProtobufEquals($formattedParent, $actualValue); $actualValue = $actualApiRequestObject->getTestId(); $this->assertProtobufEquals($testId, $actualValue); $actualValue = $actualApiRequestObject->getResource(); @@ -210,17 +208,15 @@ public function createConnectivityTestExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $parent = 'parent-995424086'; + $formattedParent = $gapicClient->projectName('[PROJECT]'); $testId = 'testId-1422455832'; $resource = new ConnectivityTest(); - $resourceName = 'resourceName-384566343'; - $resource->setName($resourceName); $resourceSource = new Endpoint(); $resource->setSource($resourceSource); $resourceDestination = new Endpoint(); $resource->setDestination($resourceDestination); $request = (new CreateConnectivityTestRequest()) - ->setParent($parent) + ->setParent($formattedParent) ->setTestId($testId) ->setResource($resource); $response = $gapicClient->createConnectivityTest($request); @@ -275,8 +271,8 @@ public function deleteConnectivityTestTest() $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $name = 'name3373707'; - $request = (new DeleteConnectivityTestRequest())->setName($name); + $formattedName = $gapicClient->connectivityTestName('[PROJECT]', '[TEST]'); + $request = (new DeleteConnectivityTestRequest())->setName($formattedName); $response = $gapicClient->deleteConnectivityTest($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -291,7 +287,7 @@ public function deleteConnectivityTestTest() $actualApiFuncCall ); $actualValue = $actualApiRequestObject->getName(); - $this->assertProtobufEquals($name, $actualValue); + $this->assertProtobufEquals($formattedName, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); $expectedOperationsRequestObject->setName('operations/deleteConnectivityTestTest'); $response->pollUntilComplete([ @@ -346,8 +342,8 @@ public function deleteConnectivityTestExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $name = 'name3373707'; - $request = (new DeleteConnectivityTestRequest())->setName($name); + $formattedName = $gapicClient->connectivityTestName('[PROJECT]', '[TEST]'); + $request = (new DeleteConnectivityTestRequest())->setName($formattedName); $response = $gapicClient->deleteConnectivityTest($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -392,8 +388,8 @@ public function getConnectivityTestTest() $expectedResponse->setBypassFirewallChecks($bypassFirewallChecks); $transport->addResponse($expectedResponse); // Mock request - $name = 'name3373707'; - $request = (new GetConnectivityTestRequest())->setName($name); + $formattedName = $gapicClient->connectivityTestName('[PROJECT]', '[TEST]'); + $request = (new GetConnectivityTestRequest())->setName($formattedName); $response = $gapicClient->getConnectivityTest($request); $this->assertEquals($expectedResponse, $response); $actualRequests = $transport->popReceivedCalls(); @@ -405,7 +401,7 @@ public function getConnectivityTestTest() $actualFuncCall ); $actualValue = $actualRequestObject->getName(); - $this->assertProtobufEquals($name, $actualValue); + $this->assertProtobufEquals($formattedName, $actualValue); $this->assertTrue($transport->isExhausted()); } @@ -431,8 +427,8 @@ public function getConnectivityTestExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $name = 'name3373707'; - $request = (new GetConnectivityTestRequest())->setName($name); + $formattedName = $gapicClient->connectivityTestName('[PROJECT]', '[TEST]'); + $request = (new GetConnectivityTestRequest())->setName($formattedName); try { $gapicClient->getConnectivityTest($request); // If the $gapicClient method call did not throw, fail the test @@ -463,8 +459,8 @@ public function listConnectivityTestsTest() $expectedResponse->setResources($resources); $transport->addResponse($expectedResponse); // Mock request - $parent = 'parent-995424086'; - $request = (new ListConnectivityTestsRequest())->setParent($parent); + $formattedParent = $gapicClient->projectName('[PROJECT]'); + $request = (new ListConnectivityTestsRequest())->setParent($formattedParent); $response = $gapicClient->listConnectivityTests($request); $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); $resources = iterator_to_array($response->iterateAllElements()); @@ -479,7 +475,7 @@ public function listConnectivityTestsTest() $actualFuncCall ); $actualValue = $actualRequestObject->getParent(); - $this->assertProtobufEquals($parent, $actualValue); + $this->assertProtobufEquals($formattedParent, $actualValue); $this->assertTrue($transport->isExhausted()); } @@ -505,8 +501,8 @@ public function listConnectivityTestsExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $parent = 'parent-995424086'; - $request = (new ListConnectivityTestsRequest())->setParent($parent); + $formattedParent = $gapicClient->projectName('[PROJECT]'); + $request = (new ListConnectivityTestsRequest())->setParent($formattedParent); try { $gapicClient->listConnectivityTests($request); // If the $gapicClient method call did not throw, fail the test @@ -560,8 +556,8 @@ public function rerunConnectivityTestTest() $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $name = 'name3373707'; - $request = (new RerunConnectivityTestRequest())->setName($name); + $formattedName = $gapicClient->connectivityTestName('[PROJECT]', '[TEST]'); + $request = (new RerunConnectivityTestRequest())->setName($formattedName); $response = $gapicClient->rerunConnectivityTest($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -576,7 +572,7 @@ public function rerunConnectivityTestTest() $actualApiFuncCall ); $actualValue = $actualApiRequestObject->getName(); - $this->assertProtobufEquals($name, $actualValue); + $this->assertProtobufEquals($formattedName, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); $expectedOperationsRequestObject->setName('operations/rerunConnectivityTestTest'); $response->pollUntilComplete([ @@ -631,8 +627,8 @@ public function rerunConnectivityTestExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $name = 'name3373707'; - $request = (new RerunConnectivityTestRequest())->setName($name); + $formattedName = $gapicClient->connectivityTestName('[PROJECT]', '[TEST]'); + $request = (new RerunConnectivityTestRequest())->setName($formattedName); $response = $gapicClient->rerunConnectivityTest($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -697,8 +693,6 @@ public function updateConnectivityTestTest() // Mock request $updateMask = new FieldMask(); $resource = new ConnectivityTest(); - $resourceName = 'resourceName-384566343'; - $resource->setName($resourceName); $resourceSource = new Endpoint(); $resource->setSource($resourceSource); $resourceDestination = new Endpoint(); @@ -777,8 +771,6 @@ public function updateConnectivityTestExceptionTest() // Mock request $updateMask = new FieldMask(); $resource = new ConnectivityTest(); - $resourceName = 'resourceName-384566343'; - $resource->setName($resourceName); $resourceSource = new Endpoint(); $resource->setSource($resourceSource); $resourceDestination = new Endpoint(); @@ -1179,17 +1171,15 @@ public function createConnectivityTestAsyncTest() $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $parent = 'parent-995424086'; + $formattedParent = $gapicClient->projectName('[PROJECT]'); $testId = 'testId-1422455832'; $resource = new ConnectivityTest(); - $resourceName = 'resourceName-384566343'; - $resource->setName($resourceName); $resourceSource = new Endpoint(); $resource->setSource($resourceSource); $resourceDestination = new Endpoint(); $resource->setDestination($resourceDestination); $request = (new CreateConnectivityTestRequest()) - ->setParent($parent) + ->setParent($formattedParent) ->setTestId($testId) ->setResource($resource); $response = $gapicClient->createConnectivityTestAsync($request)->wait(); @@ -1206,7 +1196,7 @@ public function createConnectivityTestAsyncTest() $actualApiFuncCall ); $actualValue = $actualApiRequestObject->getParent(); - $this->assertProtobufEquals($parent, $actualValue); + $this->assertProtobufEquals($formattedParent, $actualValue); $actualValue = $actualApiRequestObject->getTestId(); $this->assertProtobufEquals($testId, $actualValue); $actualValue = $actualApiRequestObject->getResource(); From 21b4eb508f3ecbc690ccddb25993b3975cc4aa31 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:50:07 -0400 Subject: [PATCH 029/157] feat: Add `ProvisioningModelMix` to support mixing of spot and standard instances for secondary workers (#7746) feat: Add support for configuration of bootdisk IOPS and throughput when bootdisk is a hyperdisk PiperOrigin-RevId: 686008645 Source-Link: https://github.com/googleapis/googleapis/commit/2f49d448f995c57186bec996ddc1bb50b1944f6c Source-Link: https://github.com/googleapis/googleapis-gen/commit/5dc57b00d9a1355d020496abe5600e78202d5d3b Copy-Tag: eyJwIjoiRGF0YXByb2MvLk93bEJvdC55YW1sIiwiaCI6IjVkYzU3YjAwZDlhMTM1NWQwMjA0OTZhYmU1NjAwZTc4MjAyZDVkM2IifQ== --- Dataproc/metadata/V1/Clusters.php | Bin 15194 -> 15663 bytes Dataproc/src/V1/DiskConfig.php | 108 +++++++++++ Dataproc/src/V1/InstanceFlexibilityPolicy.php | 48 +++++ .../ProvisioningModelMix.php | 171 ++++++++++++++++++ 4 files changed, 327 insertions(+) create mode 100644 Dataproc/src/V1/InstanceFlexibilityPolicy/ProvisioningModelMix.php diff --git a/Dataproc/metadata/V1/Clusters.php b/Dataproc/metadata/V1/Clusters.php index 3962d2eb574def42308956d327997996057cce11..e1fed04500dcad607f07da9d771f2d54b99ca618 100644 GIT binary patch delta 476 zcmcarw!Uh^Ll)M*`CKvTlj~R|H~(kJ6lHqKIyp;9MlqL5te_~rEVDQ>KQA*cJw7)- zB{e5LH?u;5QGro|+sI?GqJ*)OUI3CBUyu^t%nB#w2ab%BTcw`V?_uN;!KOk;gG;Qq zBrz`~u_z@zIk6xyIkTiPJ}I#{6>K^y*aQ!T4n{^HGcFZOl?ACq$*FlI@rggEh-4o0SROp}XbI_iaVxTKQu^Go7W zGK;h0;enHy5}%o0P%Oa;bO1Aw!;QEUu&XY~D9SHQ&nPG@kzhmU0XtfjOFACArp$cx Uf?_9SE=3&j2tzmjl1Y#Q09pg1`v3p{ delta 52 zcmV-40L%ZcdfIld;RFS#YzkZ_lYRvmv;PEX6$G~f3K^5Z8X1%H8sxK>90vgchyjzK K9f-5f9$+3Rb`$pi diff --git a/Dataproc/src/V1/DiskConfig.php b/Dataproc/src/V1/DiskConfig.php index 23f3a85cd58b..0ff25d83c2df 100644 --- a/Dataproc/src/V1/DiskConfig.php +++ b/Dataproc/src/V1/DiskConfig.php @@ -54,6 +54,23 @@ class DiskConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field string local_ssd_interface = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $local_ssd_interface = ''; + /** + * Optional. Indicates how many IOPS to provision for the disk. This sets the + * number of I/O operations per second that the disk can handle. Note: This + * field is only supported if boot_disk_type is hyperdisk-balanced. + * + * Generated from protobuf field optional int64 boot_disk_provisioned_iops = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $boot_disk_provisioned_iops = null; + /** + * Optional. Indicates how much throughput to provision for the disk. This + * sets the number of throughput mb per second that the disk can handle. + * Values must be greater than or equal to 1. Note: This field is only + * supported if boot_disk_type is hyperdisk-balanced. + * + * Generated from protobuf field optional int64 boot_disk_provisioned_throughput = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $boot_disk_provisioned_throughput = null; /** * Constructor. @@ -84,6 +101,15 @@ class DiskConfig extends \Google\Protobuf\Internal\Message * "nvme" (Non-Volatile Memory Express). * See [local SSD * performance](https://cloud.google.com/compute/docs/disks/local-ssd#performance). + * @type int|string $boot_disk_provisioned_iops + * Optional. Indicates how many IOPS to provision for the disk. This sets the + * number of I/O operations per second that the disk can handle. Note: This + * field is only supported if boot_disk_type is hyperdisk-balanced. + * @type int|string $boot_disk_provisioned_throughput + * Optional. Indicates how much throughput to provision for the disk. This + * sets the number of throughput mb per second that the disk can handle. + * Values must be greater than or equal to 1. Note: This field is only + * supported if boot_disk_type is hyperdisk-balanced. * } */ public function __construct($data = NULL) { @@ -225,5 +251,87 @@ public function setLocalSsdInterface($var) return $this; } + /** + * Optional. Indicates how many IOPS to provision for the disk. This sets the + * number of I/O operations per second that the disk can handle. Note: This + * field is only supported if boot_disk_type is hyperdisk-balanced. + * + * Generated from protobuf field optional int64 boot_disk_provisioned_iops = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getBootDiskProvisionedIops() + { + return isset($this->boot_disk_provisioned_iops) ? $this->boot_disk_provisioned_iops : 0; + } + + public function hasBootDiskProvisionedIops() + { + return isset($this->boot_disk_provisioned_iops); + } + + public function clearBootDiskProvisionedIops() + { + unset($this->boot_disk_provisioned_iops); + } + + /** + * Optional. Indicates how many IOPS to provision for the disk. This sets the + * number of I/O operations per second that the disk can handle. Note: This + * field is only supported if boot_disk_type is hyperdisk-balanced. + * + * Generated from protobuf field optional int64 boot_disk_provisioned_iops = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setBootDiskProvisionedIops($var) + { + GPBUtil::checkInt64($var); + $this->boot_disk_provisioned_iops = $var; + + return $this; + } + + /** + * Optional. Indicates how much throughput to provision for the disk. This + * sets the number of throughput mb per second that the disk can handle. + * Values must be greater than or equal to 1. Note: This field is only + * supported if boot_disk_type is hyperdisk-balanced. + * + * Generated from protobuf field optional int64 boot_disk_provisioned_throughput = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getBootDiskProvisionedThroughput() + { + return isset($this->boot_disk_provisioned_throughput) ? $this->boot_disk_provisioned_throughput : 0; + } + + public function hasBootDiskProvisionedThroughput() + { + return isset($this->boot_disk_provisioned_throughput); + } + + public function clearBootDiskProvisionedThroughput() + { + unset($this->boot_disk_provisioned_throughput); + } + + /** + * Optional. Indicates how much throughput to provision for the disk. This + * sets the number of throughput mb per second that the disk can handle. + * Values must be greater than or equal to 1. Note: This field is only + * supported if boot_disk_type is hyperdisk-balanced. + * + * Generated from protobuf field optional int64 boot_disk_provisioned_throughput = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setBootDiskProvisionedThroughput($var) + { + GPBUtil::checkInt64($var); + $this->boot_disk_provisioned_throughput = $var; + + return $this; + } + } diff --git a/Dataproc/src/V1/InstanceFlexibilityPolicy.php b/Dataproc/src/V1/InstanceFlexibilityPolicy.php index 60e39ca8fc1d..dd374b64833e 100644 --- a/Dataproc/src/V1/InstanceFlexibilityPolicy.php +++ b/Dataproc/src/V1/InstanceFlexibilityPolicy.php @@ -16,6 +16,13 @@ */ class InstanceFlexibilityPolicy extends \Google\Protobuf\Internal\Message { + /** + * Optional. Defines how the Group selects the provisioning model to ensure + * required reliability. + * + * Generated from protobuf field .google.cloud.dataproc.v1.InstanceFlexibilityPolicy.ProvisioningModelMix provisioning_model_mix = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $provisioning_model_mix = null; /** * Optional. List of instance selection options that the group will use when * creating new VMs. @@ -36,6 +43,9 @@ class InstanceFlexibilityPolicy extends \Google\Protobuf\Internal\Message * @param array $data { * Optional. Data for populating the Message object. * + * @type \Google\Cloud\Dataproc\V1\InstanceFlexibilityPolicy\ProvisioningModelMix $provisioning_model_mix + * Optional. Defines how the Group selects the provisioning model to ensure + * required reliability. * @type array<\Google\Cloud\Dataproc\V1\InstanceFlexibilityPolicy\InstanceSelection>|\Google\Protobuf\Internal\RepeatedField $instance_selection_list * Optional. List of instance selection options that the group will use when * creating new VMs. @@ -48,6 +58,44 @@ public function __construct($data = NULL) { parent::__construct($data); } + /** + * Optional. Defines how the Group selects the provisioning model to ensure + * required reliability. + * + * Generated from protobuf field .google.cloud.dataproc.v1.InstanceFlexibilityPolicy.ProvisioningModelMix provisioning_model_mix = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dataproc\V1\InstanceFlexibilityPolicy\ProvisioningModelMix|null + */ + public function getProvisioningModelMix() + { + return $this->provisioning_model_mix; + } + + public function hasProvisioningModelMix() + { + return isset($this->provisioning_model_mix); + } + + public function clearProvisioningModelMix() + { + unset($this->provisioning_model_mix); + } + + /** + * Optional. Defines how the Group selects the provisioning model to ensure + * required reliability. + * + * Generated from protobuf field .google.cloud.dataproc.v1.InstanceFlexibilityPolicy.ProvisioningModelMix provisioning_model_mix = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dataproc\V1\InstanceFlexibilityPolicy\ProvisioningModelMix $var + * @return $this + */ + public function setProvisioningModelMix($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataproc\V1\InstanceFlexibilityPolicy\ProvisioningModelMix::class); + $this->provisioning_model_mix = $var; + + return $this; + } + /** * Optional. List of instance selection options that the group will use when * creating new VMs. diff --git a/Dataproc/src/V1/InstanceFlexibilityPolicy/ProvisioningModelMix.php b/Dataproc/src/V1/InstanceFlexibilityPolicy/ProvisioningModelMix.php new file mode 100644 index 000000000000..ca3b6bff75ca --- /dev/null +++ b/Dataproc/src/V1/InstanceFlexibilityPolicy/ProvisioningModelMix.php @@ -0,0 +1,171 @@ +google.cloud.dataproc.v1.InstanceFlexibilityPolicy.ProvisioningModelMix + */ +class ProvisioningModelMix extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The base capacity that will always use Standard VMs to avoid + * risk of more preemption than the minimum capacity you need. Dataproc will + * create only standard VMs until it reaches standard_capacity_base, then it + * will start using standard_capacity_percent_above_base to mix Spot with + * Standard VMs. eg. If 15 instances are requested and + * standard_capacity_base is 5, Dataproc will create 5 standard VMs and then + * start mixing spot and standard VMs for remaining 10 instances. + * + * Generated from protobuf field optional int32 standard_capacity_base = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $standard_capacity_base = null; + /** + * Optional. The percentage of target capacity that should use Standard VM. + * The remaining percentage will use Spot VMs. The percentage applies only + * to the capacity above standard_capacity_base. eg. If 15 instances are + * requested and standard_capacity_base is 5 and + * standard_capacity_percent_above_base is 30, Dataproc will create 5 + * standard VMs and then start mixing spot and standard VMs for remaining 10 + * instances. The mix will be 30% standard and 70% spot. + * + * Generated from protobuf field optional int32 standard_capacity_percent_above_base = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $standard_capacity_percent_above_base = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $standard_capacity_base + * Optional. The base capacity that will always use Standard VMs to avoid + * risk of more preemption than the minimum capacity you need. Dataproc will + * create only standard VMs until it reaches standard_capacity_base, then it + * will start using standard_capacity_percent_above_base to mix Spot with + * Standard VMs. eg. If 15 instances are requested and + * standard_capacity_base is 5, Dataproc will create 5 standard VMs and then + * start mixing spot and standard VMs for remaining 10 instances. + * @type int $standard_capacity_percent_above_base + * Optional. The percentage of target capacity that should use Standard VM. + * The remaining percentage will use Spot VMs. The percentage applies only + * to the capacity above standard_capacity_base. eg. If 15 instances are + * requested and standard_capacity_base is 5 and + * standard_capacity_percent_above_base is 30, Dataproc will create 5 + * standard VMs and then start mixing spot and standard VMs for remaining 10 + * instances. The mix will be 30% standard and 70% spot. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataproc\V1\Clusters::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The base capacity that will always use Standard VMs to avoid + * risk of more preemption than the minimum capacity you need. Dataproc will + * create only standard VMs until it reaches standard_capacity_base, then it + * will start using standard_capacity_percent_above_base to mix Spot with + * Standard VMs. eg. If 15 instances are requested and + * standard_capacity_base is 5, Dataproc will create 5 standard VMs and then + * start mixing spot and standard VMs for remaining 10 instances. + * + * Generated from protobuf field optional int32 standard_capacity_base = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getStandardCapacityBase() + { + return isset($this->standard_capacity_base) ? $this->standard_capacity_base : 0; + } + + public function hasStandardCapacityBase() + { + return isset($this->standard_capacity_base); + } + + public function clearStandardCapacityBase() + { + unset($this->standard_capacity_base); + } + + /** + * Optional. The base capacity that will always use Standard VMs to avoid + * risk of more preemption than the minimum capacity you need. Dataproc will + * create only standard VMs until it reaches standard_capacity_base, then it + * will start using standard_capacity_percent_above_base to mix Spot with + * Standard VMs. eg. If 15 instances are requested and + * standard_capacity_base is 5, Dataproc will create 5 standard VMs and then + * start mixing spot and standard VMs for remaining 10 instances. + * + * Generated from protobuf field optional int32 standard_capacity_base = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setStandardCapacityBase($var) + { + GPBUtil::checkInt32($var); + $this->standard_capacity_base = $var; + + return $this; + } + + /** + * Optional. The percentage of target capacity that should use Standard VM. + * The remaining percentage will use Spot VMs. The percentage applies only + * to the capacity above standard_capacity_base. eg. If 15 instances are + * requested and standard_capacity_base is 5 and + * standard_capacity_percent_above_base is 30, Dataproc will create 5 + * standard VMs and then start mixing spot and standard VMs for remaining 10 + * instances. The mix will be 30% standard and 70% spot. + * + * Generated from protobuf field optional int32 standard_capacity_percent_above_base = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getStandardCapacityPercentAboveBase() + { + return isset($this->standard_capacity_percent_above_base) ? $this->standard_capacity_percent_above_base : 0; + } + + public function hasStandardCapacityPercentAboveBase() + { + return isset($this->standard_capacity_percent_above_base); + } + + public function clearStandardCapacityPercentAboveBase() + { + unset($this->standard_capacity_percent_above_base); + } + + /** + * Optional. The percentage of target capacity that should use Standard VM. + * The remaining percentage will use Spot VMs. The percentage applies only + * to the capacity above standard_capacity_base. eg. If 15 instances are + * requested and standard_capacity_base is 5 and + * standard_capacity_percent_above_base is 30, Dataproc will create 5 + * standard VMs and then start mixing spot and standard VMs for remaining 10 + * instances. The mix will be 30% standard and 70% spot. + * + * Generated from protobuf field optional int32 standard_capacity_percent_above_base = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setStandardCapacityPercentAboveBase($var) + { + GPBUtil::checkInt32($var); + $this->standard_capacity_percent_above_base = $var; + + return $this; + } + +} + + From 273bc5c899391c7aee545523a2dc734debf8cee8 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 17:06:38 -0400 Subject: [PATCH 030/157] feat: discovery of BigQuery snapshots (#7751) docs: documentation revisions for data profiles PiperOrigin-RevId: 686533927 Source-Link: https://github.com/googleapis/googleapis/commit/4c44b3061bb776caeeb5b73307786678e6191e05 Source-Link: https://github.com/googleapis/googleapis-gen/commit/51494a604e6656406118a2911bd484aa14382df7 Copy-Tag: eyJwIjoiRGxwLy5Pd2xCb3QueWFtbCIsImgiOiI1MTQ5NGE2MDRlNjY1NjQwNjExOGEyOTExYmQ0ODRhYTE0MzgyZGY3In0= --- Dlp/metadata/V2/Dlp.php | Bin 83947 -> 83982 bytes Dlp/src/V2/BigQueryTableType.php | 11 +++++-- Dlp/src/V2/BigQueryTableTypeCollection.php | 4 +-- Dlp/src/V2/Client/DlpServiceClient.php | 10 ++----- Dlp/src/V2/ColumnDataProfile.php | 32 ++++++++++----------- Dlp/src/V2/TableDataProfile.php | 28 ++++++++++-------- 6 files changed, 46 insertions(+), 39 deletions(-) diff --git a/Dlp/metadata/V2/Dlp.php b/Dlp/metadata/V2/Dlp.php index 237116b315a86a6211c3a11103193921f5a6b3de..3ed2683588ef5157ddb1531ea7c02226b9dbe415 100644 GIT binary patch delta 74 zcmV-Q0JZgoogle.privacy.dlp.v2.BigQueryTableType */ @@ -32,11 +32,18 @@ class BigQueryTableType * Generated from protobuf enum BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE = 2; */ const BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE = 2; + /** + * A snapshot of a BigQuery table. + * + * Generated from protobuf enum BIG_QUERY_TABLE_TYPE_SNAPSHOT = 3; + */ + const BIG_QUERY_TABLE_TYPE_SNAPSHOT = 3; private static $valueToName = [ self::BIG_QUERY_TABLE_TYPE_UNSPECIFIED => 'BIG_QUERY_TABLE_TYPE_UNSPECIFIED', self::BIG_QUERY_TABLE_TYPE_TABLE => 'BIG_QUERY_TABLE_TYPE_TABLE', self::BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE => 'BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE', + self::BIG_QUERY_TABLE_TYPE_SNAPSHOT => 'BIG_QUERY_TABLE_TYPE_SNAPSHOT', ]; public static function name($value) diff --git a/Dlp/src/V2/BigQueryTableTypeCollection.php b/Dlp/src/V2/BigQueryTableTypeCollection.php index b6e5441108ea..28c960f7cf56 100644 --- a/Dlp/src/V2/BigQueryTableTypeCollection.php +++ b/Dlp/src/V2/BigQueryTableTypeCollection.php @@ -7,8 +7,8 @@ use UnexpectedValueException; /** - * Over time new types may be added. Currently VIEW, MATERIALIZED_VIEW, - * and SNAPSHOT are not supported. + * Over time new types may be added. Currently VIEW, MATERIALIZED_VIEW, and + * non-BigLake external tables are not supported. * * Protobuf type google.privacy.dlp.v2.BigQueryTableTypeCollection */ diff --git a/Dlp/src/V2/Client/DlpServiceClient.php b/Dlp/src/V2/Client/DlpServiceClient.php index 2791f5142e59..f90d8b555805 100644 --- a/Dlp/src/V2/Client/DlpServiceClient.php +++ b/Dlp/src/V2/Client/DlpServiceClient.php @@ -108,13 +108,9 @@ use GuzzleHttp\Promise\PromiseInterface; /** - * Service Description: The Cloud Data Loss Prevention (DLP) API is a service that allows clients - * to detect the presence of Personally Identifiable Information (PII) and other - * privacy-sensitive data in user-supplied, unstructured data streams, like text - * blocks or images. - * The service also includes methods for sensitive data redaction and - * scheduling of data scans on Google Cloud Platform based data sets. - * + * Service Description: Sensitive Data Protection provides access to a powerful sensitive data + * inspection, classification, and de-identification platform that works + * on text, images, and Google Cloud storage repositories. * To learn more about concepts and find how-to guides see * https://cloud.google.com/sensitive-data-protection/docs/. * diff --git a/Dlp/src/V2/ColumnDataProfile.php b/Dlp/src/V2/ColumnDataProfile.php index 6afebd01c479..31666dd0d547 100644 --- a/Dlp/src/V2/ColumnDataProfile.php +++ b/Dlp/src/V2/ColumnDataProfile.php @@ -59,21 +59,21 @@ class ColumnDataProfile extends \Google\Protobuf\Internal\Message */ protected $dataset_project_id = ''; /** - * The BigQuery location where the dataset's data is stored. + * If supported, the location where the dataset's data is stored. * See https://cloud.google.com/bigquery/docs/locations for supported - * locations. + * BigQuery locations. * * Generated from protobuf field string dataset_location = 20; */ protected $dataset_location = ''; /** - * The BigQuery dataset ID. + * The BigQuery dataset ID, if the resource profiled is a BigQuery table. * * Generated from protobuf field string dataset_id = 21; */ protected $dataset_id = ''; /** - * The BigQuery table ID. + * The table ID. * * Generated from protobuf field string table_id = 22; */ @@ -166,13 +166,13 @@ class ColumnDataProfile extends \Google\Protobuf\Internal\Message * @type string $dataset_project_id * The Google Cloud project ID that owns the profiled resource. * @type string $dataset_location - * The BigQuery location where the dataset's data is stored. + * If supported, the location where the dataset's data is stored. * See https://cloud.google.com/bigquery/docs/locations for supported - * locations. + * BigQuery locations. * @type string $dataset_id - * The BigQuery dataset ID. + * The BigQuery dataset ID, if the resource profiled is a BigQuery table. * @type string $table_id - * The BigQuery table ID. + * The table ID. * @type string $column * The name of the column. * @type \Google\Cloud\Dlp\V2\SensitivityScore $sensitivity_score @@ -410,9 +410,9 @@ public function setDatasetProjectId($var) } /** - * The BigQuery location where the dataset's data is stored. + * If supported, the location where the dataset's data is stored. * See https://cloud.google.com/bigquery/docs/locations for supported - * locations. + * BigQuery locations. * * Generated from protobuf field string dataset_location = 20; * @return string @@ -423,9 +423,9 @@ public function getDatasetLocation() } /** - * The BigQuery location where the dataset's data is stored. + * If supported, the location where the dataset's data is stored. * See https://cloud.google.com/bigquery/docs/locations for supported - * locations. + * BigQuery locations. * * Generated from protobuf field string dataset_location = 20; * @param string $var @@ -440,7 +440,7 @@ public function setDatasetLocation($var) } /** - * The BigQuery dataset ID. + * The BigQuery dataset ID, if the resource profiled is a BigQuery table. * * Generated from protobuf field string dataset_id = 21; * @return string @@ -451,7 +451,7 @@ public function getDatasetId() } /** - * The BigQuery dataset ID. + * The BigQuery dataset ID, if the resource profiled is a BigQuery table. * * Generated from protobuf field string dataset_id = 21; * @param string $var @@ -466,7 +466,7 @@ public function setDatasetId($var) } /** - * The BigQuery table ID. + * The table ID. * * Generated from protobuf field string table_id = 22; * @return string @@ -477,7 +477,7 @@ public function getTableId() } /** - * The BigQuery table ID. + * The table ID. * * Generated from protobuf field string table_id = 22; * @param string $var diff --git a/Dlp/src/V2/TableDataProfile.php b/Dlp/src/V2/TableDataProfile.php index 504ea9e5786a..d7f617c0c325 100644 --- a/Dlp/src/V2/TableDataProfile.php +++ b/Dlp/src/V2/TableDataProfile.php @@ -48,19 +48,20 @@ class TableDataProfile extends \Google\Protobuf\Internal\Message */ protected $dataset_location = ''; /** - * If the resource is BigQuery, the dataset ID. + * If the resource is BigQuery, the dataset ID. * * Generated from protobuf field string dataset_id = 25; */ protected $dataset_id = ''; /** - * If the resource is BigQuery, the BigQuery table ID. + * The table ID. * * Generated from protobuf field string table_id = 26; */ protected $table_id = ''; /** - * The resource name of the resource profiled. + * The Cloud Asset Inventory resource that was profiled in order to generate + * this TableDataProfile. * https://cloud.google.com/apis/design/resource_names#full_resource_name * * Generated from protobuf field string full_resource = 3; @@ -196,11 +197,12 @@ class TableDataProfile extends \Google\Protobuf\Internal\Message * See https://cloud.google.com/bigquery/docs/locations for supported * locations. * @type string $dataset_id - * If the resource is BigQuery, the dataset ID. + * If the resource is BigQuery, the dataset ID. * @type string $table_id - * If the resource is BigQuery, the BigQuery table ID. + * The table ID. * @type string $full_resource - * The resource name of the resource profiled. + * The Cloud Asset Inventory resource that was profiled in order to generate + * this TableDataProfile. * https://cloud.google.com/apis/design/resource_names#full_resource_name * @type \Google\Cloud\Dlp\V2\ProfileStatus $profile_status * Success or error status from the most recent profile generation attempt. @@ -392,7 +394,7 @@ public function setDatasetLocation($var) } /** - * If the resource is BigQuery, the dataset ID. + * If the resource is BigQuery, the dataset ID. * * Generated from protobuf field string dataset_id = 25; * @return string @@ -403,7 +405,7 @@ public function getDatasetId() } /** - * If the resource is BigQuery, the dataset ID. + * If the resource is BigQuery, the dataset ID. * * Generated from protobuf field string dataset_id = 25; * @param string $var @@ -418,7 +420,7 @@ public function setDatasetId($var) } /** - * If the resource is BigQuery, the BigQuery table ID. + * The table ID. * * Generated from protobuf field string table_id = 26; * @return string @@ -429,7 +431,7 @@ public function getTableId() } /** - * If the resource is BigQuery, the BigQuery table ID. + * The table ID. * * Generated from protobuf field string table_id = 26; * @param string $var @@ -444,7 +446,8 @@ public function setTableId($var) } /** - * The resource name of the resource profiled. + * The Cloud Asset Inventory resource that was profiled in order to generate + * this TableDataProfile. * https://cloud.google.com/apis/design/resource_names#full_resource_name * * Generated from protobuf field string full_resource = 3; @@ -456,7 +459,8 @@ public function getFullResource() } /** - * The resource name of the resource profiled. + * The Cloud Asset Inventory resource that was profiled in order to generate + * this TableDataProfile. * https://cloud.google.com/apis/design/resource_names#full_resource_name * * Generated from protobuf field string full_resource = 3; From 869923514bca067beac9c0b754b47435fb1d8f05 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 17:07:29 -0400 Subject: [PATCH 031/157] docs: Marks the `google.cloud.essentialcontacts.v1.Contact.validation_state` field as `output_only` (#7745) PiperOrigin-RevId: 685731240 Source-Link: https://github.com/googleapis/googleapis/commit/f78cd2f7943b9a2eb9734e56a8f3428da75917e2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/1d05fdc15839d2f02bf73dd7b6f30f58f9ad701e Copy-Tag: eyJwIjoiRXNzZW50aWFsQ29udGFjdHMvLk93bEJvdC55YW1sIiwiaCI6IjFkMDVmZGMxNTgzOWQyZjAyYmY3M2RkN2I2ZjMwZjU4ZjlhZDcwMWUifQ== --- EssentialContacts/metadata/V1/Service.php | 8 ++++---- EssentialContacts/src/V1/Contact.php | 22 +++++++++++----------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/EssentialContacts/metadata/V1/Service.php b/EssentialContacts/metadata/V1/Service.php index 7c03e8cd390d..cd7ede5d98f6 100644 --- a/EssentialContacts/metadata/V1/Service.php +++ b/EssentialContacts/metadata/V1/Service.php @@ -24,14 +24,14 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -•" -/google/cloud/essentialcontacts/v1/service.proto!google.cloud.essentialcontacts.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto-google/cloud/essentialcontacts/v1/enums.protogoogle/protobuf/empty.proto google/protobuf/field_mask.protogoogle/protobuf/timestamp.proto"å +š" +/google/cloud/essentialcontacts/v1/service.proto!google.cloud.essentialcontacts.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto-google/cloud/essentialcontacts/v1/enums.protogoogle/protobuf/empty.proto google/protobuf/field_mask.protogoogle/protobuf/timestamp.proto"ê Contact name ( BàA email ( BàAi #notification_category_subscriptions (27.google.cloud.essentialcontacts.v1.NotificationCategoryBàA - language_tag ( BàAL -validation_state (22.google.cloud.essentialcontacts.v1.ValidationState1 + language_tag ( BàAQ +validation_state (22.google.cloud.essentialcontacts.v1.ValidationStateBàA1 validate_time ( 2.google.protobuf.Timestamp:«êA§ (essentialcontacts.googleapis.com/Contact%projects/{project}/contacts/{contact}#folders/{folder}/contacts/{contact}/organizations/{organization}/contacts/{contact}"ˆ ListContactsRequest@ diff --git a/EssentialContacts/src/V1/Contact.php b/EssentialContacts/src/V1/Contact.php index c0a08d7aeb7f..7c3a10ac5fa8 100644 --- a/EssentialContacts/src/V1/Contact.php +++ b/EssentialContacts/src/V1/Contact.php @@ -46,10 +46,10 @@ class Contact extends \Google\Protobuf\Internal\Message */ protected $language_tag = ''; /** - * The validity of the contact. A contact is considered valid if it is the - * correct recipient for notifications for a particular resource. + * Output only. The validity of the contact. A contact is considered valid if + * it is the correct recipient for notifications for a particular resource. * - * Generated from protobuf field .google.cloud.essentialcontacts.v1.ValidationState validation_state = 8; + * Generated from protobuf field .google.cloud.essentialcontacts.v1.ValidationState validation_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $validation_state = 0; /** @@ -82,8 +82,8 @@ class Contact extends \Google\Protobuf\Internal\Message * languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) * for a list of supported languages. * @type int $validation_state - * The validity of the contact. A contact is considered valid if it is the - * correct recipient for notifications for a particular resource. + * Output only. The validity of the contact. A contact is considered valid if + * it is the correct recipient for notifications for a particular resource. * @type \Google\Protobuf\Timestamp $validate_time * The last time the validation_state was updated, either manually or * automatically. A contact is considered stale if its validation state was @@ -212,10 +212,10 @@ public function setLanguageTag($var) } /** - * The validity of the contact. A contact is considered valid if it is the - * correct recipient for notifications for a particular resource. + * Output only. The validity of the contact. A contact is considered valid if + * it is the correct recipient for notifications for a particular resource. * - * Generated from protobuf field .google.cloud.essentialcontacts.v1.ValidationState validation_state = 8; + * Generated from protobuf field .google.cloud.essentialcontacts.v1.ValidationState validation_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int */ public function getValidationState() @@ -224,10 +224,10 @@ public function getValidationState() } /** - * The validity of the contact. A contact is considered valid if it is the - * correct recipient for notifications for a particular resource. + * Output only. The validity of the contact. A contact is considered valid if + * it is the correct recipient for notifications for a particular resource. * - * Generated from protobuf field .google.cloud.essentialcontacts.v1.ValidationState validation_state = 8; + * Generated from protobuf field .google.cloud.essentialcontacts.v1.ValidationState validation_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int $var * @return $this */ From 600d1af1e1e258e2ba6110ce1ae842637a8f8a5d Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 18 Oct 2024 16:08:17 -0400 Subject: [PATCH 032/157] feat: Add field `instance` to message `.google.cloud.securesourcemanager.v1.ListRepositoriesRequest` (#7752) docs: A comment for field `instance` in message `.google.cloud.securesourcemanager.v1.Repository` is changed PiperOrigin-RevId: 686540736 Source-Link: https://github.com/googleapis/googleapis/commit/d3566d5efe21e5736269f71247bde7a2b487be73 Source-Link: https://github.com/googleapis/googleapis-gen/commit/a481bc86211bc24fd5a72d55cf8c42dd4649b609 Copy-Tag: eyJwIjoiU2VjdXJlU291cmNlTWFuYWdlci8uT3dsQm90LnlhbWwiLCJoIjoiYTQ4MWJjODYyMTFiYzI0ZmQ1YTcyZDU1Y2Y4YzQyZGQ0NjQ5YjYwOSJ9 --- .../metadata/V1/SecureSourceManager.php | Bin 8162 -> 8281 bytes .../src/V1/ListRepositoriesRequest.php | 58 ++++++++++++++++++ SecureSourceManager/src/V1/Repository.php | 34 ++++++---- 3 files changed, 81 insertions(+), 11 deletions(-) diff --git a/SecureSourceManager/metadata/V1/SecureSourceManager.php b/SecureSourceManager/metadata/V1/SecureSourceManager.php index f9bc756b7e88fe7ee87dc9f3421fed3bcb6a4f45..a5a3a2cde5fd977498dd55c2ee03a3f237994ed9 100644 GIT binary patch delta 91 zcmaE4f74+DKMUjE%>pbF*%&WOUc_ZB=E}v9nO9trn3tR?!K}cj!RciDz>#tCJU)ZX cpSg6{7+*|Q5L_fKgshAeS()MH!-DdB07@Sm3IG5A delta 68 zcmV-K0K5O$K;l2J4+H^*vk(N41_7Xxq6#|}6$%JxZgX^DZewK_10Vq?2|@$lK>@QP a3oHf!p_5P%q68v(3K)|v7#Oov5(EyvH4=^h diff --git a/SecureSourceManager/src/V1/ListRepositoriesRequest.php b/SecureSourceManager/src/V1/ListRepositoriesRequest.php index 5d93ea44b71f..c62729e85029 100644 --- a/SecureSourceManager/src/V1/ListRepositoriesRequest.php +++ b/SecureSourceManager/src/V1/ListRepositoriesRequest.php @@ -40,6 +40,18 @@ class ListRepositoriesRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $filter = ''; + /** + * Optional. The name of the instance in which the repository is hosted, + * formatted as + * `projects/{project_number}/locations/{location_id}/instances/{instance_id}`. + * When listing repositories via + * securesourcemanager.googleapis.com (Control Plane API), this field is + * required. When listing repositories via *.sourcemanager.dev (Data Plane + * API), this field is ignored. + * + * Generated from protobuf field string instance = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $instance = ''; /** * @param string $parent Required. Parent value for ListRepositoriesRequest. Please see @@ -70,6 +82,14 @@ public static function build(string $parent): self * A token identifying a page of results the server should return. * @type string $filter * Optional. Filter results. + * @type string $instance + * Optional. The name of the instance in which the repository is hosted, + * formatted as + * `projects/{project_number}/locations/{location_id}/instances/{instance_id}`. + * When listing repositories via + * securesourcemanager.googleapis.com (Control Plane API), this field is + * required. When listing repositories via *.sourcemanager.dev (Data Plane + * API), this field is ignored. * } */ public function __construct($data = NULL) { @@ -183,5 +203,43 @@ public function setFilter($var) return $this; } + /** + * Optional. The name of the instance in which the repository is hosted, + * formatted as + * `projects/{project_number}/locations/{location_id}/instances/{instance_id}`. + * When listing repositories via + * securesourcemanager.googleapis.com (Control Plane API), this field is + * required. When listing repositories via *.sourcemanager.dev (Data Plane + * API), this field is ignored. + * + * Generated from protobuf field string instance = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getInstance() + { + return $this->instance; + } + + /** + * Optional. The name of the instance in which the repository is hosted, + * formatted as + * `projects/{project_number}/locations/{location_id}/instances/{instance_id}`. + * When listing repositories via + * securesourcemanager.googleapis.com (Control Plane API), this field is + * required. When listing repositories via *.sourcemanager.dev (Data Plane + * API), this field is ignored. + * + * Generated from protobuf field string instance = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setInstance($var) + { + GPBUtil::checkString($var, True); + $this->instance = $var; + + return $this; + } + } diff --git a/SecureSourceManager/src/V1/Repository.php b/SecureSourceManager/src/V1/Repository.php index 647cac650cf7..c43a041a3fff 100644 --- a/SecureSourceManager/src/V1/Repository.php +++ b/SecureSourceManager/src/V1/Repository.php @@ -34,10 +34,13 @@ class Repository extends \Google\Protobuf\Internal\Message * Optional. The name of the instance in which the repository is hosted, * formatted as * `projects/{project_number}/locations/{location_id}/instances/{instance_id}` - * For data plane CreateRepository requests, this field is output only. - * For control plane CreateRepository requests, this field is used as input. + * When creating repository via + * securesourcemanager.googleapis.com (Control Plane API), this field is used + * as input. + * When creating repository via *.sourcemanager.dev (Data Plane API), this + * field is output only. * - * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ protected $instance = ''; /** @@ -96,8 +99,11 @@ class Repository extends \Google\Protobuf\Internal\Message * Optional. The name of the instance in which the repository is hosted, * formatted as * `projects/{project_number}/locations/{location_id}/instances/{instance_id}` - * For data plane CreateRepository requests, this field is output only. - * For control plane CreateRepository requests, this field is used as input. + * When creating repository via + * securesourcemanager.googleapis.com (Control Plane API), this field is used + * as input. + * When creating repository via *.sourcemanager.dev (Data Plane API), this + * field is output only. * @type string $uid * Output only. Unique identifier of the repository. * @type \Google\Protobuf\Timestamp $create_time @@ -181,10 +187,13 @@ public function setDescription($var) * Optional. The name of the instance in which the repository is hosted, * formatted as * `projects/{project_number}/locations/{location_id}/instances/{instance_id}` - * For data plane CreateRepository requests, this field is output only. - * For control plane CreateRepository requests, this field is used as input. + * When creating repository via + * securesourcemanager.googleapis.com (Control Plane API), this field is used + * as input. + * When creating repository via *.sourcemanager.dev (Data Plane API), this + * field is output only. * - * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string */ public function getInstance() @@ -196,10 +205,13 @@ public function getInstance() * Optional. The name of the instance in which the repository is hosted, * formatted as * `projects/{project_number}/locations/{location_id}/instances/{instance_id}` - * For data plane CreateRepository requests, this field is output only. - * For control plane CreateRepository requests, this field is used as input. + * When creating repository via + * securesourcemanager.googleapis.com (Control Plane API), this field is used + * as input. + * When creating repository via *.sourcemanager.dev (Data Plane API), this + * field is output only. * - * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var * @return $this */ From 1d6c067b446bfe6cd2875f93ec7cf8447f882955 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 18 Oct 2024 16:09:05 -0400 Subject: [PATCH 033/157] feat: add `SamplingLevel` type to Data API v1alpha (#7753) feat: add `sampling_level` to the `ReportDefinition` type PiperOrigin-RevId: 686560382 Source-Link: https://github.com/googleapis/googleapis/commit/7b6975c4bb1f02bb05fd94cb6f8614f08fb55d24 Source-Link: https://github.com/googleapis/googleapis-gen/commit/52607af0302837ce880471a94e473deab5ca0e4f Copy-Tag: eyJwIjoiQW5hbHl0aWNzRGF0YS8uT3dsQm90LnlhbWwiLCJoIjoiNTI2MDdhZjAzMDI4MzdjZTg4MDQ3MWE5NGU0NzNkZWFiNWNhMGU0ZiJ9 --- .../metadata/V1Alpha/AnalyticsDataApi.php | Bin 12708 -> 12808 bytes AnalyticsData/metadata/V1Alpha/Data.php | Bin 15349 -> 15434 bytes .../V1alpha/ReportTask/ReportDefinition.php | 44 +++++++++++ AnalyticsData/src/V1alpha/SamplingLevel.php | 73 ++++++++++++++++++ 4 files changed, 117 insertions(+) create mode 100644 AnalyticsData/src/V1alpha/SamplingLevel.php diff --git a/AnalyticsData/metadata/V1Alpha/AnalyticsDataApi.php b/AnalyticsData/metadata/V1Alpha/AnalyticsDataApi.php index 0e18d43baed40009898cc8efab83989fa990db84..50549f2f578d3eaa2b59c27c496948d9fd3bb135 100644 GIT binary patch delta 113 zcmZ3I+>x?j8Z+zCm>4dziQZ4nqI{ diff --git a/AnalyticsData/metadata/V1Alpha/Data.php b/AnalyticsData/metadata/V1Alpha/Data.php index 281b7c696ed61165745b56ae7630f657304ff057..e82dcc15264d70356044922f7524769ce746838c 100644 GIT binary patch delta 104 zcmexbeyU=F1QX-S&5}$)mZ4g~T)e@Fxdl0ydFei>WvMwra$Hiuj=ljto__A}KCWS| zKJlS`!2zz$o^GD5E&>cf>|D$~{^0_QLR?&IzOF8wp}qo4LcCm@Kvf`ZKsC&hwXIJ9 E09Fbcl>h($ delta 18 acmX?A@wI$|1QX+w&5}$)mXjN-PXPc+00%z+ diff --git a/AnalyticsData/src/V1alpha/ReportTask/ReportDefinition.php b/AnalyticsData/src/V1alpha/ReportTask/ReportDefinition.php index 4aa90625bd5e..1aaec94828ea 100644 --- a/AnalyticsData/src/V1alpha/ReportTask/ReportDefinition.php +++ b/AnalyticsData/src/V1alpha/ReportTask/ReportDefinition.php @@ -122,6 +122,12 @@ class ReportDefinition extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool keep_empty_rows = 13 [(.google.api.field_behavior) = OPTIONAL]; */ private $keep_empty_rows = false; + /** + * Optional. The report's sampling level. + * + * Generated from protobuf field optional .google.analytics.data.v1alpha.SamplingLevel sampling_level = 14 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $sampling_level = null; /** * Constructor. @@ -188,6 +194,8 @@ class ReportDefinition extends \Google\Protobuf\Internal\Message * For example if a property never logs a `purchase` event, then a query for * the `eventName` dimension and `eventCount` metric will not have a row * containing eventName: "purchase" and eventCount: 0. + * @type int $sampling_level + * Optional. The report's sampling level. * } */ public function __construct($data = NULL) { @@ -607,6 +615,42 @@ public function setKeepEmptyRows($var) return $this; } + /** + * Optional. The report's sampling level. + * + * Generated from protobuf field optional .google.analytics.data.v1alpha.SamplingLevel sampling_level = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSamplingLevel() + { + return isset($this->sampling_level) ? $this->sampling_level : 0; + } + + public function hasSamplingLevel() + { + return isset($this->sampling_level); + } + + public function clearSamplingLevel() + { + unset($this->sampling_level); + } + + /** + * Optional. The report's sampling level. + * + * Generated from protobuf field optional .google.analytics.data.v1alpha.SamplingLevel sampling_level = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSamplingLevel($var) + { + GPBUtil::checkEnum($var, \Google\Analytics\Data\V1alpha\SamplingLevel::class); + $this->sampling_level = $var; + + return $this; + } + } diff --git a/AnalyticsData/src/V1alpha/SamplingLevel.php b/AnalyticsData/src/V1alpha/SamplingLevel.php new file mode 100644 index 000000000000..0891f0b9c2e8 --- /dev/null +++ b/AnalyticsData/src/V1alpha/SamplingLevel.php @@ -0,0 +1,73 @@ +google.analytics.data.v1alpha.SamplingLevel + */ +class SamplingLevel +{ + /** + * Unspecified type. + * + * Generated from protobuf enum SAMPLING_LEVEL_UNSPECIFIED = 0; + */ + const SAMPLING_LEVEL_UNSPECIFIED = 0; + /** + * Applies a sampling level of 10 million to standard properties and + * 100 million to Google Analytics 360 properties. + * + * Generated from protobuf enum LOW = 1; + */ + const LOW = 1; + /** + * Exclusive to Google Analytics 360 properties with a sampling level of 1 + * billion. + * + * Generated from protobuf enum MEDIUM = 2; + */ + const MEDIUM = 2; + /** + * Exclusive to Google Analytics 360 properties. Unsampled explorations are + * more accurate and can reveal insights that aren't visible in standard + * explorations. To learn more, see + * https://support.google.com/analytics/answer/10896953. + * + * Generated from protobuf enum UNSAMPLED = 3; + */ + const UNSAMPLED = 3; + + private static $valueToName = [ + self::SAMPLING_LEVEL_UNSPECIFIED => 'SAMPLING_LEVEL_UNSPECIFIED', + self::LOW => 'LOW', + self::MEDIUM => 'MEDIUM', + self::UNSAMPLED => 'UNSAMPLED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + From 6dcd0cd102770392a240cd1a5152e927a9ca55f7 Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Fri, 18 Oct 2024 18:26:02 -0400 Subject: [PATCH 034/157] chore(main): release 0.264.0 (#7742) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- AnalyticsData/VERSION | 2 +- BigQueryStorage/VERSION | 2 +- CHANGELOG.md | 109 ++++++++++++++++++++++++++++++ Dataproc/VERSION | 2 +- Datastore/VERSION | 2 +- Datastore/src/DatastoreClient.php | 2 +- Dlp/VERSION | 2 +- EssentialContacts/VERSION | 2 +- NetworkManagement/VERSION | 2 +- SecureSourceManager/VERSION | 2 +- composer.json | 16 ++--- 11 files changed, 126 insertions(+), 17 deletions(-) diff --git a/AnalyticsData/VERSION b/AnalyticsData/VERSION index 1cf0537c3438..5a03fb737b38 100644 --- a/AnalyticsData/VERSION +++ b/AnalyticsData/VERSION @@ -1 +1 @@ -0.19.0 +0.20.0 diff --git a/BigQueryStorage/VERSION b/BigQueryStorage/VERSION index 227cea215648..7ec1d6db4087 100644 --- a/BigQueryStorage/VERSION +++ b/BigQueryStorage/VERSION @@ -1 +1 @@ -2.0.0 +2.1.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index a4dc7d395b82..d2abfc83f13d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,114 @@ # Changelog +## 0.264.0 + +
google/analytics-data 0.20.0 + + + +### Features + +* Add `sampling_level` to the `ReportDefinition` type ([1d6c067](https://github.com/googleapis/google-cloud-php/commit/1d6c067b446bfe6cd2875f93ec7cf8447f882955)) +* Add `SamplingLevel` type to Data API v1alpha ([#7753](https://github.com/googleapis/google-cloud-php/issues/7753)) ([1d6c067](https://github.com/googleapis/google-cloud-php/commit/1d6c067b446bfe6cd2875f93ec7cf8447f882955)) + +
+ +
google/cloud-bigquery-storage 2.1.0 + + + +### Features + +* Add experimental ArrowData type and arrow_data field within AppendRowsRequest ([#7743](https://github.com/googleapis/google-cloud-php/issues/7743)) ([6865827](https://github.com/googleapis/google-cloud-php/commit/6865827d0c14684460a2565b0f6ecc1610c1ee3a)) + +
+ +
google/cloud-dataproc 2.2.0 + + + +### Features + +* Add `ProvisioningModelMix` to support mixing of spot and standard instances for secondary workers ([#7746](https://github.com/googleapis/google-cloud-php/issues/7746)) ([21b4eb5](https://github.com/googleapis/google-cloud-php/commit/21b4eb508f3ecbc690ccddb25993b3975cc4aa31)) +* Add support for configuration of bootdisk IOPS and throughput when bootdisk is a hyperdisk ([21b4eb5](https://github.com/googleapis/google-cloud-php/commit/21b4eb508f3ecbc690ccddb25993b3975cc4aa31)) + +
+ +
google/cloud-datastore 1.32.0 + + + +### Features + +* Add FindNearest API to the stable branch ([#7744](https://github.com/googleapis/google-cloud-php/issues/7744)) ([327de67](https://github.com/googleapis/google-cloud-php/commit/327de673ae8bcb59533d906237ce5c73416293c4)) + +
+ +
google/cloud-dlp 2.2.0 + + + +### Features + +* Discovery of BigQuery snapshots ([#7751](https://github.com/googleapis/google-cloud-php/issues/7751)) ([273bc5c](https://github.com/googleapis/google-cloud-php/commit/273bc5c899391c7aee545523a2dc734debf8cee8)) + + +### Documentation + +* Documentation revisions for data profiles ([273bc5c](https://github.com/googleapis/google-cloud-php/commit/273bc5c899391c7aee545523a2dc734debf8cee8)) + +
+ +
google/cloud-essential-contacts 1.0.1 + + + +### Documentation + +* Marks the `google.cloud.essentialcontacts.v1.Contact.validation_state` field as `output_only` ([#7745](https://github.com/googleapis/google-cloud-php/issues/7745)) ([8699235](https://github.com/googleapis/google-cloud-php/commit/869923514bca067beac9c0b754b47435fb1d8f05)) + +
+ +
google/cloud-network-management 2.1.0 + + + +### Features + +* Add fields related to advertised routes to the RouteInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add firewall policy URI to the FirewallInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add load balancer name to the ForwardingRuleInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add messages and fields related to Redis Clusters ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add messages and fields related to Redis Instances ([#7748](https://github.com/googleapis/google-cloud-php/issues/7748)) ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add more detailed abort and drop causes to corresponding enums ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add PSC network attachment URI to the InstanceInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add PSC target fields to the ForwardingRuleInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add region name field to the RouteInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add region name to the ForwardingRuleInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) +* Add subnet URI and region name to the NetworkInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) + + +### Documentation + +* Update outdated comments in the FirewallInfo proto ([72df650](https://github.com/googleapis/google-cloud-php/commit/72df650c65a54e473aeb0e186901295c40d0c7e8)) + +
+ +
google/cloud-securesourcemanager 1.2.0 + + + +### Features + +* Add field `instance` to message `.google.cloud.securesourcemanager.v1.ListRepositoriesRequest` ([#7752](https://github.com/googleapis/google-cloud-php/issues/7752)) ([600d1af](https://github.com/googleapis/google-cloud-php/commit/600d1af1e1e258e2ba6110ce1ae842637a8f8a5d)) + + +### Documentation + +* A comment for field `instance` in message `.google.cloud.securesourcemanager.v1.Repository` is changed ([600d1af](https://github.com/googleapis/google-cloud-php/commit/600d1af1e1e258e2ba6110ce1ae842637a8f8a5d)) + +
+ ## 0.263.0
google/cloud-backupdr 0.4.0 diff --git a/Dataproc/VERSION b/Dataproc/VERSION index 7ec1d6db4087..ccbccc3dc626 100644 --- a/Dataproc/VERSION +++ b/Dataproc/VERSION @@ -1 +1 @@ -2.1.0 +2.2.0 diff --git a/Datastore/VERSION b/Datastore/VERSION index 34aae156b192..359c41089a42 100644 --- a/Datastore/VERSION +++ b/Datastore/VERSION @@ -1 +1 @@ -1.31.0 +1.32.0 diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index d4ef798e4417..35ca4a8a93a0 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -92,7 +92,7 @@ class DatastoreClient use ClientTrait; use DatastoreTrait; - const VERSION = '1.31.0'; + const VERSION = '1.32.0'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/datastore'; diff --git a/Dlp/VERSION b/Dlp/VERSION index 7ec1d6db4087..ccbccc3dc626 100644 --- a/Dlp/VERSION +++ b/Dlp/VERSION @@ -1 +1 @@ -2.1.0 +2.2.0 diff --git a/EssentialContacts/VERSION b/EssentialContacts/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/EssentialContacts/VERSION +++ b/EssentialContacts/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/NetworkManagement/VERSION b/NetworkManagement/VERSION index 38f77a65b301..7ec1d6db4087 100644 --- a/NetworkManagement/VERSION +++ b/NetworkManagement/VERSION @@ -1 +1 @@ -2.0.1 +2.1.0 diff --git a/SecureSourceManager/VERSION b/SecureSourceManager/VERSION index 9084fa2f716a..26aaba0e8663 100644 --- a/SecureSourceManager/VERSION +++ b/SecureSourceManager/VERSION @@ -1 +1 @@ -1.1.0 +1.2.0 diff --git a/composer.json b/composer.json index a853a691adae..86d464ebec10 100644 --- a/composer.json +++ b/composer.json @@ -70,7 +70,7 @@ "google/access-context-manager": "1.0.0", "google/ads-marketingplatform-admin": "0.1.0", "google/analytics-admin": "0.24.0", - "google/analytics-data": "0.19.0", + "google/analytics-data": "0.20.0", "google/apps-chat": "0.6.0", "google/apps-events-subscriptions": "0.1.3", "google/apps-meet": "0.2.3", @@ -104,7 +104,7 @@ "google/cloud-bigquery-datapolicies": "1.0.0", "google/cloud-bigquery-migration": "1.1.0", "google/cloud-bigquery-reservation": "2.0.1", - "google/cloud-bigquery-storage": "2.0.0", + "google/cloud-bigquery-storage": "2.1.0", "google/cloud-bigquerydatatransfer": "2.1.0", "google/cloud-bigtable": "2.5.0", "google/cloud-billing": "2.0.0", @@ -130,9 +130,9 @@ "google/cloud-dataform": "0.4.5", "google/cloud-datalabeling": "0.5.5", "google/cloud-dataplex": "1.0.0", - "google/cloud-dataproc": "2.1.0", + "google/cloud-dataproc": "2.2.0", "google/cloud-dataproc-metastore": "1.0.0", - "google/cloud-datastore": "1.31.0", + "google/cloud-datastore": "1.32.0", "google/cloud-datastore-admin": "1.0.0", "google/cloud-datastream": "2.0.0", "google/cloud-debugger": "1.9.0", @@ -141,13 +141,13 @@ "google/cloud-dialogflow": "1.15.0", "google/cloud-dialogflow-cx": "0.4.0", "google/cloud-discoveryengine": "1.2.0", - "google/cloud-dlp": "2.1.0", + "google/cloud-dlp": "2.2.0", "google/cloud-dms": "2.0.1", "google/cloud-document-ai": "2.0.0", "google/cloud-domains": "1.0.0", "google/cloud-edgenetwork": "1.1.1", "google/cloud-error-reporting": "0.22.7", - "google/cloud-essential-contacts": "1.0.0", + "google/cloud-essential-contacts": "1.0.1", "google/cloud-eventarc": "2.0.1", "google/cloud-eventarc-publishing": "1.0.0", "google/cloud-filestore": "2.0.1", @@ -175,7 +175,7 @@ "google/cloud-monitoring": "1.11.0", "google/cloud-netapp": "1.1.0", "google/cloud-network-connectivity": "2.0.1", - "google/cloud-network-management": "2.0.1", + "google/cloud-network-management": "2.1.0", "google/cloud-network-security": "1.0.0", "google/cloud-networkservices": "0.2.0", "google/cloud-notebooks": "1.0.0", @@ -206,7 +206,7 @@ "google/cloud-run": "1.2.0", "google/cloud-scheduler": "2.0.0", "google/cloud-secret-manager": "1.15.2", - "google/cloud-securesourcemanager": "1.1.0", + "google/cloud-securesourcemanager": "1.2.0", "google/cloud-security-center": "2.0.1", "google/cloud-security-private-ca": "2.0.0", "google/cloud-security-public-ca": "1.0.0", From 12921fc2da9f29aea11ab9e6d4eb222f3b7d920c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Mendoza?= Date: Mon, 21 Oct 2024 17:55:16 -0400 Subject: [PATCH 035/157] Chore: Rework the compile splitsh command (#7755) --- .github/workflows/release.yml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 65749cf74998..dd7d41caf7aa 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -29,11 +29,17 @@ jobs: mkdir libgit2/build && cd libgit2/build cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local sudo cmake --build . --target install - - name: Compile splitsh + - name: Clone splitsh/lite + uses: actions/checkout@master + with: + repository: splitsh/lite + ref: v2.0.0 + path: lite + - name: Build splitsh-lite run: | - go env -w GO111MODULE=off - go get github.com/splitsh/lite - go build -o /usr/local/bin/splitsh-lite github.com/splitsh/lite + cd lite + go build -o splitsh-lite github.com/splitsh/lite + mv splitsh-lite /usr/local/bin/splitsh-lite - name: Checkout google/cloud uses: actions/checkout@v4 with: From be3a11c9f4b18c20264399206e6aa2c7716adb6a Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 18:28:14 -0700 Subject: [PATCH 036/157] feat: Add branch rule APIs (#7754) feat: Add field `psc_allowed_projects` to message `.google.cloud.securesourcemanager.v1.Instance` docs: A comment for field `instance` in message `.google.cloud.securesourcemanager.v1.Repository` is changed PiperOrigin-RevId: 688170540 Source-Link: https://github.com/googleapis/googleapis/commit/b6a9d807da8fb0f767a7b5b5b2d773e41e7d52b5 Source-Link: https://github.com/googleapis/googleapis-gen/commit/d9406c5e840d1e8289232ca089827b71c7601c00 Copy-Tag: eyJwIjoiU2VjdXJlU291cmNlTWFuYWdlci8uT3dsQm90LnlhbWwiLCJoIjoiZDk0MDZjNWU4NDBkMWU4Mjg5MjMyY2EwODk4MjdiNzFjNzYwMWMwMCJ9 --- .../metadata/V1/SecureSourceManager.php | Bin 8281 -> 11360 bytes .../create_branch_rule.php | 91 +++ .../delete_branch_rule.php | 84 +++ .../get_branch_rule.php | 78 +++ .../list_branch_rules.php | 79 +++ .../update_branch_rule.php | 74 ++ SecureSourceManager/src/V1/BranchRule.php | 620 +++++++++++++++++ .../src/V1/BranchRule/Check.php | 68 ++ .../V1/Client/SecureSourceManagerClient.php | 167 +++++ .../src/V1/CreateBranchRuleRequest.php | 141 ++++ .../src/V1/DeleteBranchRuleRequest.php | 111 +++ .../src/V1/GetBranchRuleRequest.php | 91 +++ .../src/V1/Instance/PrivateConfig.php | 42 ++ .../src/V1/ListBranchRulesRequest.php | 127 ++++ .../src/V1/ListBranchRulesResponse.php | 101 +++ SecureSourceManager/src/V1/Repository.php | 20 +- .../src/V1/UpdateBranchRuleRequest.php | 187 +++++ .../src/V1/gapic_metadata.json | 25 + .../secure_source_manager_client_config.json | 25 + ...ecure_source_manager_descriptor_config.php | 91 +++ ...cure_source_manager_rest_client_config.php | 64 ++ .../Client/SecureSourceManagerClientTest.php | 657 +++++++++++++++++- 22 files changed, 2912 insertions(+), 31 deletions(-) create mode 100644 SecureSourceManager/samples/V1/SecureSourceManagerClient/create_branch_rule.php create mode 100644 SecureSourceManager/samples/V1/SecureSourceManagerClient/delete_branch_rule.php create mode 100644 SecureSourceManager/samples/V1/SecureSourceManagerClient/get_branch_rule.php create mode 100644 SecureSourceManager/samples/V1/SecureSourceManagerClient/list_branch_rules.php create mode 100644 SecureSourceManager/samples/V1/SecureSourceManagerClient/update_branch_rule.php create mode 100644 SecureSourceManager/src/V1/BranchRule.php create mode 100644 SecureSourceManager/src/V1/BranchRule/Check.php create mode 100644 SecureSourceManager/src/V1/CreateBranchRuleRequest.php create mode 100644 SecureSourceManager/src/V1/DeleteBranchRuleRequest.php create mode 100644 SecureSourceManager/src/V1/GetBranchRuleRequest.php create mode 100644 SecureSourceManager/src/V1/ListBranchRulesRequest.php create mode 100644 SecureSourceManager/src/V1/ListBranchRulesResponse.php create mode 100644 SecureSourceManager/src/V1/UpdateBranchRuleRequest.php diff --git a/SecureSourceManager/metadata/V1/SecureSourceManager.php b/SecureSourceManager/metadata/V1/SecureSourceManager.php index a5a3a2cde5fd977498dd55c2ee03a3f237994ed9..ce998e64e2ba268ced99505696b5ac159bc773c9 100644 GIT binary patch delta 1812 zcma)6&2QX99F^_e?d~|6-F2MUyW7yjg-x^yyXqDW4OJAUNf93*C=y=@l9}vI6BDm( z>~TtpstT@vR5T|<{{|>pi8HxXxzGx6AQGa7UVsCfk&qaBKgMe=+&nXHe!usg-*0|i zef;+Q6CroqL{?`L`iJBaUnjSP961qQ;~#AGN~vY8I=AmQ`xa`to`ape;70RC2sgSR zem%X&{nYEGzvsF8y+(GDyC}^A+4b87v@GW)>KOFa`>2h5H8UqH=GKJAI@i0JyOOH^ zngL+VgLeC1JFt*c0x27Ik;=_+1DI3Da!SrnSY^DuJ12?y#B-ok2Ei>>Wql!%hgpeM)H5={zWycH0U%$Z#RX$g|aR>~tDr zJEjl!EYwl6bUWLxLxppCVrE|pPa{Q@S&)ua zk_^tZ9UG$$G5fE4r3H%Y&ybB=Ew_A^`(6Kx1J4qelF5Wvm|%saT>`-(+0B>B&Am}x z{N_jfh2hck^!)sjOi9}X@{0(wtK`qAwF_*iJ>Y z4w21nbJ{JStRoAJ5v5|{_g|3DU)H{(ir#QLV~Vz;9O9&saIgkSmPe#eUr7bzY3j_d zj^WtWaU^>X^XGsVL>>AQ|1e$FNAE>+TRR5Im{R0#Bj2TSiKGoM5wpmrDF_EOvNNvb zo>UfEe^+}u@^4v1`jiL7(ov_f;F&(} zLXS?(QjAahoBqB}etbgsO>KpU(;E4@T5QDgwj7Uz^a}?H3C$9DFH<9bDJhw`ON|KM z1YC*OhljPX!@f(})|sB^vx_LKN+SwS#VJUq9LSFc{9}0`vGar4sInf~=9wP7tE0jv z)AQt;>SQfmxLLm~eNIhJCTU=LayvBrt*`!<=}O$~Sd1b%@3dZS9$gw6setParent($formattedParent) + ->setBranchRule($branchRule) + ->setBranchRuleId($branchRuleId); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $secureSourceManagerClient->createBranchRule($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var BranchRule $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 +{ + $formattedParent = SecureSourceManagerClient::repositoryName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]' + ); + $branchRuleId = '[BRANCH_RULE_ID]'; + + create_branch_rule_sample($formattedParent, $branchRuleId); +} +// [END securesourcemanager_v1_generated_SecureSourceManager_CreateBranchRule_sync] diff --git a/SecureSourceManager/samples/V1/SecureSourceManagerClient/delete_branch_rule.php b/SecureSourceManager/samples/V1/SecureSourceManagerClient/delete_branch_rule.php new file mode 100644 index 000000000000..ea41d7e97423 --- /dev/null +++ b/SecureSourceManager/samples/V1/SecureSourceManagerClient/delete_branch_rule.php @@ -0,0 +1,84 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $secureSourceManagerClient->deleteBranchRule($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } 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 +{ + $formattedName = SecureSourceManagerClient::branchRuleName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]', + '[BRANCH_RULE]' + ); + + delete_branch_rule_sample($formattedName); +} +// [END securesourcemanager_v1_generated_SecureSourceManager_DeleteBranchRule_sync] diff --git a/SecureSourceManager/samples/V1/SecureSourceManagerClient/get_branch_rule.php b/SecureSourceManager/samples/V1/SecureSourceManagerClient/get_branch_rule.php new file mode 100644 index 000000000000..92d58064f39b --- /dev/null +++ b/SecureSourceManager/samples/V1/SecureSourceManagerClient/get_branch_rule.php @@ -0,0 +1,78 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var BranchRule $response */ + $response = $secureSourceManagerClient->getBranchRule($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = SecureSourceManagerClient::branchRuleName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]', + '[BRANCH_RULE]' + ); + + get_branch_rule_sample($formattedName); +} +// [END securesourcemanager_v1_generated_SecureSourceManager_GetBranchRule_sync] diff --git a/SecureSourceManager/samples/V1/SecureSourceManagerClient/list_branch_rules.php b/SecureSourceManager/samples/V1/SecureSourceManagerClient/list_branch_rules.php new file mode 100644 index 000000000000..22314e1df0b1 --- /dev/null +++ b/SecureSourceManager/samples/V1/SecureSourceManagerClient/list_branch_rules.php @@ -0,0 +1,79 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $secureSourceManagerClient->listBranchRules($request); + + /** @var BranchRule $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = SecureSourceManagerClient::repositoryName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]' + ); + + list_branch_rules_sample($formattedParent); +} +// [END securesourcemanager_v1_generated_SecureSourceManager_ListBranchRules_sync] diff --git a/SecureSourceManager/samples/V1/SecureSourceManagerClient/update_branch_rule.php b/SecureSourceManager/samples/V1/SecureSourceManagerClient/update_branch_rule.php new file mode 100644 index 000000000000..6baafcb1d6b8 --- /dev/null +++ b/SecureSourceManager/samples/V1/SecureSourceManagerClient/update_branch_rule.php @@ -0,0 +1,74 @@ +setBranchRule($branchRule) + ->setUpdateMask($updateMask); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $secureSourceManagerClient->updateBranchRule($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var BranchRule $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()); + } +} +// [END securesourcemanager_v1_generated_SecureSourceManager_UpdateBranchRule_sync] diff --git a/SecureSourceManager/src/V1/BranchRule.php b/SecureSourceManager/src/V1/BranchRule.php new file mode 100644 index 000000000000..8bb18a7dca9a --- /dev/null +++ b/SecureSourceManager/src/V1/BranchRule.php @@ -0,0 +1,620 @@ +google.cloud.securesourcemanager.v1.BranchRule + */ +class BranchRule extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. A unique identifier for a BranchRule. The name should be of the + * format: + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $name = ''; + /** + * Output only. Unique identifier of the repository. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $uid = ''; + /** + * Output only. Create timestamp. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. Update timestamp. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. User annotations. These attributes can only be set and used by + * the user. See https://google.aip.dev/128#annotations for more details such + * as format and size limitations. + * + * Generated from protobuf field map annotations = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; + /** + * Optional. This checksum is computed by the server based on the value of + * other fields, and may be sent on update and delete requests to ensure the + * client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = ''; + /** + * Optional. The pattern of the branch that can match to this BranchRule. + * Specified as regex. + * .* for all branches. Examples: main, (main|release.*). + * Current MVP phase only support `.*` for wildcard. + * + * Generated from protobuf field string include_pattern = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $include_pattern = ''; + /** + * Optional. Determines if the branch rule is disabled or not. + * + * Generated from protobuf field bool disabled = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disabled = false; + /** + * Optional. Determines if the branch rule requires a pull request or not. + * + * Generated from protobuf field bool require_pull_request = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $require_pull_request = false; + /** + * Optional. The minimum number of reviews required for the branch rule to be + * matched. + * + * Generated from protobuf field int32 minimum_reviews_count = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $minimum_reviews_count = 0; + /** + * Optional. The minimum number of approvals required for the branch rule to + * be matched. + * + * Generated from protobuf field int32 minimum_approvals_count = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $minimum_approvals_count = 0; + /** + * Optional. Determines if require comments resolved before merging to the + * branch. + * + * Generated from protobuf field bool require_comments_resolved = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $require_comments_resolved = false; + /** + * Optional. Determines if allow stale reviews or approvals before merging to + * the branch. + * + * Generated from protobuf field bool allow_stale_reviews = 15 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_stale_reviews = false; + /** + * Optional. Determines if require linear history before merging to the + * branch. + * + * Generated from protobuf field bool require_linear_history = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $require_linear_history = false; + /** + * Optional. List of required status checks before merging to the branch. + * + * Generated from protobuf field repeated .google.cloud.securesourcemanager.v1.BranchRule.Check required_status_checks = 14 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $required_status_checks; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Optional. A unique identifier for a BranchRule. The name should be of the + * format: + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}` + * @type string $uid + * Output only. Unique identifier of the repository. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. Create timestamp. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. Update timestamp. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. User annotations. These attributes can only be set and used by + * the user. See https://google.aip.dev/128#annotations for more details such + * as format and size limitations. + * @type string $etag + * Optional. This checksum is computed by the server based on the value of + * other fields, and may be sent on update and delete requests to ensure the + * client has an up-to-date value before proceeding. + * @type string $include_pattern + * Optional. The pattern of the branch that can match to this BranchRule. + * Specified as regex. + * .* for all branches. Examples: main, (main|release.*). + * Current MVP phase only support `.*` for wildcard. + * @type bool $disabled + * Optional. Determines if the branch rule is disabled or not. + * @type bool $require_pull_request + * Optional. Determines if the branch rule requires a pull request or not. + * @type int $minimum_reviews_count + * Optional. The minimum number of reviews required for the branch rule to be + * matched. + * @type int $minimum_approvals_count + * Optional. The minimum number of approvals required for the branch rule to + * be matched. + * @type bool $require_comments_resolved + * Optional. Determines if require comments resolved before merging to the + * branch. + * @type bool $allow_stale_reviews + * Optional. Determines if allow stale reviews or approvals before merging to + * the branch. + * @type bool $require_linear_history + * Optional. Determines if require linear history before merging to the + * branch. + * @type array<\Google\Cloud\SecureSourceManager\V1\BranchRule\Check>|\Google\Protobuf\Internal\RepeatedField $required_status_checks + * Optional. List of required status checks before merging to the branch. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Securesourcemanager\V1\SecureSourceManager::initOnce(); + parent::__construct($data); + } + + /** + * Optional. A unique identifier for a BranchRule. The name should be of the + * format: + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Optional. A unique identifier for a BranchRule. The name should be of the + * format: + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. Unique identifier of the repository. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getUid() + { + return $this->uid; + } + + /** + * Output only. Unique identifier of the repository. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setUid($var) + { + GPBUtil::checkString($var, True); + $this->uid = $var; + + return $this; + } + + /** + * Output only. Create timestamp. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. Create timestamp. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. Update timestamp. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. Update timestamp. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. User annotations. These attributes can only be set and used by + * the user. See https://google.aip.dev/128#annotations for more details such + * as format and size limitations. + * + * Generated from protobuf field map annotations = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. User annotations. These attributes can only be set and used by + * the user. See https://google.aip.dev/128#annotations for more details such + * as format and size limitations. + * + * Generated from protobuf field map annotations = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + + /** + * Optional. This checksum is computed by the server based on the value of + * other fields, and may be sent on update and delete requests to ensure the + * client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Optional. This checksum is computed by the server based on the value of + * other fields, and may be sent on update and delete requests to ensure the + * client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Optional. The pattern of the branch that can match to this BranchRule. + * Specified as regex. + * .* for all branches. Examples: main, (main|release.*). + * Current MVP phase only support `.*` for wildcard. + * + * Generated from protobuf field string include_pattern = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getIncludePattern() + { + return $this->include_pattern; + } + + /** + * Optional. The pattern of the branch that can match to this BranchRule. + * Specified as regex. + * .* for all branches. Examples: main, (main|release.*). + * Current MVP phase only support `.*` for wildcard. + * + * Generated from protobuf field string include_pattern = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setIncludePattern($var) + { + GPBUtil::checkString($var, True); + $this->include_pattern = $var; + + return $this; + } + + /** + * Optional. Determines if the branch rule is disabled or not. + * + * Generated from protobuf field bool disabled = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getDisabled() + { + return $this->disabled; + } + + /** + * Optional. Determines if the branch rule is disabled or not. + * + * Generated from protobuf field bool disabled = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setDisabled($var) + { + GPBUtil::checkBool($var); + $this->disabled = $var; + + return $this; + } + + /** + * Optional. Determines if the branch rule requires a pull request or not. + * + * Generated from protobuf field bool require_pull_request = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getRequirePullRequest() + { + return $this->require_pull_request; + } + + /** + * Optional. Determines if the branch rule requires a pull request or not. + * + * Generated from protobuf field bool require_pull_request = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setRequirePullRequest($var) + { + GPBUtil::checkBool($var); + $this->require_pull_request = $var; + + return $this; + } + + /** + * Optional. The minimum number of reviews required for the branch rule to be + * matched. + * + * Generated from protobuf field int32 minimum_reviews_count = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getMinimumReviewsCount() + { + return $this->minimum_reviews_count; + } + + /** + * Optional. The minimum number of reviews required for the branch rule to be + * matched. + * + * Generated from protobuf field int32 minimum_reviews_count = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setMinimumReviewsCount($var) + { + GPBUtil::checkInt32($var); + $this->minimum_reviews_count = $var; + + return $this; + } + + /** + * Optional. The minimum number of approvals required for the branch rule to + * be matched. + * + * Generated from protobuf field int32 minimum_approvals_count = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getMinimumApprovalsCount() + { + return $this->minimum_approvals_count; + } + + /** + * Optional. The minimum number of approvals required for the branch rule to + * be matched. + * + * Generated from protobuf field int32 minimum_approvals_count = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setMinimumApprovalsCount($var) + { + GPBUtil::checkInt32($var); + $this->minimum_approvals_count = $var; + + return $this; + } + + /** + * Optional. Determines if require comments resolved before merging to the + * branch. + * + * Generated from protobuf field bool require_comments_resolved = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getRequireCommentsResolved() + { + return $this->require_comments_resolved; + } + + /** + * Optional. Determines if require comments resolved before merging to the + * branch. + * + * Generated from protobuf field bool require_comments_resolved = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setRequireCommentsResolved($var) + { + GPBUtil::checkBool($var); + $this->require_comments_resolved = $var; + + return $this; + } + + /** + * Optional. Determines if allow stale reviews or approvals before merging to + * the branch. + * + * Generated from protobuf field bool allow_stale_reviews = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowStaleReviews() + { + return $this->allow_stale_reviews; + } + + /** + * Optional. Determines if allow stale reviews or approvals before merging to + * the branch. + * + * Generated from protobuf field bool allow_stale_reviews = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowStaleReviews($var) + { + GPBUtil::checkBool($var); + $this->allow_stale_reviews = $var; + + return $this; + } + + /** + * Optional. Determines if require linear history before merging to the + * branch. + * + * Generated from protobuf field bool require_linear_history = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getRequireLinearHistory() + { + return $this->require_linear_history; + } + + /** + * Optional. Determines if require linear history before merging to the + * branch. + * + * Generated from protobuf field bool require_linear_history = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setRequireLinearHistory($var) + { + GPBUtil::checkBool($var); + $this->require_linear_history = $var; + + return $this; + } + + /** + * Optional. List of required status checks before merging to the branch. + * + * Generated from protobuf field repeated .google.cloud.securesourcemanager.v1.BranchRule.Check required_status_checks = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRequiredStatusChecks() + { + return $this->required_status_checks; + } + + /** + * Optional. List of required status checks before merging to the branch. + * + * Generated from protobuf field repeated .google.cloud.securesourcemanager.v1.BranchRule.Check required_status_checks = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\SecureSourceManager\V1\BranchRule\Check>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRequiredStatusChecks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\SecureSourceManager\V1\BranchRule\Check::class); + $this->required_status_checks = $arr; + + return $this; + } + +} + diff --git a/SecureSourceManager/src/V1/BranchRule/Check.php b/SecureSourceManager/src/V1/BranchRule/Check.php new file mode 100644 index 000000000000..f222c46b9575 --- /dev/null +++ b/SecureSourceManager/src/V1/BranchRule/Check.php @@ -0,0 +1,68 @@ +google.cloud.securesourcemanager.v1.BranchRule.Check + */ +class Check extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The context of the check. + * + * Generated from protobuf field string context = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $context = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $context + * Required. The context of the check. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Securesourcemanager\V1\SecureSourceManager::initOnce(); + parent::__construct($data); + } + + /** + * Required. The context of the check. + * + * Generated from protobuf field string context = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getContext() + { + return $this->context; + } + + /** + * Required. The context of the check. + * + * Generated from protobuf field string context = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setContext($var) + { + GPBUtil::checkString($var, True); + $this->context = $var; + + return $this; + } + +} + + diff --git a/SecureSourceManager/src/V1/Client/SecureSourceManagerClient.php b/SecureSourceManager/src/V1/Client/SecureSourceManagerClient.php index aea6eda4a9e4..74d9b8633cd0 100644 --- a/SecureSourceManager/src/V1/Client/SecureSourceManagerClient.php +++ b/SecureSourceManager/src/V1/Client/SecureSourceManagerClient.php @@ -42,16 +42,22 @@ use Google\Cloud\Location\GetLocationRequest; use Google\Cloud\Location\ListLocationsRequest; use Google\Cloud\Location\Location; +use Google\Cloud\SecureSourceManager\V1\BranchRule; +use Google\Cloud\SecureSourceManager\V1\CreateBranchRuleRequest; use Google\Cloud\SecureSourceManager\V1\CreateInstanceRequest; use Google\Cloud\SecureSourceManager\V1\CreateRepositoryRequest; +use Google\Cloud\SecureSourceManager\V1\DeleteBranchRuleRequest; use Google\Cloud\SecureSourceManager\V1\DeleteInstanceRequest; use Google\Cloud\SecureSourceManager\V1\DeleteRepositoryRequest; +use Google\Cloud\SecureSourceManager\V1\GetBranchRuleRequest; use Google\Cloud\SecureSourceManager\V1\GetInstanceRequest; use Google\Cloud\SecureSourceManager\V1\GetRepositoryRequest; use Google\Cloud\SecureSourceManager\V1\Instance; +use Google\Cloud\SecureSourceManager\V1\ListBranchRulesRequest; use Google\Cloud\SecureSourceManager\V1\ListInstancesRequest; use Google\Cloud\SecureSourceManager\V1\ListRepositoriesRequest; use Google\Cloud\SecureSourceManager\V1\Repository; +use Google\Cloud\SecureSourceManager\V1\UpdateBranchRuleRequest; use Google\LongRunning\Client\OperationsClient; use Google\LongRunning\Operation; use GuzzleHttp\Promise\PromiseInterface; @@ -86,17 +92,22 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * + * @method PromiseInterface createBranchRuleAsync(CreateBranchRuleRequest $request, array $optionalArgs = []) * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBranchRuleAsync(DeleteBranchRuleRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBranchRuleAsync(GetBranchRuleRequest $request, array $optionalArgs = []) * @method PromiseInterface getIamPolicyRepoAsync(GetIamPolicyRequest $request, array $optionalArgs = []) * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBranchRulesAsync(ListBranchRulesRequest $request, array $optionalArgs = []) * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) * @method PromiseInterface setIamPolicyRepoAsync(SetIamPolicyRequest $request, array $optionalArgs = []) * @method PromiseInterface testIamPermissionsRepoAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBranchRuleAsync(UpdateBranchRuleRequest $request, array $optionalArgs = []) * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) @@ -201,6 +212,31 @@ private function createOperationsClient(array $options) return new OperationsClient($options); } + /** + * Formats a string containing the fully-qualified path to represent a branch_rule + * resource. + * + * @param string $project + * @param string $location + * @param string $repository + * @param string $branchRule + * + * @return string The formatted branch_rule resource. + */ + public static function branchRuleName( + string $project, + string $location, + string $repository, + string $branchRule + ): string { + return self::getPathTemplate('branchRule')->render([ + 'project' => $project, + 'location' => $location, + 'repository' => $repository, + 'branch_rule' => $branchRule, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a ca_pool * resource. @@ -319,6 +355,7 @@ public static function serviceAttachmentName(string $project, string $region, st * Parses a formatted name string and returns an associative array of the components in the name. * The following name formats are supported: * Template: Pattern + * - branchRule: projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule} * - caPool: projects/{project}/locations/{location}/caPools/{ca_pool} * - cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} * - instance: projects/{project}/locations/{location}/instances/{instance} @@ -416,6 +453,32 @@ public function __call($method, $args) return call_user_func_array([$this, 'startAsyncCall'], $args); } + /** + * CreateBranchRule creates a branch rule in a given repository. + * + * The async variant is {@see SecureSourceManagerClient::createBranchRuleAsync()} . + * + * @example samples/V1/SecureSourceManagerClient/create_branch_rule.php + * + * @param CreateBranchRuleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createBranchRule(CreateBranchRuleRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreateBranchRule', $request, $callOptions)->wait(); + } + /** * Creates a new instance in a given project and location. * @@ -470,6 +533,32 @@ public function createRepository(CreateRepositoryRequest $request, array $callOp return $this->startApiCall('CreateRepository', $request, $callOptions)->wait(); } + /** + * DeleteBranchRule deletes a branch rule. + * + * The async variant is {@see SecureSourceManagerClient::deleteBranchRuleAsync()} . + * + * @example samples/V1/SecureSourceManagerClient/delete_branch_rule.php + * + * @param DeleteBranchRuleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteBranchRule(DeleteBranchRuleRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteBranchRule', $request, $callOptions)->wait(); + } + /** * Deletes a single instance. * @@ -524,6 +613,32 @@ public function deleteRepository(DeleteRepositoryRequest $request, array $callOp return $this->startApiCall('DeleteRepository', $request, $callOptions)->wait(); } + /** + * GetBranchRule gets a branch rule. + * + * The async variant is {@see SecureSourceManagerClient::getBranchRuleAsync()} . + * + * @example samples/V1/SecureSourceManagerClient/get_branch_rule.php + * + * @param GetBranchRuleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return BranchRule + * + * @throws ApiException Thrown if the API call fails. + */ + public function getBranchRule(GetBranchRuleRequest $request, array $callOptions = []): BranchRule + { + return $this->startApiCall('GetBranchRule', $request, $callOptions)->wait(); + } + /** * Get IAM policy for a repository. * @@ -604,6 +719,32 @@ public function getRepository(GetRepositoryRequest $request, array $callOptions return $this->startApiCall('GetRepository', $request, $callOptions)->wait(); } + /** + * ListBranchRules lists branch rules in a given repository. + * + * The async variant is {@see SecureSourceManagerClient::listBranchRulesAsync()} . + * + * @example samples/V1/SecureSourceManagerClient/list_branch_rules.php + * + * @param ListBranchRulesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listBranchRules(ListBranchRulesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListBranchRules', $request, $callOptions); + } + /** * Lists Instances in a given project and location. * @@ -714,6 +855,32 @@ public function testIamPermissionsRepo( return $this->startApiCall('TestIamPermissionsRepo', $request, $callOptions)->wait(); } + /** + * UpdateBranchRule updates a branch rule. + * + * The async variant is {@see SecureSourceManagerClient::updateBranchRuleAsync()} . + * + * @example samples/V1/SecureSourceManagerClient/update_branch_rule.php + * + * @param UpdateBranchRuleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateBranchRule(UpdateBranchRuleRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('UpdateBranchRule', $request, $callOptions)->wait(); + } + /** * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. diff --git a/SecureSourceManager/src/V1/CreateBranchRuleRequest.php b/SecureSourceManager/src/V1/CreateBranchRuleRequest.php new file mode 100644 index 000000000000..2afd8aa99c0e --- /dev/null +++ b/SecureSourceManager/src/V1/CreateBranchRuleRequest.php @@ -0,0 +1,141 @@ +google.cloud.securesourcemanager.v1.CreateBranchRuleRequest + */ +class CreateBranchRuleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Generated from protobuf field .google.cloud.securesourcemanager.v1.BranchRule branch_rule = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $branch_rule = null; + /** + * Generated from protobuf field string branch_rule_id = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $branch_rule_id = ''; + + /** + * @param string $parent Please see {@see SecureSourceManagerClient::repositoryName()} for help formatting this field. + * @param \Google\Cloud\SecureSourceManager\V1\BranchRule $branchRule + * @param string $branchRuleId + * + * @return \Google\Cloud\SecureSourceManager\V1\CreateBranchRuleRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\SecureSourceManager\V1\BranchRule $branchRule, string $branchRuleId): self + { + return (new self()) + ->setParent($parent) + ->setBranchRule($branchRule) + ->setBranchRuleId($branchRuleId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * @type \Google\Cloud\SecureSourceManager\V1\BranchRule $branch_rule + * @type string $branch_rule_id + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Securesourcemanager\V1\SecureSourceManager::initOnce(); + parent::__construct($data); + } + + /** + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Generated from protobuf field .google.cloud.securesourcemanager.v1.BranchRule branch_rule = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\SecureSourceManager\V1\BranchRule|null + */ + public function getBranchRule() + { + return $this->branch_rule; + } + + public function hasBranchRule() + { + return isset($this->branch_rule); + } + + public function clearBranchRule() + { + unset($this->branch_rule); + } + + /** + * Generated from protobuf field .google.cloud.securesourcemanager.v1.BranchRule branch_rule = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\SecureSourceManager\V1\BranchRule $var + * @return $this + */ + public function setBranchRule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\SecureSourceManager\V1\BranchRule::class); + $this->branch_rule = $var; + + return $this; + } + + /** + * Generated from protobuf field string branch_rule_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getBranchRuleId() + { + return $this->branch_rule_id; + } + + /** + * Generated from protobuf field string branch_rule_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setBranchRuleId($var) + { + GPBUtil::checkString($var, True); + $this->branch_rule_id = $var; + + return $this; + } + +} + diff --git a/SecureSourceManager/src/V1/DeleteBranchRuleRequest.php b/SecureSourceManager/src/V1/DeleteBranchRuleRequest.php new file mode 100644 index 000000000000..e69e241dd971 --- /dev/null +++ b/SecureSourceManager/src/V1/DeleteBranchRuleRequest.php @@ -0,0 +1,111 @@ +google.cloud.securesourcemanager.v1.DeleteBranchRuleRequest + */ +class DeleteBranchRuleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. If set to true, and the branch rule is not found, the request + * will succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + + /** + * @param string $name Please see {@see SecureSourceManagerClient::branchRuleName()} for help formatting this field. + * + * @return \Google\Cloud\SecureSourceManager\V1\DeleteBranchRuleRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * @type bool $allow_missing + * Optional. If set to true, and the branch rule is not found, the request + * will succeed but no action will be taken on the server. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Securesourcemanager\V1\SecureSourceManager::initOnce(); + parent::__construct($data); + } + + /** + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. If set to true, and the branch rule is not found, the request + * will succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the branch rule is not found, the request + * will succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + +} + diff --git a/SecureSourceManager/src/V1/GetBranchRuleRequest.php b/SecureSourceManager/src/V1/GetBranchRuleRequest.php new file mode 100644 index 000000000000..99448568e4c7 --- /dev/null +++ b/SecureSourceManager/src/V1/GetBranchRuleRequest.php @@ -0,0 +1,91 @@ +google.cloud.securesourcemanager.v1.GetBranchRuleRequest + */ +class GetBranchRuleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the repository to retrieve. + * The format is + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. Name of the repository to retrieve. + * The format is + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`. Please see + * {@see SecureSourceManagerClient::branchRuleName()} for help formatting this field. + * + * @return \Google\Cloud\SecureSourceManager\V1\GetBranchRuleRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the repository to retrieve. + * The format is + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Securesourcemanager\V1\SecureSourceManager::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the repository to retrieve. + * The format is + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the repository to retrieve. + * The format is + * `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/SecureSourceManager/src/V1/Instance/PrivateConfig.php b/SecureSourceManager/src/V1/Instance/PrivateConfig.php index e3d8cec08fb0..23b157197bd8 100644 --- a/SecureSourceManager/src/V1/Instance/PrivateConfig.php +++ b/SecureSourceManager/src/V1/Instance/PrivateConfig.php @@ -42,6 +42,14 @@ class PrivateConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field string ssh_service_attachment = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { */ protected $ssh_service_attachment = ''; + /** + * Optional. Additional allowed projects for setting up PSC connections. + * Instance host project is automatically allowed and does not need to be + * included in this list. + * + * Generated from protobuf field repeated string psc_allowed_projects = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $psc_allowed_projects; /** * Constructor. @@ -60,6 +68,10 @@ class PrivateConfig extends \Google\Protobuf\Internal\Message * @type string $ssh_service_attachment * Output only. Service Attachment for SSH, resource is in the format of * `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`. + * @type array|\Google\Protobuf\Internal\RepeatedField $psc_allowed_projects + * Optional. Additional allowed projects for setting up PSC connections. + * Instance host project is automatically allowed and does not need to be + * included in this list. * } */ public function __construct($data = NULL) { @@ -177,6 +189,36 @@ public function setSshServiceAttachment($var) return $this; } + /** + * Optional. Additional allowed projects for setting up PSC connections. + * Instance host project is automatically allowed and does not need to be + * included in this list. + * + * Generated from protobuf field repeated string psc_allowed_projects = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPscAllowedProjects() + { + return $this->psc_allowed_projects; + } + + /** + * Optional. Additional allowed projects for setting up PSC connections. + * Instance host project is automatically allowed and does not need to be + * included in this list. + * + * Generated from protobuf field repeated string psc_allowed_projects = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPscAllowedProjects($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->psc_allowed_projects = $arr; + + return $this; + } + } diff --git a/SecureSourceManager/src/V1/ListBranchRulesRequest.php b/SecureSourceManager/src/V1/ListBranchRulesRequest.php new file mode 100644 index 000000000000..209d3240ebb7 --- /dev/null +++ b/SecureSourceManager/src/V1/ListBranchRulesRequest.php @@ -0,0 +1,127 @@ +google.cloud.securesourcemanager.v1.ListBranchRulesRequest + */ +class ListBranchRulesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + + /** + * @param string $parent Please see {@see SecureSourceManagerClient::repositoryName()} for help formatting this field. + * + * @return \Google\Cloud\SecureSourceManager\V1\ListBranchRulesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * @type int $page_size + * @type string $page_token + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Securesourcemanager\V1\SecureSourceManager::initOnce(); + parent::__construct($data); + } + + /** + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + +} + diff --git a/SecureSourceManager/src/V1/ListBranchRulesResponse.php b/SecureSourceManager/src/V1/ListBranchRulesResponse.php new file mode 100644 index 000000000000..f0b2969182dd --- /dev/null +++ b/SecureSourceManager/src/V1/ListBranchRulesResponse.php @@ -0,0 +1,101 @@ +google.cloud.securesourcemanager.v1.ListBranchRulesResponse + */ +class ListBranchRulesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of branch rules. + * + * Generated from protobuf field repeated .google.cloud.securesourcemanager.v1.BranchRule branch_rules = 1; + */ + private $branch_rules; + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\SecureSourceManager\V1\BranchRule>|\Google\Protobuf\Internal\RepeatedField $branch_rules + * The list of branch rules. + * @type string $next_page_token + * A token identifying a page of results the server should return. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Securesourcemanager\V1\SecureSourceManager::initOnce(); + parent::__construct($data); + } + + /** + * The list of branch rules. + * + * Generated from protobuf field repeated .google.cloud.securesourcemanager.v1.BranchRule branch_rules = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBranchRules() + { + return $this->branch_rules; + } + + /** + * The list of branch rules. + * + * Generated from protobuf field repeated .google.cloud.securesourcemanager.v1.BranchRule branch_rules = 1; + * @param array<\Google\Cloud\SecureSourceManager\V1\BranchRule>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBranchRules($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\SecureSourceManager\V1\BranchRule::class); + $this->branch_rules = $arr; + + return $this; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + +} + diff --git a/SecureSourceManager/src/V1/Repository.php b/SecureSourceManager/src/V1/Repository.php index c43a041a3fff..114d1759a1fa 100644 --- a/SecureSourceManager/src/V1/Repository.php +++ b/SecureSourceManager/src/V1/Repository.php @@ -36,9 +36,8 @@ class Repository extends \Google\Protobuf\Internal\Message * `projects/{project_number}/locations/{location_id}/instances/{instance_id}` * When creating repository via * securesourcemanager.googleapis.com (Control Plane API), this field is used - * as input. - * When creating repository via *.sourcemanager.dev (Data Plane API), this - * field is output only. + * as input. When creating repository via *.sourcemanager.dev (Data Plane + * API), this field is output only. * * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ @@ -101,9 +100,8 @@ class Repository extends \Google\Protobuf\Internal\Message * `projects/{project_number}/locations/{location_id}/instances/{instance_id}` * When creating repository via * securesourcemanager.googleapis.com (Control Plane API), this field is used - * as input. - * When creating repository via *.sourcemanager.dev (Data Plane API), this - * field is output only. + * as input. When creating repository via *.sourcemanager.dev (Data Plane + * API), this field is output only. * @type string $uid * Output only. Unique identifier of the repository. * @type \Google\Protobuf\Timestamp $create_time @@ -189,9 +187,8 @@ public function setDescription($var) * `projects/{project_number}/locations/{location_id}/instances/{instance_id}` * When creating repository via * securesourcemanager.googleapis.com (Control Plane API), this field is used - * as input. - * When creating repository via *.sourcemanager.dev (Data Plane API), this - * field is output only. + * as input. When creating repository via *.sourcemanager.dev (Data Plane + * API), this field is output only. * * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string @@ -207,9 +204,8 @@ public function getInstance() * `projects/{project_number}/locations/{location_id}/instances/{instance_id}` * When creating repository via * securesourcemanager.googleapis.com (Control Plane API), this field is used - * as input. - * When creating repository via *.sourcemanager.dev (Data Plane API), this - * field is output only. + * as input. When creating repository via *.sourcemanager.dev (Data Plane + * API), this field is output only. * * Generated from protobuf field string instance = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var diff --git a/SecureSourceManager/src/V1/UpdateBranchRuleRequest.php b/SecureSourceManager/src/V1/UpdateBranchRuleRequest.php new file mode 100644 index 000000000000..be3e12441d0a --- /dev/null +++ b/SecureSourceManager/src/V1/UpdateBranchRuleRequest.php @@ -0,0 +1,187 @@ +google.cloud.securesourcemanager.v1.UpdateBranchRuleRequest + */ +class UpdateBranchRuleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Generated from protobuf field .google.cloud.securesourcemanager.v1.BranchRule branch_rule = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $branch_rule = null; + /** + * Optional. If set, validate the request and preview the review, but do not + * actually post it. (https://google.aip.dev/163, for declarative friendly) + * + * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * branchRule resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. + * The special value "*" means full replacement. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + + /** + * @param \Google\Cloud\SecureSourceManager\V1\BranchRule $branchRule + * @param \Google\Protobuf\FieldMask $updateMask Required. Field mask is used to specify the fields to be overwritten in the + * branchRule resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. + * The special value "*" means full replacement. + * + * @return \Google\Cloud\SecureSourceManager\V1\UpdateBranchRuleRequest + * + * @experimental + */ + public static function build(\Google\Cloud\SecureSourceManager\V1\BranchRule $branchRule, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setBranchRule($branchRule) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\SecureSourceManager\V1\BranchRule $branch_rule + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * actually post it. (https://google.aip.dev/163, for declarative friendly) + * @type \Google\Protobuf\FieldMask $update_mask + * Required. Field mask is used to specify the fields to be overwritten in the + * branchRule resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. + * The special value "*" means full replacement. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Securesourcemanager\V1\SecureSourceManager::initOnce(); + parent::__construct($data); + } + + /** + * Generated from protobuf field .google.cloud.securesourcemanager.v1.BranchRule branch_rule = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\SecureSourceManager\V1\BranchRule|null + */ + public function getBranchRule() + { + return $this->branch_rule; + } + + public function hasBranchRule() + { + return isset($this->branch_rule); + } + + public function clearBranchRule() + { + unset($this->branch_rule); + } + + /** + * Generated from protobuf field .google.cloud.securesourcemanager.v1.BranchRule branch_rule = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\SecureSourceManager\V1\BranchRule $var + * @return $this + */ + public function setBranchRule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\SecureSourceManager\V1\BranchRule::class); + $this->branch_rule = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * actually post it. (https://google.aip.dev/163, for declarative friendly) + * + * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * actually post it. (https://google.aip.dev/163, for declarative friendly) + * + * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * branchRule resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. + * The special value "*" means full replacement. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * branchRule resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. + * The special value "*" means full replacement. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/SecureSourceManager/src/V1/gapic_metadata.json b/SecureSourceManager/src/V1/gapic_metadata.json index af0aaf0c1662..765eced17b9b 100644 --- a/SecureSourceManager/src/V1/gapic_metadata.json +++ b/SecureSourceManager/src/V1/gapic_metadata.json @@ -10,6 +10,11 @@ "grpc": { "libraryClient": "SecureSourceManagerGapicClient", "rpcs": { + "CreateBranchRule": { + "methods": [ + "createBranchRule" + ] + }, "CreateInstance": { "methods": [ "createInstance" @@ -20,6 +25,11 @@ "createRepository" ] }, + "DeleteBranchRule": { + "methods": [ + "deleteBranchRule" + ] + }, "DeleteInstance": { "methods": [ "deleteInstance" @@ -30,6 +40,11 @@ "deleteRepository" ] }, + "GetBranchRule": { + "methods": [ + "getBranchRule" + ] + }, "GetIamPolicyRepo": { "methods": [ "getIamPolicyRepo" @@ -45,6 +60,11 @@ "getRepository" ] }, + "ListBranchRules": { + "methods": [ + "listBranchRules" + ] + }, "ListInstances": { "methods": [ "listInstances" @@ -65,6 +85,11 @@ "testIamPermissionsRepo" ] }, + "UpdateBranchRule": { + "methods": [ + "updateBranchRule" + ] + }, "GetIamPolicy": { "methods": [ "getIamPolicy" diff --git a/SecureSourceManager/src/V1/resources/secure_source_manager_client_config.json b/SecureSourceManager/src/V1/resources/secure_source_manager_client_config.json index ad14bc6042a2..deeb50b01083 100644 --- a/SecureSourceManager/src/V1/resources/secure_source_manager_client_config.json +++ b/SecureSourceManager/src/V1/resources/secure_source_manager_client_config.json @@ -28,6 +28,11 @@ } }, "methods": { + "CreateBranchRule": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "CreateInstance": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", @@ -38,6 +43,11 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "DeleteBranchRule": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "DeleteInstance": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", @@ -48,6 +58,11 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "GetBranchRule": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "GetIamPolicyRepo": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", @@ -63,6 +78,11 @@ "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "ListBranchRules": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "ListInstances": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", @@ -83,6 +103,11 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "UpdateBranchRule": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "GetIamPolicy": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", diff --git a/SecureSourceManager/src/V1/resources/secure_source_manager_descriptor_config.php b/SecureSourceManager/src/V1/resources/secure_source_manager_descriptor_config.php index 4f4cb90c3153..30aede09a29d 100644 --- a/SecureSourceManager/src/V1/resources/secure_source_manager_descriptor_config.php +++ b/SecureSourceManager/src/V1/resources/secure_source_manager_descriptor_config.php @@ -23,6 +23,25 @@ return [ 'interfaces' => [ 'google.cloud.securesourcemanager.v1.SecureSourceManager' => [ + 'CreateBranchRule' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\SecureSourceManager\V1\BranchRule', + 'metadataReturnType' => '\Google\Cloud\SecureSourceManager\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'CreateInstance' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\SecureSourceManager\V1\Instance', @@ -61,6 +80,25 @@ ], ], ], + 'DeleteBranchRule' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Protobuf\GPBEmpty', + 'metadataReturnType' => '\Google\Cloud\SecureSourceManager\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'DeleteInstance' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Protobuf\GPBEmpty', @@ -99,6 +137,38 @@ ], ], ], + 'UpdateBranchRule' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\SecureSourceManager\V1\BranchRule', + 'metadataReturnType' => '\Google\Cloud\SecureSourceManager\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'branch_rule.name', + 'fieldAccessors' => [ + 'getBranchRule', + 'getName', + ], + ], + ], + ], + 'GetBranchRule' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\SecureSourceManager\V1\BranchRule', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'GetIamPolicyRepo' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\Iam\V1\Policy', @@ -135,6 +205,26 @@ ], ], ], + 'ListBranchRules' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getBranchRules', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\SecureSourceManager\V1\ListBranchRulesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'ListInstances' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', @@ -273,6 +363,7 @@ 'interfaceOverride' => 'google.cloud.location.Locations', ], 'templateMap' => [ + 'branchRule' => 'projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}', 'caPool' => 'projects/{project}/locations/{location}/caPools/{ca_pool}', 'cryptoKey' => 'projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}', 'instance' => 'projects/{project}/locations/{location}/instances/{instance}', diff --git a/SecureSourceManager/src/V1/resources/secure_source_manager_rest_client_config.php b/SecureSourceManager/src/V1/resources/secure_source_manager_rest_client_config.php index 75f081095832..38d22efe24dc 100644 --- a/SecureSourceManager/src/V1/resources/secure_source_manager_rest_client_config.php +++ b/SecureSourceManager/src/V1/resources/secure_source_manager_rest_client_config.php @@ -47,6 +47,21 @@ ], ], 'google.cloud.securesourcemanager.v1.SecureSourceManager' => [ + 'CreateBranchRule' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*}/branchRules', + 'body' => 'branch_rule', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'branch_rule_id', + ], + ], 'CreateInstance' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/instances', @@ -77,6 +92,17 @@ 'repository_id', ], ], + 'DeleteBranchRule' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/branchRules/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'DeleteInstance' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/instances/*}', @@ -99,6 +125,17 @@ ], ], ], + 'GetBranchRule' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/branchRules/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetIamPolicyRepo' => [ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/repositories/*}:getIamPolicy', @@ -132,6 +169,17 @@ ], ], ], + 'ListBranchRules' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*}/branchRules', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'ListInstances' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/instances', @@ -178,6 +226,22 @@ ], ], ], + 'UpdateBranchRule' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{branch_rule.name=projects/*/locations/*/repositories/*/branchRules/*}', + 'body' => 'branch_rule', + 'placeholders' => [ + 'branch_rule.name' => [ + 'getters' => [ + 'getBranchRule', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], ], 'google.iam.v1.IAMPolicy' => [ 'GetIamPolicy' => [ diff --git a/SecureSourceManager/tests/Unit/V1/Client/SecureSourceManagerClientTest.php b/SecureSourceManager/tests/Unit/V1/Client/SecureSourceManagerClientTest.php index 5376a56ca926..e4c0d3de71b8 100644 --- a/SecureSourceManager/tests/Unit/V1/Client/SecureSourceManagerClientTest.php +++ b/SecureSourceManager/tests/Unit/V1/Client/SecureSourceManagerClientTest.php @@ -35,23 +35,31 @@ use Google\Cloud\Location\ListLocationsRequest; use Google\Cloud\Location\ListLocationsResponse; use Google\Cloud\Location\Location; +use Google\Cloud\SecureSourceManager\V1\BranchRule; use Google\Cloud\SecureSourceManager\V1\Client\SecureSourceManagerClient; +use Google\Cloud\SecureSourceManager\V1\CreateBranchRuleRequest; use Google\Cloud\SecureSourceManager\V1\CreateInstanceRequest; use Google\Cloud\SecureSourceManager\V1\CreateRepositoryRequest; +use Google\Cloud\SecureSourceManager\V1\DeleteBranchRuleRequest; use Google\Cloud\SecureSourceManager\V1\DeleteInstanceRequest; use Google\Cloud\SecureSourceManager\V1\DeleteRepositoryRequest; +use Google\Cloud\SecureSourceManager\V1\GetBranchRuleRequest; use Google\Cloud\SecureSourceManager\V1\GetInstanceRequest; use Google\Cloud\SecureSourceManager\V1\GetRepositoryRequest; use Google\Cloud\SecureSourceManager\V1\Instance; +use Google\Cloud\SecureSourceManager\V1\ListBranchRulesRequest; +use Google\Cloud\SecureSourceManager\V1\ListBranchRulesResponse; use Google\Cloud\SecureSourceManager\V1\ListInstancesRequest; use Google\Cloud\SecureSourceManager\V1\ListInstancesResponse; use Google\Cloud\SecureSourceManager\V1\ListRepositoriesRequest; use Google\Cloud\SecureSourceManager\V1\ListRepositoriesResponse; use Google\Cloud\SecureSourceManager\V1\Repository; +use Google\Cloud\SecureSourceManager\V1\UpdateBranchRuleRequest; use Google\LongRunning\Client\OperationsClient; use Google\LongRunning\GetOperationRequest; use Google\LongRunning\Operation; use Google\Protobuf\Any; +use Google\Protobuf\FieldMask; use Google\Protobuf\GPBEmpty; use Google\Rpc\Code; use stdClass; @@ -86,6 +94,167 @@ private function createClient(array $options = []) return new SecureSourceManagerClient($options); } + /** @test */ + public function createBranchRuleTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createBranchRuleTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $uid = 'uid115792'; + $etag = 'etag3123477'; + $includePattern = 'includePattern-1182351623'; + $disabled = true; + $requirePullRequest = false; + $minimumReviewsCount = 672799098; + $minimumApprovalsCount = 579210129; + $requireCommentsResolved = false; + $allowStaleReviews = false; + $requireLinearHistory = true; + $expectedResponse = new BranchRule(); + $expectedResponse->setName($name); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setIncludePattern($includePattern); + $expectedResponse->setDisabled($disabled); + $expectedResponse->setRequirePullRequest($requirePullRequest); + $expectedResponse->setMinimumReviewsCount($minimumReviewsCount); + $expectedResponse->setMinimumApprovalsCount($minimumApprovalsCount); + $expectedResponse->setRequireCommentsResolved($requireCommentsResolved); + $expectedResponse->setAllowStaleReviews($allowStaleReviews); + $expectedResponse->setRequireLinearHistory($requireLinearHistory); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createBranchRuleTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $branchRule = new BranchRule(); + $branchRuleId = 'branchRuleId786871201'; + $request = (new CreateBranchRuleRequest()) + ->setParent($formattedParent) + ->setBranchRule($branchRule) + ->setBranchRuleId($branchRuleId); + $response = $gapicClient->createBranchRule($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.securesourcemanager.v1.SecureSourceManager/CreateBranchRule', + $actualApiFuncCall + ); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getBranchRule(); + $this->assertProtobufEquals($branchRule, $actualValue); + $actualValue = $actualApiRequestObject->getBranchRuleId(); + $this->assertProtobufEquals($branchRuleId, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createBranchRuleTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createBranchRuleExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createBranchRuleTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $branchRule = new BranchRule(); + $branchRuleId = 'branchRuleId786871201'; + $request = (new CreateBranchRuleRequest()) + ->setParent($formattedParent) + ->setBranchRule($branchRule) + ->setBranchRuleId($branchRuleId); + $response = $gapicClient->createBranchRule($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createBranchRuleTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function createInstanceTest() { @@ -378,6 +547,131 @@ public function createRepositoryExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function deleteBranchRuleTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBranchRuleTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteBranchRuleTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->branchRuleName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[BRANCH_RULE]'); + $request = (new DeleteBranchRuleRequest())->setName($formattedName); + $response = $gapicClient->deleteBranchRule($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.securesourcemanager.v1.SecureSourceManager/DeleteBranchRule', + $actualApiFuncCall + ); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBranchRuleTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteBranchRuleExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteBranchRuleTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->branchRuleName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[BRANCH_RULE]'); + $request = (new DeleteBranchRuleRequest())->setName($formattedName); + $response = $gapicClient->deleteBranchRule($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteBranchRuleTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function deleteInstanceTest() { @@ -628,6 +922,91 @@ public function deleteRepositoryExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function getBranchRuleTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $etag = 'etag3123477'; + $includePattern = 'includePattern-1182351623'; + $disabled = true; + $requirePullRequest = false; + $minimumReviewsCount = 672799098; + $minimumApprovalsCount = 579210129; + $requireCommentsResolved = false; + $allowStaleReviews = false; + $requireLinearHistory = true; + $expectedResponse = new BranchRule(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setIncludePattern($includePattern); + $expectedResponse->setDisabled($disabled); + $expectedResponse->setRequirePullRequest($requirePullRequest); + $expectedResponse->setMinimumReviewsCount($minimumReviewsCount); + $expectedResponse->setMinimumApprovalsCount($minimumApprovalsCount); + $expectedResponse->setRequireCommentsResolved($requireCommentsResolved); + $expectedResponse->setAllowStaleReviews($allowStaleReviews); + $expectedResponse->setRequireLinearHistory($requireLinearHistory); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->branchRuleName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[BRANCH_RULE]'); + $request = (new GetBranchRuleRequest())->setName($formattedName); + $response = $gapicClient->getBranchRule($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.securesourcemanager.v1.SecureSourceManager/GetBranchRule', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getBranchRuleExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->branchRuleName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[BRANCH_RULE]'); + $request = (new GetBranchRuleRequest())->setName($formattedName); + try { + $gapicClient->getBranchRule($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function getIamPolicyRepoTest() { @@ -835,6 +1214,77 @@ public function getRepositoryExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function listBranchRulesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $branchRulesElement = new BranchRule(); + $branchRules = [$branchRulesElement]; + $expectedResponse = new ListBranchRulesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setBranchRules($branchRules); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new ListBranchRulesRequest())->setParent($formattedParent); + $response = $gapicClient->listBranchRules($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getBranchRules()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.securesourcemanager.v1.SecureSourceManager/ListBranchRules', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listBranchRulesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new ListBranchRulesRequest())->setParent($formattedParent); + try { + $gapicClient->listBranchRules($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function listInstancesTest() { @@ -1118,6 +1568,157 @@ public function testIamPermissionsRepoExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function updateBranchRuleTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateBranchRuleTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $uid = 'uid115792'; + $etag = 'etag3123477'; + $includePattern = 'includePattern-1182351623'; + $disabled = true; + $requirePullRequest = false; + $minimumReviewsCount = 672799098; + $minimumApprovalsCount = 579210129; + $requireCommentsResolved = false; + $allowStaleReviews = false; + $requireLinearHistory = true; + $expectedResponse = new BranchRule(); + $expectedResponse->setName($name); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setIncludePattern($includePattern); + $expectedResponse->setDisabled($disabled); + $expectedResponse->setRequirePullRequest($requirePullRequest); + $expectedResponse->setMinimumReviewsCount($minimumReviewsCount); + $expectedResponse->setMinimumApprovalsCount($minimumApprovalsCount); + $expectedResponse->setRequireCommentsResolved($requireCommentsResolved); + $expectedResponse->setAllowStaleReviews($allowStaleReviews); + $expectedResponse->setRequireLinearHistory($requireLinearHistory); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/updateBranchRuleTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $branchRule = new BranchRule(); + $updateMask = new FieldMask(); + $request = (new UpdateBranchRuleRequest())->setBranchRule($branchRule)->setUpdateMask($updateMask); + $response = $gapicClient->updateBranchRule($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame( + '/google.cloud.securesourcemanager.v1.SecureSourceManager/UpdateBranchRule', + $actualApiFuncCall + ); + $actualValue = $actualApiRequestObject->getBranchRule(); + $this->assertProtobufEquals($branchRule, $actualValue); + $actualValue = $actualApiRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateBranchRuleTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function updateBranchRuleExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateBranchRuleTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $branchRule = new BranchRule(); + $updateMask = new FieldMask(); + $request = (new UpdateBranchRuleRequest())->setBranchRule($branchRule)->setUpdateMask($updateMask); + $response = $gapicClient->updateBranchRule($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateBranchRuleTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function getIamPolicyTest() { @@ -1452,7 +2053,7 @@ public function listLocationsExceptionTest() } /** @test */ - public function createInstanceAsyncTest() + public function createBranchRuleAsyncTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -1469,30 +2070,48 @@ public function createInstanceAsyncTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/createInstanceTest'); + $incompleteOperation->setName('operations/createBranchRuleTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $name = 'name3373707'; - $kmsKey = 'kmsKey-591635343'; - $expectedResponse = new Instance(); + $uid = 'uid115792'; + $etag = 'etag3123477'; + $includePattern = 'includePattern-1182351623'; + $disabled = true; + $requirePullRequest = false; + $minimumReviewsCount = 672799098; + $minimumApprovalsCount = 579210129; + $requireCommentsResolved = false; + $allowStaleReviews = false; + $requireLinearHistory = true; + $expectedResponse = new BranchRule(); $expectedResponse->setName($name); - $expectedResponse->setKmsKey($kmsKey); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setIncludePattern($includePattern); + $expectedResponse->setDisabled($disabled); + $expectedResponse->setRequirePullRequest($requirePullRequest); + $expectedResponse->setMinimumReviewsCount($minimumReviewsCount); + $expectedResponse->setMinimumApprovalsCount($minimumApprovalsCount); + $expectedResponse->setRequireCommentsResolved($requireCommentsResolved); + $expectedResponse->setAllowStaleReviews($allowStaleReviews); + $expectedResponse->setRequireLinearHistory($requireLinearHistory); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/createInstanceTest'); + $completeOperation->setName('operations/createBranchRuleTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $instanceId = 'instanceId-2101995259'; - $instance = new Instance(); - $request = (new CreateInstanceRequest()) + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $branchRule = new BranchRule(); + $branchRuleId = 'branchRuleId786871201'; + $request = (new CreateBranchRuleRequest()) ->setParent($formattedParent) - ->setInstanceId($instanceId) - ->setInstance($instance); - $response = $gapicClient->createInstanceAsync($request)->wait(); + ->setBranchRule($branchRule) + ->setBranchRuleId($branchRuleId); + $response = $gapicClient->createBranchRuleAsync($request)->wait(); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -1502,17 +2121,17 @@ public function createInstanceAsyncTest() $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); $this->assertSame( - '/google.cloud.securesourcemanager.v1.SecureSourceManager/CreateInstance', + '/google.cloud.securesourcemanager.v1.SecureSourceManager/CreateBranchRule', $actualApiFuncCall ); $actualValue = $actualApiRequestObject->getParent(); $this->assertProtobufEquals($formattedParent, $actualValue); - $actualValue = $actualApiRequestObject->getInstanceId(); - $this->assertProtobufEquals($instanceId, $actualValue); - $actualValue = $actualApiRequestObject->getInstance(); - $this->assertProtobufEquals($instance, $actualValue); + $actualValue = $actualApiRequestObject->getBranchRule(); + $this->assertProtobufEquals($branchRule, $actualValue); + $actualValue = $actualApiRequestObject->getBranchRuleId(); + $this->assertProtobufEquals($branchRuleId, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/createInstanceTest'); + $expectedOperationsRequestObject->setName('operations/createBranchRuleTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); From 385c1e763613e3c5683757447a36f133c9787530 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 18:32:20 -0700 Subject: [PATCH 037/157] feat: add `text` field for Grounding metadata support chunk output (#7758) PiperOrigin-RevId: 688271012 Source-Link: https://github.com/googleapis/googleapis/commit/09f411dc4d24214e67e74a8b52577db1c6609b46 Source-Link: https://github.com/googleapis/googleapis-gen/commit/c0e3a9274a5d5bf62faf7b448815e6a2e5906352 Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiYzBlM2E5Mjc0YTVkNWJmNjJmYWY3YjQ0ODgxNWU2YTJlNTkwNjM1MiJ9 --- AiPlatform/metadata/V1/Content.php | Bin 7208 -> 7236 bytes .../V1/GroundingChunk/RetrievedContext.php | 44 ++++++++++++++++++ AiPlatform/src/V1/RetrievalMetadata.php | 24 +++++----- AiPlatform/src/V1/VertexAISearch.php | 10 ++-- 4 files changed, 61 insertions(+), 17 deletions(-) diff --git a/AiPlatform/metadata/V1/Content.php b/AiPlatform/metadata/V1/Content.php index 2f518197707f8ef06b56007a2eab203c024376e4..08bfd7dfd1f094241601e1fc27b86b28d2e4de45 100644 GIT binary patch delta 62 zcmZ2sal~Q+FEitt&3w#!!i@JO%Zj~XOqA^JlqnIeC Q6FV1cJV diff --git a/AiPlatform/src/V1/GroundingChunk/RetrievedContext.php b/AiPlatform/src/V1/GroundingChunk/RetrievedContext.php index add14f056d98..d827b5940307 100644 --- a/AiPlatform/src/V1/GroundingChunk/RetrievedContext.php +++ b/AiPlatform/src/V1/GroundingChunk/RetrievedContext.php @@ -27,6 +27,12 @@ class RetrievedContext extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string title = 2; */ protected $title = null; + /** + * Text of the attribution. + * + * Generated from protobuf field optional string text = 3; + */ + protected $text = null; /** * Constructor. @@ -38,6 +44,8 @@ class RetrievedContext extends \Google\Protobuf\Internal\Message * URI reference of the attribution. * @type string $title * Title of the attribution. + * @type string $text + * Text of the attribution. * } */ public function __construct($data = NULL) { @@ -117,6 +125,42 @@ public function setTitle($var) return $this; } + /** + * Text of the attribution. + * + * Generated from protobuf field optional string text = 3; + * @return string + */ + public function getText() + { + return isset($this->text) ? $this->text : ''; + } + + public function hasText() + { + return isset($this->text); + } + + public function clearText() + { + unset($this->text); + } + + /** + * Text of the attribution. + * + * Generated from protobuf field optional string text = 3; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->text = $var; + + return $this; + } + } diff --git a/AiPlatform/src/V1/RetrievalMetadata.php b/AiPlatform/src/V1/RetrievalMetadata.php index 8cf571a16f22..9c32e59b9ef9 100644 --- a/AiPlatform/src/V1/RetrievalMetadata.php +++ b/AiPlatform/src/V1/RetrievalMetadata.php @@ -16,11 +16,11 @@ class RetrievalMetadata extends \Google\Protobuf\Internal\Message { /** - * Optional. Score indicating how likely information from google search could + * Optional. Score indicating how likely information from Google Search could * help answer the prompt. The score is in the range `[0, 1]`, where 0 is the * least likely and 1 is the most likely. This score is only populated when - * google search grounding and dynamic retrieval is enabled. It will be - * compared to the threshold to determine whether to trigger google search. + * Google Search grounding and dynamic retrieval is enabled. It will be + * compared to the threshold to determine whether to trigger Google Search. * * Generated from protobuf field float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -33,11 +33,11 @@ class RetrievalMetadata extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type float $google_search_dynamic_retrieval_score - * Optional. Score indicating how likely information from google search could + * Optional. Score indicating how likely information from Google Search could * help answer the prompt. The score is in the range `[0, 1]`, where 0 is the * least likely and 1 is the most likely. This score is only populated when - * google search grounding and dynamic retrieval is enabled. It will be - * compared to the threshold to determine whether to trigger google search. + * Google Search grounding and dynamic retrieval is enabled. It will be + * compared to the threshold to determine whether to trigger Google Search. * } */ public function __construct($data = NULL) { @@ -46,11 +46,11 @@ public function __construct($data = NULL) { } /** - * Optional. Score indicating how likely information from google search could + * Optional. Score indicating how likely information from Google Search could * help answer the prompt. The score is in the range `[0, 1]`, where 0 is the * least likely and 1 is the most likely. This score is only populated when - * google search grounding and dynamic retrieval is enabled. It will be - * compared to the threshold to determine whether to trigger google search. + * Google Search grounding and dynamic retrieval is enabled. It will be + * compared to the threshold to determine whether to trigger Google Search. * * Generated from protobuf field float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return float @@ -61,11 +61,11 @@ public function getGoogleSearchDynamicRetrievalScore() } /** - * Optional. Score indicating how likely information from google search could + * Optional. Score indicating how likely information from Google Search could * help answer the prompt. The score is in the range `[0, 1]`, where 0 is the * least likely and 1 is the most likely. This score is only populated when - * google search grounding and dynamic retrieval is enabled. It will be - * compared to the threshold to determine whether to trigger google search. + * Google Search grounding and dynamic retrieval is enabled. It will be + * compared to the threshold to determine whether to trigger Google Search. * * Generated from protobuf field float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param float $var diff --git a/AiPlatform/src/V1/VertexAISearch.php b/AiPlatform/src/V1/VertexAISearch.php index 9c1e78170308..f1e9f9157e9f 100644 --- a/AiPlatform/src/V1/VertexAISearch.php +++ b/AiPlatform/src/V1/VertexAISearch.php @@ -10,14 +10,14 @@ /** * Retrieve from Vertex AI Search datastore for grounding. - * See https://cloud.google.com/vertex-ai-search-and-conversation + * See https://cloud.google.com/products/agent-builder * * Generated from protobuf message google.cloud.aiplatform.v1.VertexAISearch */ class VertexAISearch extends \Google\Protobuf\Internal\Message { /** - * Required. Fully-qualified Vertex AI Search's datastore resource ID. + * Required. Fully-qualified Vertex AI Search data store resource ID. * Format: * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` * @@ -32,7 +32,7 @@ class VertexAISearch extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $datastore - * Required. Fully-qualified Vertex AI Search's datastore resource ID. + * Required. Fully-qualified Vertex AI Search data store resource ID. * Format: * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` * } @@ -43,7 +43,7 @@ public function __construct($data = NULL) { } /** - * Required. Fully-qualified Vertex AI Search's datastore resource ID. + * Required. Fully-qualified Vertex AI Search data store resource ID. * Format: * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` * @@ -56,7 +56,7 @@ public function getDatastore() } /** - * Required. Fully-qualified Vertex AI Search's datastore resource ID. + * Required. Fully-qualified Vertex AI Search data store resource ID. * Format: * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` * From 3b5afb394afe814d2fa2de028e214b528c80a234 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 18:32:36 -0700 Subject: [PATCH 038/157] feat: add brand voice lite, which lets you clone a voice with just 10 seconds of audio (#7759) PiperOrigin-RevId: 688491221 Source-Link: https://github.com/googleapis/googleapis/commit/60688dc3302894cb893531383d6a26d9416a1364 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4072c999b36baa21ccb29c5f5d5608962840b31a Copy-Tag: eyJwIjoiVGV4dFRvU3BlZWNoLy5Pd2xCb3QueWFtbCIsImgiOiI0MDcyYzk5OWIzNmJhYTIxY2NiMjljNWY1ZDU2MDg5NjI4NDBiMzFhIn0= --- TextToSpeech/metadata/V1/CloudTts.php | Bin 4560 -> 4683 bytes TextToSpeech/metadata/V1/CloudTtsLrs.php | 6 +- TextToSpeech/src/V1/VoiceCloneParams.php | 67 +++++++++++++++++++ TextToSpeech/src/V1/VoiceSelectionParams.php | 52 ++++++++++++++ 4 files changed, 122 insertions(+), 3 deletions(-) create mode 100644 TextToSpeech/src/V1/VoiceCloneParams.php diff --git a/TextToSpeech/metadata/V1/CloudTts.php b/TextToSpeech/metadata/V1/CloudTts.php index 3125c7df3ed56a36b203843004a7237903f7e3ab..cee048c39aed1706ac68ec1f4ab27f126319418c 100644 GIT binary patch delta 144 zcmcbhd|GA0Atsi6a$GtSy>&K!Vp_+_G?i)cB97DILLOY)W%-%Osqx7<`FW`ltO|@8 z+(vqn_c1FAIDinternalAddGeneratedFile( ' -ÿ +ü 0google/cloud/texttospeech/v1/cloud_tts_lrs.protogoogle.cloud.texttospeech.v1google/api/client.protogoogle/api/field_behavior.proto,google/cloud/texttospeech/v1/cloud_tts.proto#google/longrunning/operations.protogoogle/protobuf/timestamp.proto"™ SynthesizeLongAudioRequest @@ -39,8 +39,8 @@ public static function initOnce() { progress_percentage (2Ÿ TextToSpeechLongAudioSynthesizeª SynthesizeLongAudio8.google.cloud.texttospeech.v1.SynthesizeLongAudioRequest.google.longrunning.Operation"¹ÊAt -8google.cloud.texttospeech.v1.SynthesizeLongAudioResponse8google.cloud.texttospeech.v1.SynthesizeLongAudioMetadata‚Óä“<"7/v1/{parent=projects/*/locations/*}:synthesizeLongAudio:*OÊAtexttospeech.googleapis.comÒA.https://www.googleapis.com/auth/cloud-platformBò - com.google.cloud.texttospeech.v1B#TextToSpeechLongAudioSynthesisProtoPZDcloud.google.com/go/texttospeech/apiv1/texttospeechpb;texttospeechpbøªGoogle.Cloud.TextToSpeech.V1ÊGoogle\\Cloud\\TextToSpeech\\V1êGoogle::Cloud::TextToSpeech::V1bproto3' +8google.cloud.texttospeech.v1.SynthesizeLongAudioResponse8google.cloud.texttospeech.v1.SynthesizeLongAudioMetadata‚Óä“<"7/v1/{parent=projects/*/locations/*}:synthesizeLongAudio:*OÊAtexttospeech.googleapis.comÒA.https://www.googleapis.com/auth/cloud-platformBï + com.google.cloud.texttospeech.v1B#TextToSpeechLongAudioSynthesisProtoPZDcloud.google.com/go/texttospeech/apiv1/texttospeechpb;texttospeechpbªGoogle.Cloud.TextToSpeech.V1ÊGoogle\\Cloud\\TextToSpeech\\V1êGoogle::Cloud::TextToSpeech::V1bproto3' , true); static::$is_initialized = true; diff --git a/TextToSpeech/src/V1/VoiceCloneParams.php b/TextToSpeech/src/V1/VoiceCloneParams.php new file mode 100644 index 000000000000..dcdf28485990 --- /dev/null +++ b/TextToSpeech/src/V1/VoiceCloneParams.php @@ -0,0 +1,67 @@ +google.cloud.texttospeech.v1.VoiceCloneParams + */ +class VoiceCloneParams extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Created by GenerateVoiceCloningKey. + * + * Generated from protobuf field string voice_cloning_key = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $voice_cloning_key = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $voice_cloning_key + * Required. Created by GenerateVoiceCloningKey. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Texttospeech\V1\CloudTts::initOnce(); + parent::__construct($data); + } + + /** + * Required. Created by GenerateVoiceCloningKey. + * + * Generated from protobuf field string voice_cloning_key = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getVoiceCloningKey() + { + return $this->voice_cloning_key; + } + + /** + * Required. Created by GenerateVoiceCloningKey. + * + * Generated from protobuf field string voice_cloning_key = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setVoiceCloningKey($var) + { + GPBUtil::checkString($var, True); + $this->voice_cloning_key = $var; + + return $this; + } + +} + diff --git a/TextToSpeech/src/V1/VoiceSelectionParams.php b/TextToSpeech/src/V1/VoiceSelectionParams.php index 9dcb6cf601d0..2075fbe1535a 100644 --- a/TextToSpeech/src/V1/VoiceSelectionParams.php +++ b/TextToSpeech/src/V1/VoiceSelectionParams.php @@ -57,6 +57,14 @@ class VoiceSelectionParams extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.texttospeech.v1.CustomVoiceParams custom_voice = 4; */ private $custom_voice = null; + /** + * Optional. The configuration for a voice clone. If + * [VoiceCloneParams.voice_clone_key] is set, the service will choose the + * voice clone matching the specified configuration. + * + * Generated from protobuf field .google.cloud.texttospeech.v1.VoiceCloneParams voice_clone = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $voice_clone = null; /** * Constructor. @@ -90,6 +98,10 @@ class VoiceSelectionParams extends \Google\Protobuf\Internal\Message * The configuration for a custom voice. If [CustomVoiceParams.model] is set, * the service will choose the custom voice matching the specified * configuration. + * @type \Google\Cloud\TextToSpeech\V1\VoiceCloneParams $voice_clone + * Optional. The configuration for a voice clone. If + * [VoiceCloneParams.voice_clone_key] is set, the service will choose the + * voice clone matching the specified configuration. * } */ public function __construct($data = NULL) { @@ -247,5 +259,45 @@ public function setCustomVoice($var) return $this; } + /** + * Optional. The configuration for a voice clone. If + * [VoiceCloneParams.voice_clone_key] is set, the service will choose the + * voice clone matching the specified configuration. + * + * Generated from protobuf field .google.cloud.texttospeech.v1.VoiceCloneParams voice_clone = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\TextToSpeech\V1\VoiceCloneParams|null + */ + public function getVoiceClone() + { + return $this->voice_clone; + } + + public function hasVoiceClone() + { + return isset($this->voice_clone); + } + + public function clearVoiceClone() + { + unset($this->voice_clone); + } + + /** + * Optional. The configuration for a voice clone. If + * [VoiceCloneParams.voice_clone_key] is set, the service will choose the + * voice clone matching the specified configuration. + * + * Generated from protobuf field .google.cloud.texttospeech.v1.VoiceCloneParams voice_clone = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\TextToSpeech\V1\VoiceCloneParams $var + * @return $this + */ + public function setVoiceClone($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\TextToSpeech\V1\VoiceCloneParams::class); + $this->voice_clone = $var; + + return $this; + } + } From 22357f5392c482243dd47d17383d0af6367d3911 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 18:32:54 -0700 Subject: [PATCH 039/157] feat: add new PSC instance configuration setting and output the PSC DNS name (#7760) feat: add new API to execute SQL statements feat: add support for Free Trials feat: add support to schedule maintenance feat: additional field to set tags on a backup or cluster feat: add more observability options on the Instance level feat: add new API to perform a promotion or switchover on secondary instances feat: support for obtaining the public ip addresses of an instance and enabling either inbound or outbound public ip feat: add new API to list the databases in a project and location feat: add optional field to keep extra roles on a user if it already exists docs: various typo fixes, correcting the formatting, and clarifications on the request_id and validate_only fields in API requests and on the page_size when listing the database PiperOrigin-RevId: 688544999 Source-Link: https://github.com/googleapis/googleapis/commit/113ddfebbe8d4e0639eb19fe91817a13edfc0c5c Source-Link: https://github.com/googleapis/googleapis-gen/commit/14fa50edd57629ab318bb7b98a7286b46749e8df Copy-Tag: eyJwIjoiQWxsb3lEYi8uT3dsQm90LnlhbWwiLCJoIjoiMTRmYTUwZWRkNTc2MjlhYjMxOGJiN2I5OGE3Mjg2YjQ2NzQ5ZThkZiJ9 --- AlloyDb/metadata/V1/DataModel.php | Bin 0 -> 1145 bytes AlloyDb/metadata/V1/Resources.php | Bin 11817 -> 14378 bytes AlloyDb/metadata/V1/Service.php | Bin 15637 -> 17488 bytes .../V1/AlloyDBAdminClient/create_cluster.php | 2 +- .../create_secondary_cluster.php | 2 +- .../V1/AlloyDBAdminClient/execute_sql.php | 95 +++++ .../V1/AlloyDBAdminClient/list_databases.php | 76 ++++ .../V1/AlloyDBAdminClient/restore_cluster.php | 2 +- .../AlloyDBAdminClient/switchover_cluster.php | 86 +++++ .../V1/AlloyDBAdminClient/update_cluster.php | 2 +- AlloyDb/src/V1/Backup.php | 88 +++++ .../V1/BatchCreateInstanceStatus/State.php | 2 +- .../src/V1/BatchCreateInstancesRequest.php | 40 +- AlloyDb/src/V1/Client/AlloyDBAdminClient.php | 87 +++++ AlloyDb/src/V1/Cluster.php | 318 +++++++++++++++- AlloyDb/src/V1/Cluster/NetworkConfig.php | 22 +- AlloyDb/src/V1/Cluster/PscConfig.php | 72 ++++ AlloyDb/src/V1/Cluster/TrialMetadata.php | 210 +++++++++++ AlloyDb/src/V1/ConnectionInfo.php | 42 +++ AlloyDb/src/V1/CreateBackupRequest.php | 40 +- AlloyDb/src/V1/CreateClusterRequest.php | 64 ++-- AlloyDb/src/V1/CreateInstanceRequest.php | 64 ++-- .../src/V1/CreateSecondaryClusterRequest.php | 64 ++-- .../src/V1/CreateSecondaryInstanceRequest.php | 64 ++-- AlloyDb/src/V1/CreateUserRequest.php | 40 +- AlloyDb/src/V1/Database.php | 155 ++++++++ AlloyDb/src/V1/DatabaseVersion.php | 14 + AlloyDb/src/V1/DeleteBackupRequest.php | 40 +- AlloyDb/src/V1/DeleteClusterRequest.php | 60 +-- AlloyDb/src/V1/DeleteInstanceRequest.php | 60 +-- AlloyDb/src/V1/DeleteUserRequest.php | 40 +- AlloyDb/src/V1/ExecuteSqlMetadata.php | 195 ++++++++++ AlloyDb/src/V1/ExecuteSqlMetadata/Status.php | 77 ++++ AlloyDb/src/V1/ExecuteSqlRequest.php | 263 +++++++++++++ AlloyDb/src/V1/ExecuteSqlResponse.php | 115 ++++++ AlloyDb/src/V1/FailoverInstanceRequest.php | 60 +-- .../V1/GenerateClientCertificateRequest.php | 40 +- AlloyDb/src/V1/GetConnectionInfoRequest.php | 40 +- AlloyDb/src/V1/InjectFaultRequest.php | 64 ++-- AlloyDb/src/V1/Instance.php | 202 ++++++++++ .../V1/Instance/ClientConnectionConfig.php | 8 +- .../src/V1/Instance/InstanceNetworkConfig.php | 140 +++++++ .../AuthorizedNetwork.php | 68 ++++ AlloyDb/src/V1/Instance/PscInstanceConfig.php | 157 ++++++++ AlloyDb/src/V1/ListDatabasesRequest.php | 207 +++++++++++ AlloyDb/src/V1/ListDatabasesResponse.php | 105 ++++++ AlloyDb/src/V1/MaintenanceSchedule.php | 81 ++++ AlloyDb/src/V1/MaintenanceUpdatePolicy.php | 67 ++++ .../MaintenanceWindow.php | 116 ++++++ AlloyDb/src/V1/PromoteClusterRequest.php | 44 ++- AlloyDb/src/V1/RestartInstanceRequest.php | 98 +++-- AlloyDb/src/V1/RestoreClusterRequest.php | 64 ++-- AlloyDb/src/V1/SqlResult.php | 105 ++++++ AlloyDb/src/V1/SqlResultColumn.php | 109 ++++++ AlloyDb/src/V1/SqlResultRow.php | 67 ++++ AlloyDb/src/V1/SqlResultValue.php | 125 +++++++ AlloyDb/src/V1/SslConfig/SslMode.php | 4 +- AlloyDb/src/V1/SubscriptionType.php | 64 ++++ AlloyDb/src/V1/SwitchoverClusterRequest.php | 202 ++++++++++ AlloyDb/src/V1/UpdateBackupRequest.php | 40 +- AlloyDb/src/V1/UpdateClusterRequest.php | 64 ++-- AlloyDb/src/V1/UpdateInstanceRequest.php | 64 ++-- AlloyDb/src/V1/UpdateUserRequest.php | 40 +- AlloyDb/src/V1/User.php | 38 ++ AlloyDb/src/V1/gapic_metadata.json | 15 + .../alloy_db_admin_client_config.json | 15 + .../alloy_db_admin_descriptor_config.php | 51 +++ .../alloy_db_admin_rest_client_config.php | 35 ++ .../Unit/V1/Client/AlloyDBAdminClientTest.php | 350 ++++++++++++++++++ 69 files changed, 4856 insertions(+), 594 deletions(-) create mode 100644 AlloyDb/metadata/V1/DataModel.php create mode 100644 AlloyDb/samples/V1/AlloyDBAdminClient/execute_sql.php create mode 100644 AlloyDb/samples/V1/AlloyDBAdminClient/list_databases.php create mode 100644 AlloyDb/samples/V1/AlloyDBAdminClient/switchover_cluster.php create mode 100644 AlloyDb/src/V1/Cluster/PscConfig.php create mode 100644 AlloyDb/src/V1/Cluster/TrialMetadata.php create mode 100644 AlloyDb/src/V1/Database.php create mode 100644 AlloyDb/src/V1/ExecuteSqlMetadata.php create mode 100644 AlloyDb/src/V1/ExecuteSqlMetadata/Status.php create mode 100644 AlloyDb/src/V1/ExecuteSqlRequest.php create mode 100644 AlloyDb/src/V1/ExecuteSqlResponse.php create mode 100644 AlloyDb/src/V1/Instance/InstanceNetworkConfig.php create mode 100644 AlloyDb/src/V1/Instance/InstanceNetworkConfig/AuthorizedNetwork.php create mode 100644 AlloyDb/src/V1/Instance/PscInstanceConfig.php create mode 100644 AlloyDb/src/V1/ListDatabasesRequest.php create mode 100644 AlloyDb/src/V1/ListDatabasesResponse.php create mode 100644 AlloyDb/src/V1/MaintenanceSchedule.php create mode 100644 AlloyDb/src/V1/MaintenanceUpdatePolicy.php create mode 100644 AlloyDb/src/V1/MaintenanceUpdatePolicy/MaintenanceWindow.php create mode 100644 AlloyDb/src/V1/SqlResult.php create mode 100644 AlloyDb/src/V1/SqlResultColumn.php create mode 100644 AlloyDb/src/V1/SqlResultRow.php create mode 100644 AlloyDb/src/V1/SqlResultValue.php create mode 100644 AlloyDb/src/V1/SubscriptionType.php create mode 100644 AlloyDb/src/V1/SwitchoverClusterRequest.php diff --git a/AlloyDb/metadata/V1/DataModel.php b/AlloyDb/metadata/V1/DataModel.php new file mode 100644 index 0000000000000000000000000000000000000000..f334a578ea62c9be4e6ae928c56472a835c9febc GIT binary patch literal 1145 zcma)5-EPw`7$v2Y%^O3?O((c9WvH3NQk4lIQVLoY=yow$jj0zXQspFWXUUC&<8&HR z?|BwpfOp`M$KWaOPa7ttYUC!dea`v5_&ev#yX-szPhk(Im?MD`7+pefj$y``U@@aG zD#l~XVa%o(p_sc627UOke+J(N$7fF@HD?8nu?HuNO(<@~lod$}QOYips5NW15+u-Q z$`VXnEeb%2rZ~?~jA3u!pJ0I$BVtnqb-M9klpT5vj zoEKEsufcukiDH`O+ZMd*Y`k#X6+E{j9cqHT52~D9iM>`)OJL$FmU=^fh!_q3KNe01lV zW!ZJ<<$}_YIZ!>U9a-|gUjsF>=|2D)qrVvchXo$XD6MM4-zr_MZ8xw!zcdqBUNf7v zCajDX%7{$ZVp>_$DZjo~>OGw&SLeyqc?u$T*#5aZ2^Uc_Sqq|2hV6Idk)e5>=6RkW g`kpszM>U<_{buR2=f=L*+`iK38fi>D2Xg@a00r=Ds{jB1 literal 0 HcmV?d00001 diff --git a/AlloyDb/metadata/V1/Resources.php b/AlloyDb/metadata/V1/Resources.php index 1ab8a44321b87ccb5ca10a506988fe5fef98191c..06fc70f26aebc7ff49deeb0e5bcc714ccc0a2bf6 100644 GIT binary patch delta 2150 zcmZ`)Pi)&{6qn;Re_qopaof~Q(BOakPv)!>@FeY>A>Zx4mY_z33R5dpy|SV~2tTE(N_MbzXE<~c?V#H@%-)YD9xt1DRacoAp2>q>5 zu-61X<_4H_0-R_G;5XT8MB zrJ7hrmP7|D@t4QRABl|9Wv=R2<~>6*%`9|T(kkXB+zIai(qE;@Gn!>?mLfaFuAO2x zg@ruZpJy0yrT_C6#~`u?8OKA911+V~at$fYXq%ujsUH~VZA;2cbqp{Y`mPxio@a`vzgmTNY)kckT+Pg-J_QW%0*w@n%49u79XP5#b~=OJO(%as12YKW4emAI#qzn9CfU&pd5w=uQ^?Am zv6XFAh-t{$(9Lz0>XTb4z<0B+wTkq zZoCPJj!L*u7{tiDs?xe8%aY`^I?^n$rfTc%KqF1Mn{IqLa)$|SF}ub086suOVIiV=EWm}ZFH&yiwgcp+%rpBFvfD+l zjgawdy8AO4_70iJzBeiypcB#PAn3Jl{tCDdYggpHi8dZ&Z?nmcGdbY2NG`-v1dl!y z=Stp97;q;-4+cwVq zMea>(WjH$Tb%YFuLZ&2|dW|ka(4S)$IW1I!o4duUFzhD2E6k^bZky5{7rLB}Q{m4H zguN2Tqh#O7FxL+uc}+4gvRv+XOiw~Y)@wET+tD?bD^2~Wy?GCX{4j54o}X||veOkl zcHI}>5+c4x`QVG>Z{d69I{EJCtLL}_(6e~4Qa!hHrXtRqh_mgAlkqNL0pkDtA8?0Y zq;jcLnO!O`R?8O`L?Q+IvQY?Es>Ox5;?i84;UdsoT`CtZ!~>=KEDXzfo$eOjn4A2S F`4_}=v8w<8 delta 298 zcmV+_0oDGhaH(9d{{gc$0&f8Y=u`?^Cy`4hlhFejvj_xY3IePVvzreg29u^2CX;~@ zC6n%fxL0^+lDj|~;8#@qE0Rch?3I=m;b#h~6B8(EVavSXflZPMC zqf{XRlb#DMvkE1t0R(vJL3NY4CUOQ+0RbZ50h2~2I3O7c3~6q2bYX5|WnXn^WEcb> z0VoMV1K>deI*S47L5GvZCx{CorV9!NLSbWTb#Rk>8@IDDDdYl^)e#hvMJzOvy)3+w zrY)caU+O_zT$4&JSp`x70V2q=xh~NH1ZV0&WRs9FWD-IS3Jh{(b98cPV{~b6ZgV2e wlQlAqlj1T|1Z?U-X_GoLW|NFG%>h}HS~Xb+Lb3x28)I*6lYt5tvqd)L0Zlt+k^lez diff --git a/AlloyDb/metadata/V1/Service.php b/AlloyDb/metadata/V1/Service.php index c0e1f525cbfe9db730d0678dbfd02934a00f8f18..62ea24282470aad66efe7dc1f452ffbdcce0a106 100644 GIT binary patch delta 1056 zcmZXT%}*0S7{;A#>Bkhxb`)4Bgk}p^q0qE35=9dW6eO0fwj7Mn&DtGclkEqcT~LXV zkZ3q~Fqv@jpvI%d7<=*t|A0dDq9+cX)T>@~r)+5(Z9+1?Vgl%dA6Wntz6`O0`A2_ddt4q?q4YsRx})ui)v(<^++mfI<$)* zL?ycb6|+ssRr-F}51PD>02I<2s-9gftm6{(!`t+$+Xrmr_t0nt&uFOQ@gi!2uDsbI zsR|M70b9sDZaaztaSuRW;x5h_I!>=?DZFN2qN5JzD$0ax6iSNF6aZH7wNvOKbg6lw z%lRzjy|FEGD1*5p6D)AmIu7}u-5|Im*lJQ2Y$0o!WVY%!hx5A0V2$O*eXy04OW6`u z%qvya#3ulvdMr{bb<+mM@hZlDNJd;$3&N652i|+Gd z&g!|lrHlUU9qtpCVOw1dCMj$ge;&H6MboFgpv!8+^rNHG7W;jn%m<&_+di3Ds^xG( zGl*`+ac|TQYbu=^h|*X6z4Xlhv|ScQ=}~m3`N1V}65sOcv-cqX13*~w1PwBiPS*r0 zr(Ko3-l*4)dBtt;Ek0}|6^AW!9A+^KH!Lh%&H47{@03f5(~Cvj6}9 delta 93 zcmV-j0HXiUhyj&)uxJ94p8`X(CIhem1mbWCC6kN=7?bh@VUutL8?&_q$py0p3~LMv zgaHZ`Qe|^=VRCenP8MO4-549QZ5v+;12XzCv(P7>1hYXcbqceiIGqWz{6bU#CRriK diff --git a/AlloyDb/samples/V1/AlloyDBAdminClient/create_cluster.php b/AlloyDb/samples/V1/AlloyDBAdminClient/create_cluster.php index 428b9bdd7ecd..10c0d66c6a5b 100644 --- a/AlloyDb/samples/V1/AlloyDBAdminClient/create_cluster.php +++ b/AlloyDb/samples/V1/AlloyDBAdminClient/create_cluster.php @@ -40,7 +40,7 @@ * @param string $formattedClusterNetwork The resource link for the VPC network in which cluster resources * are created and from which they are accessible via Private IP. The network * must belong to the same project as the cluster. It is specified in the - * form: "projects/{project}/global/networks/{network_id}". This is required + * form: `projects/{project}/global/networks/{network_id}`. This is required * to create a cluster. Deprecated, use network_config.network instead. Please see * {@see AlloyDBAdminClient::networkName()} for help formatting this field. */ diff --git a/AlloyDb/samples/V1/AlloyDBAdminClient/create_secondary_cluster.php b/AlloyDb/samples/V1/AlloyDBAdminClient/create_secondary_cluster.php index e832e93faf37..4473dad7bca3 100644 --- a/AlloyDb/samples/V1/AlloyDBAdminClient/create_secondary_cluster.php +++ b/AlloyDb/samples/V1/AlloyDBAdminClient/create_secondary_cluster.php @@ -41,7 +41,7 @@ * @param string $formattedClusterNetwork The resource link for the VPC network in which cluster resources * are created and from which they are accessible via Private IP. The network * must belong to the same project as the cluster. It is specified in the - * form: "projects/{project}/global/networks/{network_id}". This is required + * form: `projects/{project}/global/networks/{network_id}`. This is required * to create a cluster. Deprecated, use network_config.network instead. Please see * {@see AlloyDBAdminClient::networkName()} for help formatting this field. */ diff --git a/AlloyDb/samples/V1/AlloyDBAdminClient/execute_sql.php b/AlloyDb/samples/V1/AlloyDBAdminClient/execute_sql.php new file mode 100644 index 000000000000..7e9ed33563c5 --- /dev/null +++ b/AlloyDb/samples/V1/AlloyDBAdminClient/execute_sql.php @@ -0,0 +1,95 @@ +setInstance($formattedInstance) + ->setDatabase($database) + ->setUser($user) + ->setSqlStatement($sqlStatement); + + // Call the API and handle any network failures. + try { + /** @var ExecuteSqlResponse $response */ + $response = $alloyDBAdminClient->executeSql($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedInstance = AlloyDBAdminClient::instanceName( + '[PROJECT]', + '[LOCATION]', + '[CLUSTER]', + '[INSTANCE]' + ); + $database = '[DATABASE]'; + $user = '[USER]'; + $sqlStatement = '[SQL_STATEMENT]'; + + execute_sql_sample($formattedInstance, $database, $user, $sqlStatement); +} +// [END alloydb_v1_generated_AlloyDBAdmin_ExecuteSql_sync] diff --git a/AlloyDb/samples/V1/AlloyDBAdminClient/list_databases.php b/AlloyDb/samples/V1/AlloyDBAdminClient/list_databases.php new file mode 100644 index 000000000000..bf3389d01c64 --- /dev/null +++ b/AlloyDb/samples/V1/AlloyDBAdminClient/list_databases.php @@ -0,0 +1,76 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $alloyDBAdminClient->listDatabases($request); + + /** @var Database $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = AlloyDBAdminClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]'); + + list_databases_sample($formattedParent); +} +// [END alloydb_v1_generated_AlloyDBAdmin_ListDatabases_sync] diff --git a/AlloyDb/samples/V1/AlloyDBAdminClient/restore_cluster.php b/AlloyDb/samples/V1/AlloyDBAdminClient/restore_cluster.php index 7517809adc5c..c18415e00df7 100644 --- a/AlloyDb/samples/V1/AlloyDBAdminClient/restore_cluster.php +++ b/AlloyDb/samples/V1/AlloyDBAdminClient/restore_cluster.php @@ -42,7 +42,7 @@ * @param string $formattedClusterNetwork The resource link for the VPC network in which cluster resources * are created and from which they are accessible via Private IP. The network * must belong to the same project as the cluster. It is specified in the - * form: "projects/{project}/global/networks/{network_id}". This is required + * form: `projects/{project}/global/networks/{network_id}`. This is required * to create a cluster. Deprecated, use network_config.network instead. Please see * {@see AlloyDBAdminClient::networkName()} for help formatting this field. */ diff --git a/AlloyDb/samples/V1/AlloyDBAdminClient/switchover_cluster.php b/AlloyDb/samples/V1/AlloyDBAdminClient/switchover_cluster.php new file mode 100644 index 000000000000..8b2f64626634 --- /dev/null +++ b/AlloyDb/samples/V1/AlloyDBAdminClient/switchover_cluster.php @@ -0,0 +1,86 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $alloyDBAdminClient->switchoverCluster($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Cluster $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 +{ + $formattedName = AlloyDBAdminClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]'); + + switchover_cluster_sample($formattedName); +} +// [END alloydb_v1_generated_AlloyDBAdmin_SwitchoverCluster_sync] diff --git a/AlloyDb/samples/V1/AlloyDBAdminClient/update_cluster.php b/AlloyDb/samples/V1/AlloyDBAdminClient/update_cluster.php index 58655649630f..17c67c5cde04 100644 --- a/AlloyDb/samples/V1/AlloyDBAdminClient/update_cluster.php +++ b/AlloyDb/samples/V1/AlloyDBAdminClient/update_cluster.php @@ -36,7 +36,7 @@ * @param string $formattedClusterNetwork The resource link for the VPC network in which cluster resources * are created and from which they are accessible via Private IP. The network * must belong to the same project as the cluster. It is specified in the - * form: "projects/{project}/global/networks/{network_id}". This is required + * form: `projects/{project}/global/networks/{network_id}`. This is required * to create a cluster. Deprecated, use network_config.network instead. Please see * {@see AlloyDBAdminClient::networkName()} for help formatting this field. */ diff --git a/AlloyDb/src/V1/Backup.php b/AlloyDb/src/V1/Backup.php index eb9d0691371e..3d01d0602fea 100644 --- a/AlloyDb/src/V1/Backup.php +++ b/AlloyDb/src/V1/Backup.php @@ -158,6 +158,12 @@ class Backup extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.alloydb.v1.Backup.QuantityBasedExpiry expiry_quantity = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $expiry_quantity = null; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $satisfies_pzs = false; /** * Output only. The database engine major version of the cluster this backup * was created from. Any restored cluster created from this backup will have @@ -166,6 +172,17 @@ class Backup extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.alloydb.v1.DatabaseVersion database_version = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $database_version = 0; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this + * resource. For example: + * ``` + * "123/environment": "production", + * "123/costCenter": "marketing" + * ``` + * + * Generated from protobuf field map tags = 25 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; + */ + private $tags; /** * Constructor. @@ -236,10 +253,19 @@ class Backup extends \Google\Protobuf\Internal\Message * Output only. The QuantityBasedExpiry of the backup, specified by the * backup's retention policy. Once the expiry quantity is over retention, the * backup is eligible to be garbage collected. + * @type bool $satisfies_pzs + * Output only. Reserved for future use. * @type int $database_version * Output only. The database engine major version of the cluster this backup * was created from. Any restored cluster created from this backup will have * the same database version. + * @type array|\Google\Protobuf\Internal\MapField $tags + * Optional. Input only. Immutable. Tag keys/values directly bound to this + * resource. For example: + * ``` + * "123/environment": "production", + * "123/costCenter": "marketing" + * ``` * } */ public function __construct($data = NULL) { @@ -883,6 +909,32 @@ public function setExpiryQuantity($var) return $this; } + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzs() + { + return $this->satisfies_pzs; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + /** * Output only. The database engine major version of the cluster this backup * was created from. Any restored cluster created from this backup will have @@ -913,5 +965,41 @@ public function setDatabaseVersion($var) return $this; } + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this + * resource. For example: + * ``` + * "123/environment": "production", + * "123/costCenter": "marketing" + * ``` + * + * Generated from protobuf field map tags = 25 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getTags() + { + return $this->tags; + } + + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this + * resource. For example: + * ``` + * "123/environment": "production", + * "123/costCenter": "marketing" + * ``` + * + * Generated from protobuf field map tags = 25 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setTags($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->tags = $arr; + + return $this; + } + } diff --git a/AlloyDb/src/V1/BatchCreateInstanceStatus/State.php b/AlloyDb/src/V1/BatchCreateInstanceStatus/State.php index 1197165ad623..e5e4d8a1179b 100644 --- a/AlloyDb/src/V1/BatchCreateInstanceStatus/State.php +++ b/AlloyDb/src/V1/BatchCreateInstanceStatus/State.php @@ -23,7 +23,7 @@ class State const STATE_UNSPECIFIED = 0; /** * Instance is pending creation and has not yet been picked up for - * processsing in the backend. + * processing in the backend. * * Generated from protobuf enum PENDING_CREATE = 1; */ diff --git a/AlloyDb/src/V1/BatchCreateInstancesRequest.php b/AlloyDb/src/V1/BatchCreateInstancesRequest.php index 5be73ca95737..638507a533ef 100644 --- a/AlloyDb/src/V1/BatchCreateInstancesRequest.php +++ b/AlloyDb/src/V1/BatchCreateInstancesRequest.php @@ -29,13 +29,13 @@ class BatchCreateInstancesRequest extends \Google\Protobuf\Internal\Message protected $requests = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -56,13 +56,13 @@ class BatchCreateInstancesRequest extends \Google\Protobuf\Internal\Message * Required. Resources being created. * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -137,13 +137,13 @@ public function setRequests($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -158,13 +158,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/Client/AlloyDBAdminClient.php b/AlloyDb/src/V1/Client/AlloyDBAdminClient.php index a53f30a4baf3..dabcddfb3eb2 100644 --- a/AlloyDb/src/V1/Client/AlloyDBAdminClient.php +++ b/AlloyDb/src/V1/Client/AlloyDBAdminClient.php @@ -48,6 +48,8 @@ use Google\Cloud\AlloyDb\V1\DeleteClusterRequest; use Google\Cloud\AlloyDb\V1\DeleteInstanceRequest; use Google\Cloud\AlloyDb\V1\DeleteUserRequest; +use Google\Cloud\AlloyDb\V1\ExecuteSqlRequest; +use Google\Cloud\AlloyDb\V1\ExecuteSqlResponse; use Google\Cloud\AlloyDb\V1\FailoverInstanceRequest; use Google\Cloud\AlloyDb\V1\GenerateClientCertificateRequest; use Google\Cloud\AlloyDb\V1\GenerateClientCertificateResponse; @@ -60,12 +62,14 @@ use Google\Cloud\AlloyDb\V1\Instance; use Google\Cloud\AlloyDb\V1\ListBackupsRequest; use Google\Cloud\AlloyDb\V1\ListClustersRequest; +use Google\Cloud\AlloyDb\V1\ListDatabasesRequest; use Google\Cloud\AlloyDb\V1\ListInstancesRequest; use Google\Cloud\AlloyDb\V1\ListSupportedDatabaseFlagsRequest; use Google\Cloud\AlloyDb\V1\ListUsersRequest; use Google\Cloud\AlloyDb\V1\PromoteClusterRequest; use Google\Cloud\AlloyDb\V1\RestartInstanceRequest; use Google\Cloud\AlloyDb\V1\RestoreClusterRequest; +use Google\Cloud\AlloyDb\V1\SwitchoverClusterRequest; use Google\Cloud\AlloyDb\V1\UpdateBackupRequest; use Google\Cloud\AlloyDb\V1\UpdateClusterRequest; use Google\Cloud\AlloyDb\V1\UpdateInstanceRequest; @@ -100,6 +104,7 @@ * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteUserAsync(DeleteUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface executeSqlAsync(ExecuteSqlRequest $request, array $optionalArgs = []) * @method PromiseInterface failoverInstanceAsync(FailoverInstanceRequest $request, array $optionalArgs = []) * @method PromiseInterface generateClientCertificateAsync(GenerateClientCertificateRequest $request, array $optionalArgs = []) * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) @@ -110,12 +115,14 @@ * @method PromiseInterface injectFaultAsync(InjectFaultRequest $request, array $optionalArgs = []) * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatabasesAsync(ListDatabasesRequest $request, array $optionalArgs = []) * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) * @method PromiseInterface listSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest $request, array $optionalArgs = []) * @method PromiseInterface listUsersAsync(ListUsersRequest $request, array $optionalArgs = []) * @method PromiseInterface promoteClusterAsync(PromoteClusterRequest $request, array $optionalArgs = []) * @method PromiseInterface restartInstanceAsync(RestartInstanceRequest $request, array $optionalArgs = []) * @method PromiseInterface restoreClusterAsync(RestoreClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface switchoverClusterAsync(SwitchoverClusterRequest $request, array $optionalArgs = []) * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) @@ -765,6 +772,32 @@ public function deleteUser(DeleteUserRequest $request, array $callOptions = []): $this->startApiCall('DeleteUser', $request, $callOptions)->wait(); } + /** + * Executes a SQL statement in a database inside an AlloyDB instance. + * + * The async variant is {@see AlloyDBAdminClient::executeSqlAsync()} . + * + * @example samples/V1/AlloyDBAdminClient/execute_sql.php + * + * @param ExecuteSqlRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return ExecuteSqlResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function executeSql(ExecuteSqlRequest $request, array $callOptions = []): ExecuteSqlResponse + { + return $this->startApiCall('ExecuteSql', $request, $callOptions)->wait(); + } + /** * Forces a Failover for a highly available instance. * Failover promotes the HA standby instance as the new primary. @@ -1035,6 +1068,32 @@ public function listClusters(ListClustersRequest $request, array $callOptions = return $this->startApiCall('ListClusters', $request, $callOptions); } + /** + * Lists Databases in a given project and location. + * + * The async variant is {@see AlloyDBAdminClient::listDatabasesAsync()} . + * + * @example samples/V1/AlloyDBAdminClient/list_databases.php + * + * @param ListDatabasesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listDatabases(ListDatabasesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListDatabases', $request, $callOptions); + } + /** * Lists Instances in a given project and location. * @@ -1200,6 +1259,34 @@ public function restoreCluster(RestoreClusterRequest $request, array $callOption return $this->startApiCall('RestoreCluster', $request, $callOptions)->wait(); } + /** + * Switches the roles of PRIMARY and SECONDARY clusters without any data loss. + * This promotes the SECONDARY cluster to PRIMARY and sets up the original + * PRIMARY cluster to replicate from this newly promoted cluster. + * + * The async variant is {@see AlloyDBAdminClient::switchoverClusterAsync()} . + * + * @example samples/V1/AlloyDBAdminClient/switchover_cluster.php + * + * @param SwitchoverClusterRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function switchoverCluster(SwitchoverClusterRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('SwitchoverCluster', $request, $callOptions)->wait(); + } + /** * Updates the parameters of a single Backup. * diff --git a/AlloyDb/src/V1/Cluster.php b/AlloyDb/src/V1/Cluster.php index 7a3c30dcc531..fb37d3ae0ec5 100644 --- a/AlloyDb/src/V1/Cluster.php +++ b/AlloyDb/src/V1/Cluster.php @@ -97,7 +97,7 @@ class Cluster extends \Google\Protobuf\Internal\Message * Required. The resource link for the VPC network in which cluster resources * are created and from which they are accessible via Private IP. The network * must belong to the same project as the cluster. It is specified in the - * form: "projects/{project}/global/networks/{network_id}". This is required + * form: `projects/{project}/global/networks/{network_id}`. This is required * to create a cluster. Deprecated, use network_config.network instead. * * Generated from protobuf field string network = 10 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -193,6 +193,56 @@ class Cluster extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.alloydb.v1.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $primary_config = null; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 30 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $satisfies_pzs = false; + /** + * Optional. The configuration for Private Service Connect (PSC) for the + * cluster. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Cluster.PscConfig psc_config = 31 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $psc_config = null; + /** + * Optional. The maintenance update policy determines when to allow or deny + * updates. + * + * Generated from protobuf field .google.cloud.alloydb.v1.MaintenanceUpdatePolicy maintenance_update_policy = 32 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $maintenance_update_policy = null; + /** + * Output only. The maintenance schedule for the cluster, generated for a + * specific rollout if a maintenance window is set. + * + * Generated from protobuf field .google.cloud.alloydb.v1.MaintenanceSchedule maintenance_schedule = 37 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $maintenance_schedule = null; + /** + * Optional. Subscription type of the cluster. + * + * Generated from protobuf field .google.cloud.alloydb.v1.SubscriptionType subscription_type = 38 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $subscription_type = 0; + /** + * Output only. Metadata for free trial clusters + * + * Generated from protobuf field .google.cloud.alloydb.v1.Cluster.TrialMetadata trial_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $trial_metadata = null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this + * resource. For example: + * ``` + * "123/environment": "production", + * "123/costCenter": "marketing" + * ``` + * + * Generated from protobuf field map tags = 41 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; + */ + private $tags; protected $source; /** @@ -242,7 +292,7 @@ class Cluster extends \Google\Protobuf\Internal\Message * Required. The resource link for the VPC network in which cluster resources * are created and from which they are accessible via Private IP. The network * must belong to the same project as the cluster. It is specified in the - * form: "projects/{project}/global/networks/{network_id}". This is required + * form: `projects/{project}/global/networks/{network_id}`. This is required * to create a cluster. Deprecated, use network_config.network instead. * @type string $etag * For Resource freshness validation (https://google.aip.dev/154) @@ -284,6 +334,28 @@ class Cluster extends \Google\Protobuf\Internal\Message * Cross Region replication config specific to SECONDARY cluster. * @type \Google\Cloud\AlloyDb\V1\Cluster\PrimaryConfig $primary_config * Output only. Cross Region replication config specific to PRIMARY cluster. + * @type bool $satisfies_pzs + * Output only. Reserved for future use. + * @type \Google\Cloud\AlloyDb\V1\Cluster\PscConfig $psc_config + * Optional. The configuration for Private Service Connect (PSC) for the + * cluster. + * @type \Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy $maintenance_update_policy + * Optional. The maintenance update policy determines when to allow or deny + * updates. + * @type \Google\Cloud\AlloyDb\V1\MaintenanceSchedule $maintenance_schedule + * Output only. The maintenance schedule for the cluster, generated for a + * specific rollout if a maintenance window is set. + * @type int $subscription_type + * Optional. Subscription type of the cluster. + * @type \Google\Cloud\AlloyDb\V1\Cluster\TrialMetadata $trial_metadata + * Output only. Metadata for free trial clusters + * @type array|\Google\Protobuf\Internal\MapField $tags + * Optional. Input only. Immutable. Tag keys/values directly bound to this + * resource. For example: + * ``` + * "123/environment": "production", + * "123/costCenter": "marketing" + * ``` * } */ public function __construct($data = NULL) { @@ -703,7 +775,7 @@ public function setNetworkConfig($var) * Required. The resource link for the VPC network in which cluster resources * are created and from which they are accessible via Private IP. The network * must belong to the same project as the cluster. It is specified in the - * form: "projects/{project}/global/networks/{network_id}". This is required + * form: `projects/{project}/global/networks/{network_id}`. This is required * to create a cluster. Deprecated, use network_config.network instead. * * Generated from protobuf field string network = 10 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -720,7 +792,7 @@ public function getNetwork() * Required. The resource link for the VPC network in which cluster resources * are created and from which they are accessible via Private IP. The network * must belong to the same project as the cluster. It is specified in the - * form: "projects/{project}/global/networks/{network_id}". This is required + * form: `projects/{project}/global/networks/{network_id}`. This is required * to create a cluster. Deprecated, use network_config.network instead. * * Generated from protobuf field string network = 10 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -1177,6 +1249,244 @@ public function setPrimaryConfig($var) return $this; } + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 30 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzs() + { + return $this->satisfies_pzs; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 30 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + + /** + * Optional. The configuration for Private Service Connect (PSC) for the + * cluster. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Cluster.PscConfig psc_config = 31 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\AlloyDb\V1\Cluster\PscConfig|null + */ + public function getPscConfig() + { + return $this->psc_config; + } + + public function hasPscConfig() + { + return isset($this->psc_config); + } + + public function clearPscConfig() + { + unset($this->psc_config); + } + + /** + * Optional. The configuration for Private Service Connect (PSC) for the + * cluster. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Cluster.PscConfig psc_config = 31 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\AlloyDb\V1\Cluster\PscConfig $var + * @return $this + */ + public function setPscConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\Cluster\PscConfig::class); + $this->psc_config = $var; + + return $this; + } + + /** + * Optional. The maintenance update policy determines when to allow or deny + * updates. + * + * Generated from protobuf field .google.cloud.alloydb.v1.MaintenanceUpdatePolicy maintenance_update_policy = 32 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy|null + */ + public function getMaintenanceUpdatePolicy() + { + return $this->maintenance_update_policy; + } + + public function hasMaintenanceUpdatePolicy() + { + return isset($this->maintenance_update_policy); + } + + public function clearMaintenanceUpdatePolicy() + { + unset($this->maintenance_update_policy); + } + + /** + * Optional. The maintenance update policy determines when to allow or deny + * updates. + * + * Generated from protobuf field .google.cloud.alloydb.v1.MaintenanceUpdatePolicy maintenance_update_policy = 32 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy $var + * @return $this + */ + public function setMaintenanceUpdatePolicy($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy::class); + $this->maintenance_update_policy = $var; + + return $this; + } + + /** + * Output only. The maintenance schedule for the cluster, generated for a + * specific rollout if a maintenance window is set. + * + * Generated from protobuf field .google.cloud.alloydb.v1.MaintenanceSchedule maintenance_schedule = 37 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\AlloyDb\V1\MaintenanceSchedule|null + */ + public function getMaintenanceSchedule() + { + return $this->maintenance_schedule; + } + + public function hasMaintenanceSchedule() + { + return isset($this->maintenance_schedule); + } + + public function clearMaintenanceSchedule() + { + unset($this->maintenance_schedule); + } + + /** + * Output only. The maintenance schedule for the cluster, generated for a + * specific rollout if a maintenance window is set. + * + * Generated from protobuf field .google.cloud.alloydb.v1.MaintenanceSchedule maintenance_schedule = 37 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\AlloyDb\V1\MaintenanceSchedule $var + * @return $this + */ + public function setMaintenanceSchedule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\MaintenanceSchedule::class); + $this->maintenance_schedule = $var; + + return $this; + } + + /** + * Optional. Subscription type of the cluster. + * + * Generated from protobuf field .google.cloud.alloydb.v1.SubscriptionType subscription_type = 38 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSubscriptionType() + { + return $this->subscription_type; + } + + /** + * Optional. Subscription type of the cluster. + * + * Generated from protobuf field .google.cloud.alloydb.v1.SubscriptionType subscription_type = 38 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSubscriptionType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\AlloyDb\V1\SubscriptionType::class); + $this->subscription_type = $var; + + return $this; + } + + /** + * Output only. Metadata for free trial clusters + * + * Generated from protobuf field .google.cloud.alloydb.v1.Cluster.TrialMetadata trial_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\AlloyDb\V1\Cluster\TrialMetadata|null + */ + public function getTrialMetadata() + { + return $this->trial_metadata; + } + + public function hasTrialMetadata() + { + return isset($this->trial_metadata); + } + + public function clearTrialMetadata() + { + unset($this->trial_metadata); + } + + /** + * Output only. Metadata for free trial clusters + * + * Generated from protobuf field .google.cloud.alloydb.v1.Cluster.TrialMetadata trial_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\AlloyDb\V1\Cluster\TrialMetadata $var + * @return $this + */ + public function setTrialMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\Cluster\TrialMetadata::class); + $this->trial_metadata = $var; + + return $this; + } + + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this + * resource. For example: + * ``` + * "123/environment": "production", + * "123/costCenter": "marketing" + * ``` + * + * Generated from protobuf field map tags = 41 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getTags() + { + return $this->tags; + } + + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this + * resource. For example: + * ``` + * "123/environment": "production", + * "123/costCenter": "marketing" + * ``` + * + * Generated from protobuf field map tags = 41 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setTags($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->tags = $arr; + + return $this; + } + /** * @return string */ diff --git a/AlloyDb/src/V1/Cluster/NetworkConfig.php b/AlloyDb/src/V1/Cluster/NetworkConfig.php index 38e319e5da18..08a44dcb134f 100644 --- a/AlloyDb/src/V1/Cluster/NetworkConfig.php +++ b/AlloyDb/src/V1/Cluster/NetworkConfig.php @@ -16,14 +16,14 @@ class NetworkConfig extends \Google\Protobuf\Internal\Message { /** - * Required. The resource link for the VPC network in which cluster + * Optional. The resource link for the VPC network in which cluster * resources are created and from which they are accessible via Private IP. * The network must belong to the same project as the cluster. It is * specified in the form: - * "projects/{project_number}/global/networks/{network_id}". This is + * `projects/{project_number}/global/networks/{network_id}`. This is * required to create a cluster. * - * Generated from protobuf field string network = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * Generated from protobuf field string network = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ protected $network = ''; /** @@ -46,11 +46,11 @@ class NetworkConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $network - * Required. The resource link for the VPC network in which cluster + * Optional. The resource link for the VPC network in which cluster * resources are created and from which they are accessible via Private IP. * The network must belong to the same project as the cluster. It is * specified in the form: - * "projects/{project_number}/global/networks/{network_id}". This is + * `projects/{project_number}/global/networks/{network_id}`. This is * required to create a cluster. * @type string $allocated_ip_range * Optional. Name of the allocated IP range for the private IP AlloyDB @@ -68,14 +68,14 @@ public function __construct($data = NULL) { } /** - * Required. The resource link for the VPC network in which cluster + * Optional. The resource link for the VPC network in which cluster * resources are created and from which they are accessible via Private IP. * The network must belong to the same project as the cluster. It is * specified in the form: - * "projects/{project_number}/global/networks/{network_id}". This is + * `projects/{project_number}/global/networks/{network_id}`. This is * required to create a cluster. * - * Generated from protobuf field string network = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * Generated from protobuf field string network = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string */ public function getNetwork() @@ -84,14 +84,14 @@ public function getNetwork() } /** - * Required. The resource link for the VPC network in which cluster + * Optional. The resource link for the VPC network in which cluster * resources are created and from which they are accessible via Private IP. * The network must belong to the same project as the cluster. It is * specified in the form: - * "projects/{project_number}/global/networks/{network_id}". This is + * `projects/{project_number}/global/networks/{network_id}`. This is * required to create a cluster. * - * Generated from protobuf field string network = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * Generated from protobuf field string network = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var * @return $this */ diff --git a/AlloyDb/src/V1/Cluster/PscConfig.php b/AlloyDb/src/V1/Cluster/PscConfig.php new file mode 100644 index 000000000000..6264b574acdc --- /dev/null +++ b/AlloyDb/src/V1/Cluster/PscConfig.php @@ -0,0 +1,72 @@ +google.cloud.alloydb.v1.Cluster.PscConfig + */ +class PscConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Create an instance that allows connections from Private Service + * Connect endpoints to the instance. + * + * Generated from protobuf field bool psc_enabled = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $psc_enabled = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $psc_enabled + * Optional. Create an instance that allows connections from Private Service + * Connect endpoints to the instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Create an instance that allows connections from Private Service + * Connect endpoints to the instance. + * + * Generated from protobuf field bool psc_enabled = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getPscEnabled() + { + return $this->psc_enabled; + } + + /** + * Optional. Create an instance that allows connections from Private Service + * Connect endpoints to the instance. + * + * Generated from protobuf field bool psc_enabled = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setPscEnabled($var) + { + GPBUtil::checkBool($var); + $this->psc_enabled = $var; + + return $this; + } + +} + + diff --git a/AlloyDb/src/V1/Cluster/TrialMetadata.php b/AlloyDb/src/V1/Cluster/TrialMetadata.php new file mode 100644 index 000000000000..54be80c90f8c --- /dev/null +++ b/AlloyDb/src/V1/Cluster/TrialMetadata.php @@ -0,0 +1,210 @@ +google.cloud.alloydb.v1.Cluster.TrialMetadata + */ +class TrialMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * start time of the trial cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 1; + */ + protected $start_time = null; + /** + * End time of the trial cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + */ + protected $end_time = null; + /** + * Upgrade time of trial cluster to Standard cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp upgrade_time = 3; + */ + protected $upgrade_time = null; + /** + * grace end time of the cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp grace_end_time = 4; + */ + protected $grace_end_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Timestamp $start_time + * start time of the trial cluster. + * @type \Google\Protobuf\Timestamp $end_time + * End time of the trial cluster. + * @type \Google\Protobuf\Timestamp $upgrade_time + * Upgrade time of trial cluster to Standard cluster. + * @type \Google\Protobuf\Timestamp $grace_end_time + * grace end time of the cluster. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * start time of the trial cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 1; + * @return \Google\Protobuf\Timestamp|null + */ + public function getStartTime() + { + return $this->start_time; + } + + public function hasStartTime() + { + return isset($this->start_time); + } + + public function clearStartTime() + { + unset($this->start_time); + } + + /** + * start time of the trial cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 1; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setStartTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->start_time = $var; + + return $this; + } + + /** + * End time of the trial cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * End time of the trial cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + + /** + * Upgrade time of trial cluster to Standard cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp upgrade_time = 3; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpgradeTime() + { + return $this->upgrade_time; + } + + public function hasUpgradeTime() + { + return isset($this->upgrade_time); + } + + public function clearUpgradeTime() + { + unset($this->upgrade_time); + } + + /** + * Upgrade time of trial cluster to Standard cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp upgrade_time = 3; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpgradeTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->upgrade_time = $var; + + return $this; + } + + /** + * grace end time of the cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp grace_end_time = 4; + * @return \Google\Protobuf\Timestamp|null + */ + public function getGraceEndTime() + { + return $this->grace_end_time; + } + + public function hasGraceEndTime() + { + return isset($this->grace_end_time); + } + + public function clearGraceEndTime() + { + unset($this->grace_end_time); + } + + /** + * grace end time of the cluster. + * + * Generated from protobuf field .google.protobuf.Timestamp grace_end_time = 4; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setGraceEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->grace_end_time = $var; + + return $this; + } + +} + + diff --git a/AlloyDb/src/V1/ConnectionInfo.php b/AlloyDb/src/V1/ConnectionInfo.php index 6232de3da334..c037ffcc12d2 100644 --- a/AlloyDb/src/V1/ConnectionInfo.php +++ b/AlloyDb/src/V1/ConnectionInfo.php @@ -32,6 +32,14 @@ class ConnectionInfo extends \Google\Protobuf\Internal\Message * Generated from protobuf field string ip_address = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $ip_address = ''; + /** + * Output only. The public IP addresses for the Instance. This is available + * ONLY when enable_public_ip is set. This is the connection endpoint for an + * end-user application. + * + * Generated from protobuf field string public_ip_address = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + */ + protected $public_ip_address = ''; /** * Output only. The unique ID of the Instance. * @@ -53,6 +61,10 @@ class ConnectionInfo extends \Google\Protobuf\Internal\Message * Output only. The private network IP address for the Instance. This is the * default IP for the instance and is always created (even if enable_public_ip * is set). This is the connection endpoint for an end-user application. + * @type string $public_ip_address + * Output only. The public IP addresses for the Instance. This is available + * ONLY when enable_public_ip is set. This is the connection endpoint for an + * end-user application. * @type string $instance_uid * Output only. The unique ID of the Instance. * } @@ -122,6 +134,36 @@ public function setIpAddress($var) return $this; } + /** + * Output only. The public IP addresses for the Instance. This is available + * ONLY when enable_public_ip is set. This is the connection endpoint for an + * end-user application. + * + * Generated from protobuf field string public_ip_address = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @return string + */ + public function getPublicIpAddress() + { + return $this->public_ip_address; + } + + /** + * Output only. The public IP addresses for the Instance. This is available + * ONLY when enable_public_ip is set. This is the connection endpoint for an + * end-user application. + * + * Generated from protobuf field string public_ip_address = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setPublicIpAddress($var) + { + GPBUtil::checkString($var, True); + $this->public_ip_address = $var; + + return $this; + } + /** * Output only. The unique ID of the Instance. * diff --git a/AlloyDb/src/V1/CreateBackupRequest.php b/AlloyDb/src/V1/CreateBackupRequest.php index 8311f1385500..4eedda5e924c 100644 --- a/AlloyDb/src/V1/CreateBackupRequest.php +++ b/AlloyDb/src/V1/CreateBackupRequest.php @@ -35,13 +35,13 @@ class CreateBackupRequest extends \Google\Protobuf\Internal\Message protected $backup = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -89,13 +89,13 @@ public static function build(string $parent, \Google\Cloud\AlloyDb\V1\Backup $ba * Required. The resource being created * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -199,13 +199,13 @@ public function setBackup($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -220,13 +220,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/CreateClusterRequest.php b/AlloyDb/src/V1/CreateClusterRequest.php index 7904fcc3a9a4..4bccb5c86b9c 100644 --- a/AlloyDb/src/V1/CreateClusterRequest.php +++ b/AlloyDb/src/V1/CreateClusterRequest.php @@ -36,13 +36,13 @@ class CreateClusterRequest extends \Google\Protobuf\Internal\Message protected $cluster = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -51,9 +51,9 @@ class CreateClusterRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -93,20 +93,20 @@ public static function build(string $parent, \Google\Cloud\AlloyDb\V1\Cluster $c * Required. The resource being created * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -206,13 +206,13 @@ public function setCluster($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -227,13 +227,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -251,9 +251,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -264,9 +264,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/CreateInstanceRequest.php b/AlloyDb/src/V1/CreateInstanceRequest.php index 8da4cc57bd3d..27a56f4d8b4a 100644 --- a/AlloyDb/src/V1/CreateInstanceRequest.php +++ b/AlloyDb/src/V1/CreateInstanceRequest.php @@ -36,13 +36,13 @@ class CreateInstanceRequest extends \Google\Protobuf\Internal\Message protected $instance = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -51,9 +51,9 @@ class CreateInstanceRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -93,20 +93,20 @@ public static function build(string $parent, \Google\Cloud\AlloyDb\V1\Instance $ * Required. The resource being created * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -206,13 +206,13 @@ public function setInstance($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -227,13 +227,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -251,9 +251,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -264,9 +264,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/CreateSecondaryClusterRequest.php b/AlloyDb/src/V1/CreateSecondaryClusterRequest.php index 11b2c6c2e1ec..2f275466f8bc 100644 --- a/AlloyDb/src/V1/CreateSecondaryClusterRequest.php +++ b/AlloyDb/src/V1/CreateSecondaryClusterRequest.php @@ -34,13 +34,13 @@ class CreateSecondaryClusterRequest extends \Google\Protobuf\Internal\Message protected $cluster = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -49,9 +49,9 @@ class CreateSecondaryClusterRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 6 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -91,20 +91,20 @@ public static function build(string $parent, \Google\Cloud\AlloyDb\V1\Cluster $c * Required. Configuration of the requesting object (the secondary cluster). * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -204,13 +204,13 @@ public function setCluster($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -225,13 +225,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -249,9 +249,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -262,9 +262,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/CreateSecondaryInstanceRequest.php b/AlloyDb/src/V1/CreateSecondaryInstanceRequest.php index a7f3586d36a0..0ba7eb3b2352 100644 --- a/AlloyDb/src/V1/CreateSecondaryInstanceRequest.php +++ b/AlloyDb/src/V1/CreateSecondaryInstanceRequest.php @@ -36,13 +36,13 @@ class CreateSecondaryInstanceRequest extends \Google\Protobuf\Internal\Message protected $instance = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -51,9 +51,9 @@ class CreateSecondaryInstanceRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -93,20 +93,20 @@ public static function build(string $parent, \Google\Cloud\AlloyDb\V1\Instance $ * Required. The resource being created * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -206,13 +206,13 @@ public function setInstance($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -227,13 +227,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -251,9 +251,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -264,9 +264,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the create - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/CreateUserRequest.php b/AlloyDb/src/V1/CreateUserRequest.php index 3fe9ac1ec46b..6985a4a313b1 100644 --- a/AlloyDb/src/V1/CreateUserRequest.php +++ b/AlloyDb/src/V1/CreateUserRequest.php @@ -35,13 +35,13 @@ class CreateUserRequest extends \Google\Protobuf\Internal\Message protected $user = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -89,13 +89,13 @@ public static function build(string $parent, \Google\Cloud\AlloyDb\V1\User $user * Required. The resource being created * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -199,13 +199,13 @@ public function setUser($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -220,13 +220,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/Database.php b/AlloyDb/src/V1/Database.php new file mode 100644 index 000000000000..532aefbcfc1b --- /dev/null +++ b/AlloyDb/src/V1/Database.php @@ -0,0 +1,155 @@ +google.cloud.alloydb.v1.Database + */ +class Database extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. Name of the resource in the form of + * `projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Optional. Charset for the database. + * This field can contain any PostgreSQL supported charset name. + * Example values include "UTF8", "SQL_ASCII", etc. + * + * Generated from protobuf field string charset = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $charset = ''; + /** + * Optional. Collation for the database. + * Name of the custom or native collation for postgres. + * Example values include "C", "POSIX", etc + * + * Generated from protobuf field string collation = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $collation = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. Name of the resource in the form of + * `projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}`. + * @type string $charset + * Optional. Charset for the database. + * This field can contain any PostgreSQL supported charset name. + * Example values include "UTF8", "SQL_ASCII", etc. + * @type string $collation + * Optional. Collation for the database. + * Name of the custom or native collation for postgres. + * Example values include "C", "POSIX", etc + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. Name of the resource in the form of + * `projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. Name of the resource in the form of + * `projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. Charset for the database. + * This field can contain any PostgreSQL supported charset name. + * Example values include "UTF8", "SQL_ASCII", etc. + * + * Generated from protobuf field string charset = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getCharset() + { + return $this->charset; + } + + /** + * Optional. Charset for the database. + * This field can contain any PostgreSQL supported charset name. + * Example values include "UTF8", "SQL_ASCII", etc. + * + * Generated from protobuf field string charset = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setCharset($var) + { + GPBUtil::checkString($var, True); + $this->charset = $var; + + return $this; + } + + /** + * Optional. Collation for the database. + * Name of the custom or native collation for postgres. + * Example values include "C", "POSIX", etc + * + * Generated from protobuf field string collation = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getCollation() + { + return $this->collation; + } + + /** + * Optional. Collation for the database. + * Name of the custom or native collation for postgres. + * Example values include "C", "POSIX", etc + * + * Generated from protobuf field string collation = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setCollation($var) + { + GPBUtil::checkString($var, True); + $this->collation = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/DatabaseVersion.php b/AlloyDb/src/V1/DatabaseVersion.php index 43b351f9d5d9..8bfebc860bb2 100644 --- a/AlloyDb/src/V1/DatabaseVersion.php +++ b/AlloyDb/src/V1/DatabaseVersion.php @@ -31,11 +31,25 @@ class DatabaseVersion * Generated from protobuf enum POSTGRES_14 = 2; */ const POSTGRES_14 = 2; + /** + * The database version is Postgres 15. + * + * Generated from protobuf enum POSTGRES_15 = 3; + */ + const POSTGRES_15 = 3; + /** + * The database version is Postgres 16. + * + * Generated from protobuf enum POSTGRES_16 = 4; + */ + const POSTGRES_16 = 4; private static $valueToName = [ self::DATABASE_VERSION_UNSPECIFIED => 'DATABASE_VERSION_UNSPECIFIED', self::POSTGRES_13 => 'POSTGRES_13', self::POSTGRES_14 => 'POSTGRES_14', + self::POSTGRES_15 => 'POSTGRES_15', + self::POSTGRES_16 => 'POSTGRES_16', ]; public static function name($value) diff --git a/AlloyDb/src/V1/DeleteBackupRequest.php b/AlloyDb/src/V1/DeleteBackupRequest.php index 8b9db4c24a07..7d9e222ccca8 100644 --- a/AlloyDb/src/V1/DeleteBackupRequest.php +++ b/AlloyDb/src/V1/DeleteBackupRequest.php @@ -24,13 +24,13 @@ class DeleteBackupRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -80,13 +80,13 @@ public static function build(string $name): self * the Backup.name field. * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -134,13 +134,13 @@ public function setName($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -155,13 +155,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/DeleteClusterRequest.php b/AlloyDb/src/V1/DeleteClusterRequest.php index 89e72f18c978..a0224fa99fca 100644 --- a/AlloyDb/src/V1/DeleteClusterRequest.php +++ b/AlloyDb/src/V1/DeleteClusterRequest.php @@ -24,13 +24,13 @@ class DeleteClusterRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -47,8 +47,9 @@ class DeleteClusterRequest extends \Google\Protobuf\Internal\Message */ protected $etag = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -86,13 +87,13 @@ public static function build(string $name): self * comment on the Cluster.name field. * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -101,8 +102,9 @@ public static function build(string $name): self * If an etag is provided and does not match the current etag of the Cluster, * deletion will be blocked and an ABORTED error will be returned. * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * @type bool $force * Optional. Whether to cascade delete child instances for given cluster. * } @@ -142,13 +144,13 @@ public function setName($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -163,13 +165,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -217,8 +219,9 @@ public function setEtag($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -229,8 +232,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/DeleteInstanceRequest.php b/AlloyDb/src/V1/DeleteInstanceRequest.php index 8e177fbb3777..6b04bdf45b51 100644 --- a/AlloyDb/src/V1/DeleteInstanceRequest.php +++ b/AlloyDb/src/V1/DeleteInstanceRequest.php @@ -24,13 +24,13 @@ class DeleteInstanceRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -47,8 +47,9 @@ class DeleteInstanceRequest extends \Google\Protobuf\Internal\Message */ protected $etag = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -80,13 +81,13 @@ public static function build(string $name): self * comment on the Instance.name field. * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -95,8 +96,9 @@ public static function build(string $name): self * If an etag is provided and does not match the current etag of the Instance, * deletion will be blocked and an ABORTED error will be returned. * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -134,13 +136,13 @@ public function setName($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -155,13 +157,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -209,8 +211,9 @@ public function setEtag($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -221,8 +224,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/DeleteUserRequest.php b/AlloyDb/src/V1/DeleteUserRequest.php index 05a7ca8e1900..92f7de7ab342 100644 --- a/AlloyDb/src/V1/DeleteUserRequest.php +++ b/AlloyDb/src/V1/DeleteUserRequest.php @@ -24,13 +24,13 @@ class DeleteUserRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -72,13 +72,13 @@ public static function build(string $name): self * comment on the User.name field. * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -122,13 +122,13 @@ public function setName($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -143,13 +143,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/ExecuteSqlMetadata.php b/AlloyDb/src/V1/ExecuteSqlMetadata.php new file mode 100644 index 000000000000..7b47cf87ca66 --- /dev/null +++ b/AlloyDb/src/V1/ExecuteSqlMetadata.php @@ -0,0 +1,195 @@ +google.cloud.alloydb.v1.ExecuteSqlMetadata + */ +class ExecuteSqlMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Message related to SQL execution. Marked as core content since it + * can potentially contain details related to the query or result set. This + * field can be used to convey messages such as "when the SQL result set + * exceeds the acceptable response size limits." + * + * Generated from protobuf field string message = 1; + */ + protected $message = ''; + /** + * Set to true if SQL returned a result set larger than the acceptable + * response size limits and the result was truncated. + * + * Generated from protobuf field bool partial_result = 2; + */ + protected $partial_result = false; + /** + * The time duration taken to execute the sql statement. + * + * Generated from protobuf field .google.protobuf.Duration sql_statement_execution_duration = 3; + */ + protected $sql_statement_execution_duration = null; + /** + * Status of SQL execution. + * + * Generated from protobuf field .google.cloud.alloydb.v1.ExecuteSqlMetadata.Status status = 4; + */ + protected $status = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $message + * Message related to SQL execution. Marked as core content since it + * can potentially contain details related to the query or result set. This + * field can be used to convey messages such as "when the SQL result set + * exceeds the acceptable response size limits." + * @type bool $partial_result + * Set to true if SQL returned a result set larger than the acceptable + * response size limits and the result was truncated. + * @type \Google\Protobuf\Duration $sql_statement_execution_duration + * The time duration taken to execute the sql statement. + * @type int $status + * Status of SQL execution. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Service::initOnce(); + parent::__construct($data); + } + + /** + * Message related to SQL execution. Marked as core content since it + * can potentially contain details related to the query or result set. This + * field can be used to convey messages such as "when the SQL result set + * exceeds the acceptable response size limits." + * + * Generated from protobuf field string message = 1; + * @return string + */ + public function getMessage() + { + return $this->message; + } + + /** + * Message related to SQL execution. Marked as core content since it + * can potentially contain details related to the query or result set. This + * field can be used to convey messages such as "when the SQL result set + * exceeds the acceptable response size limits." + * + * Generated from protobuf field string message = 1; + * @param string $var + * @return $this + */ + public function setMessage($var) + { + GPBUtil::checkString($var, True); + $this->message = $var; + + return $this; + } + + /** + * Set to true if SQL returned a result set larger than the acceptable + * response size limits and the result was truncated. + * + * Generated from protobuf field bool partial_result = 2; + * @return bool + */ + public function getPartialResult() + { + return $this->partial_result; + } + + /** + * Set to true if SQL returned a result set larger than the acceptable + * response size limits and the result was truncated. + * + * Generated from protobuf field bool partial_result = 2; + * @param bool $var + * @return $this + */ + public function setPartialResult($var) + { + GPBUtil::checkBool($var); + $this->partial_result = $var; + + return $this; + } + + /** + * The time duration taken to execute the sql statement. + * + * Generated from protobuf field .google.protobuf.Duration sql_statement_execution_duration = 3; + * @return \Google\Protobuf\Duration|null + */ + public function getSqlStatementExecutionDuration() + { + return $this->sql_statement_execution_duration; + } + + public function hasSqlStatementExecutionDuration() + { + return isset($this->sql_statement_execution_duration); + } + + public function clearSqlStatementExecutionDuration() + { + unset($this->sql_statement_execution_duration); + } + + /** + * The time duration taken to execute the sql statement. + * + * Generated from protobuf field .google.protobuf.Duration sql_statement_execution_duration = 3; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setSqlStatementExecutionDuration($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->sql_statement_execution_duration = $var; + + return $this; + } + + /** + * Status of SQL execution. + * + * Generated from protobuf field .google.cloud.alloydb.v1.ExecuteSqlMetadata.Status status = 4; + * @return int + */ + public function getStatus() + { + return $this->status; + } + + /** + * Status of SQL execution. + * + * Generated from protobuf field .google.cloud.alloydb.v1.ExecuteSqlMetadata.Status status = 4; + * @param int $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\AlloyDb\V1\ExecuteSqlMetadata\Status::class); + $this->status = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/ExecuteSqlMetadata/Status.php b/AlloyDb/src/V1/ExecuteSqlMetadata/Status.php new file mode 100644 index 000000000000..ba62ca093038 --- /dev/null +++ b/AlloyDb/src/V1/ExecuteSqlMetadata/Status.php @@ -0,0 +1,77 @@ +google.cloud.alloydb.v1.ExecuteSqlMetadata.Status + */ +class Status +{ + /** + * The status is unknown. + * + * Generated from protobuf enum STATUS_UNSPECIFIED = 0; + */ + const STATUS_UNSPECIFIED = 0; + /** + * No error during SQL execution i.e. All SQL statements ran to completion. + * The "message" will be empty. + * + * Generated from protobuf enum OK = 1; + */ + const OK = 1; + /** + * Same as OK, except indicates that only partial results were + * returned. The "message" field will contain details on why results were + * truncated. + * + * Generated from protobuf enum PARTIAL = 2; + */ + const PARTIAL = 2; + /** + * Error during SQL execution. Atleast 1 SQL statement execution resulted in + * a error. Side effects of other statements are rolled back. The "message" + * field will contain human readable error given by Postgres of the first + * bad SQL statement. SQL execution errors don't constitute API errors as + * defined in https://google.aip.dev/193 but will be returned as part of + * this message. + * + * Generated from protobuf enum ERROR = 3; + */ + const ERROR = 3; + + private static $valueToName = [ + self::STATUS_UNSPECIFIED => 'STATUS_UNSPECIFIED', + self::OK => 'OK', + self::PARTIAL => 'PARTIAL', + self::ERROR => 'ERROR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AlloyDb/src/V1/ExecuteSqlRequest.php b/AlloyDb/src/V1/ExecuteSqlRequest.php new file mode 100644 index 000000000000..55f92039e662 --- /dev/null +++ b/AlloyDb/src/V1/ExecuteSqlRequest.php @@ -0,0 +1,263 @@ +google.cloud.alloydb.v1.ExecuteSqlRequest + */ +class ExecuteSqlRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The instance where the SQL will be executed. For the required + * format, see the comment on the Instance.name field. + * + * Generated from protobuf field string instance = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $instance = ''; + /** + * Required. Name of the database where the query will be executed. + * Note - Value provided should be the same as expected from `SELECT + * current_database();` and NOT as a resource reference. + * + * Generated from protobuf field string database = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $database = ''; + /** + * Required. Database user to be used for executing the SQL. + * Note - Value provided should be the same as expected from + * `SELECT current_user;` and NOT as a resource reference. + * + * Generated from protobuf field string user = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $user = ''; + /** + * Required. SQL statement to execute on database. Any valid statement is + * permitted, including DDL, DML, DQL statements. + * + * Generated from protobuf field string sql_statement = 4 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $sql_statement = ''; + protected $user_credential; + + /** + * @param string $instance Required. The instance where the SQL will be executed. For the required + * format, see the comment on the Instance.name field. Please see + * {@see AlloyDBAdminClient::instanceName()} for help formatting this field. + * @param string $database Required. Name of the database where the query will be executed. + * Note - Value provided should be the same as expected from `SELECT + * current_database();` and NOT as a resource reference. + * @param string $user Required. Database user to be used for executing the SQL. + * Note - Value provided should be the same as expected from + * `SELECT current_user;` and NOT as a resource reference. + * @param string $sqlStatement Required. SQL statement to execute on database. Any valid statement is + * permitted, including DDL, DML, DQL statements. + * @param string $password Optional. The database native user’s password. + * + * @return \Google\Cloud\AlloyDb\V1\ExecuteSqlRequest + * + * @experimental + */ + public static function build(string $instance, string $database, string $user, string $sqlStatement, string $password): self + { + return (new self()) + ->setInstance($instance) + ->setDatabase($database) + ->setUser($user) + ->setSqlStatement($sqlStatement) + ->setPassword($password); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $password + * Optional. The database native user’s password. + * @type string $instance + * Required. The instance where the SQL will be executed. For the required + * format, see the comment on the Instance.name field. + * @type string $database + * Required. Name of the database where the query will be executed. + * Note - Value provided should be the same as expected from `SELECT + * current_database();` and NOT as a resource reference. + * @type string $user + * Required. Database user to be used for executing the SQL. + * Note - Value provided should be the same as expected from + * `SELECT current_user;` and NOT as a resource reference. + * @type string $sql_statement + * Required. SQL statement to execute on database. Any valid statement is + * permitted, including DDL, DML, DQL statements. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Service::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The database native user’s password. + * + * Generated from protobuf field string password = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPassword() + { + return $this->readOneof(5); + } + + public function hasPassword() + { + return $this->hasOneof(5); + } + + /** + * Optional. The database native user’s password. + * + * Generated from protobuf field string password = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPassword($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * Required. The instance where the SQL will be executed. For the required + * format, see the comment on the Instance.name field. + * + * Generated from protobuf field string instance = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getInstance() + { + return $this->instance; + } + + /** + * Required. The instance where the SQL will be executed. For the required + * format, see the comment on the Instance.name field. + * + * Generated from protobuf field string instance = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setInstance($var) + { + GPBUtil::checkString($var, True); + $this->instance = $var; + + return $this; + } + + /** + * Required. Name of the database where the query will be executed. + * Note - Value provided should be the same as expected from `SELECT + * current_database();` and NOT as a resource reference. + * + * Generated from protobuf field string database = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDatabase() + { + return $this->database; + } + + /** + * Required. Name of the database where the query will be executed. + * Note - Value provided should be the same as expected from `SELECT + * current_database();` and NOT as a resource reference. + * + * Generated from protobuf field string database = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDatabase($var) + { + GPBUtil::checkString($var, True); + $this->database = $var; + + return $this; + } + + /** + * Required. Database user to be used for executing the SQL. + * Note - Value provided should be the same as expected from + * `SELECT current_user;` and NOT as a resource reference. + * + * Generated from protobuf field string user = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getUser() + { + return $this->user; + } + + /** + * Required. Database user to be used for executing the SQL. + * Note - Value provided should be the same as expected from + * `SELECT current_user;` and NOT as a resource reference. + * + * Generated from protobuf field string user = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setUser($var) + { + GPBUtil::checkString($var, True); + $this->user = $var; + + return $this; + } + + /** + * Required. SQL statement to execute on database. Any valid statement is + * permitted, including DDL, DML, DQL statements. + * + * Generated from protobuf field string sql_statement = 4 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getSqlStatement() + { + return $this->sql_statement; + } + + /** + * Required. SQL statement to execute on database. Any valid statement is + * permitted, including DDL, DML, DQL statements. + * + * Generated from protobuf field string sql_statement = 4 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setSqlStatement($var) + { + GPBUtil::checkString($var, True); + $this->sql_statement = $var; + + return $this; + } + + /** + * @return string + */ + public function getUserCredential() + { + return $this->whichOneof("user_credential"); + } + +} + diff --git a/AlloyDb/src/V1/ExecuteSqlResponse.php b/AlloyDb/src/V1/ExecuteSqlResponse.php new file mode 100644 index 000000000000..3e192ce9f60f --- /dev/null +++ b/AlloyDb/src/V1/ExecuteSqlResponse.php @@ -0,0 +1,115 @@ +google.cloud.alloydb.v1.ExecuteSqlResponse + */ +class ExecuteSqlResponse extends \Google\Protobuf\Internal\Message +{ + /** + * SqlResult represents the results for the execution of sql statements. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResult sql_results = 1; + */ + private $sql_results; + /** + * Any additional metadata information regarding the execution of the sql + * statement. + * + * Generated from protobuf field .google.cloud.alloydb.v1.ExecuteSqlMetadata metadata = 3; + */ + protected $metadata = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\AlloyDb\V1\SqlResult>|\Google\Protobuf\Internal\RepeatedField $sql_results + * SqlResult represents the results for the execution of sql statements. + * @type \Google\Cloud\AlloyDb\V1\ExecuteSqlMetadata $metadata + * Any additional metadata information regarding the execution of the sql + * statement. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Service::initOnce(); + parent::__construct($data); + } + + /** + * SqlResult represents the results for the execution of sql statements. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResult sql_results = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSqlResults() + { + return $this->sql_results; + } + + /** + * SqlResult represents the results for the execution of sql statements. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResult sql_results = 1; + * @param array<\Google\Cloud\AlloyDb\V1\SqlResult>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSqlResults($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AlloyDb\V1\SqlResult::class); + $this->sql_results = $arr; + + return $this; + } + + /** + * Any additional metadata information regarding the execution of the sql + * statement. + * + * Generated from protobuf field .google.cloud.alloydb.v1.ExecuteSqlMetadata metadata = 3; + * @return \Google\Cloud\AlloyDb\V1\ExecuteSqlMetadata|null + */ + public function getMetadata() + { + return $this->metadata; + } + + public function hasMetadata() + { + return isset($this->metadata); + } + + public function clearMetadata() + { + unset($this->metadata); + } + + /** + * Any additional metadata information regarding the execution of the sql + * statement. + * + * Generated from protobuf field .google.cloud.alloydb.v1.ExecuteSqlMetadata metadata = 3; + * @param \Google\Cloud\AlloyDb\V1\ExecuteSqlMetadata $var + * @return $this + */ + public function setMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\ExecuteSqlMetadata::class); + $this->metadata = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/FailoverInstanceRequest.php b/AlloyDb/src/V1/FailoverInstanceRequest.php index 385f6cee2600..8aa80e2d0244 100644 --- a/AlloyDb/src/V1/FailoverInstanceRequest.php +++ b/AlloyDb/src/V1/FailoverInstanceRequest.php @@ -24,13 +24,13 @@ class FailoverInstanceRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -39,8 +39,9 @@ class FailoverInstanceRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the failover. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -72,19 +73,20 @@ public static function build(string $name): self * comment on the Instance.name field. * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the failover. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -122,13 +124,13 @@ public function setName($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -143,13 +145,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -167,8 +169,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the failover. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -179,8 +182,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the failover. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/GenerateClientCertificateRequest.php b/AlloyDb/src/V1/GenerateClientCertificateRequest.php index a66f9ccd2a1a..2b1570826e21 100644 --- a/AlloyDb/src/V1/GenerateClientCertificateRequest.php +++ b/AlloyDb/src/V1/GenerateClientCertificateRequest.php @@ -25,13 +25,13 @@ class GenerateClientCertificateRequest extends \Google\Protobuf\Internal\Message protected $parent = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -90,13 +90,13 @@ public static function build(string $parent): self * * projects/{project}/locations/{location}/clusters/{cluster} * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -149,13 +149,13 @@ public function setParent($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -170,13 +170,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/GetConnectionInfoRequest.php b/AlloyDb/src/V1/GetConnectionInfoRequest.php index e62b821f8334..20b558bedf58 100644 --- a/AlloyDb/src/V1/GetConnectionInfoRequest.php +++ b/AlloyDb/src/V1/GetConnectionInfoRequest.php @@ -24,13 +24,13 @@ class GetConnectionInfoRequest extends \Google\Protobuf\Internal\Message protected $parent = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -65,13 +65,13 @@ public static function build(string $parent): self * projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance} * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -112,13 +112,13 @@ public function setParent($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -133,13 +133,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/InjectFaultRequest.php b/AlloyDb/src/V1/InjectFaultRequest.php index 223a6851d23d..49bb9a450557 100644 --- a/AlloyDb/src/V1/InjectFaultRequest.php +++ b/AlloyDb/src/V1/InjectFaultRequest.php @@ -30,13 +30,13 @@ class InjectFaultRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -45,9 +45,9 @@ class InjectFaultRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the fault - * injection. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -84,20 +84,20 @@ public static function build(int $faultType, string $name): self * comment on the Instance.name field. * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the fault - * injection. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -161,13 +161,13 @@ public function setName($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -182,13 +182,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -206,9 +206,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the fault - * injection. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -219,9 +219,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the fault - * injection. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/Instance.php b/AlloyDb/src/V1/Instance.php index 8a5e4930c841..85eeb7dbcba6 100644 --- a/AlloyDb/src/V1/Instance.php +++ b/AlloyDb/src/V1/Instance.php @@ -159,6 +159,14 @@ class Instance extends \Google\Protobuf\Internal\Message * Generated from protobuf field string ip_address = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $ip_address = ''; + /** + * Output only. The public IP addresses for the Instance. This is available + * ONLY when enable_public_ip is set. This is the connection endpoint for an + * end-user application. + * + * Generated from protobuf field string public_ip_address = 27 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + */ + protected $public_ip_address = ''; /** * Output only. Reconciling (https://google.aip.dev/128#reconciliation). * Set to true if the current state of Instance does not match the user's @@ -189,6 +197,31 @@ class Instance extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.alloydb.v1.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL]; */ protected $client_connection_config = null; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $satisfies_pzs = false; + /** + * Optional. The configuration for Private Service Connect (PSC) for the + * instance. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Instance.PscInstanceConfig psc_instance_config = 28 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $psc_instance_config = null; + /** + * Optional. Instance-level network configuration. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $network_config = null; + /** + * Output only. All outbound public IP addresses configured for the instance. + * + * Generated from protobuf field repeated string outbound_public_ip_addresses = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + */ + private $outbound_public_ip_addresses; /** * Constructor. @@ -267,6 +300,10 @@ class Instance extends \Google\Protobuf\Internal\Message * @type string $ip_address * Output only. The IP address for the Instance. * This is the connection endpoint for an end-user application. + * @type string $public_ip_address + * Output only. The public IP addresses for the Instance. This is available + * ONLY when enable_public_ip is set. This is the connection endpoint for an + * end-user application. * @type bool $reconciling * Output only. Reconciling (https://google.aip.dev/128#reconciliation). * Set to true if the current state of Instance does not match the user's @@ -281,6 +318,15 @@ class Instance extends \Google\Protobuf\Internal\Message * https://google.aip.dev/128 * @type \Google\Cloud\AlloyDb\V1\Instance\ClientConnectionConfig $client_connection_config * Optional. Client connection specific configurations + * @type bool $satisfies_pzs + * Output only. Reserved for future use. + * @type \Google\Cloud\AlloyDb\V1\Instance\PscInstanceConfig $psc_instance_config + * Optional. The configuration for Private Service Connect (PSC) for the + * instance. + * @type \Google\Cloud\AlloyDb\V1\Instance\InstanceNetworkConfig $network_config + * Optional. Instance-level network configuration. + * @type array|\Google\Protobuf\Internal\RepeatedField $outbound_public_ip_addresses + * Output only. All outbound public IP addresses configured for the instance. * } */ public function __construct($data = NULL) { @@ -896,6 +942,36 @@ public function setIpAddress($var) return $this; } + /** + * Output only. The public IP addresses for the Instance. This is available + * ONLY when enable_public_ip is set. This is the connection endpoint for an + * end-user application. + * + * Generated from protobuf field string public_ip_address = 27 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @return string + */ + public function getPublicIpAddress() + { + return $this->public_ip_address; + } + + /** + * Output only. The public IP addresses for the Instance. This is available + * ONLY when enable_public_ip is set. This is the connection endpoint for an + * end-user application. + * + * Generated from protobuf field string public_ip_address = 27 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setPublicIpAddress($var) + { + GPBUtil::checkString($var, True); + $this->public_ip_address = $var; + + return $this; + } + /** * Output only. Reconciling (https://google.aip.dev/128#reconciliation). * Set to true if the current state of Instance does not match the user's @@ -1022,5 +1098,131 @@ public function setClientConnectionConfig($var) return $this; } + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzs() + { + return $this->satisfies_pzs; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + + /** + * Optional. The configuration for Private Service Connect (PSC) for the + * instance. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Instance.PscInstanceConfig psc_instance_config = 28 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\AlloyDb\V1\Instance\PscInstanceConfig|null + */ + public function getPscInstanceConfig() + { + return $this->psc_instance_config; + } + + public function hasPscInstanceConfig() + { + return isset($this->psc_instance_config); + } + + public function clearPscInstanceConfig() + { + unset($this->psc_instance_config); + } + + /** + * Optional. The configuration for Private Service Connect (PSC) for the + * instance. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Instance.PscInstanceConfig psc_instance_config = 28 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\AlloyDb\V1\Instance\PscInstanceConfig $var + * @return $this + */ + public function setPscInstanceConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\Instance\PscInstanceConfig::class); + $this->psc_instance_config = $var; + + return $this; + } + + /** + * Optional. Instance-level network configuration. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\AlloyDb\V1\Instance\InstanceNetworkConfig|null + */ + public function getNetworkConfig() + { + return $this->network_config; + } + + public function hasNetworkConfig() + { + return isset($this->network_config); + } + + public function clearNetworkConfig() + { + unset($this->network_config); + } + + /** + * Optional. Instance-level network configuration. + * + * Generated from protobuf field .google.cloud.alloydb.v1.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\AlloyDb\V1\Instance\InstanceNetworkConfig $var + * @return $this + */ + public function setNetworkConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AlloyDb\V1\Instance\InstanceNetworkConfig::class); + $this->network_config = $var; + + return $this; + } + + /** + * Output only. All outbound public IP addresses configured for the instance. + * + * Generated from protobuf field repeated string outbound_public_ip_addresses = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getOutboundPublicIpAddresses() + { + return $this->outbound_public_ip_addresses; + } + + /** + * Output only. All outbound public IP addresses configured for the instance. + * + * Generated from protobuf field repeated string outbound_public_ip_addresses = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setOutboundPublicIpAddresses($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->outbound_public_ip_addresses = $arr; + + return $this; + } + } diff --git a/AlloyDb/src/V1/Instance/ClientConnectionConfig.php b/AlloyDb/src/V1/Instance/ClientConnectionConfig.php index d4bf05943e8e..c7e245923cf7 100644 --- a/AlloyDb/src/V1/Instance/ClientConnectionConfig.php +++ b/AlloyDb/src/V1/Instance/ClientConnectionConfig.php @@ -23,7 +23,7 @@ class ClientConnectionConfig extends \Google\Protobuf\Internal\Message */ protected $require_connectors = false; /** - * Optional. SSL config option for this instance. + * Optional. SSL configuration option for this instance. * * Generated from protobuf field .google.cloud.alloydb.v1.SslConfig ssl_config = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -39,7 +39,7 @@ class ClientConnectionConfig extends \Google\Protobuf\Internal\Message * Optional. Configuration to enforce connectors only (ex: AuthProxy) * connections to the database. * @type \Google\Cloud\AlloyDb\V1\SslConfig $ssl_config - * Optional. SSL config option for this instance. + * Optional. SSL configuration option for this instance. * } */ public function __construct($data = NULL) { @@ -76,7 +76,7 @@ public function setRequireConnectors($var) } /** - * Optional. SSL config option for this instance. + * Optional. SSL configuration option for this instance. * * Generated from protobuf field .google.cloud.alloydb.v1.SslConfig ssl_config = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\AlloyDb\V1\SslConfig|null @@ -97,7 +97,7 @@ public function clearSslConfig() } /** - * Optional. SSL config option for this instance. + * Optional. SSL configuration option for this instance. * * Generated from protobuf field .google.cloud.alloydb.v1.SslConfig ssl_config = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\AlloyDb\V1\SslConfig $var diff --git a/AlloyDb/src/V1/Instance/InstanceNetworkConfig.php b/AlloyDb/src/V1/Instance/InstanceNetworkConfig.php new file mode 100644 index 000000000000..b6cb205089a9 --- /dev/null +++ b/AlloyDb/src/V1/Instance/InstanceNetworkConfig.php @@ -0,0 +1,140 @@ +google.cloud.alloydb.v1.Instance.InstanceNetworkConfig + */ +class InstanceNetworkConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. A list of external network authorized to access this instance. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.Instance.InstanceNetworkConfig.AuthorizedNetwork authorized_external_networks = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $authorized_external_networks; + /** + * Optional. Enabling public ip for the instance. + * + * Generated from protobuf field bool enable_public_ip = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_public_ip = false; + /** + * Optional. Enabling an outbound public IP address to support a database + * server sending requests out into the internet. + * + * Generated from protobuf field bool enable_outbound_public_ip = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enable_outbound_public_ip = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\AlloyDb\V1\Instance\InstanceNetworkConfig\AuthorizedNetwork>|\Google\Protobuf\Internal\RepeatedField $authorized_external_networks + * Optional. A list of external network authorized to access this instance. + * @type bool $enable_public_ip + * Optional. Enabling public ip for the instance. + * @type bool $enable_outbound_public_ip + * Optional. Enabling an outbound public IP address to support a database + * server sending requests out into the internet. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Optional. A list of external network authorized to access this instance. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.Instance.InstanceNetworkConfig.AuthorizedNetwork authorized_external_networks = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAuthorizedExternalNetworks() + { + return $this->authorized_external_networks; + } + + /** + * Optional. A list of external network authorized to access this instance. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.Instance.InstanceNetworkConfig.AuthorizedNetwork authorized_external_networks = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\AlloyDb\V1\Instance\InstanceNetworkConfig\AuthorizedNetwork>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAuthorizedExternalNetworks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AlloyDb\V1\Instance\InstanceNetworkConfig\AuthorizedNetwork::class); + $this->authorized_external_networks = $arr; + + return $this; + } + + /** + * Optional. Enabling public ip for the instance. + * + * Generated from protobuf field bool enable_public_ip = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnablePublicIp() + { + return $this->enable_public_ip; + } + + /** + * Optional. Enabling public ip for the instance. + * + * Generated from protobuf field bool enable_public_ip = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnablePublicIp($var) + { + GPBUtil::checkBool($var); + $this->enable_public_ip = $var; + + return $this; + } + + /** + * Optional. Enabling an outbound public IP address to support a database + * server sending requests out into the internet. + * + * Generated from protobuf field bool enable_outbound_public_ip = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getEnableOutboundPublicIp() + { + return $this->enable_outbound_public_ip; + } + + /** + * Optional. Enabling an outbound public IP address to support a database + * server sending requests out into the internet. + * + * Generated from protobuf field bool enable_outbound_public_ip = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setEnableOutboundPublicIp($var) + { + GPBUtil::checkBool($var); + $this->enable_outbound_public_ip = $var; + + return $this; + } + +} + + diff --git a/AlloyDb/src/V1/Instance/InstanceNetworkConfig/AuthorizedNetwork.php b/AlloyDb/src/V1/Instance/InstanceNetworkConfig/AuthorizedNetwork.php new file mode 100644 index 000000000000..6b50658955b3 --- /dev/null +++ b/AlloyDb/src/V1/Instance/InstanceNetworkConfig/AuthorizedNetwork.php @@ -0,0 +1,68 @@ +google.cloud.alloydb.v1.Instance.InstanceNetworkConfig.AuthorizedNetwork + */ +class AuthorizedNetwork extends \Google\Protobuf\Internal\Message +{ + /** + * CIDR range for one authorzied network of the instance. + * + * Generated from protobuf field string cidr_range = 1 [(.google.api.field_info) = { + */ + protected $cidr_range = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $cidr_range + * CIDR range for one authorzied network of the instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * CIDR range for one authorzied network of the instance. + * + * Generated from protobuf field string cidr_range = 1 [(.google.api.field_info) = { + * @return string + */ + public function getCidrRange() + { + return $this->cidr_range; + } + + /** + * CIDR range for one authorzied network of the instance. + * + * Generated from protobuf field string cidr_range = 1 [(.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setCidrRange($var) + { + GPBUtil::checkString($var, True); + $this->cidr_range = $var; + + return $this; + } + +} + + diff --git a/AlloyDb/src/V1/Instance/PscInstanceConfig.php b/AlloyDb/src/V1/Instance/PscInstanceConfig.php new file mode 100644 index 000000000000..f2a5c2b4a257 --- /dev/null +++ b/AlloyDb/src/V1/Instance/PscInstanceConfig.php @@ -0,0 +1,157 @@ +google.cloud.alloydb.v1.Instance.PscInstanceConfig + */ +class PscInstanceConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The service attachment created when Private + * Service Connect (PSC) is enabled for the instance. + * The name of the resource will be in the format of + * `projects//regions//serviceAttachments/` + * + * Generated from protobuf field string service_attachment_link = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $service_attachment_link = ''; + /** + * Optional. List of consumer projects that are allowed to create + * PSC endpoints to service-attachments to this instance. + * + * Generated from protobuf field repeated string allowed_consumer_projects = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $allowed_consumer_projects; + /** + * Output only. The DNS name of the instance for PSC connectivity. + * Name convention: ...alloydb-psc.goog + * + * Generated from protobuf field string psc_dns_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $psc_dns_name = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $service_attachment_link + * Output only. The service attachment created when Private + * Service Connect (PSC) is enabled for the instance. + * The name of the resource will be in the format of + * `projects//regions//serviceAttachments/` + * @type array|\Google\Protobuf\Internal\RepeatedField $allowed_consumer_projects + * Optional. List of consumer projects that are allowed to create + * PSC endpoints to service-attachments to this instance. + * @type string $psc_dns_name + * Output only. The DNS name of the instance for PSC connectivity. + * Name convention: ...alloydb-psc.goog + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The service attachment created when Private + * Service Connect (PSC) is enabled for the instance. + * The name of the resource will be in the format of + * `projects//regions//serviceAttachments/` + * + * Generated from protobuf field string service_attachment_link = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getServiceAttachmentLink() + { + return $this->service_attachment_link; + } + + /** + * Output only. The service attachment created when Private + * Service Connect (PSC) is enabled for the instance. + * The name of the resource will be in the format of + * `projects//regions//serviceAttachments/` + * + * Generated from protobuf field string service_attachment_link = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setServiceAttachmentLink($var) + { + GPBUtil::checkString($var, True); + $this->service_attachment_link = $var; + + return $this; + } + + /** + * Optional. List of consumer projects that are allowed to create + * PSC endpoints to service-attachments to this instance. + * + * Generated from protobuf field repeated string allowed_consumer_projects = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAllowedConsumerProjects() + { + return $this->allowed_consumer_projects; + } + + /** + * Optional. List of consumer projects that are allowed to create + * PSC endpoints to service-attachments to this instance. + * + * Generated from protobuf field repeated string allowed_consumer_projects = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAllowedConsumerProjects($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->allowed_consumer_projects = $arr; + + return $this; + } + + /** + * Output only. The DNS name of the instance for PSC connectivity. + * Name convention: ...alloydb-psc.goog + * + * Generated from protobuf field string psc_dns_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getPscDnsName() + { + return $this->psc_dns_name; + } + + /** + * Output only. The DNS name of the instance for PSC connectivity. + * Name convention: ...alloydb-psc.goog + * + * Generated from protobuf field string psc_dns_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setPscDnsName($var) + { + GPBUtil::checkString($var, True); + $this->psc_dns_name = $var; + + return $this; + } + +} + + diff --git a/AlloyDb/src/V1/ListDatabasesRequest.php b/AlloyDb/src/V1/ListDatabasesRequest.php new file mode 100644 index 000000000000..d94d59530e6a --- /dev/null +++ b/AlloyDb/src/V1/ListDatabasesRequest.php @@ -0,0 +1,207 @@ +google.cloud.alloydb.v1.ListDatabasesRequest + */ +class ListDatabasesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Parent value for ListDatabasesRequest. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of databases to return. The service may return + * fewer than this value. If unspecified, 2000 is the default page_size. The + * max value of page_size will be 4000, values above max will be coerced to + * max. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListDatabases` call. + * This should be provided to retrieve the subsequent page. + * This field is currently not supported, its value will be ignored if passed. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Filtering results. + * This field is currently not supported, its value will be ignored if passed. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + + /** + * @param string $parent Required. Parent value for ListDatabasesRequest. Please see + * {@see AlloyDBAdminClient::clusterName()} for help formatting this field. + * + * @return \Google\Cloud\AlloyDb\V1\ListDatabasesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. Parent value for ListDatabasesRequest. + * @type int $page_size + * Optional. The maximum number of databases to return. The service may return + * fewer than this value. If unspecified, 2000 is the default page_size. The + * max value of page_size will be 4000, values above max will be coerced to + * max. + * @type string $page_token + * Optional. A page token, received from a previous `ListDatabases` call. + * This should be provided to retrieve the subsequent page. + * This field is currently not supported, its value will be ignored if passed. + * @type string $filter + * Optional. Filtering results. + * This field is currently not supported, its value will be ignored if passed. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Service::initOnce(); + parent::__construct($data); + } + + /** + * Required. Parent value for ListDatabasesRequest. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. Parent value for ListDatabasesRequest. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of databases to return. The service may return + * fewer than this value. If unspecified, 2000 is the default page_size. The + * max value of page_size will be 4000, values above max will be coerced to + * max. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of databases to return. The service may return + * fewer than this value. If unspecified, 2000 is the default page_size. The + * max value of page_size will be 4000, values above max will be coerced to + * max. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListDatabases` call. + * This should be provided to retrieve the subsequent page. + * This field is currently not supported, its value will be ignored if passed. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListDatabases` call. + * This should be provided to retrieve the subsequent page. + * This field is currently not supported, its value will be ignored if passed. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Filtering results. + * This field is currently not supported, its value will be ignored if passed. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filtering results. + * This field is currently not supported, its value will be ignored if passed. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/ListDatabasesResponse.php b/AlloyDb/src/V1/ListDatabasesResponse.php new file mode 100644 index 000000000000..782f84025b54 --- /dev/null +++ b/AlloyDb/src/V1/ListDatabasesResponse.php @@ -0,0 +1,105 @@ +google.cloud.alloydb.v1.ListDatabasesResponse + */ +class ListDatabasesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of databases + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.Database databases = 1; + */ + private $databases; + /** + * A token identifying the next page of results the server should return. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\AlloyDb\V1\Database>|\Google\Protobuf\Internal\RepeatedField $databases + * The list of databases + * @type string $next_page_token + * A token identifying the next page of results the server should return. + * If this field is omitted, there are no subsequent pages. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Service::initOnce(); + parent::__construct($data); + } + + /** + * The list of databases + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.Database databases = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDatabases() + { + return $this->databases; + } + + /** + * The list of databases + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.Database databases = 1; + * @param array<\Google\Cloud\AlloyDb\V1\Database>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDatabases($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AlloyDb\V1\Database::class); + $this->databases = $arr; + + return $this; + } + + /** + * A token identifying the next page of results the server should return. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token identifying the next page of results the server should return. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/MaintenanceSchedule.php b/AlloyDb/src/V1/MaintenanceSchedule.php new file mode 100644 index 000000000000..ddb853c704c1 --- /dev/null +++ b/AlloyDb/src/V1/MaintenanceSchedule.php @@ -0,0 +1,81 @@ +google.cloud.alloydb.v1.MaintenanceSchedule + */ +class MaintenanceSchedule extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The scheduled start time for the maintenance. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $start_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Timestamp $start_time + * Output only. The scheduled start time for the maintenance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The scheduled start time for the maintenance. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getStartTime() + { + return $this->start_time; + } + + public function hasStartTime() + { + return isset($this->start_time); + } + + public function clearStartTime() + { + unset($this->start_time); + } + + /** + * Output only. The scheduled start time for the maintenance. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setStartTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->start_time = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/MaintenanceUpdatePolicy.php b/AlloyDb/src/V1/MaintenanceUpdatePolicy.php new file mode 100644 index 000000000000..d606702528c3 --- /dev/null +++ b/AlloyDb/src/V1/MaintenanceUpdatePolicy.php @@ -0,0 +1,67 @@ +google.cloud.alloydb.v1.MaintenanceUpdatePolicy + */ +class MaintenanceUpdatePolicy extends \Google\Protobuf\Internal\Message +{ + /** + * Preferred windows to perform maintenance. Currently limited to 1. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.MaintenanceUpdatePolicy.MaintenanceWindow maintenance_windows = 1; + */ + private $maintenance_windows; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy\MaintenanceWindow>|\Google\Protobuf\Internal\RepeatedField $maintenance_windows + * Preferred windows to perform maintenance. Currently limited to 1. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Preferred windows to perform maintenance. Currently limited to 1. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.MaintenanceUpdatePolicy.MaintenanceWindow maintenance_windows = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMaintenanceWindows() + { + return $this->maintenance_windows; + } + + /** + * Preferred windows to perform maintenance. Currently limited to 1. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.MaintenanceUpdatePolicy.MaintenanceWindow maintenance_windows = 1; + * @param array<\Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy\MaintenanceWindow>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMaintenanceWindows($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy\MaintenanceWindow::class); + $this->maintenance_windows = $arr; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/MaintenanceUpdatePolicy/MaintenanceWindow.php b/AlloyDb/src/V1/MaintenanceUpdatePolicy/MaintenanceWindow.php new file mode 100644 index 000000000000..203857d59a8b --- /dev/null +++ b/AlloyDb/src/V1/MaintenanceUpdatePolicy/MaintenanceWindow.php @@ -0,0 +1,116 @@ +google.cloud.alloydb.v1.MaintenanceUpdatePolicy.MaintenanceWindow + */ +class MaintenanceWindow extends \Google\Protobuf\Internal\Message +{ + /** + * Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + * + * Generated from protobuf field .google.type.DayOfWeek day = 1; + */ + protected $day = 0; + /** + * Preferred time to start the maintenance operation on the specified day. + * Maintenance will start within 1 hour of this time. + * + * Generated from protobuf field .google.type.TimeOfDay start_time = 2; + */ + protected $start_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $day + * Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + * @type \Google\Type\TimeOfDay $start_time + * Preferred time to start the maintenance operation on the specified day. + * Maintenance will start within 1 hour of this time. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Resources::initOnce(); + parent::__construct($data); + } + + /** + * Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + * + * Generated from protobuf field .google.type.DayOfWeek day = 1; + * @return int + */ + public function getDay() + { + return $this->day; + } + + /** + * Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + * + * Generated from protobuf field .google.type.DayOfWeek day = 1; + * @param int $var + * @return $this + */ + public function setDay($var) + { + GPBUtil::checkEnum($var, \Google\Type\DayOfWeek::class); + $this->day = $var; + + return $this; + } + + /** + * Preferred time to start the maintenance operation on the specified day. + * Maintenance will start within 1 hour of this time. + * + * Generated from protobuf field .google.type.TimeOfDay start_time = 2; + * @return \Google\Type\TimeOfDay|null + */ + public function getStartTime() + { + return $this->start_time; + } + + public function hasStartTime() + { + return isset($this->start_time); + } + + public function clearStartTime() + { + unset($this->start_time); + } + + /** + * Preferred time to start the maintenance operation on the specified day. + * Maintenance will start within 1 hour of this time. + * + * Generated from protobuf field .google.type.TimeOfDay start_time = 2; + * @param \Google\Type\TimeOfDay $var + * @return $this + */ + public function setStartTime($var) + { + GPBUtil::checkMessage($var, \Google\Type\TimeOfDay::class); + $this->start_time = $var; + + return $this; + } + +} + + diff --git a/AlloyDb/src/V1/PromoteClusterRequest.php b/AlloyDb/src/V1/PromoteClusterRequest.php index 94a00b7fb9d8..688fae81ebc5 100644 --- a/AlloyDb/src/V1/PromoteClusterRequest.php +++ b/AlloyDb/src/V1/PromoteClusterRequest.php @@ -24,9 +24,9 @@ class PromoteClusterRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID @@ -47,8 +47,9 @@ class PromoteClusterRequest extends \Google\Protobuf\Internal\Message */ protected $etag = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -80,9 +81,9 @@ public static function build(string $name): self * comment on the Cluster.name field * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID @@ -95,8 +96,9 @@ public static function build(string $name): self * If an etag is provided and does not match the current etag of the Cluster, * deletion will be blocked and an ABORTED error will be returned. * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -134,9 +136,9 @@ public function setName($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID @@ -155,9 +157,9 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID @@ -209,8 +211,9 @@ public function setEtag($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -221,8 +224,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/RestartInstanceRequest.php b/AlloyDb/src/V1/RestartInstanceRequest.php index d1c80af90179..b678b232cf93 100644 --- a/AlloyDb/src/V1/RestartInstanceRequest.php +++ b/AlloyDb/src/V1/RestartInstanceRequest.php @@ -22,13 +22,13 @@ class RestartInstanceRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -37,12 +37,20 @@ class RestartInstanceRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the restart. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; + /** + * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to + * restart upon. Applicable only to read instances. + * + * Generated from protobuf field repeated string node_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $node_ids; /** * @param string $name Required. The name of the resource. For the required format, see the @@ -70,19 +78,23 @@ public static function build(string $name): self * comment on the Instance.name field. * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the restart. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. + * @type array|\Google\Protobuf\Internal\RepeatedField $node_ids + * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to + * restart upon. Applicable only to read instances. * } */ public function __construct($data = NULL) { @@ -120,13 +132,13 @@ public function setName($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -141,13 +153,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes after the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -165,8 +177,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the restart. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -177,8 +190,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the restart. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var @@ -192,5 +206,33 @@ public function setValidateOnly($var) return $this; } + /** + * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to + * restart upon. Applicable only to read instances. + * + * Generated from protobuf field repeated string node_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getNodeIds() + { + return $this->node_ids; + } + + /** + * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to + * restart upon. Applicable only to read instances. + * + * Generated from protobuf field repeated string node_ids = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setNodeIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->node_ids = $arr; + + return $this; + } + } diff --git a/AlloyDb/src/V1/RestoreClusterRequest.php b/AlloyDb/src/V1/RestoreClusterRequest.php index ce7a85bdb5ed..13f6cf83e847 100644 --- a/AlloyDb/src/V1/RestoreClusterRequest.php +++ b/AlloyDb/src/V1/RestoreClusterRequest.php @@ -37,13 +37,13 @@ class RestoreClusterRequest extends \Google\Protobuf\Internal\Message protected $cluster = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -52,9 +52,9 @@ class RestoreClusterRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the import - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 6 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -81,20 +81,20 @@ class RestoreClusterRequest extends \Google\Protobuf\Internal\Message * Required. The resource being created * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the import - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * } */ public function __construct($data = NULL) { @@ -258,13 +258,13 @@ public function setCluster($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -279,13 +279,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -303,9 +303,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the import - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -316,9 +316,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the import - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/SqlResult.php b/AlloyDb/src/V1/SqlResult.php new file mode 100644 index 000000000000..2ff9cba3af42 --- /dev/null +++ b/AlloyDb/src/V1/SqlResult.php @@ -0,0 +1,105 @@ +google.cloud.alloydb.v1.SqlResult + */ +class SqlResult extends \Google\Protobuf\Internal\Message +{ + /** + * List of columns included in the result. This also includes the data type + * of the column. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultColumn columns = 1; + */ + private $columns; + /** + * Rows returned by the SQL statement. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultRow rows = 2; + */ + private $rows; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\AlloyDb\V1\SqlResultColumn>|\Google\Protobuf\Internal\RepeatedField $columns + * List of columns included in the result. This also includes the data type + * of the column. + * @type array<\Google\Cloud\AlloyDb\V1\SqlResultRow>|\Google\Protobuf\Internal\RepeatedField $rows + * Rows returned by the SQL statement. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\DataModel::initOnce(); + parent::__construct($data); + } + + /** + * List of columns included in the result. This also includes the data type + * of the column. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultColumn columns = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getColumns() + { + return $this->columns; + } + + /** + * List of columns included in the result. This also includes the data type + * of the column. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultColumn columns = 1; + * @param array<\Google\Cloud\AlloyDb\V1\SqlResultColumn>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setColumns($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AlloyDb\V1\SqlResultColumn::class); + $this->columns = $arr; + + return $this; + } + + /** + * Rows returned by the SQL statement. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultRow rows = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRows() + { + return $this->rows; + } + + /** + * Rows returned by the SQL statement. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultRow rows = 2; + * @param array<\Google\Cloud\AlloyDb\V1\SqlResultRow>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRows($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AlloyDb\V1\SqlResultRow::class); + $this->rows = $arr; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/SqlResultColumn.php b/AlloyDb/src/V1/SqlResultColumn.php new file mode 100644 index 000000000000..a382717fb18d --- /dev/null +++ b/AlloyDb/src/V1/SqlResultColumn.php @@ -0,0 +1,109 @@ +google.cloud.alloydb.v1.SqlResultColumn + */ +class SqlResultColumn extends \Google\Protobuf\Internal\Message +{ + /** + * Name of the column. + * + * Generated from protobuf field string name = 1; + */ + protected $name = ''; + /** + * Datatype of the column as reported by the postgres driver. + * Common type names are "VARCHAR", "TEXT", "NVARCHAR", "DECIMAL", "BOOL", + * "INT", and "BIGINT". + * + * Generated from protobuf field string type = 2; + */ + protected $type = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Name of the column. + * @type string $type + * Datatype of the column as reported by the postgres driver. + * Common type names are "VARCHAR", "TEXT", "NVARCHAR", "DECIMAL", "BOOL", + * "INT", and "BIGINT". + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\DataModel::initOnce(); + parent::__construct($data); + } + + /** + * Name of the column. + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Name of the column. + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Datatype of the column as reported by the postgres driver. + * Common type names are "VARCHAR", "TEXT", "NVARCHAR", "DECIMAL", "BOOL", + * "INT", and "BIGINT". + * + * Generated from protobuf field string type = 2; + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * Datatype of the column as reported by the postgres driver. + * Common type names are "VARCHAR", "TEXT", "NVARCHAR", "DECIMAL", "BOOL", + * "INT", and "BIGINT". + * + * Generated from protobuf field string type = 2; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/SqlResultRow.php b/AlloyDb/src/V1/SqlResultRow.php new file mode 100644 index 000000000000..65e45b3cb121 --- /dev/null +++ b/AlloyDb/src/V1/SqlResultRow.php @@ -0,0 +1,67 @@ +google.cloud.alloydb.v1.SqlResultRow + */ +class SqlResultRow extends \Google\Protobuf\Internal\Message +{ + /** + * List of values in a row of sql result. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultValue values = 1; + */ + private $values; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\AlloyDb\V1\SqlResultValue>|\Google\Protobuf\Internal\RepeatedField $values + * List of values in a row of sql result. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\DataModel::initOnce(); + parent::__construct($data); + } + + /** + * List of values in a row of sql result. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultValue values = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getValues() + { + return $this->values; + } + + /** + * List of values in a row of sql result. + * + * Generated from protobuf field repeated .google.cloud.alloydb.v1.SqlResultValue values = 1; + * @param array<\Google\Cloud\AlloyDb\V1\SqlResultValue>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AlloyDb\V1\SqlResultValue::class); + $this->values = $arr; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/SqlResultValue.php b/AlloyDb/src/V1/SqlResultValue.php new file mode 100644 index 000000000000..091242f1f175 --- /dev/null +++ b/AlloyDb/src/V1/SqlResultValue.php @@ -0,0 +1,125 @@ +google.cloud.alloydb.v1.SqlResultValue + */ +class SqlResultValue extends \Google\Protobuf\Internal\Message +{ + /** + * The cell value represented in string format. + * Timestamps are converted to string using RFC3339Nano format. + * + * Generated from protobuf field optional string value = 1; + */ + protected $value = null; + /** + * Set to true if cell value is null. + * + * Generated from protobuf field optional bool null_value = 2; + */ + protected $null_value = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $value + * The cell value represented in string format. + * Timestamps are converted to string using RFC3339Nano format. + * @type bool $null_value + * Set to true if cell value is null. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\DataModel::initOnce(); + parent::__construct($data); + } + + /** + * The cell value represented in string format. + * Timestamps are converted to string using RFC3339Nano format. + * + * Generated from protobuf field optional string value = 1; + * @return string + */ + public function getValue() + { + return isset($this->value) ? $this->value : ''; + } + + public function hasValue() + { + return isset($this->value); + } + + public function clearValue() + { + unset($this->value); + } + + /** + * The cell value represented in string format. + * Timestamps are converted to string using RFC3339Nano format. + * + * Generated from protobuf field optional string value = 1; + * @param string $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkString($var, True); + $this->value = $var; + + return $this; + } + + /** + * Set to true if cell value is null. + * + * Generated from protobuf field optional bool null_value = 2; + * @return bool + */ + public function getNullValue() + { + return isset($this->null_value) ? $this->null_value : false; + } + + public function hasNullValue() + { + return isset($this->null_value); + } + + public function clearNullValue() + { + unset($this->null_value); + } + + /** + * Set to true if cell value is null. + * + * Generated from protobuf field optional bool null_value = 2; + * @param bool $var + * @return $this + */ + public function setNullValue($var) + { + GPBUtil::checkBool($var); + $this->null_value = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/SslConfig/SslMode.php b/AlloyDb/src/V1/SslConfig/SslMode.php index cbbac57c134a..f6fd884e7966 100644 --- a/AlloyDb/src/V1/SslConfig/SslMode.php +++ b/AlloyDb/src/V1/SslConfig/SslMode.php @@ -14,7 +14,7 @@ class SslMode { /** - * SSL mode not specified. Defaults to ENCRYPTED_ONLY. + * SSL mode is not specified. Defaults to ENCRYPTED_ONLY. * * Generated from protobuf enum SSL_MODE_UNSPECIFIED = 0; */ @@ -35,7 +35,7 @@ class SslMode const SSL_MODE_REQUIRE = 2; /** * SSL connections are required. CA verification enforced. - * Clients must have certificates signed by a Cluster CA, e.g. via + * Clients must have certificates signed by a Cluster CA, for example, using * GenerateClientCertificate. * * Generated from protobuf enum SSL_MODE_VERIFY_CA = 3 [deprecated = true]; diff --git a/AlloyDb/src/V1/SubscriptionType.php b/AlloyDb/src/V1/SubscriptionType.php new file mode 100644 index 000000000000..68a7e3303762 --- /dev/null +++ b/AlloyDb/src/V1/SubscriptionType.php @@ -0,0 +1,64 @@ +google.cloud.alloydb.v1.SubscriptionType + */ +class SubscriptionType +{ + /** + * This is an unknown subscription type. By default, the subscription type is + * STANDARD. + * + * Generated from protobuf enum SUBSCRIPTION_TYPE_UNSPECIFIED = 0; + */ + const SUBSCRIPTION_TYPE_UNSPECIFIED = 0; + /** + * Standard subscription. + * + * Generated from protobuf enum STANDARD = 1; + */ + const STANDARD = 1; + /** + * Trial subscription. + * + * Generated from protobuf enum TRIAL = 2; + */ + const TRIAL = 2; + + private static $valueToName = [ + self::SUBSCRIPTION_TYPE_UNSPECIFIED => 'SUBSCRIPTION_TYPE_UNSPECIFIED', + self::STANDARD => 'STANDARD', + self::TRIAL => 'TRIAL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/AlloyDb/src/V1/SwitchoverClusterRequest.php b/AlloyDb/src/V1/SwitchoverClusterRequest.php new file mode 100644 index 000000000000..571773ce71cc --- /dev/null +++ b/AlloyDb/src/V1/SwitchoverClusterRequest.php @@ -0,0 +1,202 @@ +google.cloud.alloydb.v1.SwitchoverClusterRequest + */ +class SwitchoverClusterRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the resource. For the required format, see the + * comment on the Cluster.name field + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $request_id = ''; + /** + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. + * + * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $name Required. The name of the resource. For the required format, see the + * comment on the Cluster.name field + * Please see {@see AlloyDBAdminClient::clusterName()} for help formatting this field. + * + * @return \Google\Cloud\AlloyDb\V1\SwitchoverClusterRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the resource. For the required format, see the + * comment on the Cluster.name field + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * @type bool $validate_only + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Alloydb\V1\Service::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the resource. For the required format, see the + * comment on the Cluster.name field + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the resource. For the required format, see the + * comment on the Cluster.name field + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same request + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + + /** + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. + * + * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. + * + * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/AlloyDb/src/V1/UpdateBackupRequest.php b/AlloyDb/src/V1/UpdateBackupRequest.php index 4925904e8fd7..4c31c2d1ec6b 100644 --- a/AlloyDb/src/V1/UpdateBackupRequest.php +++ b/AlloyDb/src/V1/UpdateBackupRequest.php @@ -33,13 +33,13 @@ class UpdateBackupRequest extends \Google\Protobuf\Internal\Message protected $backup = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -97,13 +97,13 @@ public static function build(\Google\Cloud\AlloyDb\V1\Backup $backup, \Google\Pr * Required. The resource being updated * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -202,13 +202,13 @@ public function setBackup($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -223,13 +223,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/UpdateClusterRequest.php b/AlloyDb/src/V1/UpdateClusterRequest.php index 2727a2df5cd9..e2da04b561bf 100644 --- a/AlloyDb/src/V1/UpdateClusterRequest.php +++ b/AlloyDb/src/V1/UpdateClusterRequest.php @@ -33,13 +33,13 @@ class UpdateClusterRequest extends \Google\Protobuf\Internal\Message protected $cluster = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -48,9 +48,9 @@ class UpdateClusterRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the update - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -98,20 +98,20 @@ public static function build(\Google\Cloud\AlloyDb\V1\Cluster $cluster, \Google\ * Required. The resource being updated * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the update - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * @type bool $allow_missing * Optional. If set to true, update succeeds even if cluster is not found. In * that case, a new cluster is created and `update_mask` is ignored. @@ -204,13 +204,13 @@ public function setCluster($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -225,13 +225,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -249,9 +249,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the update - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -262,9 +262,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the update - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/UpdateInstanceRequest.php b/AlloyDb/src/V1/UpdateInstanceRequest.php index 45b774ddbd49..f75183733d59 100644 --- a/AlloyDb/src/V1/UpdateInstanceRequest.php +++ b/AlloyDb/src/V1/UpdateInstanceRequest.php @@ -33,13 +33,13 @@ class UpdateInstanceRequest extends \Google\Protobuf\Internal\Message protected $instance = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -48,9 +48,9 @@ class UpdateInstanceRequest extends \Google\Protobuf\Internal\Message */ protected $request_id = ''; /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the update - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -98,20 +98,20 @@ public static function build(\Google\Cloud\AlloyDb\V1\Instance $instance, \Googl * Required. The resource being updated * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @type bool $validate_only - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the update - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * @type bool $allow_missing * Optional. If set to true, update succeeds even if instance is not found. In * that case, a new instance is created and `update_mask` is ignored. @@ -204,13 +204,13 @@ public function setInstance($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -225,13 +225,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -249,9 +249,9 @@ public function setRequestId($var) } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the update - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -262,9 +262,9 @@ public function getValidateOnly() } /** - * Optional. If set, performs request validation (e.g. permission checks and - * any other type of validation), but do not actually execute the update - * request. + * Optional. If set, performs request validation, for example, permission + * checks and any other type of validation, but does not actually execute the + * create request. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AlloyDb/src/V1/UpdateUserRequest.php b/AlloyDb/src/V1/UpdateUserRequest.php index 0afb7647923a..eab90f471ca7 100644 --- a/AlloyDb/src/V1/UpdateUserRequest.php +++ b/AlloyDb/src/V1/UpdateUserRequest.php @@ -33,13 +33,13 @@ class UpdateUserRequest extends \Google\Protobuf\Internal\Message protected $user = null; /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -96,13 +96,13 @@ public static function build(\Google\Cloud\AlloyDb\V1\User $user, \Google\Protob * Required. The resource being updated * @type string $request_id * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -200,13 +200,13 @@ public function setUser($var) /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). @@ -221,13 +221,13 @@ public function getRequestId() /** * Optional. An optional request ID to identify requests. Specify a unique - * request ID so that if you must retry your request, the server will know to - * ignore the request if it has already been completed. The server will - * guarantee that for at least 60 minutes since the first request. + * request ID so that if you must retry your request, the server ignores the + * request if it has already been completed. The server guarantees that for at + * least 60 minutes since the first request. * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same request - * ID, the server can check if original operation with the same request ID - * was received, and if so, will ignore the second request. This prevents + * ID, the server can check if the original operation with the same request ID + * was received, and if so, ignores the second request. This prevents * clients from accidentally creating duplicate commitments. * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). diff --git a/AlloyDb/src/V1/User.php b/AlloyDb/src/V1/User.php index 5936d629c1da..f64046478ae2 100644 --- a/AlloyDb/src/V1/User.php +++ b/AlloyDb/src/V1/User.php @@ -41,6 +41,13 @@ class User extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.alloydb.v1.User.UserType user_type = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $user_type = 0; + /** + * Input only. If the user already exists and it has additional roles, keep + * them granted. + * + * Generated from protobuf field bool keep_extra_roles = 6 [(.google.api.field_behavior) = INPUT_ONLY]; + */ + protected $keep_extra_roles = false; /** * Constructor. @@ -58,6 +65,9 @@ class User extends \Google\Protobuf\Internal\Message * The database role strings are subject to the PostgreSQL naming conventions. * @type int $user_type * Optional. Type of this user. + * @type bool $keep_extra_roles + * Input only. If the user already exists and it has additional roles, keep + * them granted. * } */ public function __construct($data = NULL) { @@ -173,5 +183,33 @@ public function setUserType($var) return $this; } + /** + * Input only. If the user already exists and it has additional roles, keep + * them granted. + * + * Generated from protobuf field bool keep_extra_roles = 6 [(.google.api.field_behavior) = INPUT_ONLY]; + * @return bool + */ + public function getKeepExtraRoles() + { + return $this->keep_extra_roles; + } + + /** + * Input only. If the user already exists and it has additional roles, keep + * them granted. + * + * Generated from protobuf field bool keep_extra_roles = 6 [(.google.api.field_behavior) = INPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setKeepExtraRoles($var) + { + GPBUtil::checkBool($var); + $this->keep_extra_roles = $var; + + return $this; + } + } diff --git a/AlloyDb/src/V1/gapic_metadata.json b/AlloyDb/src/V1/gapic_metadata.json index acfc6419e997..a68014194117 100644 --- a/AlloyDb/src/V1/gapic_metadata.json +++ b/AlloyDb/src/V1/gapic_metadata.json @@ -65,6 +65,11 @@ "deleteUser" ] }, + "ExecuteSql": { + "methods": [ + "executeSql" + ] + }, "FailoverInstance": { "methods": [ "failoverInstance" @@ -115,6 +120,11 @@ "listClusters" ] }, + "ListDatabases": { + "methods": [ + "listDatabases" + ] + }, "ListInstances": { "methods": [ "listInstances" @@ -145,6 +155,11 @@ "restoreCluster" ] }, + "SwitchoverCluster": { + "methods": [ + "switchoverCluster" + ] + }, "UpdateBackup": { "methods": [ "updateBackup" diff --git a/AlloyDb/src/V1/resources/alloy_db_admin_client_config.json b/AlloyDb/src/V1/resources/alloy_db_admin_client_config.json index 3643e0bcf47b..dce1aa00708b 100644 --- a/AlloyDb/src/V1/resources/alloy_db_admin_client_config.json +++ b/AlloyDb/src/V1/resources/alloy_db_admin_client_config.json @@ -93,6 +93,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "ExecuteSql": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "FailoverInstance": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -143,6 +148,11 @@ "retry_codes_name": "retry_policy_1_codes", "retry_params_name": "retry_policy_1_params" }, + "ListDatabases": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "ListInstances": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_1_codes", @@ -173,6 +183,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "SwitchoverCluster": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "UpdateBackup": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", diff --git a/AlloyDb/src/V1/resources/alloy_db_admin_descriptor_config.php b/AlloyDb/src/V1/resources/alloy_db_admin_descriptor_config.php index 14f17c2c70d3..9ef950d79dea 100644 --- a/AlloyDb/src/V1/resources/alloy_db_admin_descriptor_config.php +++ b/AlloyDb/src/V1/resources/alloy_db_admin_descriptor_config.php @@ -289,6 +289,25 @@ ], ], ], + 'SwitchoverCluster' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\AlloyDb\V1\Cluster', + 'metadataReturnType' => '\Google\Cloud\AlloyDb\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'UpdateBackup' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\AlloyDb\V1\Backup', @@ -373,6 +392,18 @@ ], ], ], + 'ExecuteSql' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\AlloyDb\V1\ExecuteSqlResponse', + 'headerParams' => [ + [ + 'keyName' => 'instance', + 'fieldAccessors' => [ + 'getInstance', + ], + ], + ], + ], 'GenerateClientCertificate' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\AlloyDb\V1\GenerateClientCertificateResponse', @@ -485,6 +516,26 @@ ], ], ], + 'ListDatabases' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getDatabases', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\AlloyDb\V1\ListDatabasesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'ListInstances' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', diff --git a/AlloyDb/src/V1/resources/alloy_db_admin_rest_client_config.php b/AlloyDb/src/V1/resources/alloy_db_admin_rest_client_config.php index 06450b4dfd5b..cf153a4e6a9f 100644 --- a/AlloyDb/src/V1/resources/alloy_db_admin_rest_client_config.php +++ b/AlloyDb/src/V1/resources/alloy_db_admin_rest_client_config.php @@ -163,6 +163,18 @@ ], ], ], + 'ExecuteSql' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{instance=projects/*/locations/*/clusters/*/instances/*}:executeSql', + 'body' => '*', + 'placeholders' => [ + 'instance' => [ + 'getters' => [ + 'getInstance', + ], + ], + ], + ], 'FailoverInstance' => [ 'method' => 'post', 'uriTemplate' => '/v1/{name=projects/*/locations/*/clusters/*/instances/*}:failover', @@ -276,6 +288,17 @@ ], ], ], + 'ListDatabases' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/clusters/*}/databases', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'ListInstances' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*/clusters/*}/instances', @@ -345,6 +368,18 @@ ], ], ], + 'SwitchoverCluster' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/clusters/*}:switchover', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'UpdateBackup' => [ 'method' => 'patch', 'uriTemplate' => '/v1/{backup.name=projects/*/locations/*/backups/*}', diff --git a/AlloyDb/tests/Unit/V1/Client/AlloyDBAdminClientTest.php b/AlloyDb/tests/Unit/V1/Client/AlloyDBAdminClientTest.php index d01084f02807..716c9a867e40 100644 --- a/AlloyDb/tests/Unit/V1/Client/AlloyDBAdminClientTest.php +++ b/AlloyDb/tests/Unit/V1/Client/AlloyDBAdminClientTest.php @@ -39,10 +39,13 @@ use Google\Cloud\AlloyDb\V1\CreateSecondaryClusterRequest; use Google\Cloud\AlloyDb\V1\CreateSecondaryInstanceRequest; use Google\Cloud\AlloyDb\V1\CreateUserRequest; +use Google\Cloud\AlloyDb\V1\Database; use Google\Cloud\AlloyDb\V1\DeleteBackupRequest; use Google\Cloud\AlloyDb\V1\DeleteClusterRequest; use Google\Cloud\AlloyDb\V1\DeleteInstanceRequest; use Google\Cloud\AlloyDb\V1\DeleteUserRequest; +use Google\Cloud\AlloyDb\V1\ExecuteSqlRequest; +use Google\Cloud\AlloyDb\V1\ExecuteSqlResponse; use Google\Cloud\AlloyDb\V1\FailoverInstanceRequest; use Google\Cloud\AlloyDb\V1\GenerateClientCertificateRequest; use Google\Cloud\AlloyDb\V1\GenerateClientCertificateResponse; @@ -59,6 +62,8 @@ use Google\Cloud\AlloyDb\V1\ListBackupsResponse; use Google\Cloud\AlloyDb\V1\ListClustersRequest; use Google\Cloud\AlloyDb\V1\ListClustersResponse; +use Google\Cloud\AlloyDb\V1\ListDatabasesRequest; +use Google\Cloud\AlloyDb\V1\ListDatabasesResponse; use Google\Cloud\AlloyDb\V1\ListInstancesRequest; use Google\Cloud\AlloyDb\V1\ListInstancesResponse; use Google\Cloud\AlloyDb\V1\ListSupportedDatabaseFlagsRequest; @@ -69,6 +74,7 @@ use Google\Cloud\AlloyDb\V1\RestartInstanceRequest; use Google\Cloud\AlloyDb\V1\RestoreClusterRequest; use Google\Cloud\AlloyDb\V1\SupportedDatabaseFlag; +use Google\Cloud\AlloyDb\V1\SwitchoverClusterRequest; use Google\Cloud\AlloyDb\V1\UpdateBackupRequest; use Google\Cloud\AlloyDb\V1\UpdateClusterRequest; use Google\Cloud\AlloyDb\V1\UpdateInstanceRequest; @@ -276,6 +282,7 @@ public function createBackupTest() $reconciling = false; $etag = 'etag3123477'; $sizeBytes = 1796325715; + $satisfiesPzs = false; $expectedResponse = new Backup(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -286,6 +293,7 @@ public function createBackupTest() $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); $expectedResponse->setSizeBytes($sizeBytes); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -431,6 +439,7 @@ public function createClusterTest() $network = 'network1843485230'; $etag = 'etag3123477'; $reconciling = false; + $satisfiesPzs = false; $expectedResponse = new Cluster(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -438,6 +447,7 @@ public function createClusterTest() $expectedResponse->setNetwork($network); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -582,16 +592,20 @@ public function createInstanceTest() $uid = 'uid115792'; $gceZone = 'gceZone-227587294'; $ipAddress = 'ipAddress1480014044'; + $publicIpAddress = 'publicIpAddress2014408818'; $reconciling = false; $etag = 'etag3123477'; + $satisfiesPzs = false; $expectedResponse = new Instance(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setUid($uid); $expectedResponse->setGceZone($gceZone); $expectedResponse->setIpAddress($ipAddress); + $expectedResponse->setPublicIpAddress($publicIpAddress); $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -737,6 +751,7 @@ public function createSecondaryClusterTest() $network = 'network1843485230'; $etag = 'etag3123477'; $reconciling = false; + $satisfiesPzs = false; $expectedResponse = new Cluster(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -744,6 +759,7 @@ public function createSecondaryClusterTest() $expectedResponse->setNetwork($network); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -888,16 +904,20 @@ public function createSecondaryInstanceTest() $uid = 'uid115792'; $gceZone = 'gceZone-227587294'; $ipAddress = 'ipAddress1480014044'; + $publicIpAddress = 'publicIpAddress2014408818'; $reconciling = false; $etag = 'etag3123477'; + $satisfiesPzs = false; $expectedResponse = new Instance(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setUid($uid); $expectedResponse->setGceZone($gceZone); $expectedResponse->setIpAddress($ipAddress); + $expectedResponse->setPublicIpAddress($publicIpAddress); $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -1027,9 +1047,11 @@ public function createUserTest() // Mock response $name = 'name3373707'; $password = 'password1216985755'; + $keepExtraRoles = true; $expectedResponse = new User(); $expectedResponse->setName($name); $expectedResponse->setPassword($password); + $expectedResponse->setKeepExtraRoles($keepExtraRoles); $transport->addResponse($expectedResponse); // Mock request $formattedParent = $gapicClient->clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]'); @@ -1525,6 +1547,89 @@ public function deleteUserExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function executeSqlTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new ExecuteSqlResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedInstance = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[CLUSTER]', '[INSTANCE]'); + $database = 'database1789464955'; + $user = 'user3599307'; + $sqlStatement = 'sqlStatement-2051442626'; + $request = (new ExecuteSqlRequest()) + ->setInstance($formattedInstance) + ->setDatabase($database) + ->setUser($user) + ->setSqlStatement($sqlStatement); + $response = $gapicClient->executeSql($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.alloydb.v1.AlloyDBAdmin/ExecuteSql', $actualFuncCall); + $actualValue = $actualRequestObject->getInstance(); + $this->assertProtobufEquals($formattedInstance, $actualValue); + $actualValue = $actualRequestObject->getDatabase(); + $this->assertProtobufEquals($database, $actualValue); + $actualValue = $actualRequestObject->getUser(); + $this->assertProtobufEquals($user, $actualValue); + $actualValue = $actualRequestObject->getSqlStatement(); + $this->assertProtobufEquals($sqlStatement, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function executeSqlExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedInstance = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[CLUSTER]', '[INSTANCE]'); + $database = 'database1789464955'; + $user = 'user3599307'; + $sqlStatement = 'sqlStatement-2051442626'; + $request = (new ExecuteSqlRequest()) + ->setInstance($formattedInstance) + ->setDatabase($database) + ->setUser($user) + ->setSqlStatement($sqlStatement); + try { + $gapicClient->executeSql($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function failoverInstanceTest() { @@ -1551,16 +1656,20 @@ public function failoverInstanceTest() $uid = 'uid115792'; $gceZone = 'gceZone-227587294'; $ipAddress = 'ipAddress1480014044'; + $publicIpAddress = 'publicIpAddress2014408818'; $reconciling = false; $etag = 'etag3123477'; + $satisfiesPzs = false; $expectedResponse = new Instance(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setUid($uid); $expectedResponse->setGceZone($gceZone); $expectedResponse->setIpAddress($ipAddress); + $expectedResponse->setPublicIpAddress($publicIpAddress); $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -1744,6 +1853,7 @@ public function getBackupTest() $reconciling = false; $etag = 'etag3123477'; $sizeBytes = 1796325715; + $satisfiesPzs = false; $expectedResponse = new Backup(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); @@ -1754,6 +1864,7 @@ public function getBackupTest() $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); $expectedResponse->setSizeBytes($sizeBytes); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->backupName('[PROJECT]', '[LOCATION]', '[BACKUP]'); @@ -1822,6 +1933,7 @@ public function getClusterTest() $network = 'network1843485230'; $etag = 'etag3123477'; $reconciling = false; + $satisfiesPzs = false; $expectedResponse = new Cluster(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); @@ -1829,6 +1941,7 @@ public function getClusterTest() $expectedResponse->setNetwork($network); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]'); @@ -1893,10 +2006,12 @@ public function getConnectionInfoTest() // Mock response $name = 'name3373707'; $ipAddress = 'ipAddress1480014044'; + $publicIpAddress = 'publicIpAddress2014408818'; $instanceUid = 'instanceUid-737331802'; $expectedResponse = new ConnectionInfo(); $expectedResponse->setName($name); $expectedResponse->setIpAddress($ipAddress); + $expectedResponse->setPublicIpAddress($publicIpAddress); $expectedResponse->setInstanceUid($instanceUid); $transport->addResponse($expectedResponse); // Mock request @@ -1965,16 +2080,20 @@ public function getInstanceTest() $uid = 'uid115792'; $gceZone = 'gceZone-227587294'; $ipAddress = 'ipAddress1480014044'; + $publicIpAddress = 'publicIpAddress2014408818'; $reconciling = false; $etag = 'etag3123477'; + $satisfiesPzs = false; $expectedResponse = new Instance(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setUid($uid); $expectedResponse->setGceZone($gceZone); $expectedResponse->setIpAddress($ipAddress); + $expectedResponse->setPublicIpAddress($publicIpAddress); $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[CLUSTER]', '[INSTANCE]'); @@ -2039,9 +2158,11 @@ public function getUserTest() // Mock response $name2 = 'name2-1052831874'; $password = 'password1216985755'; + $keepExtraRoles = true; $expectedResponse = new User(); $expectedResponse->setName($name2); $expectedResponse->setPassword($password); + $expectedResponse->setKeepExtraRoles($keepExtraRoles); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->userName('[PROJECT]', '[LOCATION]', '[CLUSTER]', '[USER]'); @@ -2121,16 +2242,20 @@ public function injectFaultTest() $uid = 'uid115792'; $gceZone = 'gceZone-227587294'; $ipAddress = 'ipAddress1480014044'; + $publicIpAddress = 'publicIpAddress2014408818'; $reconciling = false; $etag = 'etag3123477'; + $satisfiesPzs = false; $expectedResponse = new Instance(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setUid($uid); $expectedResponse->setGceZone($gceZone); $expectedResponse->setIpAddress($ipAddress); + $expectedResponse->setPublicIpAddress($publicIpAddress); $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -2377,6 +2502,77 @@ public function listClustersExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function listDatabasesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $databasesElement = new Database(); + $databases = [$databasesElement]; + $expectedResponse = new ListDatabasesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setDatabases($databases); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]'); + $request = (new ListDatabasesRequest())->setParent($formattedParent); + $response = $gapicClient->listDatabases($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getDatabases()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.alloydb.v1.AlloyDBAdmin/ListDatabases', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listDatabasesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]'); + $request = (new ListDatabasesRequest())->setParent($formattedParent); + try { + $gapicClient->listDatabases($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function listInstancesTest() { @@ -2617,6 +2813,7 @@ public function promoteClusterTest() $network = 'network1843485230'; $etag2 = 'etag2-1293302904'; $reconciling = false; + $satisfiesPzs = false; $expectedResponse = new Cluster(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); @@ -2624,6 +2821,7 @@ public function promoteClusterTest() $expectedResponse->setNetwork($network); $expectedResponse->setEtag($etag2); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -2750,16 +2948,20 @@ public function restartInstanceTest() $uid = 'uid115792'; $gceZone = 'gceZone-227587294'; $ipAddress = 'ipAddress1480014044'; + $publicIpAddress = 'publicIpAddress2014408818'; $reconciling = false; $etag = 'etag3123477'; + $satisfiesPzs = false; $expectedResponse = new Instance(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setUid($uid); $expectedResponse->setGceZone($gceZone); $expectedResponse->setIpAddress($ipAddress); + $expectedResponse->setPublicIpAddress($publicIpAddress); $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -2887,6 +3089,7 @@ public function restoreClusterTest() $network = 'network1843485230'; $etag = 'etag3123477'; $reconciling = false; + $satisfiesPzs = false; $expectedResponse = new Cluster(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -2894,6 +3097,7 @@ public function restoreClusterTest() $expectedResponse->setNetwork($network); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -3012,6 +3216,142 @@ public function restoreClusterExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function switchoverClusterTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/switchoverClusterTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $displayName = 'displayName1615086568'; + $uid = 'uid115792'; + $network = 'network1843485230'; + $etag = 'etag3123477'; + $reconciling = false; + $satisfiesPzs = false; + $expectedResponse = new Cluster(); + $expectedResponse->setName($name2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setUid($uid); + $expectedResponse->setNetwork($network); + $expectedResponse->setEtag($etag); + $expectedResponse->setReconciling($reconciling); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/switchoverClusterTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]'); + $request = (new SwitchoverClusterRequest())->setName($formattedName); + $response = $gapicClient->switchoverCluster($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.alloydb.v1.AlloyDBAdmin/SwitchoverCluster', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/switchoverClusterTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function switchoverClusterExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/switchoverClusterTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]'); + $request = (new SwitchoverClusterRequest())->setName($formattedName); + $response = $gapicClient->switchoverCluster($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/switchoverClusterTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function updateBackupTest() { @@ -3042,6 +3382,7 @@ public function updateBackupTest() $reconciling = false; $etag = 'etag3123477'; $sizeBytes = 1796325715; + $satisfiesPzs = false; $expectedResponse = new Backup(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -3052,6 +3393,7 @@ public function updateBackupTest() $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); $expectedResponse->setSizeBytes($sizeBytes); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -3183,6 +3525,7 @@ public function updateClusterTest() $network = 'network1843485230'; $etag = 'etag3123477'; $reconciling = false; + $satisfiesPzs = false; $expectedResponse = new Cluster(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -3190,6 +3533,7 @@ public function updateClusterTest() $expectedResponse->setNetwork($network); $expectedResponse->setEtag($etag); $expectedResponse->setReconciling($reconciling); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -3320,16 +3664,20 @@ public function updateInstanceTest() $uid = 'uid115792'; $gceZone = 'gceZone-227587294'; $ipAddress = 'ipAddress1480014044'; + $publicIpAddress = 'publicIpAddress2014408818'; $reconciling = false; $etag = 'etag3123477'; + $satisfiesPzs = false; $expectedResponse = new Instance(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); $expectedResponse->setUid($uid); $expectedResponse->setGceZone($gceZone); $expectedResponse->setIpAddress($ipAddress); + $expectedResponse->setPublicIpAddress($publicIpAddress); $expectedResponse->setReconciling($reconciling); $expectedResponse->setEtag($etag); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -3445,9 +3793,11 @@ public function updateUserTest() // Mock response $name = 'name3373707'; $password = 'password1216985755'; + $keepExtraRoles = true; $expectedResponse = new User(); $expectedResponse->setName($name); $expectedResponse->setPassword($password); + $expectedResponse->setKeepExtraRoles($keepExtraRoles); $transport->addResponse($expectedResponse); // Mock request $user = new User(); From 8afaa8c19587006d276ded057c684b9a59836c66 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 18:33:12 -0700 Subject: [PATCH 040/157] feat: A new field `headline_offer_installment` is added to message `.google.shopping.css.v1.Attributes` (#7761) feat: A new field `headline_offer_subscription_cost` is added to message `.google.shopping.css.v1.Attributes` feat: A new message `HeadlineOfferSubscriptionCost` is added feat: A new message `HeadlineOfferInstallment` is added feat: A new enum `SubscriptionPeriod` is added PiperOrigin-RevId: 688649184 Source-Link: https://github.com/googleapis/googleapis/commit/c8a726182c087afc514aa51a980b937d07f86540 Source-Link: https://github.com/googleapis/googleapis-gen/commit/3dcef19e307b679a3f6c881d79f064e885fd52fd Copy-Tag: eyJwIjoiU2hvcHBpbmdDc3MvLk93bEJvdC55YW1sIiwiaCI6IjNkY2VmMTllMzA3YjY3OWEzZjZjODgxZDc5ZjA2NGU4ODVmZDUyZmQifQ== --- ShoppingCss/metadata/V1/CssProductCommon.php | Bin 4194 -> 4759 bytes ShoppingCss/src/V1/Attributes.php | 92 ++++++++++ .../src/V1/HeadlineOfferInstallment.php | 155 +++++++++++++++++ .../src/V1/HeadlineOfferSubscriptionCost.php | 157 ++++++++++++++++++ ShoppingCss/src/V1/SubscriptionPeriod.php | 61 +++++++ 5 files changed, 465 insertions(+) create mode 100644 ShoppingCss/src/V1/HeadlineOfferInstallment.php create mode 100644 ShoppingCss/src/V1/HeadlineOfferSubscriptionCost.php create mode 100644 ShoppingCss/src/V1/SubscriptionPeriod.php diff --git a/ShoppingCss/metadata/V1/CssProductCommon.php b/ShoppingCss/metadata/V1/CssProductCommon.php index 2292a7adc7a7fcceb2f12b316b2f52b30df26960..180c55b9b5fd4e89dbe7afa61c2fd28ee8623f53 100644 GIT binary patch delta 457 zcmaE)FkN-STqdS<@{{K?^)f9G+N{T1#-=6|!X=fFnwXN4nU@-$pO%(d6rY(_T#}fR zlbf1XB4Mn+sKISyFxh}t!o>rs%pau66QM{bo=XAEh~m-qS#hxyq!wl7r${gY&E_-G0-0@!Y+L|X zT1b?O7ospeCp9moptional string custom_label_4 = 50; */ protected $custom_label_4 = null; + /** + * Number and amount of installments to pay for an item. + * + * Generated from protobuf field .google.shopping.css.v1.HeadlineOfferInstallment headline_offer_installment = 51; + */ + protected $headline_offer_installment = null; + /** + * Number of periods (months or years) and amount of payment per period + * for an item with an associated subscription contract. + * + * Generated from protobuf field .google.shopping.css.v1.HeadlineOfferSubscriptionCost headline_offer_subscription_cost = 52; + */ + protected $headline_offer_subscription_cost = null; /** * Constructor. @@ -470,6 +483,11 @@ class Attributes extends \Google\Protobuf\Internal\Message * Custom label 3 for custom grouping of items in a Shopping campaign. * @type string $custom_label_4 * Custom label 4 for custom grouping of items in a Shopping campaign. + * @type \Google\Shopping\Css\V1\HeadlineOfferInstallment $headline_offer_installment + * Number and amount of installments to pay for an item. + * @type \Google\Shopping\Css\V1\HeadlineOfferSubscriptionCost $headline_offer_subscription_cost + * Number of periods (months or years) and amount of payment per period + * for an item with an associated subscription contract. * } */ public function __construct($data = NULL) { @@ -2189,5 +2207,79 @@ public function setCustomLabel4($var) return $this; } + /** + * Number and amount of installments to pay for an item. + * + * Generated from protobuf field .google.shopping.css.v1.HeadlineOfferInstallment headline_offer_installment = 51; + * @return \Google\Shopping\Css\V1\HeadlineOfferInstallment|null + */ + public function getHeadlineOfferInstallment() + { + return $this->headline_offer_installment; + } + + public function hasHeadlineOfferInstallment() + { + return isset($this->headline_offer_installment); + } + + public function clearHeadlineOfferInstallment() + { + unset($this->headline_offer_installment); + } + + /** + * Number and amount of installments to pay for an item. + * + * Generated from protobuf field .google.shopping.css.v1.HeadlineOfferInstallment headline_offer_installment = 51; + * @param \Google\Shopping\Css\V1\HeadlineOfferInstallment $var + * @return $this + */ + public function setHeadlineOfferInstallment($var) + { + GPBUtil::checkMessage($var, \Google\Shopping\Css\V1\HeadlineOfferInstallment::class); + $this->headline_offer_installment = $var; + + return $this; + } + + /** + * Number of periods (months or years) and amount of payment per period + * for an item with an associated subscription contract. + * + * Generated from protobuf field .google.shopping.css.v1.HeadlineOfferSubscriptionCost headline_offer_subscription_cost = 52; + * @return \Google\Shopping\Css\V1\HeadlineOfferSubscriptionCost|null + */ + public function getHeadlineOfferSubscriptionCost() + { + return $this->headline_offer_subscription_cost; + } + + public function hasHeadlineOfferSubscriptionCost() + { + return isset($this->headline_offer_subscription_cost); + } + + public function clearHeadlineOfferSubscriptionCost() + { + unset($this->headline_offer_subscription_cost); + } + + /** + * Number of periods (months or years) and amount of payment per period + * for an item with an associated subscription contract. + * + * Generated from protobuf field .google.shopping.css.v1.HeadlineOfferSubscriptionCost headline_offer_subscription_cost = 52; + * @param \Google\Shopping\Css\V1\HeadlineOfferSubscriptionCost $var + * @return $this + */ + public function setHeadlineOfferSubscriptionCost($var) + { + GPBUtil::checkMessage($var, \Google\Shopping\Css\V1\HeadlineOfferSubscriptionCost::class); + $this->headline_offer_subscription_cost = $var; + + return $this; + } + } diff --git a/ShoppingCss/src/V1/HeadlineOfferInstallment.php b/ShoppingCss/src/V1/HeadlineOfferInstallment.php new file mode 100644 index 000000000000..ee950616963f --- /dev/null +++ b/ShoppingCss/src/V1/HeadlineOfferInstallment.php @@ -0,0 +1,155 @@ +google.shopping.css.v1.HeadlineOfferInstallment + */ +class HeadlineOfferInstallment extends \Google\Protobuf\Internal\Message +{ + /** + * The number of installments the buyer has to pay. + * + * Generated from protobuf field int64 months = 1; + */ + protected $months = 0; + /** + * The amount the buyer has to pay per month. + * + * Generated from protobuf field .google.shopping.type.Price amount = 2; + */ + protected $amount = null; + /** + * The up-front down payment amount the buyer has to pay. + * + * Generated from protobuf field .google.shopping.type.Price downpayment = 3; + */ + protected $downpayment = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $months + * The number of installments the buyer has to pay. + * @type \Google\Shopping\Type\Price $amount + * The amount the buyer has to pay per month. + * @type \Google\Shopping\Type\Price $downpayment + * The up-front down payment amount the buyer has to pay. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Shopping\Css\V1\CssProductCommon::initOnce(); + parent::__construct($data); + } + + /** + * The number of installments the buyer has to pay. + * + * Generated from protobuf field int64 months = 1; + * @return int|string + */ + public function getMonths() + { + return $this->months; + } + + /** + * The number of installments the buyer has to pay. + * + * Generated from protobuf field int64 months = 1; + * @param int|string $var + * @return $this + */ + public function setMonths($var) + { + GPBUtil::checkInt64($var); + $this->months = $var; + + return $this; + } + + /** + * The amount the buyer has to pay per month. + * + * Generated from protobuf field .google.shopping.type.Price amount = 2; + * @return \Google\Shopping\Type\Price|null + */ + public function getAmount() + { + return $this->amount; + } + + public function hasAmount() + { + return isset($this->amount); + } + + public function clearAmount() + { + unset($this->amount); + } + + /** + * The amount the buyer has to pay per month. + * + * Generated from protobuf field .google.shopping.type.Price amount = 2; + * @param \Google\Shopping\Type\Price $var + * @return $this + */ + public function setAmount($var) + { + GPBUtil::checkMessage($var, \Google\Shopping\Type\Price::class); + $this->amount = $var; + + return $this; + } + + /** + * The up-front down payment amount the buyer has to pay. + * + * Generated from protobuf field .google.shopping.type.Price downpayment = 3; + * @return \Google\Shopping\Type\Price|null + */ + public function getDownpayment() + { + return $this->downpayment; + } + + public function hasDownpayment() + { + return isset($this->downpayment); + } + + public function clearDownpayment() + { + unset($this->downpayment); + } + + /** + * The up-front down payment amount the buyer has to pay. + * + * Generated from protobuf field .google.shopping.type.Price downpayment = 3; + * @param \Google\Shopping\Type\Price $var + * @return $this + */ + public function setDownpayment($var) + { + GPBUtil::checkMessage($var, \Google\Shopping\Type\Price::class); + $this->downpayment = $var; + + return $this; + } + +} + diff --git a/ShoppingCss/src/V1/HeadlineOfferSubscriptionCost.php b/ShoppingCss/src/V1/HeadlineOfferSubscriptionCost.php new file mode 100644 index 000000000000..d2769f8faceb --- /dev/null +++ b/ShoppingCss/src/V1/HeadlineOfferSubscriptionCost.php @@ -0,0 +1,157 @@ +google.shopping.css.v1.HeadlineOfferSubscriptionCost + */ +class HeadlineOfferSubscriptionCost extends \Google\Protobuf\Internal\Message +{ + /** + * The type of subscription period. + * Supported values are: + * * "`month`" + * * "`year`" + * + * Generated from protobuf field .google.shopping.css.v1.SubscriptionPeriod period = 1; + */ + protected $period = 0; + /** + * The number of subscription periods the buyer has to pay. + * + * Generated from protobuf field int64 period_length = 2; + */ + protected $period_length = 0; + /** + * The amount the buyer has to pay per subscription period. + * + * Generated from protobuf field .google.shopping.type.Price amount = 3; + */ + protected $amount = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $period + * The type of subscription period. + * Supported values are: + * * "`month`" + * * "`year`" + * @type int|string $period_length + * The number of subscription periods the buyer has to pay. + * @type \Google\Shopping\Type\Price $amount + * The amount the buyer has to pay per subscription period. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Shopping\Css\V1\CssProductCommon::initOnce(); + parent::__construct($data); + } + + /** + * The type of subscription period. + * Supported values are: + * * "`month`" + * * "`year`" + * + * Generated from protobuf field .google.shopping.css.v1.SubscriptionPeriod period = 1; + * @return int + */ + public function getPeriod() + { + return $this->period; + } + + /** + * The type of subscription period. + * Supported values are: + * * "`month`" + * * "`year`" + * + * Generated from protobuf field .google.shopping.css.v1.SubscriptionPeriod period = 1; + * @param int $var + * @return $this + */ + public function setPeriod($var) + { + GPBUtil::checkEnum($var, \Google\Shopping\Css\V1\SubscriptionPeriod::class); + $this->period = $var; + + return $this; + } + + /** + * The number of subscription periods the buyer has to pay. + * + * Generated from protobuf field int64 period_length = 2; + * @return int|string + */ + public function getPeriodLength() + { + return $this->period_length; + } + + /** + * The number of subscription periods the buyer has to pay. + * + * Generated from protobuf field int64 period_length = 2; + * @param int|string $var + * @return $this + */ + public function setPeriodLength($var) + { + GPBUtil::checkInt64($var); + $this->period_length = $var; + + return $this; + } + + /** + * The amount the buyer has to pay per subscription period. + * + * Generated from protobuf field .google.shopping.type.Price amount = 3; + * @return \Google\Shopping\Type\Price|null + */ + public function getAmount() + { + return $this->amount; + } + + public function hasAmount() + { + return isset($this->amount); + } + + public function clearAmount() + { + unset($this->amount); + } + + /** + * The amount the buyer has to pay per subscription period. + * + * Generated from protobuf field .google.shopping.type.Price amount = 3; + * @param \Google\Shopping\Type\Price $var + * @return $this + */ + public function setAmount($var) + { + GPBUtil::checkMessage($var, \Google\Shopping\Type\Price::class); + $this->amount = $var; + + return $this; + } + +} + diff --git a/ShoppingCss/src/V1/SubscriptionPeriod.php b/ShoppingCss/src/V1/SubscriptionPeriod.php new file mode 100644 index 000000000000..0d83dbf1474f --- /dev/null +++ b/ShoppingCss/src/V1/SubscriptionPeriod.php @@ -0,0 +1,61 @@ +google.shopping.css.v1.SubscriptionPeriod + */ +class SubscriptionPeriod +{ + /** + * Indicates that the subscription period is unspecified. + * + * Generated from protobuf enum SUBSCRIPTION_PERIOD_UNSPECIFIED = 0; + */ + const SUBSCRIPTION_PERIOD_UNSPECIFIED = 0; + /** + * Indicates that the subscription period is month. + * + * Generated from protobuf enum MONTH = 1; + */ + const MONTH = 1; + /** + * Indicates that the subscription period is year. + * + * Generated from protobuf enum YEAR = 2; + */ + const YEAR = 2; + + private static $valueToName = [ + self::SUBSCRIPTION_PERIOD_UNSPECIFIED => 'SUBSCRIPTION_PERIOD_UNSPECIFIED', + self::MONTH => 'MONTH', + self::YEAR => 'YEAR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + From c134d3debb4e4afa724c2e769c4adaff113a3477 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 18:33:28 -0700 Subject: [PATCH 041/157] feat(spanner): Add support for Cloud Spanner Default Backup Schedules (#7762) PiperOrigin-RevId: 688946300 Source-Link: https://github.com/googleapis/googleapis/commit/b11e6b0741fc333f7d558447f2efda76db44243d Source-Link: https://github.com/googleapis/googleapis-gen/commit/f93f56b21ff01e499977c4dd54689cce1b7cf530 Copy-Tag: eyJwIjoiU3Bhbm5lci8uT3dsQm90LnlhbWwiLCJoIjoiZjkzZjU2YjIxZmYwMWU0OTk5NzdjNGRkNTQ2ODljY2UxYjdjZjUzMCJ9 --- .../Instance/V1/SpannerInstanceAdmin.php | Bin 16388 -> 16601 bytes Spanner/src/Admin/Instance/V1/Instance.php | 58 +++++++++++++++ .../V1/Instance/DefaultBackupScheduleType.php | 70 ++++++++++++++++++ 3 files changed, 128 insertions(+) create mode 100644 Spanner/src/Admin/Instance/V1/Instance/DefaultBackupScheduleType.php diff --git a/Spanner/metadata/Admin/Instance/V1/SpannerInstanceAdmin.php b/Spanner/metadata/Admin/Instance/V1/SpannerInstanceAdmin.php index 1e2e58c40e2cbb5bc005178fc1d3b852ce4d36e8..8b5e9db042db74928e64a578df25e8e81c54bec9 100644 GIT binary patch delta 225 zcmZo^V7%GLxM3m-%ky$B+sQm^iW75WHeX^X=VF@0x!Ie42a|?SK9@{NYFc7xPDy-H zVsdtAL40v?MrulFPHKEfWkIThxB{aFpOMStg)&-FdM*%^PGE(>P<0_dWt0C29?4Wn z;*!LvLP&>8!^PFjG1Mm{-pSF~J2W6Z*xAF?CDg|?J|r^0H9piYIKb7})6LV>MSwww qgNwz_-_KQmQHYm|(=jx}-`6q3(^-JY%J-F{*JOTa#mz5-WOMOo4A L?.google.spanner.admin.instance.v1.Instance.Edition edition = 20 [(.google.api.field_behavior) = OPTIONAL]; */ private $edition = 0; + /** + * Optional. Controls the default backup behavior for new databases within the + * instance. + * Note that `AUTOMATIC` is not permitted for free instances, as backups and + * backup schedules are not allowed for free instances. + * In the `GetInstance` or `ListInstances` response, if the value of + * default_backup_schedule_type is unset or NONE, no default backup + * schedule will be created for new databases within the instance. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $default_backup_schedule_type = 0; /** * Constructor. @@ -248,6 +260,14 @@ class Instance extends \Google\Protobuf\Internal\Message * Output only. The time at which the instance was most recently updated. * @type int $edition * Optional. The `Edition` of the current instance. + * @type int $default_backup_schedule_type + * Optional. Controls the default backup behavior for new databases within the + * instance. + * Note that `AUTOMATIC` is not permitted for free instances, as backups and + * backup schedules are not allowed for free instances. + * In the `GetInstance` or `ListInstances` response, if the value of + * default_backup_schedule_type is unset or NONE, no default backup + * schedule will be created for new databases within the instance. * } */ public function __construct($data = NULL) { @@ -745,5 +765,43 @@ public function setEdition($var) return $this; } + /** + * Optional. Controls the default backup behavior for new databases within the + * instance. + * Note that `AUTOMATIC` is not permitted for free instances, as backups and + * backup schedules are not allowed for free instances. + * In the `GetInstance` or `ListInstances` response, if the value of + * default_backup_schedule_type is unset or NONE, no default backup + * schedule will be created for new databases within the instance. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getDefaultBackupScheduleType() + { + return $this->default_backup_schedule_type; + } + + /** + * Optional. Controls the default backup behavior for new databases within the + * instance. + * Note that `AUTOMATIC` is not permitted for free instances, as backups and + * backup schedules are not allowed for free instances. + * In the `GetInstance` or `ListInstances` response, if the value of + * default_backup_schedule_type is unset or NONE, no default backup + * schedule will be created for new databases within the instance. + * + * Generated from protobuf field .google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType default_backup_schedule_type = 23 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setDefaultBackupScheduleType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Spanner\Admin\Instance\V1\Instance\DefaultBackupScheduleType::class); + $this->default_backup_schedule_type = $var; + + return $this; + } + } diff --git a/Spanner/src/Admin/Instance/V1/Instance/DefaultBackupScheduleType.php b/Spanner/src/Admin/Instance/V1/Instance/DefaultBackupScheduleType.php new file mode 100644 index 000000000000..ee1c54f26a01 --- /dev/null +++ b/Spanner/src/Admin/Instance/V1/Instance/DefaultBackupScheduleType.php @@ -0,0 +1,70 @@ +google.spanner.admin.instance.v1.Instance.DefaultBackupScheduleType + */ +class DefaultBackupScheduleType +{ + /** + * Not specified. + * + * Generated from protobuf enum DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0; + */ + const DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0; + /** + * No default backup schedule will be created automatically on creation of a + * database within the instance. + * + * Generated from protobuf enum NONE = 1; + */ + const NONE = 1; + /** + * A default backup schedule will be created automatically on creation of a + * database within the instance. The default backup schedule creates a full + * backup every 24 hours and retains the backup for a period of 7 days. Once + * created, the default backup schedule can be edited/deleted similar to any + * other backup schedule. + * + * Generated from protobuf enum AUTOMATIC = 2; + */ + const AUTOMATIC = 2; + + private static $valueToName = [ + self::DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED => 'DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED', + self::NONE => 'NONE', + self::AUTOMATIC => 'AUTOMATIC', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(DefaultBackupScheduleType::class, \Google\Cloud\Spanner\Admin\Instance\V1\Instance_DefaultBackupScheduleType::class); + From 4d427bf3f9b23c2d790e0d23ad0b9e842ceed691 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 18:33:57 -0700 Subject: [PATCH 042/157] feat: Updated the exponential backoff settings for the Document AI ProcessDocument and BatchProcessDocuments methods (#7757) feat: Add RESOURCE_EXHAUSTED to retryable status codes for ProcessDocument method feat: Added an url for issue reporting and api short name PiperOrigin-RevId: 688214664 Source-Link: https://github.com/googleapis/googleapis/commit/76ca663d1df1cdd8e48f45af6e84212c551533ed Source-Link: https://github.com/googleapis/googleapis-gen/commit/6ad97277430744dd9c73e7ff397dce00547d8e0c Copy-Tag: eyJwIjoiRG9jdW1lbnRBaS8uT3dsQm90LnlhbWwiLCJoIjoiNmFkOTcyNzc0MzA3NDRkZDljNzNlN2ZmMzk3ZGNlMDA1NDdkOGUwYyJ9 --- .../document_processor_service_client_config.json | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/DocumentAi/src/V1/resources/document_processor_service_client_config.json b/DocumentAi/src/V1/resources/document_processor_service_client_config.json index 30f1e5961a04..d750f74493d7 100644 --- a/DocumentAi/src/V1/resources/document_processor_service_client_config.json +++ b/DocumentAi/src/V1/resources/document_processor_service_client_config.json @@ -5,7 +5,8 @@ "no_retry_codes": [], "retry_policy_1_codes": [ "DEADLINE_EXCEEDED", - "UNAVAILABLE" + "UNAVAILABLE", + "RESOURCE_EXHAUSTED" ], "retry_policy_2_codes": [ "DEADLINE_EXCEEDED", @@ -23,17 +24,17 @@ "total_timeout_millis": 0 }, "retry_policy_1_params": { - "initial_retry_delay_millis": 100, - "retry_delay_multiplier": 1.3, - "max_retry_delay_millis": 60000, + "initial_retry_delay_millis": 1000, + "retry_delay_multiplier": 9.0, + "max_retry_delay_millis": 90000, "initial_rpc_timeout_millis": 300000, "rpc_timeout_multiplier": 1.0, "max_rpc_timeout_millis": 300000, "total_timeout_millis": 300000 }, "retry_policy_2_params": { - "initial_retry_delay_millis": 100, - "retry_delay_multiplier": 1.3, + "initial_retry_delay_millis": 1000, + "retry_delay_multiplier": 1.5, "max_retry_delay_millis": 60000, "initial_rpc_timeout_millis": 120000, "rpc_timeout_multiplier": 1.0, From c8289d51320fc3367fa1ab837c777288352f4bf3 Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Mon, 28 Oct 2024 11:08:18 -0700 Subject: [PATCH 043/157] feat: add Parallelstore V1 (#7764) --- Parallelstore/.OwlBot.yaml | 2 +- Parallelstore/metadata/V1/Parallelstore.php | Bin 0 -> 8431 bytes .../ParallelstoreClient/create_instance.php | 104 ++ .../ParallelstoreClient/delete_instance.php | 80 ++ .../V1/ParallelstoreClient/export_data.php | 83 ++ .../V1/ParallelstoreClient/get_instance.php | 72 ++ .../V1/ParallelstoreClient/get_location.php | 57 + .../V1/ParallelstoreClient/import_data.php | 83 ++ .../V1/ParallelstoreClient/list_instances.php | 80 ++ .../V1/ParallelstoreClient/list_locations.php | 62 + .../ParallelstoreClient/update_instance.php | 89 ++ .../src/V1/Client/ParallelstoreClient.php | 607 +++++++++ .../src/V1/CreateInstanceRequest.php | 273 ++++ .../src/V1/DeleteInstanceRequest.php | 155 +++ Parallelstore/src/V1/DestinationGcsBucket.php | 75 ++ .../src/V1/DestinationParallelstore.php | 71 ++ Parallelstore/src/V1/DirectoryStripeLevel.php | 68 + Parallelstore/src/V1/ExportDataMetadata.php | 351 ++++++ Parallelstore/src/V1/ExportDataRequest.php | 287 +++++ Parallelstore/src/V1/ExportDataResponse.php | 33 + Parallelstore/src/V1/FileStripeLevel.php | 68 + Parallelstore/src/V1/GetInstanceRequest.php | 86 ++ Parallelstore/src/V1/ImportDataMetadata.php | 351 ++++++ Parallelstore/src/V1/ImportDataRequest.php | 287 +++++ Parallelstore/src/V1/ImportDataResponse.php | 33 + Parallelstore/src/V1/Instance.php | 625 ++++++++++ Parallelstore/src/V1/Instance/State.php | 83 ++ Parallelstore/src/V1/ListInstancesRequest.php | 237 ++++ .../src/V1/ListInstancesResponse.php | 136 ++ Parallelstore/src/V1/OperationMetadata.php | 307 +++++ Parallelstore/src/V1/SourceGcsBucket.php | 75 ++ Parallelstore/src/V1/SourceParallelstore.php | 71 ++ Parallelstore/src/V1/TransferCounters.php | 261 ++++ .../src/V1/TransferOperationMetadata.php | 261 ++++ Parallelstore/src/V1/TransferType.php | 61 + .../src/V1/UpdateInstanceRequest.php | 225 ++++ Parallelstore/src/V1/gapic_metadata.json | 63 + .../parallelstore_client_config.json | 67 + .../parallelstore_descriptor_config.php | 197 +++ .../parallelstore_rest_client_config.php | 188 +++ .../V1/Client/ParallelstoreClientTest.php | 1111 +++++++++++++++++ 41 files changed, 7424 insertions(+), 1 deletion(-) create mode 100644 Parallelstore/metadata/V1/Parallelstore.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/create_instance.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/delete_instance.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/export_data.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/get_instance.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/get_location.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/import_data.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/list_instances.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/list_locations.php create mode 100644 Parallelstore/samples/V1/ParallelstoreClient/update_instance.php create mode 100644 Parallelstore/src/V1/Client/ParallelstoreClient.php create mode 100644 Parallelstore/src/V1/CreateInstanceRequest.php create mode 100644 Parallelstore/src/V1/DeleteInstanceRequest.php create mode 100644 Parallelstore/src/V1/DestinationGcsBucket.php create mode 100644 Parallelstore/src/V1/DestinationParallelstore.php create mode 100644 Parallelstore/src/V1/DirectoryStripeLevel.php create mode 100644 Parallelstore/src/V1/ExportDataMetadata.php create mode 100644 Parallelstore/src/V1/ExportDataRequest.php create mode 100644 Parallelstore/src/V1/ExportDataResponse.php create mode 100644 Parallelstore/src/V1/FileStripeLevel.php create mode 100644 Parallelstore/src/V1/GetInstanceRequest.php create mode 100644 Parallelstore/src/V1/ImportDataMetadata.php create mode 100644 Parallelstore/src/V1/ImportDataRequest.php create mode 100644 Parallelstore/src/V1/ImportDataResponse.php create mode 100644 Parallelstore/src/V1/Instance.php create mode 100644 Parallelstore/src/V1/Instance/State.php create mode 100644 Parallelstore/src/V1/ListInstancesRequest.php create mode 100644 Parallelstore/src/V1/ListInstancesResponse.php create mode 100644 Parallelstore/src/V1/OperationMetadata.php create mode 100644 Parallelstore/src/V1/SourceGcsBucket.php create mode 100644 Parallelstore/src/V1/SourceParallelstore.php create mode 100644 Parallelstore/src/V1/TransferCounters.php create mode 100644 Parallelstore/src/V1/TransferOperationMetadata.php create mode 100644 Parallelstore/src/V1/TransferType.php create mode 100644 Parallelstore/src/V1/UpdateInstanceRequest.php create mode 100644 Parallelstore/src/V1/gapic_metadata.json create mode 100644 Parallelstore/src/V1/resources/parallelstore_client_config.json create mode 100644 Parallelstore/src/V1/resources/parallelstore_descriptor_config.php create mode 100644 Parallelstore/src/V1/resources/parallelstore_rest_client_config.php create mode 100644 Parallelstore/tests/Unit/V1/Client/ParallelstoreClientTest.php diff --git a/Parallelstore/.OwlBot.yaml b/Parallelstore/.OwlBot.yaml index 7822dbcb99dd..b4d71bfaf41d 100644 --- a/Parallelstore/.OwlBot.yaml +++ b/Parallelstore/.OwlBot.yaml @@ -1,4 +1,4 @@ deep-copy-regex: - - source: /google/cloud/parallelstore/(v1beta)/.*-php/(.*) + - source: /google/cloud/parallelstore/(v1|v1beta)/.*-php/(.*) dest: /owl-bot-staging/Parallelstore/$1/$2 api-name: Parallelstore diff --git a/Parallelstore/metadata/V1/Parallelstore.php b/Parallelstore/metadata/V1/Parallelstore.php new file mode 100644 index 0000000000000000000000000000000000000000..0da87d8cc8afb9f56b4d726ce21300ad34db8e43 GIT binary patch literal 8431 zcmeHM&2QVt6<><6R~diL+KJ+Jh;FiDYMf<-8*;<+KK_G;_HV_ zcUl&qOZSZ+9@R!848ILX+l4S-X!zVfpMQjw&z-M$j+10qif3Xeo;g~cy&Q1V9RpB+ zh7r&6*=v!7JsK-oEeMui!_`w83L7rA_g;G|%O5I)@D3s3M3>0c#LvS@*C05$Lwx0#fD_(*1#5>e(dzKureE`gsK6)SZC7>%sV3PwWa zOc*^ORm%aa4XB0&qk4dbO}z$~o*GtU_{<05Gu`8%E$0^7E z^t+5~i&Am3KS7roh70o9?s1&yBxBmoq3eRUlk@Bn8i_a=k0AMg9P=c=V`%6|H(P{9 zelBrGO6zEd#W0>hQ@a(lQqUf4@0JQ{#f@TNeex|lijr&Pf?6qVZ%#@Wp<#8cQhZ#P zOwg6}!d8K;$aG~xEp7qL1^CRxN2SfOx=x9PawlJ@pQ3NXF^Z>G=zNh+_#WiR55X*6 z_IdDhk~Qr*FA>@2;_)PF1ZfT%#pB81Me*pZB*kO;4-%T*GCaR1D9YqVEdX%5iiSZb zz{UU~mLTH4R;xGgfU;gf7ahF`F##u4 zAjme-vH-s7`+Ci!FbK(<{yxH+Bs83`+uazj3abt1;q;$Cu{DO1LMXxaP5lArE}X6z zjW)U`@O>191M|l@EJj_L0J9;NM-Amnp*?WZZ$O(z48J?IfpQQ4JFQ?W#JZJ(uo2-O zib_fy^M;brY8FU(h-TJ_Nqo{N=o`7S!!qrPn*K=wO@-Z^7$`c6B(2TetkO{=mr;^f z4PIBdRr=Od$TeSgq4#empiEl=sARRa17&;_jnl&4@-%4bJV@tu63TcUT?*U|#i&lZ z3e#jz1Z7uRNK%){w5b3b3rpnN!sK##9!>1BiEOj(yq6g&>a2amw)*p znMg`Fk0xkGV$_KSJ&)ajlEI-G`Wk3z=FxRSKkRI1b~%O03Gzua%*~k}V_m2)MVeZ_ z@JXlj%V;{Ve%w?%{8##ziaQ|YcyPiaXgVT3h`5#FME@=_;(#zt|Hq9#jc_#bd5KMb zk%+zy!K;FBIMM)I@H3JC+3)o6NCg^M4^D6TLgIk<7KKFay>mcfSistl7`7hWAd#XS zD+y)Yk&-^h=4Su zZncAk!MSUP;P`P*?4mR2>tPq?En)qv+JqSU*R4(B6B{VW>ITfwLAA>c2pDU$+yEKl zgg4QcA0Ub5A3KCKBI7IH8jx89NEoBu<>)gBO^S#S--h9E%&xJyOxpu_8VvMgIyBUd zec}Z#DRjwn#1MPE1H*AhgJ~>NCVaPeO<_pJm(aM_U$-3two@#U@iZFc+k>|>Ddfch z8Wqw}W$+xtcUj%u-6)i`%F|Nk_zGib@nLDFT;aoO;R$$f1>f$mkIOcXuJu@t2zUk)D&@*AM$uTTqriWZ&{%9n#r=*gV!MMz zbM|(h;O!s^YR3JSYB0Y4?C)RxI+4Xo^lsxhbW1SNuZG76i;?4l#mKP%{;h;YBEv0S z?juEHuMm9Tu{(Y5rOFN?W1`a2$sU46jyD!h@Rt%AkB`i_pUvXig}`${$H*ydChSPk zCoj~w=mBcDA}aDr^(wdTEh9Kg2_IlCX3Bk(KA#_Q;be~g32Me?>Aq^lw-2c1kNc}R z9qJdE;hBE+gxZZX{Q@a~e!KwW&F}KNXs55KyhB_1bSmyEa3$b1euCP1qu;CK>tAxT? zVt+3#<&#jxLUDM5Ma1#Ot)xi^-hd=GfP+T~C*oC1>n)IeL z`UD^QX2*;-~Ql6c!hb3-;hTx)ahZG SQSWk@&UW%k?-O)_(0>5sx$5iy literal 0 HcmV?d00001 diff --git a/Parallelstore/samples/V1/ParallelstoreClient/create_instance.php b/Parallelstore/samples/V1/ParallelstoreClient/create_instance.php new file mode 100644 index 000000000000..56f45bf3e947 --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/create_instance.php @@ -0,0 +1,104 @@ +setCapacityGib($instanceCapacityGib); + $request = (new CreateInstanceRequest()) + ->setParent($formattedParent) + ->setInstanceId($instanceId) + ->setInstance($instance); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $parallelstoreClient->createInstance($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Instance $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 +{ + $formattedParent = ParallelstoreClient::locationName('[PROJECT]', '[LOCATION]'); + $instanceId = '[INSTANCE_ID]'; + $instanceCapacityGib = 0; + + create_instance_sample($formattedParent, $instanceId, $instanceCapacityGib); +} +// [END parallelstore_v1_generated_Parallelstore_CreateInstance_sync] diff --git a/Parallelstore/samples/V1/ParallelstoreClient/delete_instance.php b/Parallelstore/samples/V1/ParallelstoreClient/delete_instance.php new file mode 100644 index 000000000000..8202d349d9ba --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/delete_instance.php @@ -0,0 +1,80 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $parallelstoreClient->deleteInstance($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } 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 +{ + $formattedName = ParallelstoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + + delete_instance_sample($formattedName); +} +// [END parallelstore_v1_generated_Parallelstore_DeleteInstance_sync] diff --git a/Parallelstore/samples/V1/ParallelstoreClient/export_data.php b/Parallelstore/samples/V1/ParallelstoreClient/export_data.php new file mode 100644 index 000000000000..9a64b7551feb --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/export_data.php @@ -0,0 +1,83 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $parallelstoreClient->exportData($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var ExportDataResponse $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 +{ + $formattedName = ParallelstoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + + export_data_sample($formattedName); +} +// [END parallelstore_v1_generated_Parallelstore_ExportData_sync] diff --git a/Parallelstore/samples/V1/ParallelstoreClient/get_instance.php b/Parallelstore/samples/V1/ParallelstoreClient/get_instance.php new file mode 100644 index 000000000000..aba7bdaedf3d --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/get_instance.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Instance $response */ + $response = $parallelstoreClient->getInstance($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = ParallelstoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + + get_instance_sample($formattedName); +} +// [END parallelstore_v1_generated_Parallelstore_GetInstance_sync] diff --git a/Parallelstore/samples/V1/ParallelstoreClient/get_location.php b/Parallelstore/samples/V1/ParallelstoreClient/get_location.php new file mode 100644 index 000000000000..0950b50a4c68 --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/get_location.php @@ -0,0 +1,57 @@ +getLocation($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END parallelstore_v1_generated_Parallelstore_GetLocation_sync] diff --git a/Parallelstore/samples/V1/ParallelstoreClient/import_data.php b/Parallelstore/samples/V1/ParallelstoreClient/import_data.php new file mode 100644 index 000000000000..a4e745a904ed --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/import_data.php @@ -0,0 +1,83 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $parallelstoreClient->importData($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var ImportDataResponse $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 +{ + $formattedName = ParallelstoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + + import_data_sample($formattedName); +} +// [END parallelstore_v1_generated_Parallelstore_ImportData_sync] diff --git a/Parallelstore/samples/V1/ParallelstoreClient/list_instances.php b/Parallelstore/samples/V1/ParallelstoreClient/list_instances.php new file mode 100644 index 000000000000..8388dfa1a884 --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/list_instances.php @@ -0,0 +1,80 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $parallelstoreClient->listInstances($request); + + /** @var Instance $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = ParallelstoreClient::locationName('[PROJECT]', '[LOCATION]'); + + list_instances_sample($formattedParent); +} +// [END parallelstore_v1_generated_Parallelstore_ListInstances_sync] diff --git a/Parallelstore/samples/V1/ParallelstoreClient/list_locations.php b/Parallelstore/samples/V1/ParallelstoreClient/list_locations.php new file mode 100644 index 000000000000..05b2ed1ff36a --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/list_locations.php @@ -0,0 +1,62 @@ +listLocations($request); + + /** @var Location $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); + } + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END parallelstore_v1_generated_Parallelstore_ListLocations_sync] diff --git a/Parallelstore/samples/V1/ParallelstoreClient/update_instance.php b/Parallelstore/samples/V1/ParallelstoreClient/update_instance.php new file mode 100644 index 000000000000..a4aff2499ae7 --- /dev/null +++ b/Parallelstore/samples/V1/ParallelstoreClient/update_instance.php @@ -0,0 +1,89 @@ +setCapacityGib($instanceCapacityGib); + $request = (new UpdateInstanceRequest()) + ->setUpdateMask($updateMask) + ->setInstance($instance); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $parallelstoreClient->updateInstance($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Instance $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 +{ + $instanceCapacityGib = 0; + + update_instance_sample($instanceCapacityGib); +} +// [END parallelstore_v1_generated_Parallelstore_UpdateInstance_sync] diff --git a/Parallelstore/src/V1/Client/ParallelstoreClient.php b/Parallelstore/src/V1/Client/ParallelstoreClient.php new file mode 100644 index 000000000000..d7f7d28afc7a --- /dev/null +++ b/Parallelstore/src/V1/Client/ParallelstoreClient.php @@ -0,0 +1,607 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/parallelstore_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/parallelstore_descriptor_config.php', + 'gcpApiConfigPath' => __DIR__ . '/../resources/parallelstore_grpc_config.json', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/parallelstore_rest_client_config.php', + ], + ], + ]; + } + + /** + * Return an OperationsClient object with the same endpoint as $this. + * + * @return OperationsClient + */ + public function getOperationsClient() + { + return $this->operationsClient; + } + + /** + * Resume an existing long running operation that was previously started by a long + * running API method. If $methodName is not provided, or does not match a long + * running API method, then the operation can still be resumed, but the + * OperationResponse object will not deserialize the final response. + * + * @param string $operationName The name of the long running operation + * @param string $methodName The name of the method used to start the operation + * + * @return OperationResponse + */ + public function resumeOperation($operationName, $methodName = null) + { + $options = isset($this->descriptors[$methodName]['longRunning']) + ? $this->descriptors[$methodName]['longRunning'] + : []; + $operation = new OperationResponse($operationName, $this->getOperationsClient(), $options); + $operation->reload(); + return $operation; + } + + /** + * Create the default operation client for the service. + * + * @param array $options ClientOptions for the client. + * + * @return OperationsClient + */ + private function createOperationsClient(array $options) + { + // Unset client-specific configuration options + unset($options['serviceName'], $options['clientConfig'], $options['descriptorsConfigPath']); + + if (isset($options['operationsClient'])) { + return $options['operationsClient']; + } + + return new OperationsClient($options); + } + + /** + * Formats a string containing the fully-qualified path to represent a address + * resource. + * + * @param string $project + * @param string $region + * @param string $address + * + * @return string The formatted address resource. + */ + public static function addressName(string $project, string $region, string $address): string + { + return self::getPathTemplate('address')->render([ + 'project' => $project, + 'region' => $region, + 'address' => $address, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a instance + * resource. + * + * @param string $project + * @param string $location + * @param string $instance + * + * @return string The formatted instance resource. + */ + public static function instanceName(string $project, string $location, string $instance): string + { + return self::getPathTemplate('instance')->render([ + 'project' => $project, + 'location' => $location, + 'instance' => $instance, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a location + * resource. + * + * @param string $project + * @param string $location + * + * @return string The formatted location resource. + */ + public static function locationName(string $project, string $location): string + { + return self::getPathTemplate('location')->render([ + 'project' => $project, + 'location' => $location, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $project + * @param string $network + * + * @return string The formatted network resource. + */ + public static function networkName(string $project, string $network): string + { + return self::getPathTemplate('network')->render([ + 'project' => $project, + 'network' => $network, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * service_account resource. + * + * @param string $project + * @param string $serviceAccount + * + * @return string The formatted service_account resource. + */ + public static function serviceAccountName(string $project, string $serviceAccount): string + { + return self::getPathTemplate('serviceAccount')->render([ + 'project' => $project, + 'service_account' => $serviceAccount, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - address: projects/{project}/regions/{region}/addresses/{address} + * - instance: projects/{project}/locations/{location}/instances/{instance} + * - location: projects/{project}/locations/{location} + * - network: projects/{project}/global/networks/{network} + * - serviceAccount: projects/{project}/serviceAccounts/{service_account} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'parallelstore.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. May be either the string + * `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. + * *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'grpc' => [...], + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and + * {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + $this->operationsClient = $this->createOperationsClient($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * Creates a Parallelstore instance in a given project and location. + * + * The async variant is {@see ParallelstoreClient::createInstanceAsync()} . + * + * @example samples/V1/ParallelstoreClient/create_instance.php + * + * @param CreateInstanceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createInstance(CreateInstanceRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreateInstance', $request, $callOptions)->wait(); + } + + /** + * Deletes a single instance. + * + * The async variant is {@see ParallelstoreClient::deleteInstanceAsync()} . + * + * @example samples/V1/ParallelstoreClient/delete_instance.php + * + * @param DeleteInstanceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteInstance(DeleteInstanceRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteInstance', $request, $callOptions)->wait(); + } + + /** + * Copies data from Parallelstore to Cloud Storage. + * + * The async variant is {@see ParallelstoreClient::exportDataAsync()} . + * + * @example samples/V1/ParallelstoreClient/export_data.php + * + * @param ExportDataRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function exportData(ExportDataRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('ExportData', $request, $callOptions)->wait(); + } + + /** + * Gets details of a single instance. + * + * The async variant is {@see ParallelstoreClient::getInstanceAsync()} . + * + * @example samples/V1/ParallelstoreClient/get_instance.php + * + * @param GetInstanceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Instance + * + * @throws ApiException Thrown if the API call fails. + */ + public function getInstance(GetInstanceRequest $request, array $callOptions = []): Instance + { + return $this->startApiCall('GetInstance', $request, $callOptions)->wait(); + } + + /** + * Copies data from Cloud Storage to Parallelstore. + * + * The async variant is {@see ParallelstoreClient::importDataAsync()} . + * + * @example samples/V1/ParallelstoreClient/import_data.php + * + * @param ImportDataRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function importData(ImportDataRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('ImportData', $request, $callOptions)->wait(); + } + + /** + * Lists all instances in a given project and location. + * + * The async variant is {@see ParallelstoreClient::listInstancesAsync()} . + * + * @example samples/V1/ParallelstoreClient/list_instances.php + * + * @param ListInstancesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listInstances(ListInstancesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListInstances', $request, $callOptions); + } + + /** + * Updates the parameters of a single instance. + * + * The async variant is {@see ParallelstoreClient::updateInstanceAsync()} . + * + * @example samples/V1/ParallelstoreClient/update_instance.php + * + * @param UpdateInstanceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateInstance(UpdateInstanceRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('UpdateInstance', $request, $callOptions)->wait(); + } + + /** + * Gets information about a location. + * + * The async variant is {@see ParallelstoreClient::getLocationAsync()} . + * + * @example samples/V1/ParallelstoreClient/get_location.php + * + * @param GetLocationRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Location + * + * @throws ApiException Thrown if the API call fails. + */ + public function getLocation(GetLocationRequest $request, array $callOptions = []): Location + { + return $this->startApiCall('GetLocation', $request, $callOptions)->wait(); + } + + /** + * Lists information about the supported locations for this service. + * + * The async variant is {@see ParallelstoreClient::listLocationsAsync()} . + * + * @example samples/V1/ParallelstoreClient/list_locations.php + * + * @param ListLocationsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listLocations(ListLocationsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListLocations', $request, $callOptions); + } +} diff --git a/Parallelstore/src/V1/CreateInstanceRequest.php b/Parallelstore/src/V1/CreateInstanceRequest.php new file mode 100644 index 000000000000..602bfbf612b0 --- /dev/null +++ b/Parallelstore/src/V1/CreateInstanceRequest.php @@ -0,0 +1,273 @@ +google.cloud.parallelstore.v1.CreateInstanceRequest + */ +class CreateInstanceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The instance's project and location, in the format + * `projects/{project}/locations/{location}`. + * Locations map to Google Cloud zones; for example, `us-west1-b`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The name of the Parallelstore instance. + * * Must contain only lowercase letters, numbers, and hyphens. + * * Must start with a letter. + * * Must be between 1-63 characters. + * * Must end with a number or a letter. + * * Must be unique within the customer project / location + * + * Generated from protobuf field string instance_id = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $instance_id = ''; + /** + * Required. The instance to create. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance instance = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $instance = null; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $request_id = ''; + + /** + * @param string $parent Required. The instance's project and location, in the format + * `projects/{project}/locations/{location}`. + * Locations map to Google Cloud zones; for example, `us-west1-b`. Please see + * {@see ParallelstoreClient::locationName()} for help formatting this field. + * @param \Google\Cloud\Parallelstore\V1\Instance $instance Required. The instance to create. + * @param string $instanceId Required. The name of the Parallelstore instance. + * + * * Must contain only lowercase letters, numbers, and hyphens. + * * Must start with a letter. + * * Must be between 1-63 characters. + * * Must end with a number or a letter. + * * Must be unique within the customer project / location + * + * @return \Google\Cloud\Parallelstore\V1\CreateInstanceRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\Parallelstore\V1\Instance $instance, string $instanceId): self + { + return (new self()) + ->setParent($parent) + ->setInstance($instance) + ->setInstanceId($instanceId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The instance's project and location, in the format + * `projects/{project}/locations/{location}`. + * Locations map to Google Cloud zones; for example, `us-west1-b`. + * @type string $instance_id + * Required. The name of the Parallelstore instance. + * * Must contain only lowercase letters, numbers, and hyphens. + * * Must start with a letter. + * * Must be between 1-63 characters. + * * Must end with a number or a letter. + * * Must be unique within the customer project / location + * @type \Google\Cloud\Parallelstore\V1\Instance $instance + * Required. The instance to create. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Required. The instance's project and location, in the format + * `projects/{project}/locations/{location}`. + * Locations map to Google Cloud zones; for example, `us-west1-b`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The instance's project and location, in the format + * `projects/{project}/locations/{location}`. + * Locations map to Google Cloud zones; for example, `us-west1-b`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The name of the Parallelstore instance. + * * Must contain only lowercase letters, numbers, and hyphens. + * * Must start with a letter. + * * Must be between 1-63 characters. + * * Must end with a number or a letter. + * * Must be unique within the customer project / location + * + * Generated from protobuf field string instance_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getInstanceId() + { + return $this->instance_id; + } + + /** + * Required. The name of the Parallelstore instance. + * * Must contain only lowercase letters, numbers, and hyphens. + * * Must start with a letter. + * * Must be between 1-63 characters. + * * Must end with a number or a letter. + * * Must be unique within the customer project / location + * + * Generated from protobuf field string instance_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setInstanceId($var) + { + GPBUtil::checkString($var, True); + $this->instance_id = $var; + + return $this; + } + + /** + * Required. The instance to create. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance instance = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Parallelstore\V1\Instance|null + */ + public function getInstance() + { + return $this->instance; + } + + public function hasInstance() + { + return isset($this->instance); + } + + public function clearInstance() + { + unset($this->instance); + } + + /** + * Required. The instance to create. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance instance = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Parallelstore\V1\Instance $var + * @return $this + */ + public function setInstance($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\Instance::class); + $this->instance = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/DeleteInstanceRequest.php b/Parallelstore/src/V1/DeleteInstanceRequest.php new file mode 100644 index 000000000000..af5164d5b835 --- /dev/null +++ b/Parallelstore/src/V1/DeleteInstanceRequest.php @@ -0,0 +1,155 @@ +google.cloud.parallelstore.v1.DeleteInstanceRequest + */ +class DeleteInstanceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the resource + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $request_id = ''; + + /** + * @param string $name Required. Name of the resource + * Please see {@see ParallelstoreClient::instanceName()} for help formatting this field. + * + * @return \Google\Cloud\Parallelstore\V1\DeleteInstanceRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Name of the resource + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the resource + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the resource + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes after the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/DestinationGcsBucket.php b/Parallelstore/src/V1/DestinationGcsBucket.php new file mode 100644 index 000000000000..0acc29d59857 --- /dev/null +++ b/Parallelstore/src/V1/DestinationGcsBucket.php @@ -0,0 +1,75 @@ +google.cloud.parallelstore.v1.DestinationGcsBucket + */ +class DestinationGcsBucket extends \Google\Protobuf\Internal\Message +{ + /** + * Required. URI to a Cloud Storage bucket in the format: + * `gs:///`. The path inside the bucket is + * optional. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * Required. URI to a Cloud Storage bucket in the format: + * `gs:///`. The path inside the bucket is + * optional. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Required. URI to a Cloud Storage bucket in the format: + * `gs:///`. The path inside the bucket is + * optional. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * Required. URI to a Cloud Storage bucket in the format: + * `gs:///`. The path inside the bucket is + * optional. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/DestinationParallelstore.php b/Parallelstore/src/V1/DestinationParallelstore.php new file mode 100644 index 000000000000..79e74ab6adf9 --- /dev/null +++ b/Parallelstore/src/V1/DestinationParallelstore.php @@ -0,0 +1,71 @@ +google.cloud.parallelstore.v1.DestinationParallelstore + */ +class DestinationParallelstore extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Root directory path to the Paralellstore filesystem, starting + * with `/`. Defaults to `/` if unset. + * + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $path = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $path + * Optional. Root directory path to the Paralellstore filesystem, starting + * with `/`. Defaults to `/` if unset. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Root directory path to the Paralellstore filesystem, starting + * with `/`. Defaults to `/` if unset. + * + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPath() + { + return $this->path; + } + + /** + * Optional. Root directory path to the Paralellstore filesystem, starting + * with `/`. Defaults to `/` if unset. + * + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPath($var) + { + GPBUtil::checkString($var, True); + $this->path = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/DirectoryStripeLevel.php b/Parallelstore/src/V1/DirectoryStripeLevel.php new file mode 100644 index 000000000000..d55b9050370c --- /dev/null +++ b/Parallelstore/src/V1/DirectoryStripeLevel.php @@ -0,0 +1,68 @@ +google.cloud.parallelstore.v1.DirectoryStripeLevel + */ +class DirectoryStripeLevel +{ + /** + * If not set, DirectoryStripeLevel will default to DIRECTORY_STRIPE_LEVEL_MAX + * + * Generated from protobuf enum DIRECTORY_STRIPE_LEVEL_UNSPECIFIED = 0; + */ + const DIRECTORY_STRIPE_LEVEL_UNSPECIFIED = 0; + /** + * Minimum directory striping + * + * Generated from protobuf enum DIRECTORY_STRIPE_LEVEL_MIN = 1; + */ + const DIRECTORY_STRIPE_LEVEL_MIN = 1; + /** + * Medium directory striping + * + * Generated from protobuf enum DIRECTORY_STRIPE_LEVEL_BALANCED = 2; + */ + const DIRECTORY_STRIPE_LEVEL_BALANCED = 2; + /** + * Maximum directory striping + * + * Generated from protobuf enum DIRECTORY_STRIPE_LEVEL_MAX = 3; + */ + const DIRECTORY_STRIPE_LEVEL_MAX = 3; + + private static $valueToName = [ + self::DIRECTORY_STRIPE_LEVEL_UNSPECIFIED => 'DIRECTORY_STRIPE_LEVEL_UNSPECIFIED', + self::DIRECTORY_STRIPE_LEVEL_MIN => 'DIRECTORY_STRIPE_LEVEL_MIN', + self::DIRECTORY_STRIPE_LEVEL_BALANCED => 'DIRECTORY_STRIPE_LEVEL_BALANCED', + self::DIRECTORY_STRIPE_LEVEL_MAX => 'DIRECTORY_STRIPE_LEVEL_MAX', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/Parallelstore/src/V1/ExportDataMetadata.php b/Parallelstore/src/V1/ExportDataMetadata.php new file mode 100644 index 000000000000..946a522a2a00 --- /dev/null +++ b/Parallelstore/src/V1/ExportDataMetadata.php @@ -0,0 +1,351 @@ +google.cloud.parallelstore.v1.ExportDataMetadata + */ +class ExportDataMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Data transfer operation metadata. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferOperationMetadata operation_metadata = 1; + */ + protected $operation_metadata = null; + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $end_time = null; + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $target = ''; + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $verb = ''; + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status_message = ''; + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have successfully been cancelled + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $requested_cancellation = false; + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $api_version = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Parallelstore\V1\TransferOperationMetadata $operation_metadata + * Data transfer operation metadata. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time the operation was created. + * @type \Google\Protobuf\Timestamp $end_time + * Output only. The time the operation finished running. + * @type string $target + * Output only. Server-defined resource path for the target of the operation. + * @type string $verb + * Output only. Name of the verb executed by the operation. + * @type string $status_message + * Output only. Human-readable status of the operation, if any. + * @type bool $requested_cancellation + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have successfully been cancelled + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * @type string $api_version + * Output only. API version used to start the operation. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Data transfer operation metadata. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferOperationMetadata operation_metadata = 1; + * @return \Google\Cloud\Parallelstore\V1\TransferOperationMetadata|null + */ + public function getOperationMetadata() + { + return $this->operation_metadata; + } + + public function hasOperationMetadata() + { + return isset($this->operation_metadata); + } + + public function clearOperationMetadata() + { + unset($this->operation_metadata); + } + + /** + * Data transfer operation metadata. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferOperationMetadata operation_metadata = 1; + * @param \Google\Cloud\Parallelstore\V1\TransferOperationMetadata $var + * @return $this + */ + public function setOperationMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\TransferOperationMetadata::class); + $this->operation_metadata = $var; + + return $this; + } + + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getTarget() + { + return $this->target; + } + + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setTarget($var) + { + GPBUtil::checkString($var, True); + $this->target = $var; + + return $this; + } + + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getVerb() + { + return $this->verb; + } + + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setVerb($var) + { + GPBUtil::checkString($var, True); + $this->verb = $var; + + return $this; + } + + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getStatusMessage() + { + return $this->status_message; + } + + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setStatusMessage($var) + { + GPBUtil::checkString($var, True); + $this->status_message = $var; + + return $this; + } + + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have successfully been cancelled + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getRequestedCancellation() + { + return $this->requested_cancellation; + } + + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have successfully been cancelled + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setRequestedCancellation($var) + { + GPBUtil::checkBool($var); + $this->requested_cancellation = $var; + + return $this; + } + + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getApiVersion() + { + return $this->api_version; + } + + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setApiVersion($var) + { + GPBUtil::checkString($var, True); + $this->api_version = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/ExportDataRequest.php b/Parallelstore/src/V1/ExportDataRequest.php new file mode 100644 index 000000000000..25a1ed7d4d1e --- /dev/null +++ b/Parallelstore/src/V1/ExportDataRequest.php @@ -0,0 +1,287 @@ +google.cloud.parallelstore.v1.ExportDataRequest + */ +class ExportDataRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + /** + * Optional. User-specified Service Account (SA) credentials to be used when + * performing the transfer. + * Use one of the following formats: + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * If unspecified, the Parallelstore service agent is used: + * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + * + * Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $service_account = ''; + protected $source; + protected $destination; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Parallelstore\V1\SourceParallelstore $source_parallelstore + * Parallelstore source. + * @type \Google\Cloud\Parallelstore\V1\DestinationGcsBucket $destination_gcs_bucket + * Cloud Storage destination. + * @type string $name + * Required. Name of the resource. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * @type string $service_account + * Optional. User-specified Service Account (SA) credentials to be used when + * performing the transfer. + * Use one of the following formats: + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * If unspecified, the Parallelstore service agent is used: + * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Parallelstore source. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.SourceParallelstore source_parallelstore = 2; + * @return \Google\Cloud\Parallelstore\V1\SourceParallelstore|null + */ + public function getSourceParallelstore() + { + return $this->readOneof(2); + } + + public function hasSourceParallelstore() + { + return $this->hasOneof(2); + } + + /** + * Parallelstore source. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.SourceParallelstore source_parallelstore = 2; + * @param \Google\Cloud\Parallelstore\V1\SourceParallelstore $var + * @return $this + */ + public function setSourceParallelstore($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\SourceParallelstore::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Cloud Storage destination. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DestinationGcsBucket destination_gcs_bucket = 3; + * @return \Google\Cloud\Parallelstore\V1\DestinationGcsBucket|null + */ + public function getDestinationGcsBucket() + { + return $this->readOneof(3); + } + + public function hasDestinationGcsBucket() + { + return $this->hasOneof(3); + } + + /** + * Cloud Storage destination. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DestinationGcsBucket destination_gcs_bucket = 3; + * @param \Google\Cloud\Parallelstore\V1\DestinationGcsBucket $var + * @return $this + */ + public function setDestinationGcsBucket($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\DestinationGcsBucket::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + + /** + * Optional. User-specified Service Account (SA) credentials to be used when + * performing the transfer. + * Use one of the following formats: + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * If unspecified, the Parallelstore service agent is used: + * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + * + * Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getServiceAccount() + { + return $this->service_account; + } + + /** + * Optional. User-specified Service Account (SA) credentials to be used when + * performing the transfer. + * Use one of the following formats: + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * If unspecified, the Parallelstore service agent is used: + * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + * + * Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->service_account = $var; + + return $this; + } + + /** + * @return string + */ + public function getSource() + { + return $this->whichOneof("source"); + } + + /** + * @return string + */ + public function getDestination() + { + return $this->whichOneof("destination"); + } + +} + diff --git a/Parallelstore/src/V1/ExportDataResponse.php b/Parallelstore/src/V1/ExportDataResponse.php new file mode 100644 index 000000000000..7a2a7ca3f977 --- /dev/null +++ b/Parallelstore/src/V1/ExportDataResponse.php @@ -0,0 +1,33 @@ +google.cloud.parallelstore.v1.ExportDataResponse + */ +class ExportDataResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + +} + diff --git a/Parallelstore/src/V1/FileStripeLevel.php b/Parallelstore/src/V1/FileStripeLevel.php new file mode 100644 index 000000000000..7f349e1ef995 --- /dev/null +++ b/Parallelstore/src/V1/FileStripeLevel.php @@ -0,0 +1,68 @@ +google.cloud.parallelstore.v1.FileStripeLevel + */ +class FileStripeLevel +{ + /** + * If not set, FileStripeLevel will default to FILE_STRIPE_LEVEL_BALANCED + * + * Generated from protobuf enum FILE_STRIPE_LEVEL_UNSPECIFIED = 0; + */ + const FILE_STRIPE_LEVEL_UNSPECIFIED = 0; + /** + * Minimum file striping + * + * Generated from protobuf enum FILE_STRIPE_LEVEL_MIN = 1; + */ + const FILE_STRIPE_LEVEL_MIN = 1; + /** + * Medium file striping + * + * Generated from protobuf enum FILE_STRIPE_LEVEL_BALANCED = 2; + */ + const FILE_STRIPE_LEVEL_BALANCED = 2; + /** + * Maximum file striping + * + * Generated from protobuf enum FILE_STRIPE_LEVEL_MAX = 3; + */ + const FILE_STRIPE_LEVEL_MAX = 3; + + private static $valueToName = [ + self::FILE_STRIPE_LEVEL_UNSPECIFIED => 'FILE_STRIPE_LEVEL_UNSPECIFIED', + self::FILE_STRIPE_LEVEL_MIN => 'FILE_STRIPE_LEVEL_MIN', + self::FILE_STRIPE_LEVEL_BALANCED => 'FILE_STRIPE_LEVEL_BALANCED', + self::FILE_STRIPE_LEVEL_MAX => 'FILE_STRIPE_LEVEL_MAX', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/Parallelstore/src/V1/GetInstanceRequest.php b/Parallelstore/src/V1/GetInstanceRequest.php new file mode 100644 index 000000000000..1faa91f63398 --- /dev/null +++ b/Parallelstore/src/V1/GetInstanceRequest.php @@ -0,0 +1,86 @@ +google.cloud.parallelstore.v1.GetInstanceRequest + */ +class GetInstanceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The instance resource name, in the format + * `projects/{project_id}/locations/{location}/instances/{instance_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The instance resource name, in the format + * `projects/{project_id}/locations/{location}/instances/{instance_id}`. Please see + * {@see ParallelstoreClient::instanceName()} for help formatting this field. + * + * @return \Google\Cloud\Parallelstore\V1\GetInstanceRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The instance resource name, in the format + * `projects/{project_id}/locations/{location}/instances/{instance_id}`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Required. The instance resource name, in the format + * `projects/{project_id}/locations/{location}/instances/{instance_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The instance resource name, in the format + * `projects/{project_id}/locations/{location}/instances/{instance_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/ImportDataMetadata.php b/Parallelstore/src/V1/ImportDataMetadata.php new file mode 100644 index 000000000000..e64fbf40267f --- /dev/null +++ b/Parallelstore/src/V1/ImportDataMetadata.php @@ -0,0 +1,351 @@ +google.cloud.parallelstore.v1.ImportDataMetadata + */ +class ImportDataMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Data transfer operation metadata. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferOperationMetadata operation_metadata = 1; + */ + protected $operation_metadata = null; + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $end_time = null; + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $target = ''; + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $verb = ''; + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status_message = ''; + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have successfully been cancelled + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $requested_cancellation = false; + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $api_version = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Parallelstore\V1\TransferOperationMetadata $operation_metadata + * Data transfer operation metadata. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time the operation was created. + * @type \Google\Protobuf\Timestamp $end_time + * Output only. The time the operation finished running. + * @type string $target + * Output only. Server-defined resource path for the target of the operation. + * @type string $verb + * Output only. Name of the verb executed by the operation. + * @type string $status_message + * Output only. Human-readable status of the operation, if any. + * @type bool $requested_cancellation + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have successfully been cancelled + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * @type string $api_version + * Output only. API version used to start the operation. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Data transfer operation metadata. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferOperationMetadata operation_metadata = 1; + * @return \Google\Cloud\Parallelstore\V1\TransferOperationMetadata|null + */ + public function getOperationMetadata() + { + return $this->operation_metadata; + } + + public function hasOperationMetadata() + { + return isset($this->operation_metadata); + } + + public function clearOperationMetadata() + { + unset($this->operation_metadata); + } + + /** + * Data transfer operation metadata. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferOperationMetadata operation_metadata = 1; + * @param \Google\Cloud\Parallelstore\V1\TransferOperationMetadata $var + * @return $this + */ + public function setOperationMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\TransferOperationMetadata::class); + $this->operation_metadata = $var; + + return $this; + } + + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getTarget() + { + return $this->target; + } + + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setTarget($var) + { + GPBUtil::checkString($var, True); + $this->target = $var; + + return $this; + } + + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getVerb() + { + return $this->verb; + } + + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setVerb($var) + { + GPBUtil::checkString($var, True); + $this->verb = $var; + + return $this; + } + + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getStatusMessage() + { + return $this->status_message; + } + + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setStatusMessage($var) + { + GPBUtil::checkString($var, True); + $this->status_message = $var; + + return $this; + } + + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have successfully been cancelled + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getRequestedCancellation() + { + return $this->requested_cancellation; + } + + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have successfully been cancelled + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setRequestedCancellation($var) + { + GPBUtil::checkBool($var); + $this->requested_cancellation = $var; + + return $this; + } + + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getApiVersion() + { + return $this->api_version; + } + + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setApiVersion($var) + { + GPBUtil::checkString($var, True); + $this->api_version = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/ImportDataRequest.php b/Parallelstore/src/V1/ImportDataRequest.php new file mode 100644 index 000000000000..e9822439ab58 --- /dev/null +++ b/Parallelstore/src/V1/ImportDataRequest.php @@ -0,0 +1,287 @@ +google.cloud.parallelstore.v1.ImportDataRequest + */ +class ImportDataRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + */ + protected $request_id = ''; + /** + * Optional. User-specified service account credentials to be used when + * performing the transfer. + * Use one of the following formats: + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * If unspecified, the Parallelstore service agent is used: + * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + * + * Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $service_account = ''; + protected $source; + protected $destination; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Parallelstore\V1\SourceGcsBucket $source_gcs_bucket + * The Cloud Storage source bucket and, optionally, path inside the bucket. + * @type \Google\Cloud\Parallelstore\V1\DestinationParallelstore $destination_parallelstore + * Parallelstore destination. + * @type string $name + * Required. Name of the resource. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * @type string $service_account + * Optional. User-specified service account credentials to be used when + * performing the transfer. + * Use one of the following formats: + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * If unspecified, the Parallelstore service agent is used: + * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * The Cloud Storage source bucket and, optionally, path inside the bucket. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.SourceGcsBucket source_gcs_bucket = 2; + * @return \Google\Cloud\Parallelstore\V1\SourceGcsBucket|null + */ + public function getSourceGcsBucket() + { + return $this->readOneof(2); + } + + public function hasSourceGcsBucket() + { + return $this->hasOneof(2); + } + + /** + * The Cloud Storage source bucket and, optionally, path inside the bucket. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.SourceGcsBucket source_gcs_bucket = 2; + * @param \Google\Cloud\Parallelstore\V1\SourceGcsBucket $var + * @return $this + */ + public function setSourceGcsBucket($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\SourceGcsBucket::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Parallelstore destination. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DestinationParallelstore destination_parallelstore = 3; + * @return \Google\Cloud\Parallelstore\V1\DestinationParallelstore|null + */ + public function getDestinationParallelstore() + { + return $this->readOneof(3); + } + + public function hasDestinationParallelstore() + { + return $this->hasOneof(3); + } + + /** + * Parallelstore destination. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DestinationParallelstore destination_parallelstore = 3; + * @param \Google\Cloud\Parallelstore\V1\DestinationParallelstore $var + * @return $this + */ + public function setDestinationParallelstore($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\DestinationParallelstore::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Name of the resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + + /** + * Optional. User-specified service account credentials to be used when + * performing the transfer. + * Use one of the following formats: + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * If unspecified, the Parallelstore service agent is used: + * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + * + * Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getServiceAccount() + { + return $this->service_account; + } + + /** + * Optional. User-specified service account credentials to be used when + * performing the transfer. + * Use one of the following formats: + * * `{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * If unspecified, the Parallelstore service agent is used: + * `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + * + * Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->service_account = $var; + + return $this; + } + + /** + * @return string + */ + public function getSource() + { + return $this->whichOneof("source"); + } + + /** + * @return string + */ + public function getDestination() + { + return $this->whichOneof("destination"); + } + +} + diff --git a/Parallelstore/src/V1/ImportDataResponse.php b/Parallelstore/src/V1/ImportDataResponse.php new file mode 100644 index 000000000000..49d0ebaf5aee --- /dev/null +++ b/Parallelstore/src/V1/ImportDataResponse.php @@ -0,0 +1,33 @@ +google.cloud.parallelstore.v1.ImportDataResponse + */ +class ImportDataResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + +} + diff --git a/Parallelstore/src/V1/Instance.php b/Parallelstore/src/V1/Instance.php new file mode 100644 index 000000000000..af2dc82ba626 --- /dev/null +++ b/Parallelstore/src/V1/Instance.php @@ -0,0 +1,625 @@ +google.cloud.parallelstore.v1.Instance + */ +class Instance extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the instance, in the format + * `projects/{project}/locations/{location}/instances/{instance_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Optional. The description of the instance. 2048 characters or less. + * + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $description = ''; + /** + * Output only. The instance state. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $state = 0; + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. Cloud Labels are a flexible and lightweight mechanism for + * organizing cloud resources into groups that reflect a customer's + * organizational needs and deployment strategies. See + * https://cloud.google.com/resource-manager/docs/labels-overview for details. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Required. Immutable. The instance's storage capacity in Gibibytes (GiB). + * Allowed values are between 12000 and 100000, in multiples of 4000; e.g., + * 12000, 16000, 20000, ... + * + * Generated from protobuf field int64 capacity_gib = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + */ + protected $capacity_gib = 0; + /** + * Output only. The version of DAOS software running in the instance. + * + * Generated from protobuf field string daos_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $daos_version = ''; + /** + * Output only. A list of IPv4 addresses used for client side configuration. + * + * Generated from protobuf field repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $access_points; + /** + * Optional. Immutable. The name of the Compute Engine + * [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the + * instance is connected. + * + * Generated from protobuf field string network = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $network = ''; + /** + * Optional. Immutable. The ID of the IP address range being used by the + * instance's VPC network. See [Configure a VPC + * network](https://cloud.google.com/parallelstore/docs/vpc#create_and_configure_the_vpc). + * If no ID is provided, all ranges are considered. + * + * Generated from protobuf field string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $reserved_ip_range = ''; + /** + * Output only. Immutable. The ID of the IP address range being used by the + * instance's VPC network. This field is populated by the service and contains + * the value currently used by the service. + * + * Generated from protobuf field string effective_reserved_ip_range = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + */ + protected $effective_reserved_ip_range = ''; + /** + * Optional. Stripe level for files. Allowed values are: + * * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size + * files. + * * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads + * involving a mix of small and large files. + * * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.FileStripeLevel file_stripe_level = 15 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $file_stripe_level = 0; + /** + * Optional. Stripe level for directories. Allowed values are: + * * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a + * small number of files. + * * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads + * involving a mix of small and large directories. + * * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large + * number of files. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DirectoryStripeLevel directory_stripe_level = 16 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $directory_stripe_level = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the instance, in the format + * `projects/{project}/locations/{location}/instances/{instance_id}`. + * @type string $description + * Optional. The description of the instance. 2048 characters or less. + * @type int $state + * Output only. The instance state. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the instance was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the instance was updated. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. Cloud Labels are a flexible and lightweight mechanism for + * organizing cloud resources into groups that reflect a customer's + * organizational needs and deployment strategies. See + * https://cloud.google.com/resource-manager/docs/labels-overview for details. + * @type int|string $capacity_gib + * Required. Immutable. The instance's storage capacity in Gibibytes (GiB). + * Allowed values are between 12000 and 100000, in multiples of 4000; e.g., + * 12000, 16000, 20000, ... + * @type string $daos_version + * Output only. The version of DAOS software running in the instance. + * @type array|\Google\Protobuf\Internal\RepeatedField $access_points + * Output only. A list of IPv4 addresses used for client side configuration. + * @type string $network + * Optional. Immutable. The name of the Compute Engine + * [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the + * instance is connected. + * @type string $reserved_ip_range + * Optional. Immutable. The ID of the IP address range being used by the + * instance's VPC network. See [Configure a VPC + * network](https://cloud.google.com/parallelstore/docs/vpc#create_and_configure_the_vpc). + * If no ID is provided, all ranges are considered. + * @type string $effective_reserved_ip_range + * Output only. Immutable. The ID of the IP address range being used by the + * instance's VPC network. This field is populated by the service and contains + * the value currently used by the service. + * @type int $file_stripe_level + * Optional. Stripe level for files. Allowed values are: + * * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size + * files. + * * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads + * involving a mix of small and large files. + * * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files. + * @type int $directory_stripe_level + * Optional. Stripe level for directories. Allowed values are: + * * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a + * small number of files. + * * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads + * involving a mix of small and large directories. + * * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large + * number of files. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the instance, in the format + * `projects/{project}/locations/{location}/instances/{instance_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the instance, in the format + * `projects/{project}/locations/{location}/instances/{instance_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. The description of the instance. 2048 characters or less. + * + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDescription() + { + return $this->description; + } + + /** + * Optional. The description of the instance. 2048 characters or less. + * + * Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Output only. The instance state. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getState() + { + return $this->state; + } + + /** + * Output only. The instance state. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Parallelstore\V1\Instance\State::class); + $this->state = $var; + + return $this; + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the instance was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the instance was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. Cloud Labels are a flexible and lightweight mechanism for + * organizing cloud resources into groups that reflect a customer's + * organizational needs and deployment strategies. See + * https://cloud.google.com/resource-manager/docs/labels-overview for details. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. Cloud Labels are a flexible and lightweight mechanism for + * organizing cloud resources into groups that reflect a customer's + * organizational needs and deployment strategies. See + * https://cloud.google.com/resource-manager/docs/labels-overview for details. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Required. Immutable. The instance's storage capacity in Gibibytes (GiB). + * Allowed values are between 12000 and 100000, in multiples of 4000; e.g., + * 12000, 16000, 20000, ... + * + * Generated from protobuf field int64 capacity_gib = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + * @return int|string + */ + public function getCapacityGib() + { + return $this->capacity_gib; + } + + /** + * Required. Immutable. The instance's storage capacity in Gibibytes (GiB). + * Allowed values are between 12000 and 100000, in multiples of 4000; e.g., + * 12000, 16000, 20000, ... + * + * Generated from protobuf field int64 capacity_gib = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + * @param int|string $var + * @return $this + */ + public function setCapacityGib($var) + { + GPBUtil::checkInt64($var); + $this->capacity_gib = $var; + + return $this; + } + + /** + * Output only. The version of DAOS software running in the instance. + * + * Generated from protobuf field string daos_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getDaosVersion() + { + return $this->daos_version; + } + + /** + * Output only. The version of DAOS software running in the instance. + * + * Generated from protobuf field string daos_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setDaosVersion($var) + { + GPBUtil::checkString($var, True); + $this->daos_version = $var; + + return $this; + } + + /** + * Output only. A list of IPv4 addresses used for client side configuration. + * + * Generated from protobuf field repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAccessPoints() + { + return $this->access_points; + } + + /** + * Output only. A list of IPv4 addresses used for client side configuration. + * + * Generated from protobuf field repeated string access_points = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAccessPoints($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->access_points = $arr; + + return $this; + } + + /** + * Optional. Immutable. The name of the Compute Engine + * [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the + * instance is connected. + * + * Generated from protobuf field string network = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getNetwork() + { + return $this->network; + } + + /** + * Optional. Immutable. The name of the Compute Engine + * [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the + * instance is connected. + * + * Generated from protobuf field string network = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setNetwork($var) + { + GPBUtil::checkString($var, True); + $this->network = $var; + + return $this; + } + + /** + * Optional. Immutable. The ID of the IP address range being used by the + * instance's VPC network. See [Configure a VPC + * network](https://cloud.google.com/parallelstore/docs/vpc#create_and_configure_the_vpc). + * If no ID is provided, all ranges are considered. + * + * Generated from protobuf field string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getReservedIpRange() + { + return $this->reserved_ip_range; + } + + /** + * Optional. Immutable. The ID of the IP address range being used by the + * instance's VPC network. See [Configure a VPC + * network](https://cloud.google.com/parallelstore/docs/vpc#create_and_configure_the_vpc). + * If no ID is provided, all ranges are considered. + * + * Generated from protobuf field string reserved_ip_range = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setReservedIpRange($var) + { + GPBUtil::checkString($var, True); + $this->reserved_ip_range = $var; + + return $this; + } + + /** + * Output only. Immutable. The ID of the IP address range being used by the + * instance's VPC network. This field is populated by the service and contains + * the value currently used by the service. + * + * Generated from protobuf field string effective_reserved_ip_range = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @return string + */ + public function getEffectiveReservedIpRange() + { + return $this->effective_reserved_ip_range; + } + + /** + * Output only. Immutable. The ID of the IP address range being used by the + * instance's VPC network. This field is populated by the service and contains + * the value currently used by the service. + * + * Generated from protobuf field string effective_reserved_ip_range = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setEffectiveReservedIpRange($var) + { + GPBUtil::checkString($var, True); + $this->effective_reserved_ip_range = $var; + + return $this; + } + + /** + * Optional. Stripe level for files. Allowed values are: + * * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size + * files. + * * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads + * involving a mix of small and large files. + * * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.FileStripeLevel file_stripe_level = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getFileStripeLevel() + { + return $this->file_stripe_level; + } + + /** + * Optional. Stripe level for files. Allowed values are: + * * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size + * files. + * * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads + * involving a mix of small and large files. + * * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.FileStripeLevel file_stripe_level = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setFileStripeLevel($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Parallelstore\V1\FileStripeLevel::class); + $this->file_stripe_level = $var; + + return $this; + } + + /** + * Optional. Stripe level for directories. Allowed values are: + * * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a + * small number of files. + * * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads + * involving a mix of small and large directories. + * * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large + * number of files. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DirectoryStripeLevel directory_stripe_level = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getDirectoryStripeLevel() + { + return $this->directory_stripe_level; + } + + /** + * Optional. Stripe level for directories. Allowed values are: + * * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a + * small number of files. + * * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads + * involving a mix of small and large directories. + * * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large + * number of files. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DirectoryStripeLevel directory_stripe_level = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setDirectoryStripeLevel($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Parallelstore\V1\DirectoryStripeLevel::class); + $this->directory_stripe_level = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/Instance/State.php b/Parallelstore/src/V1/Instance/State.php new file mode 100644 index 000000000000..d0f8642ed08d --- /dev/null +++ b/Parallelstore/src/V1/Instance/State.php @@ -0,0 +1,83 @@ +google.cloud.parallelstore.v1.Instance.State + */ +class State +{ + /** + * Not set. + * + * Generated from protobuf enum STATE_UNSPECIFIED = 0; + */ + const STATE_UNSPECIFIED = 0; + /** + * The instance is being created. + * + * Generated from protobuf enum CREATING = 1; + */ + const CREATING = 1; + /** + * The instance is available for use. + * + * Generated from protobuf enum ACTIVE = 2; + */ + const ACTIVE = 2; + /** + * The instance is being deleted. + * + * Generated from protobuf enum DELETING = 3; + */ + const DELETING = 3; + /** + * The instance is not usable. + * + * Generated from protobuf enum FAILED = 4; + */ + const FAILED = 4; + /** + * The instance is being upgraded. + * + * Generated from protobuf enum UPGRADING = 5; + */ + const UPGRADING = 5; + + private static $valueToName = [ + self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', + self::CREATING => 'CREATING', + self::ACTIVE => 'ACTIVE', + self::DELETING => 'DELETING', + self::FAILED => 'FAILED', + self::UPGRADING => 'UPGRADING', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Parallelstore/src/V1/ListInstancesRequest.php b/Parallelstore/src/V1/ListInstancesRequest.php new file mode 100644 index 000000000000..0a02c88d3081 --- /dev/null +++ b/Parallelstore/src/V1/ListInstancesRequest.php @@ -0,0 +1,237 @@ +google.cloud.parallelstore.v1.ListInstancesRequest + */ +class ListInstancesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The project and location for which to retrieve instance + * information, in the format `projects/{project_id}/locations/{location}`. + * To retrieve instance information for all locations, use "-" as the value of + * `{location}`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, the server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + + /** + * @param string $parent Required. The project and location for which to retrieve instance + * information, in the format `projects/{project_id}/locations/{location}`. + * + * To retrieve instance information for all locations, use "-" as the value of + * `{location}`. Please see + * {@see ParallelstoreClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\Parallelstore\V1\ListInstancesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The project and location for which to retrieve instance + * information, in the format `projects/{project_id}/locations/{location}`. + * To retrieve instance information for all locations, use "-" as the value of + * `{location}`. + * @type int $page_size + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, the server will pick an appropriate default. + * @type string $page_token + * Optional. A token identifying a page of results the server should return. + * @type string $filter + * Optional. Filtering results. + * @type string $order_by + * Optional. Hint for how to order the results. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Required. The project and location for which to retrieve instance + * information, in the format `projects/{project_id}/locations/{location}`. + * To retrieve instance information for all locations, use "-" as the value of + * `{location}`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The project and location for which to retrieve instance + * information, in the format `projects/{project_id}/locations/{location}`. + * To retrieve instance information for all locations, use "-" as the value of + * `{location}`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, the server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. Requested page size. Server may return fewer items than + * requested. If unspecified, the server will pick an appropriate default. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A token identifying a page of results the server should return. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filtering results. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Hint for how to order the results. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/ListInstancesResponse.php b/Parallelstore/src/V1/ListInstancesResponse.php new file mode 100644 index 000000000000..c8b9fd39f5d9 --- /dev/null +++ b/Parallelstore/src/V1/ListInstancesResponse.php @@ -0,0 +1,136 @@ +google.cloud.parallelstore.v1.ListInstancesResponse + */ +class ListInstancesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The list of Parallelstore instances. + * + * Generated from protobuf field repeated .google.cloud.parallelstore.v1.Instance instances = 1; + */ + private $instances; + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Parallelstore\V1\Instance>|\Google\Protobuf\Internal\RepeatedField $instances + * The list of Parallelstore instances. + * @type string $next_page_token + * A token identifying a page of results the server should return. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Locations that could not be reached. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * The list of Parallelstore instances. + * + * Generated from protobuf field repeated .google.cloud.parallelstore.v1.Instance instances = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getInstances() + { + return $this->instances; + } + + /** + * The list of Parallelstore instances. + * + * Generated from protobuf field repeated .google.cloud.parallelstore.v1.Instance instances = 1; + * @param array<\Google\Cloud\Parallelstore\V1\Instance>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setInstances($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Parallelstore\V1\Instance::class); + $this->instances = $arr; + + return $this; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token identifying a page of results the server should return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Locations that could not be reached. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/OperationMetadata.php b/Parallelstore/src/V1/OperationMetadata.php new file mode 100644 index 000000000000..98a34bef6798 --- /dev/null +++ b/Parallelstore/src/V1/OperationMetadata.php @@ -0,0 +1,307 @@ +google.cloud.parallelstore.v1.OperationMetadata + */ +class OperationMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $end_time = null; + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $target = ''; + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $verb = ''; + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status_message = ''; + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have been cancelled successfully + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $requested_cancellation = false; + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $api_version = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time the operation was created. + * @type \Google\Protobuf\Timestamp $end_time + * Output only. The time the operation finished running. + * @type string $target + * Output only. Server-defined resource path for the target of the operation. + * @type string $verb + * Output only. Name of the verb executed by the operation. + * @type string $status_message + * Output only. Human-readable status of the operation, if any. + * @type bool $requested_cancellation + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have been cancelled successfully + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * @type string $api_version + * Output only. API version used to start the operation. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time the operation was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * Output only. The time the operation finished running. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getTarget() + { + return $this->target; + } + + /** + * Output only. Server-defined resource path for the target of the operation. + * + * Generated from protobuf field string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setTarget($var) + { + GPBUtil::checkString($var, True); + $this->target = $var; + + return $this; + } + + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getVerb() + { + return $this->verb; + } + + /** + * Output only. Name of the verb executed by the operation. + * + * Generated from protobuf field string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setVerb($var) + { + GPBUtil::checkString($var, True); + $this->verb = $var; + + return $this; + } + + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getStatusMessage() + { + return $this->status_message; + } + + /** + * Output only. Human-readable status of the operation, if any. + * + * Generated from protobuf field string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setStatusMessage($var) + { + GPBUtil::checkString($var, True); + $this->status_message = $var; + + return $this; + } + + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have been cancelled successfully + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getRequestedCancellation() + { + return $this->requested_cancellation; + } + + /** + * Output only. Identifies whether the user has requested cancellation + * of the operation. Operations that have been cancelled successfully + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. + * + * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setRequestedCancellation($var) + { + GPBUtil::checkBool($var); + $this->requested_cancellation = $var; + + return $this; + } + + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getApiVersion() + { + return $this->api_version; + } + + /** + * Output only. API version used to start the operation. + * + * Generated from protobuf field string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setApiVersion($var) + { + GPBUtil::checkString($var, True); + $this->api_version = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/SourceGcsBucket.php b/Parallelstore/src/V1/SourceGcsBucket.php new file mode 100644 index 000000000000..6b042397ff31 --- /dev/null +++ b/Parallelstore/src/V1/SourceGcsBucket.php @@ -0,0 +1,75 @@ +google.cloud.parallelstore.v1.SourceGcsBucket + */ +class SourceGcsBucket extends \Google\Protobuf\Internal\Message +{ + /** + * Required. URI to a Cloud Storage bucket in the format: + * `gs:///`. The path inside the bucket is + * optional. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * Required. URI to a Cloud Storage bucket in the format: + * `gs:///`. The path inside the bucket is + * optional. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Required. URI to a Cloud Storage bucket in the format: + * `gs:///`. The path inside the bucket is + * optional. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * Required. URI to a Cloud Storage bucket in the format: + * `gs:///`. The path inside the bucket is + * optional. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/SourceParallelstore.php b/Parallelstore/src/V1/SourceParallelstore.php new file mode 100644 index 000000000000..63a37aaeebf2 --- /dev/null +++ b/Parallelstore/src/V1/SourceParallelstore.php @@ -0,0 +1,71 @@ +google.cloud.parallelstore.v1.SourceParallelstore + */ +class SourceParallelstore extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Root directory path to the Paralellstore filesystem, starting + * with `/`. Defaults to `/` if unset. + * + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $path = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $path + * Optional. Root directory path to the Paralellstore filesystem, starting + * with `/`. Defaults to `/` if unset. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Root directory path to the Paralellstore filesystem, starting + * with `/`. Defaults to `/` if unset. + * + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPath() + { + return $this->path; + } + + /** + * Optional. Root directory path to the Paralellstore filesystem, starting + * with `/`. Defaults to `/` if unset. + * + * Generated from protobuf field string path = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPath($var) + { + GPBUtil::checkString($var, True); + $this->path = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/TransferCounters.php b/Parallelstore/src/V1/TransferCounters.php new file mode 100644 index 000000000000..9b4b96f6fd44 --- /dev/null +++ b/Parallelstore/src/V1/TransferCounters.php @@ -0,0 +1,261 @@ +google.cloud.parallelstore.v1.TransferCounters + */ +class TransferCounters extends \Google\Protobuf\Internal\Message +{ + /** + * Objects found in the data source that are scheduled to be transferred, + * excluding any that are filtered based on object conditions or skipped due + * to sync. + * + * Generated from protobuf field int64 objects_found = 1; + */ + protected $objects_found = 0; + /** + * Bytes found in the data source that are scheduled to be transferred, + * excluding any that are filtered based on object conditions or skipped due + * to sync. + * + * Generated from protobuf field int64 bytes_found = 2; + */ + protected $bytes_found = 0; + /** + * Objects in the data source that are not transferred because they already + * exist in the data destination. + * + * Generated from protobuf field int64 objects_skipped = 3; + */ + protected $objects_skipped = 0; + /** + * Bytes in the data source that are not transferred because they already + * exist in the data destination. + * + * Generated from protobuf field int64 bytes_skipped = 4; + */ + protected $bytes_skipped = 0; + /** + * Objects that are copied to the data destination. + * + * Generated from protobuf field int64 objects_copied = 5; + */ + protected $objects_copied = 0; + /** + * Bytes that are copied to the data destination. + * + * Generated from protobuf field int64 bytes_copied = 6; + */ + protected $bytes_copied = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $objects_found + * Objects found in the data source that are scheduled to be transferred, + * excluding any that are filtered based on object conditions or skipped due + * to sync. + * @type int|string $bytes_found + * Bytes found in the data source that are scheduled to be transferred, + * excluding any that are filtered based on object conditions or skipped due + * to sync. + * @type int|string $objects_skipped + * Objects in the data source that are not transferred because they already + * exist in the data destination. + * @type int|string $bytes_skipped + * Bytes in the data source that are not transferred because they already + * exist in the data destination. + * @type int|string $objects_copied + * Objects that are copied to the data destination. + * @type int|string $bytes_copied + * Bytes that are copied to the data destination. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Objects found in the data source that are scheduled to be transferred, + * excluding any that are filtered based on object conditions or skipped due + * to sync. + * + * Generated from protobuf field int64 objects_found = 1; + * @return int|string + */ + public function getObjectsFound() + { + return $this->objects_found; + } + + /** + * Objects found in the data source that are scheduled to be transferred, + * excluding any that are filtered based on object conditions or skipped due + * to sync. + * + * Generated from protobuf field int64 objects_found = 1; + * @param int|string $var + * @return $this + */ + public function setObjectsFound($var) + { + GPBUtil::checkInt64($var); + $this->objects_found = $var; + + return $this; + } + + /** + * Bytes found in the data source that are scheduled to be transferred, + * excluding any that are filtered based on object conditions or skipped due + * to sync. + * + * Generated from protobuf field int64 bytes_found = 2; + * @return int|string + */ + public function getBytesFound() + { + return $this->bytes_found; + } + + /** + * Bytes found in the data source that are scheduled to be transferred, + * excluding any that are filtered based on object conditions or skipped due + * to sync. + * + * Generated from protobuf field int64 bytes_found = 2; + * @param int|string $var + * @return $this + */ + public function setBytesFound($var) + { + GPBUtil::checkInt64($var); + $this->bytes_found = $var; + + return $this; + } + + /** + * Objects in the data source that are not transferred because they already + * exist in the data destination. + * + * Generated from protobuf field int64 objects_skipped = 3; + * @return int|string + */ + public function getObjectsSkipped() + { + return $this->objects_skipped; + } + + /** + * Objects in the data source that are not transferred because they already + * exist in the data destination. + * + * Generated from protobuf field int64 objects_skipped = 3; + * @param int|string $var + * @return $this + */ + public function setObjectsSkipped($var) + { + GPBUtil::checkInt64($var); + $this->objects_skipped = $var; + + return $this; + } + + /** + * Bytes in the data source that are not transferred because they already + * exist in the data destination. + * + * Generated from protobuf field int64 bytes_skipped = 4; + * @return int|string + */ + public function getBytesSkipped() + { + return $this->bytes_skipped; + } + + /** + * Bytes in the data source that are not transferred because they already + * exist in the data destination. + * + * Generated from protobuf field int64 bytes_skipped = 4; + * @param int|string $var + * @return $this + */ + public function setBytesSkipped($var) + { + GPBUtil::checkInt64($var); + $this->bytes_skipped = $var; + + return $this; + } + + /** + * Objects that are copied to the data destination. + * + * Generated from protobuf field int64 objects_copied = 5; + * @return int|string + */ + public function getObjectsCopied() + { + return $this->objects_copied; + } + + /** + * Objects that are copied to the data destination. + * + * Generated from protobuf field int64 objects_copied = 5; + * @param int|string $var + * @return $this + */ + public function setObjectsCopied($var) + { + GPBUtil::checkInt64($var); + $this->objects_copied = $var; + + return $this; + } + + /** + * Bytes that are copied to the data destination. + * + * Generated from protobuf field int64 bytes_copied = 6; + * @return int|string + */ + public function getBytesCopied() + { + return $this->bytes_copied; + } + + /** + * Bytes that are copied to the data destination. + * + * Generated from protobuf field int64 bytes_copied = 6; + * @param int|string $var + * @return $this + */ + public function setBytesCopied($var) + { + GPBUtil::checkInt64($var); + $this->bytes_copied = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/TransferOperationMetadata.php b/Parallelstore/src/V1/TransferOperationMetadata.php new file mode 100644 index 000000000000..0cdbf05167ac --- /dev/null +++ b/Parallelstore/src/V1/TransferOperationMetadata.php @@ -0,0 +1,261 @@ +google.cloud.parallelstore.v1.TransferOperationMetadata + */ +class TransferOperationMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The progress of the transfer operation. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferCounters counters = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $counters = null; + /** + * Output only. The type of transfer occurring. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferType transfer_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $transfer_type = 0; + protected $source; + protected $destination; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Parallelstore\V1\SourceParallelstore $source_parallelstore + * Output only. Parallelstore source. + * @type \Google\Cloud\Parallelstore\V1\SourceGcsBucket $source_gcs_bucket + * Output only. Cloud Storage source. + * @type \Google\Cloud\Parallelstore\V1\DestinationGcsBucket $destination_gcs_bucket + * Output only. Cloud Storage destination. + * @type \Google\Cloud\Parallelstore\V1\DestinationParallelstore $destination_parallelstore + * Output only. Parallelstore destination. + * @type \Google\Cloud\Parallelstore\V1\TransferCounters $counters + * Output only. The progress of the transfer operation. + * @type int $transfer_type + * Output only. The type of transfer occurring. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Parallelstore source. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.SourceParallelstore source_parallelstore = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Parallelstore\V1\SourceParallelstore|null + */ + public function getSourceParallelstore() + { + return $this->readOneof(7); + } + + public function hasSourceParallelstore() + { + return $this->hasOneof(7); + } + + /** + * Output only. Parallelstore source. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.SourceParallelstore source_parallelstore = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Parallelstore\V1\SourceParallelstore $var + * @return $this + */ + public function setSourceParallelstore($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\SourceParallelstore::class); + $this->writeOneof(7, $var); + + return $this; + } + + /** + * Output only. Cloud Storage source. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.SourceGcsBucket source_gcs_bucket = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Parallelstore\V1\SourceGcsBucket|null + */ + public function getSourceGcsBucket() + { + return $this->readOneof(8); + } + + public function hasSourceGcsBucket() + { + return $this->hasOneof(8); + } + + /** + * Output only. Cloud Storage source. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.SourceGcsBucket source_gcs_bucket = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Parallelstore\V1\SourceGcsBucket $var + * @return $this + */ + public function setSourceGcsBucket($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\SourceGcsBucket::class); + $this->writeOneof(8, $var); + + return $this; + } + + /** + * Output only. Cloud Storage destination. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DestinationGcsBucket destination_gcs_bucket = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Parallelstore\V1\DestinationGcsBucket|null + */ + public function getDestinationGcsBucket() + { + return $this->readOneof(9); + } + + public function hasDestinationGcsBucket() + { + return $this->hasOneof(9); + } + + /** + * Output only. Cloud Storage destination. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DestinationGcsBucket destination_gcs_bucket = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Parallelstore\V1\DestinationGcsBucket $var + * @return $this + */ + public function setDestinationGcsBucket($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\DestinationGcsBucket::class); + $this->writeOneof(9, $var); + + return $this; + } + + /** + * Output only. Parallelstore destination. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DestinationParallelstore destination_parallelstore = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Parallelstore\V1\DestinationParallelstore|null + */ + public function getDestinationParallelstore() + { + return $this->readOneof(10); + } + + public function hasDestinationParallelstore() + { + return $this->hasOneof(10); + } + + /** + * Output only. Parallelstore destination. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.DestinationParallelstore destination_parallelstore = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Parallelstore\V1\DestinationParallelstore $var + * @return $this + */ + public function setDestinationParallelstore($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\DestinationParallelstore::class); + $this->writeOneof(10, $var); + + return $this; + } + + /** + * Output only. The progress of the transfer operation. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferCounters counters = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Parallelstore\V1\TransferCounters|null + */ + public function getCounters() + { + return $this->counters; + } + + public function hasCounters() + { + return isset($this->counters); + } + + public function clearCounters() + { + unset($this->counters); + } + + /** + * Output only. The progress of the transfer operation. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferCounters counters = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Parallelstore\V1\TransferCounters $var + * @return $this + */ + public function setCounters($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\TransferCounters::class); + $this->counters = $var; + + return $this; + } + + /** + * Output only. The type of transfer occurring. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferType transfer_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getTransferType() + { + return $this->transfer_type; + } + + /** + * Output only. The type of transfer occurring. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.TransferType transfer_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setTransferType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Parallelstore\V1\TransferType::class); + $this->transfer_type = $var; + + return $this; + } + + /** + * @return string + */ + public function getSource() + { + return $this->whichOneof("source"); + } + + /** + * @return string + */ + public function getDestination() + { + return $this->whichOneof("destination"); + } + +} + diff --git a/Parallelstore/src/V1/TransferType.php b/Parallelstore/src/V1/TransferType.php new file mode 100644 index 000000000000..cecde2a1b640 --- /dev/null +++ b/Parallelstore/src/V1/TransferType.php @@ -0,0 +1,61 @@ +google.cloud.parallelstore.v1.TransferType + */ +class TransferType +{ + /** + * Zero is an illegal value. + * + * Generated from protobuf enum TRANSFER_TYPE_UNSPECIFIED = 0; + */ + const TRANSFER_TYPE_UNSPECIFIED = 0; + /** + * Imports to Parallelstore. + * + * Generated from protobuf enum IMPORT = 1; + */ + const IMPORT = 1; + /** + * Exports from Parallelstore. + * + * Generated from protobuf enum EXPORT = 2; + */ + const EXPORT = 2; + + private static $valueToName = [ + self::TRANSFER_TYPE_UNSPECIFIED => 'TRANSFER_TYPE_UNSPECIFIED', + self::IMPORT => 'IMPORT', + self::EXPORT => 'EXPORT', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/Parallelstore/src/V1/UpdateInstanceRequest.php b/Parallelstore/src/V1/UpdateInstanceRequest.php new file mode 100644 index 000000000000..e2e23b6223a6 --- /dev/null +++ b/Parallelstore/src/V1/UpdateInstanceRequest.php @@ -0,0 +1,225 @@ +google.cloud.parallelstore.v1.UpdateInstanceRequest + */ +class UpdateInstanceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Mask of fields to update. Field mask is used to specify the + * fields to be overwritten in the Instance resource by the update. At least + * one path must be supplied in this field. The fields specified in the + * update_mask are relative to the resource, not the full request. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + /** + * Required. The instance to update. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $instance = null; + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $request_id = ''; + + /** + * @param \Google\Cloud\Parallelstore\V1\Instance $instance Required. The instance to update. + * @param \Google\Protobuf\FieldMask $updateMask Required. Mask of fields to update. Field mask is used to specify the + * fields to be overwritten in the Instance resource by the update. At least + * one path must be supplied in this field. The fields specified in the + * update_mask are relative to the resource, not the full request. + * + * @return \Google\Cloud\Parallelstore\V1\UpdateInstanceRequest + * + * @experimental + */ + public static function build(\Google\Cloud\Parallelstore\V1\Instance $instance, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setInstance($instance) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Protobuf\FieldMask $update_mask + * Required. Mask of fields to update. Field mask is used to specify the + * fields to be overwritten in the Instance resource by the update. At least + * one path must be supplied in this field. The fields specified in the + * update_mask are relative to the resource, not the full request. + * @type \Google\Cloud\Parallelstore\V1\Instance $instance + * Required. The instance to update. + * @type string $request_id + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Parallelstore\V1\Parallelstore::initOnce(); + parent::__construct($data); + } + + /** + * Required. Mask of fields to update. Field mask is used to specify the + * fields to be overwritten in the Instance resource by the update. At least + * one path must be supplied in this field. The fields specified in the + * update_mask are relative to the resource, not the full request. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. Mask of fields to update. Field mask is used to specify the + * fields to be overwritten in the Instance resource by the update. At least + * one path must be supplied in this field. The fields specified in the + * update_mask are relative to the resource, not the full request. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * Required. The instance to update. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Parallelstore\V1\Instance|null + */ + public function getInstance() + { + return $this->instance; + } + + public function hasInstance() + { + return isset($this->instance); + } + + public function clearInstance() + { + unset($this->instance); + } + + /** + * Required. The instance to update. + * + * Generated from protobuf field .google.cloud.parallelstore.v1.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Parallelstore\V1\Instance $var + * @return $this + */ + public function setInstance($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Parallelstore\V1\Instance::class); + $this->instance = $var; + + return $this; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getRequestId() + { + return $this->request_id; + } + + /** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. + * For example, consider a situation where you make an initial request and t + * he request times out. If you make the request again with the same request + * ID, the server can check if original operation with the same request ID + * was received, and if so, will ignore the second request. This prevents + * clients from accidentally creating duplicate commitments. + * The request ID must be a valid UUID with the exception that zero UUID is + * not supported (00000000-0000-0000-0000-000000000000). + * + * Generated from protobuf field string request_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setRequestId($var) + { + GPBUtil::checkString($var, True); + $this->request_id = $var; + + return $this; + } + +} + diff --git a/Parallelstore/src/V1/gapic_metadata.json b/Parallelstore/src/V1/gapic_metadata.json new file mode 100644 index 000000000000..2eaf40bfd51c --- /dev/null +++ b/Parallelstore/src/V1/gapic_metadata.json @@ -0,0 +1,63 @@ +{ + "schema": "1.0", + "comment": "This file maps proto services\/RPCs to the corresponding library clients\/methods", + "language": "php", + "protoPackage": "google.cloud.parallelstore.v1", + "libraryPackage": "Google\\Cloud\\Parallelstore\\V1", + "services": { + "Parallelstore": { + "clients": { + "grpc": { + "libraryClient": "ParallelstoreGapicClient", + "rpcs": { + "CreateInstance": { + "methods": [ + "createInstance" + ] + }, + "DeleteInstance": { + "methods": [ + "deleteInstance" + ] + }, + "ExportData": { + "methods": [ + "exportData" + ] + }, + "GetInstance": { + "methods": [ + "getInstance" + ] + }, + "ImportData": { + "methods": [ + "importData" + ] + }, + "ListInstances": { + "methods": [ + "listInstances" + ] + }, + "UpdateInstance": { + "methods": [ + "updateInstance" + ] + }, + "GetLocation": { + "methods": [ + "getLocation" + ] + }, + "ListLocations": { + "methods": [ + "listLocations" + ] + } + } + } + } + } + } +} \ No newline at end of file diff --git a/Parallelstore/src/V1/resources/parallelstore_client_config.json b/Parallelstore/src/V1/resources/parallelstore_client_config.json new file mode 100644 index 000000000000..bc0e63dce49b --- /dev/null +++ b/Parallelstore/src/V1/resources/parallelstore_client_config.json @@ -0,0 +1,67 @@ +{ + "interfaces": { + "google.cloud.parallelstore.v1.Parallelstore": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "CreateInstance": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "DeleteInstance": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ExportData": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "GetInstance": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ImportData": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListInstances": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "UpdateInstance": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "GetLocation": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListLocations": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/Parallelstore/src/V1/resources/parallelstore_descriptor_config.php b/Parallelstore/src/V1/resources/parallelstore_descriptor_config.php new file mode 100644 index 000000000000..8f886377a798 --- /dev/null +++ b/Parallelstore/src/V1/resources/parallelstore_descriptor_config.php @@ -0,0 +1,197 @@ + [ + 'google.cloud.parallelstore.v1.Parallelstore' => [ + 'CreateInstance' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Parallelstore\V1\Instance', + 'metadataReturnType' => '\Google\Cloud\Parallelstore\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'DeleteInstance' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Protobuf\GPBEmpty', + 'metadataReturnType' => '\Google\Cloud\Parallelstore\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ExportData' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Parallelstore\V1\ExportDataResponse', + 'metadataReturnType' => '\Google\Cloud\Parallelstore\V1\ExportDataMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ImportData' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Parallelstore\V1\ImportDataResponse', + 'metadataReturnType' => '\Google\Cloud\Parallelstore\V1\ImportDataMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'UpdateInstance' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Parallelstore\V1\Instance', + 'metadataReturnType' => '\Google\Cloud\Parallelstore\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'instance.name', + 'fieldAccessors' => [ + 'getInstance', + 'getName', + ], + ], + ], + ], + 'GetInstance' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Parallelstore\V1\Instance', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListInstances' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getInstances', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Parallelstore\V1\ListInstancesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'GetLocation' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Location\Location', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + 'interfaceOverride' => 'google.cloud.location.Locations', + ], + 'ListLocations' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getLocations', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Location\ListLocationsResponse', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + 'interfaceOverride' => 'google.cloud.location.Locations', + ], + 'templateMap' => [ + 'address' => 'projects/{project}/regions/{region}/addresses/{address}', + 'instance' => 'projects/{project}/locations/{location}/instances/{instance}', + 'location' => 'projects/{project}/locations/{location}', + 'network' => 'projects/{project}/global/networks/{network}', + 'serviceAccount' => 'projects/{project}/serviceAccounts/{service_account}', + ], + ], + ], +]; diff --git a/Parallelstore/src/V1/resources/parallelstore_rest_client_config.php b/Parallelstore/src/V1/resources/parallelstore_rest_client_config.php new file mode 100644 index 000000000000..f7d9fb7afb54 --- /dev/null +++ b/Parallelstore/src/V1/resources/parallelstore_rest_client_config.php @@ -0,0 +1,188 @@ + [ + 'google.cloud.location.Locations' => [ + 'GetLocation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListLocations' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*}/locations', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + 'google.cloud.parallelstore.v1.Parallelstore' => [ + 'CreateInstance' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/instances', + 'body' => 'instance', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'instance_id', + ], + ], + 'DeleteInstance' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/instances/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ExportData' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/instances/*}:exportData', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetInstance' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/instances/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ImportData' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/instances/*}:importData', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListInstances' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/instances', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'UpdateInstance' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{instance.name=projects/*/locations/*/instances/*}', + 'body' => 'instance', + 'placeholders' => [ + 'instance.name' => [ + 'getters' => [ + 'getInstance', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], + ], + 'google.longrunning.Operations' => [ + 'CancelOperation' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}:cancel', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'DeleteOperation' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListOperations' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*}/operations', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/Parallelstore/tests/Unit/V1/Client/ParallelstoreClientTest.php b/Parallelstore/tests/Unit/V1/Client/ParallelstoreClientTest.php new file mode 100644 index 000000000000..0453788ed2cc --- /dev/null +++ b/Parallelstore/tests/Unit/V1/Client/ParallelstoreClientTest.php @@ -0,0 +1,1111 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return ParallelstoreClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new ParallelstoreClient($options); + } + + /** @test */ + public function createInstanceTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createInstanceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $description = 'description-1724546052'; + $capacityGib = 498394811; + $daosVersion = 'daosVersion-1809382982'; + $network = 'network1843485230'; + $reservedIpRange = 'reservedIpRange-1082940580'; + $effectiveReservedIpRange = 'effectiveReservedIpRange-598066492'; + $expectedResponse = new Instance(); + $expectedResponse->setName($name); + $expectedResponse->setDescription($description); + $expectedResponse->setCapacityGib($capacityGib); + $expectedResponse->setDaosVersion($daosVersion); + $expectedResponse->setNetwork($network); + $expectedResponse->setReservedIpRange($reservedIpRange); + $expectedResponse->setEffectiveReservedIpRange($effectiveReservedIpRange); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createInstanceTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $instanceId = 'instanceId-2101995259'; + $instance = new Instance(); + $instanceCapacityGib = 1813257007; + $instance->setCapacityGib($instanceCapacityGib); + $request = (new CreateInstanceRequest()) + ->setParent($formattedParent) + ->setInstanceId($instanceId) + ->setInstance($instance); + $response = $gapicClient->createInstance($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.parallelstore.v1.Parallelstore/CreateInstance', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getInstanceId(); + $this->assertProtobufEquals($instanceId, $actualValue); + $actualValue = $actualApiRequestObject->getInstance(); + $this->assertProtobufEquals($instance, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createInstanceTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createInstanceExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createInstanceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $instanceId = 'instanceId-2101995259'; + $instance = new Instance(); + $instanceCapacityGib = 1813257007; + $instance->setCapacityGib($instanceCapacityGib); + $request = (new CreateInstanceRequest()) + ->setParent($formattedParent) + ->setInstanceId($instanceId) + ->setInstance($instance); + $response = $gapicClient->createInstance($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createInstanceTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteInstanceTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteInstanceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteInstanceTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + $request = (new DeleteInstanceRequest())->setName($formattedName); + $response = $gapicClient->deleteInstance($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.parallelstore.v1.Parallelstore/DeleteInstance', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteInstanceTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteInstanceExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteInstanceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + $request = (new DeleteInstanceRequest())->setName($formattedName); + $response = $gapicClient->deleteInstance($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteInstanceTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function exportDataTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/exportDataTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new ExportDataResponse(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/exportDataTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + $request = (new ExportDataRequest())->setName($formattedName); + $response = $gapicClient->exportData($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.parallelstore.v1.Parallelstore/ExportData', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/exportDataTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function exportDataExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/exportDataTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + $request = (new ExportDataRequest())->setName($formattedName); + $response = $gapicClient->exportData($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/exportDataTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function getInstanceTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $description = 'description-1724546052'; + $capacityGib = 498394811; + $daosVersion = 'daosVersion-1809382982'; + $network = 'network1843485230'; + $reservedIpRange = 'reservedIpRange-1082940580'; + $effectiveReservedIpRange = 'effectiveReservedIpRange-598066492'; + $expectedResponse = new Instance(); + $expectedResponse->setName($name2); + $expectedResponse->setDescription($description); + $expectedResponse->setCapacityGib($capacityGib); + $expectedResponse->setDaosVersion($daosVersion); + $expectedResponse->setNetwork($network); + $expectedResponse->setReservedIpRange($reservedIpRange); + $expectedResponse->setEffectiveReservedIpRange($effectiveReservedIpRange); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + $request = (new GetInstanceRequest())->setName($formattedName); + $response = $gapicClient->getInstance($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.parallelstore.v1.Parallelstore/GetInstance', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getInstanceExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + $request = (new GetInstanceRequest())->setName($formattedName); + try { + $gapicClient->getInstance($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function importDataTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/importDataTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new ImportDataResponse(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/importDataTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + $request = (new ImportDataRequest())->setName($formattedName); + $response = $gapicClient->importData($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.parallelstore.v1.Parallelstore/ImportData', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/importDataTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function importDataExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/importDataTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]'); + $request = (new ImportDataRequest())->setName($formattedName); + $response = $gapicClient->importData($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/importDataTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function listInstancesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $instancesElement = new Instance(); + $instances = [$instancesElement]; + $expectedResponse = new ListInstancesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setInstances($instances); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListInstancesRequest())->setParent($formattedParent); + $response = $gapicClient->listInstances($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getInstances()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.parallelstore.v1.Parallelstore/ListInstances', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listInstancesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListInstancesRequest())->setParent($formattedParent); + try { + $gapicClient->listInstances($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateInstanceTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateInstanceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $description = 'description-1724546052'; + $capacityGib = 498394811; + $daosVersion = 'daosVersion-1809382982'; + $network = 'network1843485230'; + $reservedIpRange = 'reservedIpRange-1082940580'; + $effectiveReservedIpRange = 'effectiveReservedIpRange-598066492'; + $expectedResponse = new Instance(); + $expectedResponse->setName($name); + $expectedResponse->setDescription($description); + $expectedResponse->setCapacityGib($capacityGib); + $expectedResponse->setDaosVersion($daosVersion); + $expectedResponse->setNetwork($network); + $expectedResponse->setReservedIpRange($reservedIpRange); + $expectedResponse->setEffectiveReservedIpRange($effectiveReservedIpRange); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/updateInstanceTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $updateMask = new FieldMask(); + $instance = new Instance(); + $instanceCapacityGib = 1813257007; + $instance->setCapacityGib($instanceCapacityGib); + $request = (new UpdateInstanceRequest())->setUpdateMask($updateMask)->setInstance($instance); + $response = $gapicClient->updateInstance($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.parallelstore.v1.Parallelstore/UpdateInstance', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $actualValue = $actualApiRequestObject->getInstance(); + $this->assertProtobufEquals($instance, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateInstanceTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function updateInstanceExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateInstanceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $updateMask = new FieldMask(); + $instance = new Instance(); + $instanceCapacityGib = 1813257007; + $instance->setCapacityGib($instanceCapacityGib); + $request = (new UpdateInstanceRequest())->setUpdateMask($updateMask)->setInstance($instance); + $response = $gapicClient->updateInstance($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateInstanceTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function getLocationTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $locationId = 'locationId552319461'; + $displayName = 'displayName1615086568'; + $expectedResponse = new Location(); + $expectedResponse->setName($name2); + $expectedResponse->setLocationId($locationId); + $expectedResponse->setDisplayName($displayName); + $transport->addResponse($expectedResponse); + $request = new GetLocationRequest(); + $response = $gapicClient->getLocation($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.location.Locations/GetLocation', $actualFuncCall); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getLocationExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + $request = new GetLocationRequest(); + try { + $gapicClient->getLocation($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listLocationsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $locationsElement = new Location(); + $locations = [$locationsElement]; + $expectedResponse = new ListLocationsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setLocations($locations); + $transport->addResponse($expectedResponse); + $request = new ListLocationsRequest(); + $response = $gapicClient->listLocations($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getLocations()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.location.Locations/ListLocations', $actualFuncCall); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listLocationsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + $request = new ListLocationsRequest(); + try { + $gapicClient->listLocations($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function createInstanceAsyncTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createInstanceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $description = 'description-1724546052'; + $capacityGib = 498394811; + $daosVersion = 'daosVersion-1809382982'; + $network = 'network1843485230'; + $reservedIpRange = 'reservedIpRange-1082940580'; + $effectiveReservedIpRange = 'effectiveReservedIpRange-598066492'; + $expectedResponse = new Instance(); + $expectedResponse->setName($name); + $expectedResponse->setDescription($description); + $expectedResponse->setCapacityGib($capacityGib); + $expectedResponse->setDaosVersion($daosVersion); + $expectedResponse->setNetwork($network); + $expectedResponse->setReservedIpRange($reservedIpRange); + $expectedResponse->setEffectiveReservedIpRange($effectiveReservedIpRange); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createInstanceTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $instanceId = 'instanceId-2101995259'; + $instance = new Instance(); + $instanceCapacityGib = 1813257007; + $instance->setCapacityGib($instanceCapacityGib); + $request = (new CreateInstanceRequest()) + ->setParent($formattedParent) + ->setInstanceId($instanceId) + ->setInstance($instance); + $response = $gapicClient->createInstanceAsync($request)->wait(); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.parallelstore.v1.Parallelstore/CreateInstance', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getInstanceId(); + $this->assertProtobufEquals($instanceId, $actualValue); + $actualValue = $actualApiRequestObject->getInstance(); + $this->assertProtobufEquals($instance, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createInstanceTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } +} From 9b4de9431c6774156ac0a58271fd0355f7d3004f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Mendoza?= Date: Mon, 28 Oct 2024 15:10:25 -0400 Subject: [PATCH 044/157] feat: introduce AdManager component (#7767) --- .repo-metadata-full.json | 8 + AdsAdManager/.OwlBot.yaml | 4 + AdsAdManager/.gitattributes | 7 + AdsAdManager/.github/pull_request_template.md | 24 + AdsAdManager/CONTRIBUTING.md | 10 + AdsAdManager/LICENSE | 202 + AdsAdManager/README.md | 45 + AdsAdManager/VERSION | 1 + AdsAdManager/composer.json | 30 + AdsAdManager/metadata/V1/AdUnitEnums.php | Bin 0 -> 1115 bytes AdsAdManager/metadata/V1/AdUnitMessages.php | Bin 0 -> 3739 bytes AdsAdManager/metadata/V1/AdUnitService.php | 67 + AdsAdManager/metadata/V1/AdmanagerError.php | 37 + AdsAdManager/metadata/V1/AppliedLabel.php | 33 + .../metadata/V1/CompanyCreditStatusEnum.php | Bin 0 -> 1005 bytes AdsAdManager/metadata/V1/CompanyMessages.php | Bin 0 -> 2216 bytes AdsAdManager/metadata/V1/CompanyService.php | 53 + AdsAdManager/metadata/V1/CompanyTypeEnum.php | Bin 0 -> 968 bytes AdsAdManager/metadata/V1/ContactMessages.php | 34 + AdsAdManager/metadata/V1/CustomFieldEnums.php | Bin 0 -> 1388 bytes .../metadata/V1/CustomFieldMessages.php | 46 + .../metadata/V1/CustomFieldService.php | 52 + AdsAdManager/metadata/V1/CustomFieldValue.php | Bin 0 -> 1252 bytes .../metadata/V1/CustomTargetingKeyEnums.php | Bin 0 -> 1285 bytes .../V1/CustomTargetingKeyMessages.php | 39 + .../metadata/V1/CustomTargetingKeyService.php | 53 + .../metadata/V1/CustomTargetingValueEnums.php | Bin 0 -> 1200 bytes .../V1/CustomTargetingValueMessages.php | 38 + .../V1/CustomTargetingValueService.php | 53 + .../V1/EntitySignalsMappingMessages.php | Bin 0 -> 1411 bytes .../V1/EntitySignalsMappingService.php | 73 + .../metadata/V1/EnvironmentTypeEnum.php | Bin 0 -> 942 bytes AdsAdManager/metadata/V1/FrequencyCap.php | Bin 0 -> 1071 bytes AdsAdManager/metadata/V1/LabelMessages.php | 32 + AdsAdManager/metadata/V1/NetworkMessages.php | 44 + AdsAdManager/metadata/V1/NetworkService.php | 42 + AdsAdManager/metadata/V1/OrderEnums.php | Bin 0 -> 966 bytes AdsAdManager/metadata/V1/OrderMessages.php | 79 + AdsAdManager/metadata/V1/OrderService.php | 53 + AdsAdManager/metadata/V1/PlacementEnums.php | Bin 0 -> 929 bytes .../metadata/V1/PlacementMessages.php | 43 + AdsAdManager/metadata/V1/PlacementService.php | 53 + AdsAdManager/metadata/V1/ReportService.php | Bin 0 -> 35098 bytes AdsAdManager/metadata/V1/RoleEnums.php | Bin 0 -> 880 bytes AdsAdManager/metadata/V1/RoleMessages.php | 38 + AdsAdManager/metadata/V1/RoleService.php | 52 + AdsAdManager/metadata/V1/Size.php | 33 + AdsAdManager/metadata/V1/SizeTypeEnum.php | Bin 0 -> 958 bytes .../metadata/V1/TaxonomyCategoryMessages.php | 40 + .../metadata/V1/TaxonomyCategoryService.php | 52 + AdsAdManager/metadata/V1/TaxonomyTypeEnum.php | Bin 0 -> 1055 bytes AdsAdManager/metadata/V1/TeamMessages.php | 33 + AdsAdManager/metadata/V1/TimeUnitEnum.php | Bin 0 -> 950 bytes AdsAdManager/metadata/V1/UserMessages.php | 42 + AdsAdManager/metadata/V1/UserService.php | 37 + AdsAdManager/owlbot.py | 56 + AdsAdManager/phpunit.xml.dist | 16 + .../V1/AdUnitServiceClient/get_ad_unit.php | 72 + .../list_ad_unit_sizes.php | 75 + .../V1/AdUnitServiceClient/list_ad_units.php | 75 + .../V1/CompanyServiceClient/get_company.php | 72 + .../CompanyServiceClient/list_companies.php | 75 + .../get_custom_field.php | 72 + .../list_custom_fields.php | 75 + .../get_custom_targeting_key.php | 76 + .../list_custom_targeting_keys.php | 75 + .../get_custom_targeting_value.php | 77 + .../list_custom_targeting_values.php | 79 + .../batch_create_entity_signals_mappings.php | 99 + .../batch_update_entity_signals_mappings.php | 95 + .../create_entity_signals_mapping.php | 84 + .../get_entity_signals_mapping.php | 76 + .../list_entity_signals_mappings.php | 75 + .../update_entity_signals_mapping.php | 78 + .../V1/NetworkServiceClient/get_network.php | 72 + .../V1/NetworkServiceClient/list_networks.php | 57 + .../V1/OrderServiceClient/get_order.php | 72 + .../V1/OrderServiceClient/list_orders.php | 80 + .../PlacementServiceClient/get_placement.php | 72 + .../list_placements.php | 75 + .../V1/ReportServiceClient/create_report.php | 105 + .../fetch_report_result_rows.php | 60 + .../V1/ReportServiceClient/get_report.php | 72 + .../V1/ReportServiceClient/list_reports.php | 75 + .../V1/ReportServiceClient/run_report.php | 91 + .../V1/ReportServiceClient/update_report.php | 101 + .../samples/V1/RoleServiceClient/get_role.php | 72 + .../V1/RoleServiceClient/list_roles.php | 75 + .../get_taxonomy_category.php | 75 + .../list_taxonomy_categories.php | 75 + .../samples/V1/UserServiceClient/get_user.php | 75 + AdsAdManager/src/V1/AdManagerError.php | 241 + AdsAdManager/src/V1/AdUnit.php | 1049 +++++ AdsAdManager/src/V1/AdUnitParent.php | 143 + AdsAdManager/src/V1/AdUnitSize.php | 153 + AdsAdManager/src/V1/AdUnitStatusEnum.php | 34 + .../src/V1/AdUnitStatusEnum/AdUnitStatus.php | 69 + AdsAdManager/src/V1/AppliedLabel.php | 105 + ...atchCreateEntitySignalsMappingsRequest.php | 132 + ...tchCreateEntitySignalsMappingsResponse.php | 67 + ...atchUpdateEntitySignalsMappingsRequest.php | 132 + ...tchUpdateEntitySignalsMappingsResponse.php | 67 + .../src/V1/Client/AdUnitServiceClient.php | 317 ++ .../src/V1/Client/CompanyServiceClient.php | 289 ++ .../V1/Client/CustomFieldServiceClient.php | 289 ++ .../CustomTargetingKeyServiceClient.php | 296 ++ .../CustomTargetingValueServiceClient.php | 303 ++ .../EntitySignalsMappingServiceClient.php | 424 ++ .../src/V1/Client/NetworkServiceClient.php | 271 ++ .../src/V1/Client/OrderServiceClient.php | 294 ++ .../src/V1/Client/PlacementServiceClient.php | 289 ++ .../src/V1/Client/ReportServiceClient.php | 471 ++ .../src/V1/Client/RoleServiceClient.php | 289 ++ .../Client/TaxonomyCategoryServiceClient.php | 294 ++ .../src/V1/Client/UserServiceClient.php | 247 + AdsAdManager/src/V1/Company.php | 649 +++ .../src/V1/CompanyCreditStatusEnum.php | 34 + .../CompanyCreditStatus.php | 117 + AdsAdManager/src/V1/CompanyTypeEnum.php | 34 + .../src/V1/CompanyTypeEnum/CompanyType.php | 84 + AdsAdManager/src/V1/Contact.php | 112 + .../V1/CreateEntitySignalsMappingRequest.php | 132 + AdsAdManager/src/V1/CreateReportRequest.php | 132 + AdsAdManager/src/V1/CustomField.php | 355 ++ .../src/V1/CustomFieldDataTypeEnum.php | 34 + .../CustomFieldDataType.php | 77 + .../src/V1/CustomFieldEntityTypeEnum.php | 34 + .../CustomFieldEntityType.php | 83 + AdsAdManager/src/V1/CustomFieldOption.php | 105 + AdsAdManager/src/V1/CustomFieldStatusEnum.php | 34 + .../CustomFieldStatus.php | 62 + AdsAdManager/src/V1/CustomFieldValue.php | 115 + .../src/V1/CustomFieldValue/Value.php | 176 + .../src/V1/CustomFieldVisibilityEnum.php | 34 + .../CustomFieldVisibility.php | 70 + AdsAdManager/src/V1/CustomTargetingKey.php | 295 ++ .../CustomTargetingKeyReportableTypeEnum.php | 34 + .../CustomTargetingKeyReportableType.php | 69 + .../src/V1/CustomTargetingKeyStatusEnum.php | 34 + .../CustomTargetingKeyStatus.php | 62 + .../src/V1/CustomTargetingKeyTypeEnum.php | 34 + .../CustomTargetingKeyType.php | 62 + AdsAdManager/src/V1/CustomTargetingValue.php | 231 + .../V1/CustomTargetingValueMatchTypeEnum.php | 34 + .../CustomTargetingValueMatchType.php | 111 + .../src/V1/CustomTargetingValueStatusEnum.php | 34 + .../CustomTargetingValueStatus.php | 62 + AdsAdManager/src/V1/EntitySignalsMapping.php | 255 + AdsAdManager/src/V1/EnvironmentTypeEnum.php | 34 + .../EnvironmentTypeEnum/EnvironmentType.php | 62 + .../src/V1/FetchReportResultRowsRequest.php | 170 + .../src/V1/FetchReportResultRowsResponse.php | 283 ++ AdsAdManager/src/V1/FrequencyCap.php | 165 + AdsAdManager/src/V1/GetAdUnitRequest.php | 86 + AdsAdManager/src/V1/GetCompanyRequest.php | 86 + AdsAdManager/src/V1/GetCustomFieldRequest.php | 86 + .../src/V1/GetCustomTargetingKeyRequest.php | 91 + .../src/V1/GetCustomTargetingValueRequest.php | 91 + .../src/V1/GetEntitySignalsMappingRequest.php | 91 + AdsAdManager/src/V1/GetNetworkRequest.php | 86 + AdsAdManager/src/V1/GetOrderRequest.php | 86 + AdsAdManager/src/V1/GetPlacementRequest.php | 86 + AdsAdManager/src/V1/GetReportRequest.php | 86 + AdsAdManager/src/V1/GetRoleRequest.php | 86 + .../src/V1/GetTaxonomyCategoryRequest.php | 86 + AdsAdManager/src/V1/GetUserRequest.php | 86 + AdsAdManager/src/V1/Label.php | 71 + AdsAdManager/src/V1/LabelFrequencyCap.php | 115 + .../src/V1/ListAdUnitSizesRequest.php | 296 ++ .../src/V1/ListAdUnitSizesResponse.php | 171 + AdsAdManager/src/V1/ListAdUnitsRequest.php | 296 ++ AdsAdManager/src/V1/ListAdUnitsResponse.php | 171 + AdsAdManager/src/V1/ListCompaniesRequest.php | 296 ++ AdsAdManager/src/V1/ListCompaniesResponse.php | 172 + .../src/V1/ListCustomFieldsRequest.php | 296 ++ .../src/V1/ListCustomFieldsResponse.php | 172 + .../src/V1/ListCustomTargetingKeysRequest.php | 296 ++ .../V1/ListCustomTargetingKeysResponse.php | 172 + .../V1/ListCustomTargetingValuesRequest.php | 309 ++ .../V1/ListCustomTargetingValuesResponse.php | 172 + .../V1/ListEntitySignalsMappingsRequest.php | 304 ++ .../V1/ListEntitySignalsMappingsResponse.php | 172 + AdsAdManager/src/V1/ListNetworksRequest.php | 33 + AdsAdManager/src/V1/ListNetworksResponse.php | 67 + AdsAdManager/src/V1/ListOrdersRequest.php | 296 ++ AdsAdManager/src/V1/ListOrdersResponse.php | 172 + AdsAdManager/src/V1/ListPlacementsRequest.php | 296 ++ .../src/V1/ListPlacementsResponse.php | 172 + AdsAdManager/src/V1/ListReportsRequest.php | 296 ++ AdsAdManager/src/V1/ListReportsResponse.php | 172 + AdsAdManager/src/V1/ListRolesRequest.php | 292 ++ AdsAdManager/src/V1/ListRolesResponse.php | 171 + .../src/V1/ListTaxonomyCategoriesRequest.php | 296 ++ .../src/V1/ListTaxonomyCategoriesResponse.php | 172 + AdsAdManager/src/V1/Network.php | 393 ++ AdsAdManager/src/V1/Order.php | 1169 +++++ AdsAdManager/src/V1/OrderStatusEnum.php | 34 + .../src/V1/OrderStatusEnum/OrderStatus.php | 100 + AdsAdManager/src/V1/Placement.php | 339 ++ AdsAdManager/src/V1/PlacementStatusEnum.php | 34 + .../PlacementStatusEnum/PlacementStatus.php | 69 + AdsAdManager/src/V1/Report.php | 391 ++ AdsAdManager/src/V1/Report/DataTable.php | 34 + .../V1/Report/DataTable/MetricValueGroup.php | 287 ++ AdsAdManager/src/V1/Report/DataTable/Row.php | 134 + AdsAdManager/src/V1/Report/DateRange.php | 109 + .../V1/Report/DateRange/FixedDateRange.php | 122 + .../V1/Report/DateRange/RelativeDateRange.php | 276 ++ AdsAdManager/src/V1/Report/Dimension.php | 4169 +++++++++++++++++ AdsAdManager/src/V1/Report/Field.php | 109 + AdsAdManager/src/V1/Report/Filter.php | 175 + .../src/V1/Report/Filter/FieldFilter.php | 286 ++ .../src/V1/Report/Filter/FilterList.php | 68 + .../src/V1/Report/Filter/Operation.php | 132 + AdsAdManager/src/V1/Report/Flag.php | 118 + AdsAdManager/src/V1/Report/Metric.php | 1306 ++++++ .../src/V1/Report/MetricValueType.php | 83 + AdsAdManager/src/V1/Report/ReportType.php | 55 + AdsAdManager/src/V1/Report/Slice.php | 114 + AdsAdManager/src/V1/Report/Sort.php | 252 + .../src/V1/Report/TimePeriodColumn.php | 76 + AdsAdManager/src/V1/Report/Value.php | 274 ++ AdsAdManager/src/V1/Report/Value/IntList.php | 68 + .../src/V1/Report/Value/StringList.php | 68 + AdsAdManager/src/V1/Report/Visibility.php | 65 + AdsAdManager/src/V1/ReportDefinition.php | 667 +++ AdsAdManager/src/V1/Role.php | 241 + AdsAdManager/src/V1/RoleStatusEnum.php | 34 + .../src/V1/RoleStatusEnum/RoleStatus.php | 62 + AdsAdManager/src/V1/RunReportMetadata.php | 105 + AdsAdManager/src/V1/RunReportRequest.php | 86 + AdsAdManager/src/V1/RunReportResponse.php | 71 + AdsAdManager/src/V1/Schedule.php | 306 ++ AdsAdManager/src/V1/Schedule/Frequency.php | 97 + .../src/V1/Schedule/MonthlySchedule.php | 72 + .../src/V1/Schedule/WeeklySchedule.php | 68 + AdsAdManager/src/V1/ScheduleOptions.php | 149 + .../V1/ScheduleOptions/DeliveryCondition.php | 62 + AdsAdManager/src/V1/Size.php | 163 + AdsAdManager/src/V1/SizeTypeEnum.php | 34 + AdsAdManager/src/V1/SizeTypeEnum/SizeType.php | 103 + AdsAdManager/src/V1/SmartSizeModeEnum.php | 34 + .../V1/SmartSizeModeEnum/SmartSizeMode.php | 70 + AdsAdManager/src/V1/TargetWindowEnum.php | 34 + .../src/V1/TargetWindowEnum/TargetWindow.php | 63 + AdsAdManager/src/V1/TaxonomyCategory.php | 317 ++ AdsAdManager/src/V1/TaxonomyTypeEnum.php | 34 + .../src/V1/TaxonomyTypeEnum/TaxonomyType.php | 84 + AdsAdManager/src/V1/Team.php | 109 + AdsAdManager/src/V1/TimeUnitEnum.php | 33 + AdsAdManager/src/V1/TimeUnitEnum/TimeUnit.php | 105 + .../V1/UpdateEntitySignalsMappingRequest.php | 157 + AdsAdManager/src/V1/UpdateReportRequest.php | 136 + AdsAdManager/src/V1/User.php | 379 ++ AdsAdManager/src/V1/gapic_metadata.json | 296 ++ .../ad_unit_service_client_config.json | 37 + .../ad_unit_service_descriptor_config.php | 84 + .../ad_unit_service_rest_client_config.php | 81 + .../company_service_client_config.json | 32 + .../company_service_descriptor_config.php | 64 + .../company_service_rest_client_config.php | 70 + .../custom_field_service_client_config.json | 32 + ...custom_field_service_descriptor_config.php | 64 + ...ustom_field_service_rest_client_config.php | 70 + ...m_targeting_key_service_client_config.json | 32 + ...argeting_key_service_descriptor_config.php | 64 + ...rgeting_key_service_rest_client_config.php | 70 + ...targeting_value_service_client_config.json | 32 + ...geting_value_service_descriptor_config.php | 64 + ...eting_value_service_rest_client_config.php | 70 + ...signals_mapping_service_client_config.json | 52 + ...nals_mapping_service_descriptor_config.php | 113 + ...als_mapping_service_rest_client_config.php | 122 + .../network_service_client_config.json | 32 + .../network_service_descriptor_config.php | 47 + .../network_service_rest_client_config.php | 63 + .../order_service_client_config.json | 44 + .../order_service_descriptor_config.php | 64 + .../order_service_rest_client_config.php | 70 + .../placement_service_client_config.json | 32 + .../placement_service_descriptor_config.php | 64 + .../placement_service_rest_client_config.php | 70 + .../report_service_client_config.json | 52 + .../report_service_descriptor_config.php | 120 + .../report_service_rest_client_config.php | 121 + .../resources/role_service_client_config.json | 32 + .../role_service_descriptor_config.php | 64 + .../role_service_rest_client_config.php | 70 + ...xonomy_category_service_client_config.json | 32 + ...omy_category_service_descriptor_config.php | 64 + ...my_category_service_rest_client_config.php | 70 + .../resources/user_service_client_config.json | 27 + .../user_service_descriptor_config.php | 43 + .../user_service_rest_client_config.php | 59 + .../V1/Client/AdUnitServiceClientTest.php | 348 ++ .../V1/Client/CompanyServiceClientTest.php | 272 ++ .../Client/CustomFieldServiceClientTest.php | 244 + .../CustomTargetingKeyServiceClientTest.php | 247 + .../CustomTargetingValueServiceClientTest.php | 261 ++ .../EntitySignalsMappingServiceClientTest.php | 561 +++ .../V1/Client/NetworkServiceClientTest.php | 248 + .../Unit/V1/Client/OrderServiceClientTest.php | 292 ++ .../V1/Client/PlacementServiceClientTest.php | 248 + .../V1/Client/ReportServiceClientTest.php | 646 +++ .../Unit/V1/Client/RoleServiceClientTest.php | 248 + .../TaxonomyCategoryServiceClientTest.php | 248 + .../Unit/V1/Client/UserServiceClientTest.php | 189 + composer.json | 5 +- 308 files changed, 43635 insertions(+), 1 deletion(-) create mode 100644 AdsAdManager/.OwlBot.yaml create mode 100644 AdsAdManager/.gitattributes create mode 100644 AdsAdManager/.github/pull_request_template.md create mode 100644 AdsAdManager/CONTRIBUTING.md create mode 100644 AdsAdManager/LICENSE create mode 100644 AdsAdManager/README.md create mode 100644 AdsAdManager/VERSION create mode 100644 AdsAdManager/composer.json create mode 100644 AdsAdManager/metadata/V1/AdUnitEnums.php create mode 100644 AdsAdManager/metadata/V1/AdUnitMessages.php create mode 100644 AdsAdManager/metadata/V1/AdUnitService.php create mode 100644 AdsAdManager/metadata/V1/AdmanagerError.php create mode 100644 AdsAdManager/metadata/V1/AppliedLabel.php create mode 100644 AdsAdManager/metadata/V1/CompanyCreditStatusEnum.php create mode 100644 AdsAdManager/metadata/V1/CompanyMessages.php create mode 100644 AdsAdManager/metadata/V1/CompanyService.php create mode 100644 AdsAdManager/metadata/V1/CompanyTypeEnum.php create mode 100644 AdsAdManager/metadata/V1/ContactMessages.php create mode 100644 AdsAdManager/metadata/V1/CustomFieldEnums.php create mode 100644 AdsAdManager/metadata/V1/CustomFieldMessages.php create mode 100644 AdsAdManager/metadata/V1/CustomFieldService.php create mode 100644 AdsAdManager/metadata/V1/CustomFieldValue.php create mode 100644 AdsAdManager/metadata/V1/CustomTargetingKeyEnums.php create mode 100644 AdsAdManager/metadata/V1/CustomTargetingKeyMessages.php create mode 100644 AdsAdManager/metadata/V1/CustomTargetingKeyService.php create mode 100644 AdsAdManager/metadata/V1/CustomTargetingValueEnums.php create mode 100644 AdsAdManager/metadata/V1/CustomTargetingValueMessages.php create mode 100644 AdsAdManager/metadata/V1/CustomTargetingValueService.php create mode 100644 AdsAdManager/metadata/V1/EntitySignalsMappingMessages.php create mode 100644 AdsAdManager/metadata/V1/EntitySignalsMappingService.php create mode 100644 AdsAdManager/metadata/V1/EnvironmentTypeEnum.php create mode 100644 AdsAdManager/metadata/V1/FrequencyCap.php create mode 100644 AdsAdManager/metadata/V1/LabelMessages.php create mode 100644 AdsAdManager/metadata/V1/NetworkMessages.php create mode 100644 AdsAdManager/metadata/V1/NetworkService.php create mode 100644 AdsAdManager/metadata/V1/OrderEnums.php create mode 100644 AdsAdManager/metadata/V1/OrderMessages.php create mode 100644 AdsAdManager/metadata/V1/OrderService.php create mode 100644 AdsAdManager/metadata/V1/PlacementEnums.php create mode 100644 AdsAdManager/metadata/V1/PlacementMessages.php create mode 100644 AdsAdManager/metadata/V1/PlacementService.php create mode 100644 AdsAdManager/metadata/V1/ReportService.php create mode 100644 AdsAdManager/metadata/V1/RoleEnums.php create mode 100644 AdsAdManager/metadata/V1/RoleMessages.php create mode 100644 AdsAdManager/metadata/V1/RoleService.php create mode 100644 AdsAdManager/metadata/V1/Size.php create mode 100644 AdsAdManager/metadata/V1/SizeTypeEnum.php create mode 100644 AdsAdManager/metadata/V1/TaxonomyCategoryMessages.php create mode 100644 AdsAdManager/metadata/V1/TaxonomyCategoryService.php create mode 100644 AdsAdManager/metadata/V1/TaxonomyTypeEnum.php create mode 100644 AdsAdManager/metadata/V1/TeamMessages.php create mode 100644 AdsAdManager/metadata/V1/TimeUnitEnum.php create mode 100644 AdsAdManager/metadata/V1/UserMessages.php create mode 100644 AdsAdManager/metadata/V1/UserService.php create mode 100644 AdsAdManager/owlbot.py create mode 100644 AdsAdManager/phpunit.xml.dist create mode 100644 AdsAdManager/samples/V1/AdUnitServiceClient/get_ad_unit.php create mode 100644 AdsAdManager/samples/V1/AdUnitServiceClient/list_ad_unit_sizes.php create mode 100644 AdsAdManager/samples/V1/AdUnitServiceClient/list_ad_units.php create mode 100644 AdsAdManager/samples/V1/CompanyServiceClient/get_company.php create mode 100644 AdsAdManager/samples/V1/CompanyServiceClient/list_companies.php create mode 100644 AdsAdManager/samples/V1/CustomFieldServiceClient/get_custom_field.php create mode 100644 AdsAdManager/samples/V1/CustomFieldServiceClient/list_custom_fields.php create mode 100644 AdsAdManager/samples/V1/CustomTargetingKeyServiceClient/get_custom_targeting_key.php create mode 100644 AdsAdManager/samples/V1/CustomTargetingKeyServiceClient/list_custom_targeting_keys.php create mode 100644 AdsAdManager/samples/V1/CustomTargetingValueServiceClient/get_custom_targeting_value.php create mode 100644 AdsAdManager/samples/V1/CustomTargetingValueServiceClient/list_custom_targeting_values.php create mode 100644 AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/batch_create_entity_signals_mappings.php create mode 100644 AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/batch_update_entity_signals_mappings.php create mode 100644 AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/create_entity_signals_mapping.php create mode 100644 AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/get_entity_signals_mapping.php create mode 100644 AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/list_entity_signals_mappings.php create mode 100644 AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/update_entity_signals_mapping.php create mode 100644 AdsAdManager/samples/V1/NetworkServiceClient/get_network.php create mode 100644 AdsAdManager/samples/V1/NetworkServiceClient/list_networks.php create mode 100644 AdsAdManager/samples/V1/OrderServiceClient/get_order.php create mode 100644 AdsAdManager/samples/V1/OrderServiceClient/list_orders.php create mode 100644 AdsAdManager/samples/V1/PlacementServiceClient/get_placement.php create mode 100644 AdsAdManager/samples/V1/PlacementServiceClient/list_placements.php create mode 100644 AdsAdManager/samples/V1/ReportServiceClient/create_report.php create mode 100644 AdsAdManager/samples/V1/ReportServiceClient/fetch_report_result_rows.php create mode 100644 AdsAdManager/samples/V1/ReportServiceClient/get_report.php create mode 100644 AdsAdManager/samples/V1/ReportServiceClient/list_reports.php create mode 100644 AdsAdManager/samples/V1/ReportServiceClient/run_report.php create mode 100644 AdsAdManager/samples/V1/ReportServiceClient/update_report.php create mode 100644 AdsAdManager/samples/V1/RoleServiceClient/get_role.php create mode 100644 AdsAdManager/samples/V1/RoleServiceClient/list_roles.php create mode 100644 AdsAdManager/samples/V1/TaxonomyCategoryServiceClient/get_taxonomy_category.php create mode 100644 AdsAdManager/samples/V1/TaxonomyCategoryServiceClient/list_taxonomy_categories.php create mode 100644 AdsAdManager/samples/V1/UserServiceClient/get_user.php create mode 100644 AdsAdManager/src/V1/AdManagerError.php create mode 100644 AdsAdManager/src/V1/AdUnit.php create mode 100644 AdsAdManager/src/V1/AdUnitParent.php create mode 100644 AdsAdManager/src/V1/AdUnitSize.php create mode 100644 AdsAdManager/src/V1/AdUnitStatusEnum.php create mode 100644 AdsAdManager/src/V1/AdUnitStatusEnum/AdUnitStatus.php create mode 100644 AdsAdManager/src/V1/AppliedLabel.php create mode 100644 AdsAdManager/src/V1/BatchCreateEntitySignalsMappingsRequest.php create mode 100644 AdsAdManager/src/V1/BatchCreateEntitySignalsMappingsResponse.php create mode 100644 AdsAdManager/src/V1/BatchUpdateEntitySignalsMappingsRequest.php create mode 100644 AdsAdManager/src/V1/BatchUpdateEntitySignalsMappingsResponse.php create mode 100644 AdsAdManager/src/V1/Client/AdUnitServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/CompanyServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/CustomFieldServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/CustomTargetingKeyServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/CustomTargetingValueServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/EntitySignalsMappingServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/NetworkServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/OrderServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/PlacementServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/ReportServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/RoleServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/TaxonomyCategoryServiceClient.php create mode 100644 AdsAdManager/src/V1/Client/UserServiceClient.php create mode 100644 AdsAdManager/src/V1/Company.php create mode 100644 AdsAdManager/src/V1/CompanyCreditStatusEnum.php create mode 100644 AdsAdManager/src/V1/CompanyCreditStatusEnum/CompanyCreditStatus.php create mode 100644 AdsAdManager/src/V1/CompanyTypeEnum.php create mode 100644 AdsAdManager/src/V1/CompanyTypeEnum/CompanyType.php create mode 100644 AdsAdManager/src/V1/Contact.php create mode 100644 AdsAdManager/src/V1/CreateEntitySignalsMappingRequest.php create mode 100644 AdsAdManager/src/V1/CreateReportRequest.php create mode 100644 AdsAdManager/src/V1/CustomField.php create mode 100644 AdsAdManager/src/V1/CustomFieldDataTypeEnum.php create mode 100644 AdsAdManager/src/V1/CustomFieldDataTypeEnum/CustomFieldDataType.php create mode 100644 AdsAdManager/src/V1/CustomFieldEntityTypeEnum.php create mode 100644 AdsAdManager/src/V1/CustomFieldEntityTypeEnum/CustomFieldEntityType.php create mode 100644 AdsAdManager/src/V1/CustomFieldOption.php create mode 100644 AdsAdManager/src/V1/CustomFieldStatusEnum.php create mode 100644 AdsAdManager/src/V1/CustomFieldStatusEnum/CustomFieldStatus.php create mode 100644 AdsAdManager/src/V1/CustomFieldValue.php create mode 100644 AdsAdManager/src/V1/CustomFieldValue/Value.php create mode 100644 AdsAdManager/src/V1/CustomFieldVisibilityEnum.php create mode 100644 AdsAdManager/src/V1/CustomFieldVisibilityEnum/CustomFieldVisibility.php create mode 100644 AdsAdManager/src/V1/CustomTargetingKey.php create mode 100644 AdsAdManager/src/V1/CustomTargetingKeyReportableTypeEnum.php create mode 100644 AdsAdManager/src/V1/CustomTargetingKeyReportableTypeEnum/CustomTargetingKeyReportableType.php create mode 100644 AdsAdManager/src/V1/CustomTargetingKeyStatusEnum.php create mode 100644 AdsAdManager/src/V1/CustomTargetingKeyStatusEnum/CustomTargetingKeyStatus.php create mode 100644 AdsAdManager/src/V1/CustomTargetingKeyTypeEnum.php create mode 100644 AdsAdManager/src/V1/CustomTargetingKeyTypeEnum/CustomTargetingKeyType.php create mode 100644 AdsAdManager/src/V1/CustomTargetingValue.php create mode 100644 AdsAdManager/src/V1/CustomTargetingValueMatchTypeEnum.php create mode 100644 AdsAdManager/src/V1/CustomTargetingValueMatchTypeEnum/CustomTargetingValueMatchType.php create mode 100644 AdsAdManager/src/V1/CustomTargetingValueStatusEnum.php create mode 100644 AdsAdManager/src/V1/CustomTargetingValueStatusEnum/CustomTargetingValueStatus.php create mode 100644 AdsAdManager/src/V1/EntitySignalsMapping.php create mode 100644 AdsAdManager/src/V1/EnvironmentTypeEnum.php create mode 100644 AdsAdManager/src/V1/EnvironmentTypeEnum/EnvironmentType.php create mode 100644 AdsAdManager/src/V1/FetchReportResultRowsRequest.php create mode 100644 AdsAdManager/src/V1/FetchReportResultRowsResponse.php create mode 100644 AdsAdManager/src/V1/FrequencyCap.php create mode 100644 AdsAdManager/src/V1/GetAdUnitRequest.php create mode 100644 AdsAdManager/src/V1/GetCompanyRequest.php create mode 100644 AdsAdManager/src/V1/GetCustomFieldRequest.php create mode 100644 AdsAdManager/src/V1/GetCustomTargetingKeyRequest.php create mode 100644 AdsAdManager/src/V1/GetCustomTargetingValueRequest.php create mode 100644 AdsAdManager/src/V1/GetEntitySignalsMappingRequest.php create mode 100644 AdsAdManager/src/V1/GetNetworkRequest.php create mode 100644 AdsAdManager/src/V1/GetOrderRequest.php create mode 100644 AdsAdManager/src/V1/GetPlacementRequest.php create mode 100644 AdsAdManager/src/V1/GetReportRequest.php create mode 100644 AdsAdManager/src/V1/GetRoleRequest.php create mode 100644 AdsAdManager/src/V1/GetTaxonomyCategoryRequest.php create mode 100644 AdsAdManager/src/V1/GetUserRequest.php create mode 100644 AdsAdManager/src/V1/Label.php create mode 100644 AdsAdManager/src/V1/LabelFrequencyCap.php create mode 100644 AdsAdManager/src/V1/ListAdUnitSizesRequest.php create mode 100644 AdsAdManager/src/V1/ListAdUnitSizesResponse.php create mode 100644 AdsAdManager/src/V1/ListAdUnitsRequest.php create mode 100644 AdsAdManager/src/V1/ListAdUnitsResponse.php create mode 100644 AdsAdManager/src/V1/ListCompaniesRequest.php create mode 100644 AdsAdManager/src/V1/ListCompaniesResponse.php create mode 100644 AdsAdManager/src/V1/ListCustomFieldsRequest.php create mode 100644 AdsAdManager/src/V1/ListCustomFieldsResponse.php create mode 100644 AdsAdManager/src/V1/ListCustomTargetingKeysRequest.php create mode 100644 AdsAdManager/src/V1/ListCustomTargetingKeysResponse.php create mode 100644 AdsAdManager/src/V1/ListCustomTargetingValuesRequest.php create mode 100644 AdsAdManager/src/V1/ListCustomTargetingValuesResponse.php create mode 100644 AdsAdManager/src/V1/ListEntitySignalsMappingsRequest.php create mode 100644 AdsAdManager/src/V1/ListEntitySignalsMappingsResponse.php create mode 100644 AdsAdManager/src/V1/ListNetworksRequest.php create mode 100644 AdsAdManager/src/V1/ListNetworksResponse.php create mode 100644 AdsAdManager/src/V1/ListOrdersRequest.php create mode 100644 AdsAdManager/src/V1/ListOrdersResponse.php create mode 100644 AdsAdManager/src/V1/ListPlacementsRequest.php create mode 100644 AdsAdManager/src/V1/ListPlacementsResponse.php create mode 100644 AdsAdManager/src/V1/ListReportsRequest.php create mode 100644 AdsAdManager/src/V1/ListReportsResponse.php create mode 100644 AdsAdManager/src/V1/ListRolesRequest.php create mode 100644 AdsAdManager/src/V1/ListRolesResponse.php create mode 100644 AdsAdManager/src/V1/ListTaxonomyCategoriesRequest.php create mode 100644 AdsAdManager/src/V1/ListTaxonomyCategoriesResponse.php create mode 100644 AdsAdManager/src/V1/Network.php create mode 100644 AdsAdManager/src/V1/Order.php create mode 100644 AdsAdManager/src/V1/OrderStatusEnum.php create mode 100644 AdsAdManager/src/V1/OrderStatusEnum/OrderStatus.php create mode 100644 AdsAdManager/src/V1/Placement.php create mode 100644 AdsAdManager/src/V1/PlacementStatusEnum.php create mode 100644 AdsAdManager/src/V1/PlacementStatusEnum/PlacementStatus.php create mode 100644 AdsAdManager/src/V1/Report.php create mode 100644 AdsAdManager/src/V1/Report/DataTable.php create mode 100644 AdsAdManager/src/V1/Report/DataTable/MetricValueGroup.php create mode 100644 AdsAdManager/src/V1/Report/DataTable/Row.php create mode 100644 AdsAdManager/src/V1/Report/DateRange.php create mode 100644 AdsAdManager/src/V1/Report/DateRange/FixedDateRange.php create mode 100644 AdsAdManager/src/V1/Report/DateRange/RelativeDateRange.php create mode 100644 AdsAdManager/src/V1/Report/Dimension.php create mode 100644 AdsAdManager/src/V1/Report/Field.php create mode 100644 AdsAdManager/src/V1/Report/Filter.php create mode 100644 AdsAdManager/src/V1/Report/Filter/FieldFilter.php create mode 100644 AdsAdManager/src/V1/Report/Filter/FilterList.php create mode 100644 AdsAdManager/src/V1/Report/Filter/Operation.php create mode 100644 AdsAdManager/src/V1/Report/Flag.php create mode 100644 AdsAdManager/src/V1/Report/Metric.php create mode 100644 AdsAdManager/src/V1/Report/MetricValueType.php create mode 100644 AdsAdManager/src/V1/Report/ReportType.php create mode 100644 AdsAdManager/src/V1/Report/Slice.php create mode 100644 AdsAdManager/src/V1/Report/Sort.php create mode 100644 AdsAdManager/src/V1/Report/TimePeriodColumn.php create mode 100644 AdsAdManager/src/V1/Report/Value.php create mode 100644 AdsAdManager/src/V1/Report/Value/IntList.php create mode 100644 AdsAdManager/src/V1/Report/Value/StringList.php create mode 100644 AdsAdManager/src/V1/Report/Visibility.php create mode 100644 AdsAdManager/src/V1/ReportDefinition.php create mode 100644 AdsAdManager/src/V1/Role.php create mode 100644 AdsAdManager/src/V1/RoleStatusEnum.php create mode 100644 AdsAdManager/src/V1/RoleStatusEnum/RoleStatus.php create mode 100644 AdsAdManager/src/V1/RunReportMetadata.php create mode 100644 AdsAdManager/src/V1/RunReportRequest.php create mode 100644 AdsAdManager/src/V1/RunReportResponse.php create mode 100644 AdsAdManager/src/V1/Schedule.php create mode 100644 AdsAdManager/src/V1/Schedule/Frequency.php create mode 100644 AdsAdManager/src/V1/Schedule/MonthlySchedule.php create mode 100644 AdsAdManager/src/V1/Schedule/WeeklySchedule.php create mode 100644 AdsAdManager/src/V1/ScheduleOptions.php create mode 100644 AdsAdManager/src/V1/ScheduleOptions/DeliveryCondition.php create mode 100644 AdsAdManager/src/V1/Size.php create mode 100644 AdsAdManager/src/V1/SizeTypeEnum.php create mode 100644 AdsAdManager/src/V1/SizeTypeEnum/SizeType.php create mode 100644 AdsAdManager/src/V1/SmartSizeModeEnum.php create mode 100644 AdsAdManager/src/V1/SmartSizeModeEnum/SmartSizeMode.php create mode 100644 AdsAdManager/src/V1/TargetWindowEnum.php create mode 100644 AdsAdManager/src/V1/TargetWindowEnum/TargetWindow.php create mode 100644 AdsAdManager/src/V1/TaxonomyCategory.php create mode 100644 AdsAdManager/src/V1/TaxonomyTypeEnum.php create mode 100644 AdsAdManager/src/V1/TaxonomyTypeEnum/TaxonomyType.php create mode 100644 AdsAdManager/src/V1/Team.php create mode 100644 AdsAdManager/src/V1/TimeUnitEnum.php create mode 100644 AdsAdManager/src/V1/TimeUnitEnum/TimeUnit.php create mode 100644 AdsAdManager/src/V1/UpdateEntitySignalsMappingRequest.php create mode 100644 AdsAdManager/src/V1/UpdateReportRequest.php create mode 100644 AdsAdManager/src/V1/User.php create mode 100644 AdsAdManager/src/V1/gapic_metadata.json create mode 100644 AdsAdManager/src/V1/resources/ad_unit_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/ad_unit_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/ad_unit_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/company_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/company_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/company_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/custom_field_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/custom_field_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/custom_field_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/custom_targeting_key_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/custom_targeting_key_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/custom_targeting_key_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/custom_targeting_value_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/custom_targeting_value_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/custom_targeting_value_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/entity_signals_mapping_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/entity_signals_mapping_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/entity_signals_mapping_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/network_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/network_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/network_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/order_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/order_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/order_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/placement_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/placement_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/placement_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/report_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/report_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/report_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/role_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/role_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/role_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/taxonomy_category_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/taxonomy_category_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/taxonomy_category_service_rest_client_config.php create mode 100644 AdsAdManager/src/V1/resources/user_service_client_config.json create mode 100644 AdsAdManager/src/V1/resources/user_service_descriptor_config.php create mode 100644 AdsAdManager/src/V1/resources/user_service_rest_client_config.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/AdUnitServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/CompanyServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/CustomFieldServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/CustomTargetingKeyServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/CustomTargetingValueServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/EntitySignalsMappingServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/NetworkServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/OrderServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/PlacementServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/ReportServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/RoleServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/TaxonomyCategoryServiceClientTest.php create mode 100644 AdsAdManager/tests/Unit/V1/Client/UserServiceClientTest.php diff --git a/.repo-metadata-full.json b/.repo-metadata-full.json index 14057a6a5f24..98e0ec780eb1 100644 --- a/.repo-metadata-full.json +++ b/.repo-metadata-full.json @@ -15,6 +15,14 @@ "library_type": "GAPIC_AUTO", "api_shortname": "accesscontextmanager" }, + "AdsAdManager": { + "language": "php", + "distribution_name": "googleads/ad-manager", + "release_level": "preview", + "client_documentation": "https://cloud.google.com/php/docs/reference/googleads/ad-manager/latest", + "library_type": "GAPIC_AUTO", + "api_shortname": "admanager" + }, "AdsMarketingPlatformAdmin": { "language": "php", "distribution_name": "google/ads-marketingplatform-admin", diff --git a/AdsAdManager/.OwlBot.yaml b/AdsAdManager/.OwlBot.yaml new file mode 100644 index 000000000000..bb14e9bf83e7 --- /dev/null +++ b/AdsAdManager/.OwlBot.yaml @@ -0,0 +1,4 @@ +deep-copy-regex: + - source: /google/ads/admanager/(v1)/.*-php/(.*) + dest: /owl-bot-staging/AdsAdManager/$1/$2 +api-name: AdsAdManager diff --git a/AdsAdManager/.gitattributes b/AdsAdManager/.gitattributes new file mode 100644 index 000000000000..4bf0fe6f415b --- /dev/null +++ b/AdsAdManager/.gitattributes @@ -0,0 +1,7 @@ +/*.xml.dist export-ignore +/.OwlBot.yaml export-ignore +/.github export-ignore +/owlbot.py export-ignore +/src/**/gapic_metadata.json export-ignore +/samples export-ignore +/tests export-ignore diff --git a/AdsAdManager/.github/pull_request_template.md b/AdsAdManager/.github/pull_request_template.md new file mode 100644 index 000000000000..183b69e825e8 --- /dev/null +++ b/AdsAdManager/.github/pull_request_template.md @@ -0,0 +1,24 @@ +**PLEASE READ THIS ENTIRE MESSAGE** + +Hello, and thank you for your contribution! Please note that this repository is +a read-only split of `googleapis/google-cloud-php`. As such, we are +unable to accept pull requests to this repository. + +We welcome your pull request and would be happy to consider it for inclusion in +our library if you follow these steps: + +* Clone the parent client library repository: + +```sh +$ git clone git@github.com:googleapis/google-cloud-php.git +``` + +* Move your changes into the correct location in that library. Library code +belongs in `AdsAdManager/src`, and tests in `AdsAdManager/tests`. + +* Push the changes in a new branch to a fork, and open a new pull request +[here](https://github.com/googleapis/google-cloud-php). + +Thanks again, and we look forward to seeing your proposed change! + +The Google Cloud PHP team diff --git a/AdsAdManager/CONTRIBUTING.md b/AdsAdManager/CONTRIBUTING.md new file mode 100644 index 000000000000..76ea811cacdb --- /dev/null +++ b/AdsAdManager/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# How to Contribute + +We'd love to accept your patches and contributions to this project. We accept +and review pull requests against the main +[Google Cloud PHP](https://github.com/googleapis/google-cloud-php) +repository, which contains all of our client libraries. You will also need to +sign a Contributor License Agreement. For more details about how to contribute, +see the +[CONTRIBUTING.md](https://github.com/googleapis/google-cloud-php/blob/main/CONTRIBUTING.md) +file in the main Google Cloud PHP repository. diff --git a/AdsAdManager/LICENSE b/AdsAdManager/LICENSE new file mode 100644 index 000000000000..8f71f43fee3f --- /dev/null +++ b/AdsAdManager/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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 + + http://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. + diff --git a/AdsAdManager/README.md b/AdsAdManager/README.md new file mode 100644 index 000000000000..1840ee564ef2 --- /dev/null +++ b/AdsAdManager/README.md @@ -0,0 +1,45 @@ +# Google Ads Ad Manager for PHP + +> Idiomatic PHP client for [Google Ads Ad Manager](https://developers.google.com/ad-manager). + +[![Latest Stable Version](https://poser.pugx.org/googleads/ad-manager/v/stable)](https://packagist.org/packages/googleads/ad-manager) [![Packagist](https://img.shields.io/packagist/dm/googleads/ad-manager.svg)](https://packagist.org/packages/googleads/ad-manager) + +* [API documentation](https://cloud.google.com/php/docs/reference/googleads/ad-manager/latest) + +**NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googleapis/google-cloud-php). Any +support requests, bug reports, or development contributions should be directed to +that project. + +### Installation + +To begin, install the preferred dependency manager for PHP, [Composer](https://getcomposer.org/). + +Now, install this component: + +```sh +$ composer require googleads/ad-manager +``` + +> Browse the complete list of [Google Cloud APIs](https://cloud.google.com/php/docs/reference) +> for PHP + +This component supports both REST over HTTP/1.1 and gRPC. In order to take advantage of the benefits +offered by gRPC (such as streaming methods) please see our +[gRPC installation guide](https://cloud.google.com/php/grpc). + +### Authentication + +Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information +on authenticating your client. Once authenticated, you'll be ready to start making requests. + +### Sample + +See the [samples directory](https://github.com/googleapis/php-ads-ad-manager/tree/main/samples) for a canonical list of samples. + +### Version + +This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. + +### Next Steps + +1. Understand the [official documentation](https://developers.google.com/ad-manager/api/beta). diff --git a/AdsAdManager/VERSION b/AdsAdManager/VERSION new file mode 100644 index 000000000000..77d6f4ca2371 --- /dev/null +++ b/AdsAdManager/VERSION @@ -0,0 +1 @@ +0.0.0 diff --git a/AdsAdManager/composer.json b/AdsAdManager/composer.json new file mode 100644 index 000000000000..7f03e4f66aee --- /dev/null +++ b/AdsAdManager/composer.json @@ -0,0 +1,30 @@ +{ + "name": "googleads/ad-manager", + "description": "Google Ads Ad Manager Client for PHP", + "license": "Apache-2.0", + "minimum-stability": "stable", + "autoload": { + "psr-4": { + "Google\\Ads\\AdManager\\": "src", + "GPBMetadata\\Google\\Ads\\Admanager\\": "metadata" + } + }, + "extra": { + "component": { + "id": "googleads/ad-manager", + "path": "AdsAdManager", + "target": "googleapis/php-ads-ad-manager" + } + }, + "require": { + "php": "^8.0", + "google/gax": "^1.34.0" + }, + "require-dev": { + "phpunit/phpunit": "^9.0" + }, + "suggest": { + "ext-grpc": "Enables use of gRPC, a universal high-performance RPC framework created by Google.", + "ext-protobuf": "Provides a significant increase in throughput over the pure PHP protobuf implementation. See https://cloud.google.com/php/grpc for installation instructions." + } +} diff --git a/AdsAdManager/metadata/V1/AdUnitEnums.php b/AdsAdManager/metadata/V1/AdUnitEnums.php new file mode 100644 index 0000000000000000000000000000000000000000..25564e2ab81ea80be3ee8d322809208f757197eb GIT binary patch literal 1115 zcmb7D+iuf95T$8>G76H(O9d6MluAtnIEr{nDd5CzupoAnIH{;Ctc|^KjU3xruZsZn zdyshIJNPQbmqux;K459>-Ptp9#xrx?yh~0Kcux8(Vw?)*k=b`5P8msfEMhkf$t;`C z87FSMNP>`YnGn?^hG`K^)vagfn#LJ-S%>&>?1!vHy%g7iM$~7#b=Jm%lSP4WSd=YN zxrhr8(FIEr>N3(Fb_YyQj|yt{ix9TrrMRjP_OyKf;D$6!iQ-K#l9mU8pFr?QvRN3o zBo$QPXE#Wl01*KVgCF=Whh$E}l%fB1>^zHH5yTP69n8pO&3#hF%(1&kjQ@T}E>ari z<-k(ddL$T+XlSb}b$O78m=6)!>G(`6ip=1Np4I^A)7B z{9~+jmgY^^nL>Tl)_4Ms6xEp+y5)>5#hQ$9KOSm5{YckT=~e^aj?%OAsV1#8>aeLB z)v1=Blu_>kUa8XhP6`jk3(Cb9yEuqFR*-#x`s@fI0P1rC@ zBPWxfUP8NyVQ3?%mRr=%hBDB5g*%c?K(Z*uHXa9&7k?`_6{xS;8js02vNhS^xk5 literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/AdUnitMessages.php b/AdsAdManager/metadata/V1/AdUnitMessages.php new file mode 100644 index 0000000000000000000000000000000000000000..0bd0922863bd0edb97dcc929d8e27ae578ea6ef9 GIT binary patch literal 3739 zcmbtX-Ez}L6t1HrkaY+}ltu}KEa5Mq!EQ|HbPP1L8%UXwCes9%q3)<_X>IRRmQ?LJ zkTSXK3^RR+Uh^ou=riQHkH8gYeO6`#XnP-;(> z?;zv_gmYZ+9|PFB!9p()hM%}o515C!AOikeVccb4#7MyYfD_%r4H9q)5QDajPUs01 zg;*}w2tB&6h&86Py%I+dfqOXhYEuRU0#bVz3Yvr@sI5}&B`g+EvI(Z;a+8WIlyYQY z(QGT>SOYI;AIs$dC+}gAbm+m|F;1xHB;g(9w*=VB-fBmP83a(q>VDX1^K!X+z%Jg= zP~tdX)PF?k6b|^_F!#e9mPBEjhGKg+rqZhqKzoqT-#aw)cE2O>2f%CrL5{IJX0->5 z27Z;c$PSB=<1PJ(no>D(5Hr55cAz+crbpi}Te{7l%mir<36rAu&2N|?bj9~G{yuv^PxbRac&?fr{!Yy)-Yq*<&`UdSS|%- znMFf)Xr%OUJrWz^`C&V7Ac?V=OKoCSY)B@!bwdSXFmu2lG5I!A7tNHCKM;|kZ<5-F zoz06hbJ}43uSqnnOWHnzMx}f@Ih~QB43{I84I%LN!Wh|w|xS$8L z3(wFwVu&S30z&ORXQ3ZGca{#p-d5I6m9fG;I3Tfewu`1Iv`J_sJJjt(zxhGv{-am9 zoP7<=bkEjrd_Fa{%D?_s`Q>owTnwpr9woo=;!E@9N}1b(?_&9N2E&HedpAy)q0+d1 zsm>zD9pd%;zd3}o&dQ_PU!YMLG1U?Br3=G@1x7L=Blgeecj)SOe8d&{ z#x(dce6PcefrOwOTC5IpYW~k0n$!ointernalAddGeneratedFile( + ' +¿ +-google/ads/admanager/v1/ad_unit_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"I +GetAdUnitRequest5 +name ( B\'àAúA! +admanager.googleapis.com/AdUnit"¾ +ListAdUnitsRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"u +ListAdUnitsResponse1 +ad_units ( 2.google.ads.admanager.v1.AdUnit +next_page_token (  + +total_size (" +ListAdUnitSizesRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"‚ +ListAdUnitSizesResponse: + ad_unit_sizes ( 2#.google.ads.admanager.v1.AdUnitSize +next_page_token (  + +total_size (2€ + AdUnitService‡ + GetAdUnit).google.ads.admanager.v1.GetAdUnitRequest.google.ads.admanager.v1.AdUnit".ÚAname‚Óä“!/v1/{name=networks/*/adUnits/*}š + ListAdUnits+.google.ads.admanager.v1.ListAdUnitsRequest,.google.ads.admanager.v1.ListAdUnitsResponse"0ÚAparent‚Óä“!/v1/{parent=networks/*}/adUnitsª +ListAdUnitSizes/.google.ads.admanager.v1.ListAdUnitSizesRequest0.google.ads.admanager.v1.ListAdUnitSizesResponse"4ÚAparent‚Óä“%#/v1/{parent=networks/*}/adUnitSizesÊAadmanager.googleapis.comB© +com.google.ads.admanager.v1BAdUnitServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/AdmanagerError.php b/AdsAdManager/metadata/V1/AdmanagerError.php new file mode 100644 index 000000000000..8fc32636626a --- /dev/null +++ b/AdsAdManager/metadata/V1/AdmanagerError.php @@ -0,0 +1,37 @@ +internalAddGeneratedFile( + ' +– +-google/ads/admanager/v1/admanager_error.protogoogle.ads.admanager.v1"– +AdManagerError + +error_code (  +message (  + +field_path (  +trigger (  + stack_trace ( % +details ( 2.google.protobuf.AnyBª +com.google.ads.admanager.v1BAdManagerErrorProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/AppliedLabel.php b/AdsAdManager/metadata/V1/AppliedLabel.php new file mode 100644 index 000000000000..ccf44e94926e --- /dev/null +++ b/AdsAdManager/metadata/V1/AppliedLabel.php @@ -0,0 +1,33 @@ +internalAddGeneratedFile( + ' +ì ++google/ads/admanager/v1/applied_label.protogoogle.ads.admanager.v1google/api/resource.proto"V + AppliedLabel5 +label ( B&àAúA +admanager.googleapis.com/Label +negated (B¨ +com.google.ads.admanager.v1BAppliedLabelProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/CompanyCreditStatusEnum.php b/AdsAdManager/metadata/V1/CompanyCreditStatusEnum.php new file mode 100644 index 0000000000000000000000000000000000000000..da04aa2a013a71883c545d76bcf1d64ff1c9f7c5 GIT binary patch literal 1005 zcmbVLO>fgc5G8FX)xse%haBi(TZ)=W;3(pPk_JeeG*~pTMcharOV-BTxGOok)_Ps3 zMfn;02)Obu_*Lw#U8|_g1xw?vnR)X(@A>pYdYOWkaEvMDNZ<%AuA#WZFy&0JkR@=D zFPE6ZkgZaZU~WPp^5{oVHTFy@*Q^Rv+cEgL4c`5)WJaUtG^N-w zN^#7q_Ti5jXlxMX@CH18AZ5G)2bME&`_r$1^+lN~n0bBgVisIXXYRT7e zw{Lm&d{nO)&%mBNEuXfGr{IY*4L&*N!}_+d2X%qBWeU{yi2fu6Jg*2kM zf%jnl0cOfgT3)yI?PJ*(vjoxDWIS%gm}>vFiWEwTGXB5j?^etCwbdAFLz~jjGA6|j rV$R!tZZp32x;&LRU%Gv24gEBl)Tht)U-aKcRh4Ekgf<5!1}?wa3B`}d1~Ct*(oEyeL#_gzaLrlFf5MP<>5#<=5aYb;FiS$s(}Ws@qa=jJ6Ix&z z*@q&<6ztN{tz(lF%!vOY(I68R`}?3m$%RhkF^aa^Bha&48cO4dHEZDbkTwb*+wF5s z?our?ShP;51f9ubC->U`oX+0-DT z(X0&)aBdp2!kIEYCV$q5cfEmeHVb(V2MixO8s5qF)~A;Ng?Zru(|MT+083ZQ;8yc8 zO^pRwRJd0v2;Ll;G6Vx#2a9-jK|tDMTUM!?k3Y^(QK~n(&L*w^yGnTEE+M087**#kxfO9GVm1wOoocDGaswue$L`9Uwn3^x_R3wIQ&38b(*)d`bDB%) z@TyoL0Y+1sbI=loIe|pGWKR8_ti4f1w~oB^*8XJ?ot@b-vPHUyu;O&dIxE&i5Sx9W z+*`ETsJ9+nXku}@6c`8Owvc?nsit~)DmA+_T6XmX>E4A*U9OWK)??RM5N;^+UJrj6LATS-~-bN4Vt*tVQvi-c- zKo?!~fV`u}TtV17 zIUvItIQ^hjydkk=DsOIO*C89hnM`(ntB`k*U&e8E4Rr79y?Gk*&2?P)?u#PRs28(j zGfVQXOPjs?Dtma9@i{DRyZ3VY_mbo12OGaE&&QKJSjlaC a@_4rTJ}NHU!a=<780M12nK~t>g!}{Q3D=$g literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/CompanyService.php b/AdsAdManager/metadata/V1/CompanyService.php new file mode 100644 index 000000000000..f8993ba708f7 --- /dev/null +++ b/AdsAdManager/metadata/V1/CompanyService.php @@ -0,0 +1,53 @@ +internalAddGeneratedFile( + ' +ß +-google/ads/admanager/v1/company_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"K +GetCompanyRequest6 +name ( B(àAúA" + admanager.googleapis.com/Company"À +ListCompaniesRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"y +ListCompaniesResponse3 + companies ( 2 .google.ads.admanager.v1.Company +next_page_token (  + +total_size (2á +CompanyServiceŒ + +GetCompany*.google.ads.admanager.v1.GetCompanyRequest .google.ads.admanager.v1.Company"0ÚAname‚Óä“#!/v1/{name=networks/*/companies/*}¢ + ListCompanies-.google.ads.admanager.v1.ListCompaniesRequest..google.ads.admanager.v1.ListCompaniesResponse"2ÚAparent‚Óä“#!/v1/{parent=networks/*}/companiesÊAadmanager.googleapis.comBª +com.google.ads.admanager.v1BCompanyServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/CompanyTypeEnum.php b/AdsAdManager/metadata/V1/CompanyTypeEnum.php new file mode 100644 index 0000000000000000000000000000000000000000..b212272e79bdb310cf674b2b5515e836552396a7 GIT binary patch literal 968 zcmb7CU5nE|6t%m$52I)Z3oGcubzRslXiC|))~fx;)*@{}o2^s=VVX>{1L;hdOctsX z|AXM4(0}5ua`LgEy6l62n+bRBJ@@3E^X6TA6{D9hB#a0wNdU_Y$SVS|;F9}1f@Qi| z5dl75$220s02o*>u^cc5Bj<%`O?WDN(t?olFd_{cBr4XJ;gE>Nb+eImVz%+*CMF(X z>DtJ#5n^~vk{J60hIVgEBo45|?l6aOyFsF&gmLH1HbQ=clLYz&oTJc81%|#NP*0pL zBkDsUu~f$iO+3n|q&T8q)IW7#g`UiMiTA2X1KD z*;>>}+!2#RFdVr9lK6tgk_%gvwpt;P)iSe8{j40D!O<1e3y!VUEs`COA|<=i0R)k$ zVC|fD2C%KZa%QjJ(vn9v2&%CcN~n5On6;gvAN#2Bp9<+mMT4OvRZ(hTTsM!u*U*!H zbU6No9`2;{=jdtQ8r$8;!gCh3>0M4{w%H$DjLd;{Pk)S1cQ7}n&S+*%wVHm2v=7$h z%=C7$dpbe~-Jv<@FSLDKLyyXeB6GjM@Fu47$(nxD9`t_I&@<&V;||ij!yS5=b8;!| z+UNIWL&zh{LW7I25fYYrwA>huY3Av_eci4$@^kNKn48v6rd2U6yl>2#zi)2b+|TM& g-nq)r%Y%Hz`DvxptHJ;~e!0^td1YaXE!raV2NuLLz5oCK literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/ContactMessages.php b/AdsAdManager/metadata/V1/ContactMessages.php new file mode 100644 index 000000000000..54aed933eb50 --- /dev/null +++ b/AdsAdManager/metadata/V1/ContactMessages.php @@ -0,0 +1,34 @@ +internalAddGeneratedFile( + ' +¸ +.google/ads/admanager/v1/contact_messages.protogoogle.ads.admanager.v1google/api/resource.proto"› +Contact +name ( BàA + +contact_id (BàA:dêAa + admanager.googleapis.com/Contact*networks/{network_code}/contacts/{contact}*contacts2contactB« +com.google.ads.admanager.v1BContactMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/CustomFieldEnums.php b/AdsAdManager/metadata/V1/CustomFieldEnums.php new file mode 100644 index 0000000000000000000000000000000000000000..8ea7ee7cff7c1fe1f4092de4a6a1d6a92713b505 GIT binary patch literal 1388 zcmb7E%Wl&^6eXpt=m?}>1QlYzkXAI6z#(FnQoxDbU@5V!*bOR*WKEojJHoLodt9lY zZrQNlKM-vB2)>FtcACaYyTH;oGrq5rbLQSR@8Z)K?cgpAX+k)i;PE-;rxeFY#3L^X z@Hm@JX@b3I7PEjRGRCTj4b#DzsyojhG>x*vqb=-5ksr_onWV60BqTmf8fVRhm!&+K zxl=}iiA%$5mdbf@ghDc-X-qtdyH>kTIhhbnM%_HmNSUOt=6OcL<^e)pK++U<@_a`k zohGuOuL#2vXXAi*IOT-H&n`<{7BbFAz`nr0I>b{Fq!f~@`cAXZ<17lX2rxsB*7tFd zQ~2)25wLKGFL7Cd7$9Y&hnyxM2}UYSy@bU)N-S_~wS3AKbc!$a{drlDj!kjBz}RZ7 zfIP%J$>?%*j1$VUBs|D*iv$;oU5@PKTQVGwowu=ZE zRE0HHLq2QPzE{xpk`gK?=bXn>C{l~jgKJFEb5!db+m6|Hk94i4x~k$Ru5)5(?y+H8 zT1SV^YW0?c(5CGSbfa6Xh`n*#Z)=0U!;W1wCFW zsfC>J^97zC74-00t5iq3B}kg#=+4P?prBw+H#Apwv_9b4LL25l&0*a|cRB-2arB`8 z1}6)EnYPlau1k-Qba`^G!Z&K4OMq;+vss!`H$eB7kQN4M2R$vJv>nAcwpUqGIys1n z0HGW6(^~CYnVca@*_Z`DP+pOhpj;WH(H`0ub z^iDuCKqBUZ(iW<33@wkHmmaK{XD{t0uuUil=uywhWQw26ebcg zF?Y(d=U{PVf39tJ^SL6!T!Gau=94^Z{=Kw}@{t3txorePXS|u$c)hpir58nuE_L*c O-JE+CjeCJE5c&tBldFFK literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/CustomFieldMessages.php b/AdsAdManager/metadata/V1/CustomFieldMessages.php new file mode 100644 index 000000000000..6e2776c20d37 --- /dev/null +++ b/AdsAdManager/metadata/V1/CustomFieldMessages.php @@ -0,0 +1,46 @@ +internalAddGeneratedFile( + ' +È +3google/ads/admanager/v1/custom_field_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"¬ + CustomField +name ( BàA +custom_field_id (BàA + display_name ( BàA + description ( BàAU +status (2@.google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatusBàAb + entity_type (2H.google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityTypeBàA\\ + data_type (2D.google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataTypeBàAa + +visibility (2H.google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibilityBàA@ +options + ( 2*.google.ads.admanager.v1.CustomFieldOptionBàA:yêAv +$admanager.googleapis.com/CustomField3networks/{network_code}/customFields/{custom_field}* customFields2 customField"S +CustomFieldOption# +custom_field_option_id (BàA + display_name ( BàAB¯ +com.google.ads.admanager.v1BCustomFieldMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/CustomFieldService.php b/AdsAdManager/metadata/V1/CustomFieldService.php new file mode 100644 index 000000000000..6960a5365982 --- /dev/null +++ b/AdsAdManager/metadata/V1/CustomFieldService.php @@ -0,0 +1,52 @@ +internalAddGeneratedFile( + ' +ž +2google/ads/admanager/v1/custom_field_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"S +GetCustomFieldRequest: +name ( B,àAúA& +$admanager.googleapis.com/CustomField"à +ListCustomFieldsRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"„ +ListCustomFieldsResponse; + custom_fields ( 2$.google.ads.admanager.v1.CustomField +next_page_token (  + +total_size (2€ +CustomFieldService› +GetCustomField..google.ads.admanager.v1.GetCustomFieldRequest$.google.ads.admanager.v1.CustomField"3ÚAname‚Óä“&$/v1/{name=networks/*/customFields/*}® +ListCustomFields0.google.ads.admanager.v1.ListCustomFieldsRequest1.google.ads.admanager.v1.ListCustomFieldsResponse"5ÚAparent‚Óä“&$/v1/{parent=networks/*}/customFieldsÊAadmanager.googleapis.comB® +com.google.ads.admanager.v1BCustomFieldServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/CustomFieldValue.php b/AdsAdManager/metadata/V1/CustomFieldValue.php new file mode 100644 index 0000000000000000000000000000000000000000..6111d1bcb16167ba6a319594a129860857036bc1 GIT binary patch literal 1252 zcmb7E-EPw`6mHsWY-U2J5^Rhc0~PC}kx;nH7|>AG?qak;(=Mh+m7AQVmQp*iogzTJ z=P7sq#53>!JO$6e6^@hsXj?Cc zB11!85!P3d4q_T$sff~#8kK#@sG=mMUvyW;ct~Oi8sz%fVaftUIm1~(mjzHiz&U1i zww7=`g=0M9)yoE>hvJ_y1%i>-Z-ER1O%xYBebjX$Q1fwSk@`VVHiM%>T+cbW?lqFf zScw#tt79xcrGgz9-WkAj{^s8_wS@X+G#-q|gmU4!i>?+Rt5QEg@ilMEGNX9*nih>W z!*Jf`iPlDa&Mf1(kAAJ8=l?5;>Q0_vYZ>WPe13b<*n2R8N~j|Wnz@i3e=noES5;B< z(Dt(Ob}ekxx4gqY&GO&oQ&d}E=eQ)H($*q(mVl}qv~C2uTh__9UpV#(a`sY^(WGte zUPV{yl)hQko@y$-jyH$|(Hql1D<^8nKL*3gd`rf^({Ef(a*5%ux;fTkCMK%|a69F^! zbry5G=J})fbbpk0+Q!ee_Oo7R`G3K_X#Ae-_{Qq`R_yuO?1K$c94e ze~sW*|A3$URo=WTY_|Ji;WjVloacFR&wb9j5AjJ1Ptk~mlo3v6Xu3rFgrb;5JaVG| zP1E_DGUP^!*bgX^5gO`9(=CLDs`W&aCQ-^<+C^Rzc>!&cSt8bggv6t)ecEZeX~Lt0 z!wK^!_e0P5LYEE=(?ufZBmf~<&?F`rkug)ly0Z9@x z$Z@R;*aN!687O=MBz|!^4SW|RoN#g3_7leseeRRM|0+ImAI(XSP=U3YJ5NKG`%#Fp z0zGtTYZn!mS?+cmiA~u@7xIj3pTr*7YRD-INnj6Y;xa$x5i>+;w=2H7+TH9;YqzA$ z;QTpi6&kzU6_NXhvy@(DM~G3LvT!fgodKLxce%2c@BLCoZ#JuF716m?m6(<7!0(&z z_J3O@Z55TWXtr2obL7)b^Lq^*uQp~Px{xMWdzu6uTo;#~gS|62oLKtUv3lkRTdFp4 z4)C!vv3l0w#5vR^1|F!2iieFG62N9}V5vvAQIqb#ZB;9u>dkX_xXNKIV_GV>zdkDM z!n3vX*0F*AA-@Y?n0Sa4RTE-z0g8#SqMPGJz4@aC+p8QVjU&d%G@zB1b69hXujWZ_ z;MH1HCN^}_>h(WiXN|yHu%Ro8P__wmU2D{(d(bFhhUyq=6IHz3=>Mw0BVld%ntt}z zG&6Tue(a6f=Z|Hf7X>8rnCEVWBfP1NaNMTAr-{ literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/CustomTargetingKeyMessages.php b/AdsAdManager/metadata/V1/CustomTargetingKeyMessages.php new file mode 100644 index 000000000000..d8f35616f16f --- /dev/null +++ b/AdsAdManager/metadata/V1/CustomTargetingKeyMessages.php @@ -0,0 +1,39 @@ +internalAddGeneratedFile( + ' +» +;google/ads/admanager/v1/custom_targeting_key_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"å +CustomTargetingKey +name ( BàA$ +custom_targeting_key_id (BàA + ad_tag_name ( BàA + display_name ( BàA] +type (2J.google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyTypeBàAc +status (2N.google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatusBàA| +reportable_type (2^.google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableTypeBàA:žêAš ++admanager.googleapis.com/CustomTargetingKeyBnetworks/{network_code}/customTargetingKeys/{custom_targeting_key}*customTargetingKeys2customTargetingKeyB¶ +com.google.ads.admanager.v1BCustomTargetingKeyMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/CustomTargetingKeyService.php b/AdsAdManager/metadata/V1/CustomTargetingKeyService.php new file mode 100644 index 000000000000..c8b81f388c75 --- /dev/null +++ b/AdsAdManager/metadata/V1/CustomTargetingKeyService.php @@ -0,0 +1,53 @@ +internalAddGeneratedFile( + ' +— + +:google/ads/admanager/v1/custom_targeting_key_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"a +GetCustomTargetingKeyRequestA +name ( B3àAúA- ++admanager.googleapis.com/CustomTargetingKey"Ê +ListCustomTargetingKeysRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"š +ListCustomTargetingKeysResponseJ +custom_targeting_keys ( 2+.google.ads.admanager.v1.CustomTargetingKey +next_page_token (  + +total_size (2¿ +CustomTargetingKeyService· +GetCustomTargetingKey5.google.ads.admanager.v1.GetCustomTargetingKeyRequest+.google.ads.admanager.v1.CustomTargetingKey":ÚAname‚Óä“-+/v1/{name=networks/*/customTargetingKeys/*}Ê +ListCustomTargetingKeys7.google.ads.admanager.v1.ListCustomTargetingKeysRequest8.google.ads.admanager.v1.ListCustomTargetingKeysResponse"<ÚAparent‚Óä“-+/v1/{parent=networks/*}/customTargetingKeysÊAadmanager.googleapis.comBµ +com.google.ads.admanager.v1BCustomTargetingKeyServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/CustomTargetingValueEnums.php b/AdsAdManager/metadata/V1/CustomTargetingValueEnums.php new file mode 100644 index 0000000000000000000000000000000000000000..5eabde725644136cca0119b8d889cfdf1ed613d0 GIT binary patch literal 1200 zcmbVLL2uJA6sBXFz}lheWfBPFl}YO)ma5vVV?f%bB@%6;#jOU46uGIJSxW85aV8D4 zGk=3Kcm4tgehEJV+sUfIRt`jR;`qJyz0dEx@70_1A_XttfG{GkBy%{sg7SjERB*{7 zp1@hYSP%gtzD#LCgau)53`b)Got}&KRA|O?5s@~GIgb<4#Pdw8C1yA#qIubBMtLUr zGL%@vL{b)qmpI8uNLaqiERzNRhLkNs+b1ZQ%Fo=OY&(targK6sofGELP z2D=6s-2hKDuA^bWX8_fc=Cg!GFq2rS&pypU%BZ9`p`X-6PvHV58Bu6=eHS^4B;^e1 zfH8|m;}8~@+IK(YsxYVUhM=cwrRo&8OcKFx67)zG37SeSJmuPMtDCPXtWO$;Wm*kK z7qC%qY`5=_JcUx^haG@lo1p#w zZL94Tv6gDNT4jT*%U1nM1w6m6Ilk&dp6M3V33#&Jqjm%iyAvOchas}h1`cvZgK%oU zpE#k9Y&7x1$;kJduG@E=UiCo@fNi^r+^JKo)ONrlcU1mu)PGdK-hFw7SVkA5fOpc1M17yYsyQo+=GmYf9d^x86n!W;(sf$G2r@%oEIFi;K7! z6J`Y1EKE41TDyPh_hi-CZyUPinternalAddGeneratedFile( + ' +í +=google/ads/admanager/v1/custom_targeting_value_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"“ +CustomTargetingValue +name ( BàA + ad_tag_name ( BàA + display_name ( BàAt + +match_type (2X.google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchTypeBàAàAg +status (2R.google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatusBàA:ÓêAÏ +-admanager.googleapis.com/CustomTargetingValueqnetworks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}*customTargetingValues2customTargetingValueB¸ +com.google.ads.admanager.v1B!CustomTargetingValueMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/CustomTargetingValueService.php b/AdsAdManager/metadata/V1/CustomTargetingValueService.php new file mode 100644 index 000000000000..8de715a70ffa --- /dev/null +++ b/AdsAdManager/metadata/V1/CustomTargetingValueService.php @@ -0,0 +1,53 @@ +internalAddGeneratedFile( + ' +ð + +dSu2BTyElho|(_=@~sbJUQDyS1l9egF{0p!w75^Xk2|JSP04<)NBxj zo1v$9C|IPuK8s^6Laz^6BSc%-NrVW7J2CTtwmQu=7#1+Y+*U^FHUf>SAa&1c2ZZ<$ z)0!S-TC6WdFKZ@3gR zbvPA1RCj64nPRtNiRG!&s~9_J#jslLi7=orSN9OKuXt>v>LAo{LNMbxr#sc%;@Fgq z_h>bb(Q$4BS*J!NaQ$>j6_`YcgDmcpU^ISnr&TcK?lFfbXu<^>aH$+;lGTLdHrLls zT=P_~tQ7mtc#(J`2*!CHW7AZ}k)?6&kneM({$JfvS;^fkY&Kj)Us!|M{k1FJnA@s| zIq$H|Pi3++tz9Y)$UT+>9PolY4PhS}*5koynU<>Mmv<`bWYL$H8SZuy5k!z0XA9#N zS@RQZWZyGP;r*taJz!Cif#wR(BAHFQd$ok$cbny(jfKiXvWA4ybb;hEsb7jKS2oGA zVIQQB{h{ZhK0~R7c)nhpr{x?o<9sRoYJ4t{{YfG6BCwci3w3Kx&H7k?c`wyFZC@5| zo-YF!6?*+sQV5zJ?SZukrTcxl>pbAim~`^|49vW~G?w_Id%`4u7jHH8crM}Lrw6Y0f;e^4}&c~K@Ui)!nakJrre}&D(@zb5p a&UmsjZtT5Wpx5+#tCllluDB5y5%L?b9@+x{ literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/EntitySignalsMappingService.php b/AdsAdManager/metadata/V1/EntitySignalsMappingService.php new file mode 100644 index 000000000000..6bfe888da928 --- /dev/null +++ b/AdsAdManager/metadata/V1/EntitySignalsMappingService.php @@ -0,0 +1,73 @@ +internalAddGeneratedFile( + ' +ã +ÚAparent‚Óä“/-/v1/{parent=networks/*}/entitySignalsMappingsö +CreateEntitySignalsMapping:.google.ads.admanager.v1.CreateEntitySignalsMappingRequest-.google.ads.admanager.v1.EntitySignalsMapping"mÚAparent,entity_signals_mapping‚Óä“G"-/v1/{parent=networks/*}/entitySignalsMappings:entity_signals_mapping“ +UpdateEntitySignalsMapping:.google.ads.admanager.v1.UpdateEntitySignalsMappingRequest-.google.ads.admanager.v1.EntitySignalsMapping"‰ÚA"entity_signals_mapping,update_mask‚Óä“^2D/v1/{entity_signals_mapping.name=networks/*/entitySignalsMappings/*}:entity_signals_mappingÿ + BatchCreateEntitySignalsMappings@.google.ads.admanager.v1.BatchCreateEntitySignalsMappingsRequestA.google.ads.admanager.v1.BatchCreateEntitySignalsMappingsResponse"VÚAparent,requests‚Óä“>"9/v1/{parent=networks/*}/entitySignalsMappings:batchCreate:*ÿ + BatchUpdateEntitySignalsMappings@.google.ads.admanager.v1.BatchUpdateEntitySignalsMappingsRequestA.google.ads.admanager.v1.BatchUpdateEntitySignalsMappingsResponse"VÚAparent,requests‚Óä“>"9/v1/{parent=networks/*}/entitySignalsMappings:batchUpdate:*ÊAadmanager.googleapis.comB· +com.google.ads.admanager.v1B EntitySignalsMappingServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/EnvironmentTypeEnum.php b/AdsAdManager/metadata/V1/EnvironmentTypeEnum.php new file mode 100644 index 0000000000000000000000000000000000000000..629c52c2bd780fefe81a5114bbe24805aaf1923a GIT binary patch literal 942 zcmbVKO>fgc5G6T)v>*|MLy_PxluAt{a1`~H5ZZ*ektGsaX$UH^WNqxRyOOhOt=EwX z${*sw|KRWN2Uvg9l$KtwG`2N6^XBcm_wFRQOvr1PB1cIT2C%*Yb%~Hjp@c7DSZ85~ z5`3{qSd7vDnAkA4mtan;J13-W16O5{()R-L{kHjZv^y{ zWb2sukSeP5=YXXi<4iFcv#BOmN5>Z0=*{2ujSn_8<{@7elzF z=H%bcf=5Q>8PRX&~ze92eN@jR-I)Fr# zNj@le=K#C2PD!`+0rh7LL`g>de)iT|X>l93R#?yeZ|q;f8yiP*j$p I@5qjj-+22pLjV8( literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/FrequencyCap.php b/AdsAdManager/metadata/V1/FrequencyCap.php new file mode 100644 index 0000000000000000000000000000000000000000..2d8f433f4630e14159d1944222723a5cb8318e43 GIT binary patch literal 1071 zcmb7D!EVz)5XFgv#1a+ArIFw;K&7Sv90hI;0cz5uJ(T1SdO((}jlFhPvUknyx}u=m z`4q%AaNx{Wv0gi_p^5~S)`>mi_vX#ad-*y$&(LF-5k>@7B!tx^sB;3D;ED%4fmI$w zL_omPj3z|b0Fybqn=j#La@Xm%Kgn|T13DXVKTb!XU2=tZZtAqw1 z6;}FZk4m31swhtAXDwz75l$r00M~P)oCS(<2E_++7Lfh{l$b^CUdFZfF>GpD6#dY> z@J^T_g5kuQ5E%%XDJ~W|)p25?>Mj;<`Ue$l0Y@X~mo+-hwIau$L{6IQ0D`Dou#u^| z09e=mynpDJx1=d~uXP=l5-e_b@fv{=zh&tu?nCfwaE zlWn~Y`c$*DFNTkPTBy^UWA_2Nlj2W4O*28H)B}+{3#@+o_{LYu>h{oWrM37t*!k*^R#(ZHx0*&{d%BJ%XMpP=hn?MndQ!`(Hf!O2Tohi literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/LabelMessages.php b/AdsAdManager/metadata/V1/LabelMessages.php new file mode 100644 index 000000000000..cff18e627525 --- /dev/null +++ b/AdsAdManager/metadata/V1/LabelMessages.php @@ -0,0 +1,32 @@ +internalAddGeneratedFile( + ' +Ž +,google/ads/admanager/v1/label_messages.protogoogle.ads.admanager.v1google/api/resource.proto"v +Label +name ( BàA:ZêAW +admanager.googleapis.com/Label&networks/{network_code}/labels/{label}*labels2labelB© +com.google.ads.admanager.v1BLabelMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/NetworkMessages.php b/AdsAdManager/metadata/V1/NetworkMessages.php new file mode 100644 index 000000000000..a56a18beed04 --- /dev/null +++ b/AdsAdManager/metadata/V1/NetworkMessages.php @@ -0,0 +1,44 @@ +internalAddGeneratedFile( + ' +¶ +.google/ads/admanager/v1/network_messages.protogoogle.ads.admanager.v1google/api/resource.proto"™ +Network +name ( BàA + display_name ( BàA + network_code ( BàA + property_code ( BàA + time_zone ( BàA + currency_code ( BàA% +secondary_currency_codes ( BàAG +effective_root_ad_unit ( B\'àAúA! +admanager.googleapis.com/AdUnit + test_network + (BàA + +network_id (BàA:QêAN + admanager.googleapis.com/Networknetworks/{network_code}*networks2networkB« +com.google.ads.admanager.v1BNetworkMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/NetworkService.php b/AdsAdManager/metadata/V1/NetworkService.php new file mode 100644 index 000000000000..a78ae63f7332 --- /dev/null +++ b/AdsAdManager/metadata/V1/NetworkService.php @@ -0,0 +1,42 @@ +internalAddGeneratedFile( + ' +× +-google/ads/admanager/v1/network_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"K +GetNetworkRequest6 +name ( B(àAúA" + admanager.googleapis.com/Network" +ListNetworksRequest"J +ListNetworksResponse2 +networks ( 2 .google.ads.admanager.v1.Network2´ +NetworkService€ + +GetNetwork*.google.ads.admanager.v1.GetNetworkRequest .google.ads.admanager.v1.Network"$ÚAname‚Óä“/v1/{name=networks/*} + ListNetworks,.google.ads.admanager.v1.ListNetworksRequest-.google.ads.admanager.v1.ListNetworksResponse"‚Óä“ /v1/networksÊAadmanager.googleapis.comBª +com.google.ads.admanager.v1BNetworkServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/OrderEnums.php b/AdsAdManager/metadata/V1/OrderEnums.php new file mode 100644 index 0000000000000000000000000000000000000000..50e78befe4b07a118820051a08f1a50b66146ea9 GIT binary patch literal 966 zcma)4%WB&|6s?oSNymj4QAnX(Ow&MYXk|=xcHLICWMfDyVaZ+;ff-9Zd9>BW1!so6h&ePq!1ond*(_iV z?vzO?7>Qh+CY}gm$%O^bUN4}snqYR*YL{sFA3f9l- z&IoqZUtZb!k6~Gd=KEFJF>I$*0kg16^z#t4|9dUUSpijHgJ9(X)VuEauNpedhi}8A z(&(M)R*TzosKzV_hmNC<( zv&l-cthu?=uA7I-b97Ri0RB`tMGbvwR~JVLLUl`9*x;;Z(2+J98P{++RvPG7hhGN{ zCqpRo6$n**q>*9KMJ}Oyr&jID=Mo$6h_FEABIpE^p@G5;SsCr$`b6j0kD|=TcVNW=ZiY7-E`q-fzLVp3-BP`$m literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/OrderMessages.php b/AdsAdManager/metadata/V1/OrderMessages.php new file mode 100644 index 000000000000..fd26aa927f01 --- /dev/null +++ b/AdsAdManager/metadata/V1/OrderMessages.php @@ -0,0 +1,79 @@ +internalAddGeneratedFile( + ' +Ç +,google/ads/admanager/v1/order_messages.protogoogle.ads.admanager.v10google/ads/admanager/v1/custom_field_value.proto)google/ads/admanager/v1/order_enums.protogoogle/api/field_behavior.protogoogle/api/resource.protogoogle/protobuf/timestamp.proto" +Order +name ( BàA +order_id (BàA + display_name ( BàA + programmatic (BàA9 + +trafficker ( B%àAúA +admanager.googleapis.com/UserE +advertiser_contacts ( B(àAúA" + admanager.googleapis.com/Contact< + +advertiser ( B(àAúA" + admanager.googleapis.com/CompanyA +agency_contacts ( B(àAúA" + admanager.googleapis.com/Contact8 +agency ( B(àAúA" + admanager.googleapis.com/Company< + applied_teams ( B%àAúA +admanager.googleapis.com/Team> +effective_teams ( B%àAúA +admanager.googleapis.com/Team6 +creator + ( B%àAúA +admanager.googleapis.com/User + currency_code ( BàA3 + +start_time ( 2.google.protobuf.TimestampBàA1 +end_time ( 2.google.protobuf.TimestampBàA +unlimited_end_time- (BàA +external_order_id (BàA +archived (BàA! +last_modified_by_app ( BàA4 + update_time ( 2.google.protobuf.TimestampBàA +notes ( BàA + po_number ( BàAI +status (24.google.ads.admanager.v1.OrderStatusEnum.OrderStatusBàA: + salesperson ( B%àAúA +admanager.googleapis.com/UserG +secondary_salespeople ( B(àAàAúA +admanager.googleapis.com/UserG +secondary_traffickers ( B(àAàAúA +admanager.googleapis.com/UserB +applied_labels ( 2%.google.ads.admanager.v1.AppliedLabelBàAL +effective_applied_labels ( 2%.google.ads.admanager.v1.AppliedLabelBàAK +custom_field_values& ( 2).google.ads.admanager.v1.CustomFieldValueBàA:ZêAW +admanager.googleapis.com/Order&networks/{network_code}/orders/{order}*orders2orderB© +com.google.ads.admanager.v1BOrderMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/OrderService.php b/AdsAdManager/metadata/V1/OrderService.php new file mode 100644 index 000000000000..71b9f7757efc --- /dev/null +++ b/AdsAdManager/metadata/V1/OrderService.php @@ -0,0 +1,53 @@ +internalAddGeneratedFile( + ' +µ ++google/ads/admanager/v1/order_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"G +GetOrderRequest4 +name ( B&àAúA +admanager.googleapis.com/Order"½ +ListOrdersRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"q +ListOrdersResponse. +orders ( 2.google.ads.admanager.v1.Order +next_page_token (  + +total_size (2Ê + OrderServiceƒ +GetOrder(.google.ads.admanager.v1.GetOrderRequest.google.ads.admanager.v1.Order"-ÚAname‚Óä“ /v1/{name=networks/*/orders/*}– + +ListOrders*.google.ads.admanager.v1.ListOrdersRequest+.google.ads.admanager.v1.ListOrdersResponse"/ÚAparent‚Óä“ /v1/{parent=networks/*}/ordersÊAadmanager.googleapis.comB¨ +com.google.ads.admanager.v1BOrderServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/PlacementEnums.php b/AdsAdManager/metadata/V1/PlacementEnums.php new file mode 100644 index 0000000000000000000000000000000000000000..8eccdd7c4121bbd8c6e6e7a286ec98e2a528961e GIT binary patch literal 929 zcmb7C(QeZ)6s1L)kcC859`*namoaIb#8Oqfbt{mzS&2m3h-Q6&NR^wonWfZ@Y-bXn z{?I;!zu^zCoiq%lJrL<8vG4V{$M>9z_xW{>Uc-biBCsL}tiOS}CXfrRc+4|c7n=FJ5WKM;zS2h}FGNiGkaC`8q>B@&V~ZJ1iRj++x_O3UvL#Hd2rIVI zvB(H9yd^T%DVPMqDN#7V3P%$Q61j=gQGrCu-Z?^XhNXmH59S#x^aFu@@?xFQ7^K2V ze~zhKQAQQT8U3y=G=L4xB+(G}Yc~ap73B=ffjNsw=M+jzQ+u3qJ%9o1Sp{Y$dLEI_ z6cG$((U{0s&|Gm5=+b^aC90mJ+3B2CZ4DgVK&Rx`@82Ui03`}?w>y9!su1kl@-_gw z`p+^udq*oCZj#h(FSSaYy3iauLBE>l?7!q`AC~2gR#QhMgmcq766krY!9owbkVc84 zujtu7+igHEgHP_rn|iZwwFuqtYO%VSEdp=kU;5s-^{9=|fjbKQrPpe-pQ0!JtXehA z%Kbe0s8i$CinternalAddGeneratedFile( + ' +« +0google/ads/admanager/v1/placement_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.protogoogle/protobuf/timestamp.proto"È + Placement +name ( BàA + placement_id (BàA + display_name ( BàA + description ( BàA +placement_code ( BàAQ +status (2<.google.ads.admanager.v1.PlacementStatusEnum.PlacementStatusBàAB +targeted_ad_units ( B\'àAúA! +admanager.googleapis.com/AdUnit4 + update_time ( 2.google.protobuf.TimestampBàA:nêAk +"admanager.googleapis.com/Placement.networks/{network_code}/placements/{placement}* +placements2 placementB­ +com.google.ads.admanager.v1BPlacementMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/PlacementService.php b/AdsAdManager/metadata/V1/PlacementService.php new file mode 100644 index 000000000000..2512b3925512 --- /dev/null +++ b/AdsAdManager/metadata/V1/PlacementService.php @@ -0,0 +1,53 @@ +internalAddGeneratedFile( + ' +ù +/google/ads/admanager/v1/placement_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"O +GetPlacementRequest8 +name ( B*àAúA$ +"admanager.googleapis.com/Placement"Á +ListPlacementsRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"} +ListPlacementsResponse6 + +placements ( 2".google.ads.admanager.v1.Placement +next_page_token (  + +total_size (2î +PlacementService“ + GetPlacement,.google.ads.admanager.v1.GetPlacementRequest".google.ads.admanager.v1.Placement"1ÚAname‚Óä“$"/v1/{name=networks/*/placements/*}¦ +ListPlacements..google.ads.admanager.v1.ListPlacementsRequest/.google.ads.admanager.v1.ListPlacementsResponse"3ÚAparent‚Óä“$"/v1/{parent=networks/*}/placementsÊAadmanager.googleapis.comB¬ +com.google.ads.admanager.v1BPlacementServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/ReportService.php b/AdsAdManager/metadata/V1/ReportService.php new file mode 100644 index 0000000000000000000000000000000000000000..128aacca11e6462f885a65908f34f2bc0d33cb3f GIT binary patch literal 35098 zcmc(I33OaXm3F#i$yUir`FV*f$FVFsiS0O&CGQF$w7Q?9#=WJxB}X|5Z`xAJ=|6I} zrn_Y@jAyd%2_zv90)*_4u){DwfUwT|L)ZyxW@A`pfUs}F&fHted-b|sy?%!OoImFn z)Ky>Ix^?T;ty}e~>OSw{g)0`w*50vVxmYdKi?h8)PxjWYDE2N?EA`4uWxn_5;@n)Z z+B;J@zEGMkR{MK4xk5wwi=8FS`*&6&iUMLri6{`a$ z1_!Feg-W$<)r!>()3Yz_Vi8q<@5 z7ZNfvU#Qi3vy4`blOiu8z3|_{;?eoiOmD4TsKftlE7h!0xl}I|=1VVy=3LY}SD3FA zfkHEOZm~R5FICFDSRh@VDQ@4<%V{EZ+d>7Je^IYwDuWUMX-vn<^L$&g1ZK6O$M9)~ky}wf5fLYO%gpEnmp^Mgpho zzoxxJwosaml*<*ALZw_A9(LN~kkA#3&X^o((`%&NcZ};~p>}0(j_tDf5~yswaC{+n+5E|c;&cqg)oB+w zS($rrv3MG6vZ|29%G_+>q<4Kxr7w7XNhok+cGlL{Q5f9YZ4EXvH zlcW2=2*5uvfcsAj_K1vu!a`|ahG`o&1U;K2eaM(Ym9mZsof3cz3ZNJ4r09BKPTWSOy^bPB6kn(c0b^fpXyGopl?DAh_wOY^1r z$?h;@tQ^|e&$(!lc|WJ$KWUdhA|WGARtw^@#W`jwE9LGbK&xwLM+;gpy8x038ym>- z*-~v`zHriFO=y=*2pM}x*Wv=o%EGpHcQE=rlD-smKPoI6Q@nvtYNlGWODzpnY7Oa_ zugnzYi`~m418v3_p|zPSinELJMXR#F>_vAcqqkjh(Ws^UIZ+_Z@l0Ml&xA?)WMO`> zXsjWfFm$XF_=9y<+xQvKSIcKBFa;GwI`&G4r`PILFjyiTyRj3}*Aj9R<_3|9a$g3i zV`L?go-frTeJ-&Jw7kmRMP~Y8N=iUcAe1DlMYReoF2~)$Xyq8!g4{aNb@XJtSQG4` ze3y@((X)Xp6;&E5Ne2^14J6XGy{+dgLL3SWxt$|RNjpRLd@4+qek#-IWAt+B)A1{KeX1HuDv<}@k0#*(Uv}y!6JW!Bn720i1H4Ico zmXQvN@jkMa7;NmgxL~PG)%M)nPC8+lDdY>Fh&^uzk+y8*#m2>i&O$TFHJB_plf07x zNQALw93g95bsei#78hzD={7JH!>t-=Gt{p%cMM7Ne7%j(#zf;HvT~tXI$o%r{Ii%% zkeF)m6C$=37`)eq?FsI520t%rPefcOEk|ddi3sPImJ<=W5C0z~q8Adv zrHGmV>bZ1|DY=|?0_r9cUf+`;(rNdF(LuuT6g|Trqyu&zEciQQEGNsN=~O-vPvvOX zpkz7b*ePws3euS{b2%$N9!b$9;CfN}r)6F;5lQ4|I~E(unvuMj<+u*xOtMBzkcsXU#+; zAD=X>81%B0jikm*Ya*4)n9=xX+>C)zb&~dcIu@A%odTViGIO8}_%n<@^W*WH1)YAF zwi)ZlYWt^^Pcw>i6S%pAB_}}}$3fH96T|s!<9blnSUTul7ODX4>n3Z}6dSwIu6fFg zWNC+8Gyb$uXE7CzxRivg>tTs+;(;rd8y(#+=LIk0!JbP{Z* zl>+h5pCN~8rgMOaZ4V}({F`98r9_Nr7=y;K5A-m_R~>K&H*~6$vH^JH93c9oDFBuaWOLkRrthcQJ<|`+ou26j=`PRoL$n{%)gEfl zLHTq>bkH3*fbDU~27QmwgVu(RR7_F&bCcTBEKiQv&FY9yb9U1~UDhDoqstni`*c}* z=mA~UUV2EEwU1t?%i2#b(ll#`ZqelIp<6XMd+9lvoPBiqJWbYqx{e8y1v(CPA*<1ApC*Q|LYl7%6gOi!fp^kQ`ch^+in#-z`O8GNNwid;UDpUBbA zhM<0X6!S!G?LWt-g-phR2@U5udQ+RRjcgu?L=TU~(KT>pI(0Jpw=nYUg#s({Y#1ja zuS_w${YMyFflXQfo9F&L3|>dK7l!Hnzl4qLWUE(pr=TM{0?mu3 z#w;ea-@3_pg1E$fr$I&&@#tY#{bbVCDHbH-loBL~23`CEd7m!4r|k|!bUII=s^e6gtz5?+z1edX~pwq(u!oG;~=9L zeO1^PB)e=H4kDUPW+Ewcj$&p4px|nxGt95JCT#2{gQru3Gjna&m_Cp6X$nr{&6p+B z`AuPC7nwe4(as-!;%0TVm4CgE5gPW za+VIp#D7!RIG1ekgK+k4c6YZTVyUUn*L;!mhp^F4c6gDL&};i0gxhx7-= zbABGyic3}k-H^?5j()Ed*F-jJrlRP8f(Q9P7}l%jcraosPdpWigJTLheOF6t7MGx` zfscfZ0kYGNu8rl5dsHXvSUeX+!)irFa*HZP7gn5oHlHl2bcNuIa;ZDHdAvfZQYjY!_|tF?sX8YO1(h05#Q22)`{ zBEf>)scX(?7IuYr&qp%!?P2gy)_E`qB%aU?W42CBrekbt!5W#eBAE<*P-`C&@llhl z?U)VD(bwt;OJqC=YuFr4csY7s*w{yQd+=z}os7fW3(I3mE%rKHmnS2K&9OABn_r1* z(lb2>Gc*5Y-C$0^@Qr3-)<`;i7)%o^#?91(N$=Nn3)jvyKub8~sw0h`(_*lL}*Z)jDZ_!O5n9JFDt8S1@q!Q5OIB|jXpfA^1s>w)V z!UPMf&RlovG~|dm0vkJNFlyjmFsuCrx2Th_DF*YOGxOVS3k>F8G>kbtm?{4+-F6|J zjR9paq%dR9_q#nmH4pbuo(#iY&IWr_@oX_xqM0cDfNy@1e$YLRczJss5}NZRx3%;H z@jm*pyOTLm+I0FMcPG1Zxt4s`?JWz4VroAUhQ;FQh6aNmzUU=G;bDK)ONK0uIoF@_ zl7VgRgc<#qmkex>Y6?Fd#`Q%5hpeBU@!}(swo((x5!k!^gnPL2wu2ImWg|)W4iJyh zk9tWb7lCgOpr|=mul%E1pE-$~312W`xc?=f=?rXcezHMFeXyu#|Ljj0T*uK-@cDra z`l%L_6)aMI+Dk

p?&5)jdu=*PG9H5pgP_|Kz25PCoMSf4v}X+wzo~6}4}yk%=i7 zwLs_dZad`xV#@G^Fz$ekz{i7_z3}=|7#6aID~*q_maP?dWHpG_81jfM+LWqe*ve`K2{HI~W$OMM@2~*i9_#ip%e<({} zpn5&qY4y%#Ba zaL|UIXyDt7l^*3Ed6wYUkeHbSO|+u$VKZeW-~%M=bh^_xA%fqHL`H66MB>-u?psqb zFLEY)+3bkHSCptpzZt@BD*T6|$E$Ehs3DP;rMOWqa+pB>GlV-b=A~FMe05W|0r*_Z zbm9FWTyFZJ7_}#v{*K18;1ndl!-P3M9>w99oj?aSMt>c`rL7LYX#6IGq8(39Wa%t^ zM2Lfu;zHV9c>V{|^u}b~zHi_M3@8F#EiCt@tkHB9Og&wV1G_PmmoTumoGj)&t-;=M zr*ZIFv@!6pF%rAfip8@geEaw#QxQm08ik7;dS@Gg51X)`f}TL$o<@rd2o+I&vrci5Mk zR8aGd$MiIQR#P#myEuU}dqXDcfG@GZ?2*H3{xTcPO188Iwrli`5bm^iAl!Qx9}3~t zK`R)q^r;Z;D|%p^xs$#^L&`&a>qX+O7JdH}K zl96t!+)F6ns8*=Rd>Ckx?tXCZ8(hVXqBsQs-=OcFdj#)6rBnuu?X3!z*1}KF4plo_ zb!J}#yM@!|d4N230shJ@e0%Lbg*M9}!i-25?6{)vnsxqBx5(7h{be{oIz(LyX*MXo z*f6G=5WL%-3BeAtGNxQGT#&6JVNiR+II~}9 z&~L!(U3{y>AV_FBDP>ehhfHT%2S?5$sY!$7)?jU+vU>FVul8ce3aO@z;i@O=oz zr%A73O;b|i;GnXP9ap2fxb2f=0e zzA(BG3M>cSgh@}K1KgO(OZ<|3P7`@<*MZKU9rMiMW!Isx68X8`#|5fjk;3hQ>BI{UnV=@PGn$#)qZ_u;>t zeUk^6J1SDu?UL6kO;LAA9%QZtFW|j7@(8mEJ_zi?M?J|nn+iGlm?s$pfn?sO^toeE z>6;Y6Imx__9#@Ju)aXM>r#i`4$HPjF+s=N9outSlB2kllO#$#?s(?0vOnZym9BSoV}8PB z8Qmt#Pf;#wUAb~ay8`DruN*$AR^lgr_^1b4wXpGQuefvZ%S`%Jw!~tee!vdFDFygg z3+Xxf4Yt7|GWg_w7t>KSiPOJ31ZPN>CXfjXV!c;^_;nlpAt)|%_#(RNPF&tT8x9kP)5A=)I4% zRm}vc`~xGYCNk`ML+o3+9#W96Nj2;os9iLu_R)R5NVSh% z>x)$T=ykqGwU1u!i&XpQ{#3)3gxaFre2<0xdcp@ZC_umQ0}Tn#Z~Z`f1n75upuGb0 zdq2=V0s4a0(yZ*>@b* z<5aDErw>lm+jsfkRLy<24^GwHzxTnZR^vTBIMs0cgAY!%9q;wQspjK-J~-8ay#F}! z7ri^g<+VKNi&XpM1HMSLS3c;ARQu&azDTuao;r>n4ZIs94a>c_oua|W@$ecSj2sd7 z`C#Ojc&!gcj*8d$V5FUSy$?p3n)`h)(%QVi2O|y613nmOa~@p8iQHSxw%K{e4up(;5-*F1QRePVXSKBYm<9FfuVGz6=z~2jqmt*<+0r7HJKNk=$NB9o{ z;-zW*VL-ezvp))mmnQee0rArO{v;q?n&O`VzTflgxXZt?t@6(T;${E-JRn~7?=J%4 zW&i#%AYS(GuK@4TPtP?3Kc|74VxNakWUcV(IQ~KaygG=#7yz%1;AaBh)#3Z40C?4E ze>nhNwb@?@fLAT{R|DWxd;PTlc-2~e9q_6?dvveMR6iR4ulDc11i-8P`>z4;YXAOQ z0KD42{|@*a%I!Cg_Da+IJ~(vO0xC!C`&&chfPJzxRF2gTw1&!I`oY#vX@Nh~8Y+$N zQ>~%W?tZv6RGQq6w1!G+`%!@IR4(*+^p>mSQWtaUE zV0SAwu)N)S)i-_szN)q^p^m->1C>z6-$Q{)s3Y*RSS#<*>dr5LyoG+XA7bIles*T3X~g0->c*et96Y zw9BsugqEiHPC&aHJ@3x6>IW@v=Yf4v3dM`pSTK*{Ame#LHfN72vnP8GF8na~`-6 z+KRsK1Gjg0LPV1g@}LGHT7i&W?YKpgFSX%TO}^~?+cf$1DAwfL z<5rVzk5o;*JvKG@_GrAPqwl#3NC$s{5)alU%{<&rfGhXvLu2QVEqK=eo^Zeux$t-u zoPmRT5%%$1c8~fZJZr1M;FW^0c;g-3Vfbj!r=pT(BsY<5y6bz0oe6FYgon}K^vd%Z z>$X`_PkJ51Gq@^AFBB(uAsDG0kys9%qk_YjE!!T4`Dwcs+*1aluyoq#h1STzgf|5S zg5!A$#&s-tH5%Sh8YCBZRpEu^6^I9ugouPnn9)p<_TV8dNlYBWI}(_{E)I$lWQG`=iz=0JiwKS(X-(g zQnv)c8RiV!T8GOjc-Bko|=;|hDg7z zghqP~8wbdq(<{R}IOWHlmtMdNWc$dVt}3q*yrLwRwju{rn+!BdDp8>et9UOsrJ|r! zl=r`rs4B-wJaVj3YS6B=@VR8OSH4PQ4Oc;@21!I}**b2ylx}T6xHN4ud=@@St+Pqn zcJhJZR46N2&4&~`R{+mHL;V|BlUmx*{s^zeU5MCa~Le_zV_Y9O3u-;aqDXfk$-HsM^B*+{lkX zH{tkjyNR{iO-24e8-y8UmOh^U;r3{T0pj(FRq6-J9KyLUDpAy zK*KeWl2TQhb3W|9o;v}y!b$=`SS;k=CitkCJ%aCF+DW-_xQj$jqEn;8DlD0)F(8B& z2y*nLI6?4p-RhlZX(7}!wm^U@x8ON87k~$G6Ojz~cJy+zl+6J1Qh0O?3=6x**qjZb zN?1AA!+?bX{VQ}nnlVYZM4Y1q)RN}ROaxkLS|U=Bjy0?r=PlqjNZ1cmiA-hWCo_(O`RPhS~fag?9!#P-Zrp&RT=JcMIbQ zZz%ep1_cUkdibD*1PZQrXi-CUjc~oe2PJES%MLy$StIPO`=Is+zTn{mEozU=7u?G7 zK}o*gmX;4n@&%W+d{B}vxWlDI?X~%Wds#jx$rs$w@#NzVr*`GQM(KB&Dys&DZ@9kRKH z3q4v|hjvTu;WZVwe%WZ{)X5rNSMi`DCphUgz_(zS(;MmJ;UUO`#jPRN2zdAa&M&()hzx_ zjKfUTQ_{_PQbRwpi6<4ur1TL-r3TTJc8m;A?h%iK-Ez*lMr^5zZ1xwIA%Od;o8$1)HvYq){2H+1|E&V zgQ7Wl0$omTdg=o{Y=`o)zE_9fqP#nv8T!fMSp*2KfeQoiqQ6`g!&^qIQ>b_q3f|+* z#_>foe8y=bdxwVo#z$-MnNocGh!?1ndriFwI`G8Ps}wSI^JHo*BXwwH_b7gwrR)&^cC{<3B&v&B;) zNG>Gv(2S>cF6DpJhC28keQ{WkES5Q)Z1JxbA#5V-2&thXr_X~RRlkjFX~{<43|I!!P#K~Oqn6DVAv6mHTxo|`j)Dmm1Fv&rTcApIDwROQ*9C}5TZB!56}&wb z#PVF6ue0DUo!GdsV*US3h*PUcSwS$dg+djg!tp9cwliV%kzQ?|rFdV# zrfKH_1T(g35Kx#)1S8YnEq21v>y;~uWfp3Xhvorg?BHRKguEDf9a&bX&K9fI(UUAn zpuj@(&)Sux1r{Ka2X*SJ!=pti|3Y-TiPQ;b0mgdUEF(=w=K~5M_4EV}=uWP6|3@HmbhGBs@50}FmV#WH*6_NwgR0ybO>(X*{+?}?5 z^nE8xHfiXKzP^wwsX~3Cqgw_6g=k4U^kYAUecS~BoEFPG?kbmjbA#=;s}L}>%ZYze z12sm~`m^Il8JCjvO3Xu*GLLik=Tio4=1L2a0js$PBbh})^HOt+e%9Id%?_}cEMmA5 zxYihfprJCxAQ$lIL?z@}1#!)evl)+vlw8?5<{qCQ?b0$T8khEIL`B2r2Rd17(wA1s zMb*CakQFnFRWNWfC)u2$8X0V}9pgyE;%yb{mxbVB!NoY&S+dTvV?|Ki(<27~axsMJ zIi!1Lu~x4fx9l#lt}LFkO0zteBnx}Yb}D=3OXZ?fsuz!2q6Ckjh{!HbS%KV2)^j7< z1X}KZ&LtaIkYN`5l2`8#TjAhhq^rtf*JD&D7F#$#xMi+z=y7nlT|x{smh23RCe=+q zL01m7j7ZoRg$hZAATDM*hTW`nuVjODTZ?(19|O?YC2J6Lx7NKXSV@e~%Sw)Pll7oh zb~sc=o%$XMlT{6Yli?fEG8ufCO}AY`TeM8dvc@DaW{dOCD-Zy7rUF5IF=(?0L8lKk zD~pSm&HXV!A}T33;^Lz%xVZYp;qA;Oa^Ur);92u5_=4aUMiNJG$;h_9kBplsYcvrV zgB3SC6N^tu=3t99Ps4q;wv%O&Q{ymMg|Xe|Pg=H+c(iA|KFG5DM_57m6Ts%FGRj^6SKUz6-erujaWf53~h%kXT zfS9f88d@(2;Fx6L!_#xI!pR;8pzRh7ILGT6q>NDnPfDBbCIlqXb4Z|P5LPp8slY;b zeWQpKQtf^BLi9C6GH@LM54R*R&LFH<@<-BadpHO2DB_UFzM;YD(u9Xn zVb@qDv&V!-p`0sq2`)c)xpq`Ue1ipObg;OT7={pjEX8oqb{E*%HuTssvVz;GT(Nor zVqY6KLKAEc+|V0y8zbE6o>op>U;ncawn(|=nQz}6-ePPXI57x|9|(AVk-Zk$X)k|v zo-*zWK}15w{WbI&qo5==yQFqBxx_9o_pQRJ~^(231&K1`j_QF?dzG7MYW7 zpsy}PukT`;+4q3b+3QdrrL!@T%}uhK=PTu7;Omwl{(HY2Dz@)MPe;!6 zT6{JydR5)r-nX@dZVp3L!=atV(;*n*Uh4y6pJc2_|2*-sJ^N3$m{8ymmH&Ol9)JE} zl;J|AHn8*5@El_wmKZ%7pN@3vmcS#AhsZ{l^>yrx7+K~Z2`iGRR_c{Z=&~2^%?~Iw z4?#8iE7fBI$BN|z%pGv{MFv1d@b7q`42$b3uzsQa literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/RoleEnums.php b/AdsAdManager/metadata/V1/RoleEnums.php new file mode 100644 index 0000000000000000000000000000000000000000..39f8c01d5c9d7f3a48757661a7ad9475a23c7ae9 GIT binary patch literal 880 zcma)4U2EGg6kYOAh8UydB@cbM>k3U_a|nA&mTmcPgJDfV^YJhYL9uUKfg>47E^H+~ zr!V^{{Z*4>*Xt;S8LnkZ=YHs%^Z9Fblaco@L5`AYjA8o|^bJBLg%*)WVVm!EC?OL2 zjHM_&fbk5bvnBZBVEN9ZDv`?wyO0Qxq}ZmhGO?$eCMestowgJyZjk4D<+-ASaJom8 z(FkEOA6}uRG1WAjxcqPsD-&gYxbE}_iBhT*T$?(+Eko`Im?z7(DT_d9s?Bo7)P`}U z8BN(QbB#XiXsXa;KgaHJ9%&{x*n}C6uyp}NO^ZFtgt>Mf9tWCRCJYN z*R${bX0aSBSBuSRx|sW;;4<*X$FCZM91TXxVC^5*8gIz!U|RmwhxavdVm#%&(01sW zI=LPH^V*MZB{UH!<%uU`(oT>&OSOw5nlbCWfBo01Zu7g|oH&np#$zU~3Xgj0&cowL k=n+a literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/RoleMessages.php b/AdsAdManager/metadata/V1/RoleMessages.php new file mode 100644 index 000000000000..be6641a6d1b4 --- /dev/null +++ b/AdsAdManager/metadata/V1/RoleMessages.php @@ -0,0 +1,38 @@ +internalAddGeneratedFile( + ' +Ó ++google/ads/admanager/v1/role_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"› +Role +name ( BàA +role_id (BàA + display_name ( BàA + description ( BàA +built_in (BàAG +status (22.google.ads.admanager.v1.RoleStatusEnum.RoleStatusBàA:UêAR +admanager.googleapis.com/Role$networks/{network_code}/roles/{role}*roles2roleB¨ +com.google.ads.admanager.v1BRoleMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/RoleService.php b/AdsAdManager/metadata/V1/RoleService.php new file mode 100644 index 000000000000..d3021bd5ff87 --- /dev/null +++ b/AdsAdManager/metadata/V1/RoleService.php @@ -0,0 +1,52 @@ +internalAddGeneratedFile( + ' +£ +*google/ads/admanager/v1/role_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"E +GetRoleRequest3 +name ( B%àAúA +admanager.googleapis.com/Role"¼ +ListRolesRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"n +ListRolesResponse, +roles ( 2.google.ads.admanager.v1.Role +next_page_token (  + +total_size (2À + RoleService +GetRole\'.google.ads.admanager.v1.GetRoleRequest.google.ads.admanager.v1.Role",ÚAname‚Óä“/v1/{name=networks/*/roles/*}’ + ListRoles).google.ads.admanager.v1.ListRolesRequest*.google.ads.admanager.v1.ListRolesResponse".ÚAparent‚Óä“/v1/{parent=networks/*}/rolesÊAadmanager.googleapis.comB§ +com.google.ads.admanager.v1BRoleServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/Size.php b/AdsAdManager/metadata/V1/Size.php new file mode 100644 index 000000000000..f1880c9571c6 --- /dev/null +++ b/AdsAdManager/metadata/V1/Size.php @@ -0,0 +1,33 @@ +internalAddGeneratedFile( + ' +‚ +"google/ads/admanager/v1/size.protogoogle.ads.admanager.v1google/api/field_behavior.proto"w +Size +width (BàA +height (BàAF + size_type (2..google.ads.admanager.v1.SizeTypeEnum.SizeTypeBàAB  +com.google.ads.admanager.v1B SizeProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/SizeTypeEnum.php b/AdsAdManager/metadata/V1/SizeTypeEnum.php new file mode 100644 index 0000000000000000000000000000000000000000..3e89b84e3c031ce0a57e9d8f442a5f480c0b028f GIT binary patch literal 958 zcmb7C(Q4Z;6kXai-LyVZWmCwN-TS5;n>i+wFTpcA?-o+3gM? zCnD#xQ_QUh*4tAt+1vMVHHR67+qQivQDX~KWoO{WKDhWFZS><3ZAc|$R4N#^t&^WM zaI~wy$@dy~vboS-f)`VCZTs#Q$M$EVsbhaaePmnOBmF5jaL{LasMT~09GNQR`V-Sd zV{K2}ppk1&rY>@kIn?&`XW$SGM&pUBeXIjeA4%lg)(#X;e>g*yR#!)JW=Vp>-me;X zCGBZEFm~_xW<=$hLPn={{jowvEWtD~7>}9}p@lh{WeTUUa`L}!?razGd+&HqxYdwu um2p)%-k7)kY%*S9WcjLcp0x6!Ui7#;+p2U?iofHP2Ypf?OG~W58i2nO3@Z)* literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/TaxonomyCategoryMessages.php b/AdsAdManager/metadata/V1/TaxonomyCategoryMessages.php new file mode 100644 index 000000000000..10a791d6c682 --- /dev/null +++ b/AdsAdManager/metadata/V1/TaxonomyCategoryMessages.php @@ -0,0 +1,40 @@ +internalAddGeneratedFile( + ' +° +8google/ads/admanager/v1/taxonomy_category_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"ß +TaxonomyCategory +name ( BàA! +taxonomy_category_id (BàA + display_name ( BàA + grouping_only (BàA( +parent_taxonomy_category_id (BàAR + taxonomy_type (26.google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyTypeBàA +ancestor_names ( BàA+ +ancestor_taxonomy_category_ids (BàA:•êA‘ +)admanager.googleapis.com/TaxonomyCategory>networks/{network_code}/taxonomyCategories/{taxonomy_category}*taxonomyCategories2taxonomyCategoryB´ +com.google.ads.admanager.v1BTaxonomyCategoryMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/TaxonomyCategoryService.php b/AdsAdManager/metadata/V1/TaxonomyCategoryService.php new file mode 100644 index 000000000000..e0d958fa9808 --- /dev/null +++ b/AdsAdManager/metadata/V1/TaxonomyCategoryService.php @@ -0,0 +1,52 @@ +internalAddGeneratedFile( + ' +û +7google/ads/admanager/v1/taxonomy_category_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"] +GetTaxonomyCategoryRequest? +name ( B1àAúA+ +)admanager.googleapis.com/TaxonomyCategory"É +ListTaxonomyCategoriesRequest8 +parent ( B(àAúA" + admanager.googleapis.com/Network + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA +skip (BàA"• +ListTaxonomyCategoriesResponseF +taxonomy_categories ( 2).google.ads.admanager.v1.TaxonomyCategory +next_page_token (  + +total_size (2² +TaxonomyCategoryService° +GetTaxonomyCategory3.google.ads.admanager.v1.GetTaxonomyCategoryRequest).google.ads.admanager.v1.TaxonomyCategory"9ÚAname‚Óä“,*/v1/{name=networks/*/taxonomyCategories/*}Æ +ListTaxonomyCategories6.google.ads.admanager.v1.ListTaxonomyCategoriesRequest7.google.ads.admanager.v1.ListTaxonomyCategoriesResponse";ÚAparent‚Óä“,*/v1/{parent=networks/*}/taxonomyCategoriesÊAadmanager.googleapis.comB³ +com.google.ads.admanager.v1BTaxonomyCategoryServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/TaxonomyTypeEnum.php b/AdsAdManager/metadata/V1/TaxonomyTypeEnum.php new file mode 100644 index 0000000000000000000000000000000000000000..7e0f028bad09eb63fb5d2931fd46b7d5be41f059 GIT binary patch literal 1055 zcmb7D-HOvd6t=FeFnAFPvWg1hTG%dV+U(x7R&ASX2-u|Trp1-OFiob}Kspm9lf^21 zA@NDP@+G|SDV+Rl=(?<6;3Q$bbG~!tobSAOms}*^B{T^o919Y_#TtqW0u#;z^H~fR z*>XuZ^w}zjV!~AjbqCsx3k}_JU&zpuW!xt{7%~>dq=SQ0+6q$~65hGgIs$)Yl&#iC ztP_F=%~onb4gkd~k|x+E(43AYMBo4m?3o3RHw;o~6^}R9`T+PbPE+Vse6FN3Bpdh& zpnQ^S5l22u1s3wtic%EONJKb}zQ|h*;1b6vkt8>Lml^d%#3;-I9O{$yAuKs_-&Vq8 z7Y6XEu4&#F*%Z&Bf^dpsPbaC*qeL)1m9D*BNJQPv{G@$YrOoN0C2W^9_Ifvp96-S{ zvYj15PDI9OzoaAXZ#<-zEC13Z=5S8wUV=+X9lb2%3Jm^MDWuOdPgV;ZWAhnOA;+>^y_k>mKF9{;OSRa+vwRe*(O KskIH*0PqKVuu%p8 literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/TeamMessages.php b/AdsAdManager/metadata/V1/TeamMessages.php new file mode 100644 index 000000000000..10949b444e90 --- /dev/null +++ b/AdsAdManager/metadata/V1/TeamMessages.php @@ -0,0 +1,33 @@ +internalAddGeneratedFile( + ' + ++google/ads/admanager/v1/team_messages.protogoogle.ads.admanager.v1google/api/resource.proto"† +Team +name ( BàA +team_id (BàA:UêAR +admanager.googleapis.com/Team$networks/{network_code}/teams/{team}*teams2teamB¨ +com.google.ads.admanager.v1BTeamMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/TimeUnitEnum.php b/AdsAdManager/metadata/V1/TimeUnitEnum.php new file mode 100644 index 0000000000000000000000000000000000000000..e19c07fce545fbe6f9f6488b0c6d800d83206875 GIT binary patch literal 950 zcmb7C-D=w~7+sqFWTF?IVU)2Ott&Kz&LQkBS+*s!lbX%3X`PM@Lr`qR6*!WS<-&gQ z0E0cq*rV*JCfSb3D7~2BlWpnfd`CLx)tmGt1<&CGQ_PXT5nOzM;s(Q%Gr>ZZz(u}X zVh%&LN=bsb0io%_sp~__wEbstYsPXO;vS3{ixb>IQ6_7JD2g%f+;%&HtnfUiM9eYG zS4Ke$07WaDr6|O3;*A_EP=o{uCIv?@j51jjM{wQk0}v)C%b+j0W|GR1OyC=U@=5bW zLPD4cB;@OaWOE_`1SRCFJk0%~~q*QjRNXH{E8N0zW%YV7syh#Ww{bG+RhLXJhw zX}{2|2-fviq3p$LQt22*QQdYdEo#?5we1xAXoBw`VE6s5MWu%2sb2a4*-zqE#q)*Ah4fTuE+#yxUJ zk2cy=S_=ET#^<*cI%Wx?vB7xUi7_og*(sM$N>qaXO>w`zh~GO$lOm;tOsOoVOuBL1 o{j*sKiU7-@S_@=^7yCtzm#4Km=cVae8M!wf1+t978ms~M3tSE+-v9sr literal 0 HcmV?d00001 diff --git a/AdsAdManager/metadata/V1/UserMessages.php b/AdsAdManager/metadata/V1/UserMessages.php new file mode 100644 index 000000000000..2e50bd46d2a4 --- /dev/null +++ b/AdsAdManager/metadata/V1/UserMessages.php @@ -0,0 +1,42 @@ +internalAddGeneratedFile( + ' +ö ++google/ads/admanager/v1/user_messages.protogoogle.ads.admanager.v1google/api/resource.proto"ß +User +name ( BàA +user_id + (BàA + display_name ( BàA +email ( BàA3 +role ( B%àAúA +admanager.googleapis.com/Role +active (BàA + external_id ( BàA +service_account (BàA& +orders_ui_local_time_zone ( BàA:UêAR +admanager.googleapis.com/User$networks/{network_code}/users/{user}*users2userB¨ +com.google.ads.admanager.v1BUserMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/metadata/V1/UserService.php b/AdsAdManager/metadata/V1/UserService.php new file mode 100644 index 000000000000..9bd35f41953e --- /dev/null +++ b/AdsAdManager/metadata/V1/UserService.php @@ -0,0 +1,37 @@ +internalAddGeneratedFile( + ' +ß +*google/ads/admanager/v1/user_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"E +GetUserRequest3 +name ( B%àAúA +admanager.googleapis.com/User2« + UserService +GetUser\'.google.ads.admanager.v1.GetUserRequest.google.ads.admanager.v1.User",ÚAname‚Óä“/v1/{name=networks/*/users/*}ÊAadmanager.googleapis.comB§ +com.google.ads.admanager.v1BUserServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/AdsAdManager/owlbot.py b/AdsAdManager/owlbot.py new file mode 100644 index 000000000000..361341924d7c --- /dev/null +++ b/AdsAdManager/owlbot.py @@ -0,0 +1,56 @@ +# Copyright 2024 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 +# +# http://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. + +"""This script is used to synthesize generated parts of this library.""" + +import logging +from pathlib import Path +import subprocess + +import synthtool as s +from synthtool.languages import php +from synthtool import _tracked_paths + +logging.basicConfig(level=logging.DEBUG) + +src = Path(f"../{php.STAGING_DIR}/AdsAdManager").resolve() +dest = Path().resolve() + +# Added so that we can pass copy_excludes in the owlbot_main() call +_tracked_paths.add(src) + +php.owlbot_main(src=src, dest=dest) + +# remove class_alias code +s.replace( + "src/V*/**/*.php", + r"^// Adding a class alias for backwards compatibility with the previous class name.$" + + "\n" + + r"^class_alias\(.*\);$" + + "\n", + '') + +# format generated clients +subprocess.run([ + 'npm', + 'exec', + '--yes', + '--package=@prettier/plugin-php@^0.16', + '--', + 'prettier', + '**/Client/*', + '--write', + '--parser=php', + '--single-quote', + '--print-width=120']) diff --git a/AdsAdManager/phpunit.xml.dist b/AdsAdManager/phpunit.xml.dist new file mode 100644 index 000000000000..97699d75cfd8 --- /dev/null +++ b/AdsAdManager/phpunit.xml.dist @@ -0,0 +1,16 @@ + + + + + src + + + src/V[!a-zA-Z]* + + + + + tests/Unit + + + diff --git a/AdsAdManager/samples/V1/AdUnitServiceClient/get_ad_unit.php b/AdsAdManager/samples/V1/AdUnitServiceClient/get_ad_unit.php new file mode 100644 index 000000000000..8846a613c9d3 --- /dev/null +++ b/AdsAdManager/samples/V1/AdUnitServiceClient/get_ad_unit.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var AdUnit $response */ + $response = $adUnitServiceClient->getAdUnit($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = AdUnitServiceClient::adUnitName('[NETWORK_CODE]', '[AD_UNIT]'); + + get_ad_unit_sample($formattedName); +} +// [END admanager_v1_generated_AdUnitService_GetAdUnit_sync] diff --git a/AdsAdManager/samples/V1/AdUnitServiceClient/list_ad_unit_sizes.php b/AdsAdManager/samples/V1/AdUnitServiceClient/list_ad_unit_sizes.php new file mode 100644 index 000000000000..ab8027b0a04f --- /dev/null +++ b/AdsAdManager/samples/V1/AdUnitServiceClient/list_ad_unit_sizes.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $adUnitServiceClient->listAdUnitSizes($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = AdUnitServiceClient::networkName('[NETWORK_CODE]'); + + list_ad_unit_sizes_sample($formattedParent); +} +// [END admanager_v1_generated_AdUnitService_ListAdUnitSizes_sync] diff --git a/AdsAdManager/samples/V1/AdUnitServiceClient/list_ad_units.php b/AdsAdManager/samples/V1/AdUnitServiceClient/list_ad_units.php new file mode 100644 index 000000000000..f1538e9f9629 --- /dev/null +++ b/AdsAdManager/samples/V1/AdUnitServiceClient/list_ad_units.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $adUnitServiceClient->listAdUnits($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = AdUnitServiceClient::networkName('[NETWORK_CODE]'); + + list_ad_units_sample($formattedParent); +} +// [END admanager_v1_generated_AdUnitService_ListAdUnits_sync] diff --git a/AdsAdManager/samples/V1/CompanyServiceClient/get_company.php b/AdsAdManager/samples/V1/CompanyServiceClient/get_company.php new file mode 100644 index 000000000000..0c1e0dc60633 --- /dev/null +++ b/AdsAdManager/samples/V1/CompanyServiceClient/get_company.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Company $response */ + $response = $companyServiceClient->getCompany($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = CompanyServiceClient::companyName('[NETWORK_CODE]', '[COMPANY]'); + + get_company_sample($formattedName); +} +// [END admanager_v1_generated_CompanyService_GetCompany_sync] diff --git a/AdsAdManager/samples/V1/CompanyServiceClient/list_companies.php b/AdsAdManager/samples/V1/CompanyServiceClient/list_companies.php new file mode 100644 index 000000000000..ce3426dcd278 --- /dev/null +++ b/AdsAdManager/samples/V1/CompanyServiceClient/list_companies.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $companyServiceClient->listCompanies($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = CompanyServiceClient::networkName('[NETWORK_CODE]'); + + list_companies_sample($formattedParent); +} +// [END admanager_v1_generated_CompanyService_ListCompanies_sync] diff --git a/AdsAdManager/samples/V1/CustomFieldServiceClient/get_custom_field.php b/AdsAdManager/samples/V1/CustomFieldServiceClient/get_custom_field.php new file mode 100644 index 000000000000..1d7294b16391 --- /dev/null +++ b/AdsAdManager/samples/V1/CustomFieldServiceClient/get_custom_field.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var CustomField $response */ + $response = $customFieldServiceClient->getCustomField($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = CustomFieldServiceClient::customFieldName('[NETWORK_CODE]', '[CUSTOM_FIELD]'); + + get_custom_field_sample($formattedName); +} +// [END admanager_v1_generated_CustomFieldService_GetCustomField_sync] diff --git a/AdsAdManager/samples/V1/CustomFieldServiceClient/list_custom_fields.php b/AdsAdManager/samples/V1/CustomFieldServiceClient/list_custom_fields.php new file mode 100644 index 000000000000..f473dc1ef5d3 --- /dev/null +++ b/AdsAdManager/samples/V1/CustomFieldServiceClient/list_custom_fields.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $customFieldServiceClient->listCustomFields($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = CustomFieldServiceClient::networkName('[NETWORK_CODE]'); + + list_custom_fields_sample($formattedParent); +} +// [END admanager_v1_generated_CustomFieldService_ListCustomFields_sync] diff --git a/AdsAdManager/samples/V1/CustomTargetingKeyServiceClient/get_custom_targeting_key.php b/AdsAdManager/samples/V1/CustomTargetingKeyServiceClient/get_custom_targeting_key.php new file mode 100644 index 000000000000..4ac51252a78c --- /dev/null +++ b/AdsAdManager/samples/V1/CustomTargetingKeyServiceClient/get_custom_targeting_key.php @@ -0,0 +1,76 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var CustomTargetingKey $response */ + $response = $customTargetingKeyServiceClient->getCustomTargetingKey($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = CustomTargetingKeyServiceClient::customTargetingKeyName( + '[NETWORK_CODE]', + '[CUSTOM_TARGETING_KEY]' + ); + + get_custom_targeting_key_sample($formattedName); +} +// [END admanager_v1_generated_CustomTargetingKeyService_GetCustomTargetingKey_sync] diff --git a/AdsAdManager/samples/V1/CustomTargetingKeyServiceClient/list_custom_targeting_keys.php b/AdsAdManager/samples/V1/CustomTargetingKeyServiceClient/list_custom_targeting_keys.php new file mode 100644 index 000000000000..29e88c3c2904 --- /dev/null +++ b/AdsAdManager/samples/V1/CustomTargetingKeyServiceClient/list_custom_targeting_keys.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $customTargetingKeyServiceClient->listCustomTargetingKeys($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = CustomTargetingKeyServiceClient::networkName('[NETWORK_CODE]'); + + list_custom_targeting_keys_sample($formattedParent); +} +// [END admanager_v1_generated_CustomTargetingKeyService_ListCustomTargetingKeys_sync] diff --git a/AdsAdManager/samples/V1/CustomTargetingValueServiceClient/get_custom_targeting_value.php b/AdsAdManager/samples/V1/CustomTargetingValueServiceClient/get_custom_targeting_value.php new file mode 100644 index 000000000000..4f15dfc8c026 --- /dev/null +++ b/AdsAdManager/samples/V1/CustomTargetingValueServiceClient/get_custom_targeting_value.php @@ -0,0 +1,77 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var CustomTargetingValue $response */ + $response = $customTargetingValueServiceClient->getCustomTargetingValue($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = CustomTargetingValueServiceClient::customTargetingValueName( + '[NETWORK_CODE]', + '[CUSTOM_TARGETING_KEY]', + '[CUSTOM_TARGETING_VALUE]' + ); + + get_custom_targeting_value_sample($formattedName); +} +// [END admanager_v1_generated_CustomTargetingValueService_GetCustomTargetingValue_sync] diff --git a/AdsAdManager/samples/V1/CustomTargetingValueServiceClient/list_custom_targeting_values.php b/AdsAdManager/samples/V1/CustomTargetingValueServiceClient/list_custom_targeting_values.php new file mode 100644 index 000000000000..f2e059ab37d9 --- /dev/null +++ b/AdsAdManager/samples/V1/CustomTargetingValueServiceClient/list_custom_targeting_values.php @@ -0,0 +1,79 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $customTargetingValueServiceClient->listCustomTargetingValues($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = CustomTargetingValueServiceClient::customTargetingKeyName( + '[NETWORK_CODE]', + '[CUSTOM_TARGETING_KEY]' + ); + + list_custom_targeting_values_sample($formattedParent); +} +// [END admanager_v1_generated_CustomTargetingValueService_ListCustomTargetingValues_sync] diff --git a/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/batch_create_entity_signals_mappings.php b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/batch_create_entity_signals_mappings.php new file mode 100644 index 000000000000..a7b924a0dd25 --- /dev/null +++ b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/batch_create_entity_signals_mappings.php @@ -0,0 +1,99 @@ +setTaxonomyCategoryIds($requestsEntitySignalsMappingTaxonomyCategoryIds); + $createEntitySignalsMappingRequest = (new CreateEntitySignalsMappingRequest()) + ->setParent($formattedRequestsParent) + ->setEntitySignalsMapping($requestsEntitySignalsMapping); + $requests = [$createEntitySignalsMappingRequest,]; + $request = (new BatchCreateEntitySignalsMappingsRequest()) + ->setParent($formattedParent) + ->setRequests($requests); + + // Call the API and handle any network failures. + try { + /** @var BatchCreateEntitySignalsMappingsResponse $response */ + $response = $entitySignalsMappingServiceClient->batchCreateEntitySignalsMappings($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedParent = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]'); + $formattedRequestsParent = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]'); + $requestsEntitySignalsMappingTaxonomyCategoryIdsElement = 0; + + batch_create_entity_signals_mappings_sample( + $formattedParent, + $formattedRequestsParent, + $requestsEntitySignalsMappingTaxonomyCategoryIdsElement + ); +} +// [END admanager_v1_generated_EntitySignalsMappingService_BatchCreateEntitySignalsMappings_sync] diff --git a/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/batch_update_entity_signals_mappings.php b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/batch_update_entity_signals_mappings.php new file mode 100644 index 000000000000..3a8f3c005f14 --- /dev/null +++ b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/batch_update_entity_signals_mappings.php @@ -0,0 +1,95 @@ +setTaxonomyCategoryIds($requestsEntitySignalsMappingTaxonomyCategoryIds); + $requestsUpdateMask = new FieldMask(); + $updateEntitySignalsMappingRequest = (new UpdateEntitySignalsMappingRequest()) + ->setEntitySignalsMapping($requestsEntitySignalsMapping) + ->setUpdateMask($requestsUpdateMask); + $requests = [$updateEntitySignalsMappingRequest,]; + $request = (new BatchUpdateEntitySignalsMappingsRequest()) + ->setParent($formattedParent) + ->setRequests($requests); + + // Call the API and handle any network failures. + try { + /** @var BatchUpdateEntitySignalsMappingsResponse $response */ + $response = $entitySignalsMappingServiceClient->batchUpdateEntitySignalsMappings($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedParent = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]'); + $requestsEntitySignalsMappingTaxonomyCategoryIdsElement = 0; + + batch_update_entity_signals_mappings_sample( + $formattedParent, + $requestsEntitySignalsMappingTaxonomyCategoryIdsElement + ); +} +// [END admanager_v1_generated_EntitySignalsMappingService_BatchUpdateEntitySignalsMappings_sync] diff --git a/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/create_entity_signals_mapping.php b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/create_entity_signals_mapping.php new file mode 100644 index 000000000000..c1fb72f8b838 --- /dev/null +++ b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/create_entity_signals_mapping.php @@ -0,0 +1,84 @@ +setTaxonomyCategoryIds($entitySignalsMappingTaxonomyCategoryIds); + $request = (new CreateEntitySignalsMappingRequest()) + ->setParent($formattedParent) + ->setEntitySignalsMapping($entitySignalsMapping); + + // Call the API and handle any network failures. + try { + /** @var EntitySignalsMapping $response */ + $response = $entitySignalsMappingServiceClient->createEntitySignalsMapping($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedParent = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]'); + $entitySignalsMappingTaxonomyCategoryIdsElement = 0; + + create_entity_signals_mapping_sample( + $formattedParent, + $entitySignalsMappingTaxonomyCategoryIdsElement + ); +} +// [END admanager_v1_generated_EntitySignalsMappingService_CreateEntitySignalsMapping_sync] diff --git a/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/get_entity_signals_mapping.php b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/get_entity_signals_mapping.php new file mode 100644 index 000000000000..7b7aaf4d0295 --- /dev/null +++ b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/get_entity_signals_mapping.php @@ -0,0 +1,76 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var EntitySignalsMapping $response */ + $response = $entitySignalsMappingServiceClient->getEntitySignalsMapping($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = EntitySignalsMappingServiceClient::entitySignalsMappingName( + '[NETWORK_CODE]', + '[ENTITY_SIGNALS_MAPPING]' + ); + + get_entity_signals_mapping_sample($formattedName); +} +// [END admanager_v1_generated_EntitySignalsMappingService_GetEntitySignalsMapping_sync] diff --git a/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/list_entity_signals_mappings.php b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/list_entity_signals_mappings.php new file mode 100644 index 000000000000..d52e3906c8af --- /dev/null +++ b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/list_entity_signals_mappings.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $entitySignalsMappingServiceClient->listEntitySignalsMappings($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = EntitySignalsMappingServiceClient::networkName('[NETWORK_CODE]'); + + list_entity_signals_mappings_sample($formattedParent); +} +// [END admanager_v1_generated_EntitySignalsMappingService_ListEntitySignalsMappings_sync] diff --git a/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/update_entity_signals_mapping.php b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/update_entity_signals_mapping.php new file mode 100644 index 000000000000..a845c4403460 --- /dev/null +++ b/AdsAdManager/samples/V1/EntitySignalsMappingServiceClient/update_entity_signals_mapping.php @@ -0,0 +1,78 @@ +setTaxonomyCategoryIds($entitySignalsMappingTaxonomyCategoryIds); + $updateMask = new FieldMask(); + $request = (new UpdateEntitySignalsMappingRequest()) + ->setEntitySignalsMapping($entitySignalsMapping) + ->setUpdateMask($updateMask); + + // Call the API and handle any network failures. + try { + /** @var EntitySignalsMapping $response */ + $response = $entitySignalsMappingServiceClient->updateEntitySignalsMapping($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $entitySignalsMappingTaxonomyCategoryIdsElement = 0; + + update_entity_signals_mapping_sample($entitySignalsMappingTaxonomyCategoryIdsElement); +} +// [END admanager_v1_generated_EntitySignalsMappingService_UpdateEntitySignalsMapping_sync] diff --git a/AdsAdManager/samples/V1/NetworkServiceClient/get_network.php b/AdsAdManager/samples/V1/NetworkServiceClient/get_network.php new file mode 100644 index 000000000000..9818680de8f5 --- /dev/null +++ b/AdsAdManager/samples/V1/NetworkServiceClient/get_network.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Network $response */ + $response = $networkServiceClient->getNetwork($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = NetworkServiceClient::networkName('[NETWORK_CODE]'); + + get_network_sample($formattedName); +} +// [END admanager_v1_generated_NetworkService_GetNetwork_sync] diff --git a/AdsAdManager/samples/V1/NetworkServiceClient/list_networks.php b/AdsAdManager/samples/V1/NetworkServiceClient/list_networks.php new file mode 100644 index 000000000000..aa1441a7bd6c --- /dev/null +++ b/AdsAdManager/samples/V1/NetworkServiceClient/list_networks.php @@ -0,0 +1,57 @@ +listNetworks($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END admanager_v1_generated_NetworkService_ListNetworks_sync] diff --git a/AdsAdManager/samples/V1/OrderServiceClient/get_order.php b/AdsAdManager/samples/V1/OrderServiceClient/get_order.php new file mode 100644 index 000000000000..5fe249566baf --- /dev/null +++ b/AdsAdManager/samples/V1/OrderServiceClient/get_order.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Order $response */ + $response = $orderServiceClient->getOrder($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = OrderServiceClient::orderName('[NETWORK_CODE]', '[ORDER]'); + + get_order_sample($formattedName); +} +// [END admanager_v1_generated_OrderService_GetOrder_sync] diff --git a/AdsAdManager/samples/V1/OrderServiceClient/list_orders.php b/AdsAdManager/samples/V1/OrderServiceClient/list_orders.php new file mode 100644 index 000000000000..5d7c96bdc617 --- /dev/null +++ b/AdsAdManager/samples/V1/OrderServiceClient/list_orders.php @@ -0,0 +1,80 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $orderServiceClient->listOrders($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = OrderServiceClient::networkName('[NETWORK_CODE]'); + + list_orders_sample($formattedParent); +} +// [END admanager_v1_generated_OrderService_ListOrders_sync] diff --git a/AdsAdManager/samples/V1/PlacementServiceClient/get_placement.php b/AdsAdManager/samples/V1/PlacementServiceClient/get_placement.php new file mode 100644 index 000000000000..b9b03f3758f2 --- /dev/null +++ b/AdsAdManager/samples/V1/PlacementServiceClient/get_placement.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Placement $response */ + $response = $placementServiceClient->getPlacement($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = PlacementServiceClient::placementName('[NETWORK_CODE]', '[PLACEMENT]'); + + get_placement_sample($formattedName); +} +// [END admanager_v1_generated_PlacementService_GetPlacement_sync] diff --git a/AdsAdManager/samples/V1/PlacementServiceClient/list_placements.php b/AdsAdManager/samples/V1/PlacementServiceClient/list_placements.php new file mode 100644 index 000000000000..bd1d6b8e230b --- /dev/null +++ b/AdsAdManager/samples/V1/PlacementServiceClient/list_placements.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $placementServiceClient->listPlacements($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = PlacementServiceClient::networkName('[NETWORK_CODE]'); + + list_placements_sample($formattedParent); +} +// [END admanager_v1_generated_PlacementService_ListPlacements_sync] diff --git a/AdsAdManager/samples/V1/ReportServiceClient/create_report.php b/AdsAdManager/samples/V1/ReportServiceClient/create_report.php new file mode 100644 index 000000000000..ca38b7b8f5fe --- /dev/null +++ b/AdsAdManager/samples/V1/ReportServiceClient/create_report.php @@ -0,0 +1,105 @@ +setDimensions($reportReportDefinitionDimensions) + ->setMetrics($reportReportDefinitionMetrics) + ->setDateRange($reportReportDefinitionDateRange) + ->setReportType($reportReportDefinitionReportType); + $report = (new Report()) + ->setReportDefinition($reportReportDefinition); + $request = (new CreateReportRequest()) + ->setParent($formattedParent) + ->setReport($report); + + // Call the API and handle any network failures. + try { + /** @var Report $response */ + $response = $reportServiceClient->createReport($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedParent = ReportServiceClient::networkName('[NETWORK_CODE]'); + $reportReportDefinitionDimensionsElement = Dimension::DIMENSION_UNSPECIFIED; + $reportReportDefinitionMetricsElement = Metric::METRIC_UNSPECIFIED; + $reportReportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED; + + create_report_sample( + $formattedParent, + $reportReportDefinitionDimensionsElement, + $reportReportDefinitionMetricsElement, + $reportReportDefinitionReportType + ); +} +// [END admanager_v1_generated_ReportService_CreateReport_sync] diff --git a/AdsAdManager/samples/V1/ReportServiceClient/fetch_report_result_rows.php b/AdsAdManager/samples/V1/ReportServiceClient/fetch_report_result_rows.php new file mode 100644 index 000000000000..3f7124c71921 --- /dev/null +++ b/AdsAdManager/samples/V1/ReportServiceClient/fetch_report_result_rows.php @@ -0,0 +1,60 @@ +fetchReportResultRows($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END admanager_v1_generated_ReportService_FetchReportResultRows_sync] diff --git a/AdsAdManager/samples/V1/ReportServiceClient/get_report.php b/AdsAdManager/samples/V1/ReportServiceClient/get_report.php new file mode 100644 index 000000000000..0b5d5b11d47e --- /dev/null +++ b/AdsAdManager/samples/V1/ReportServiceClient/get_report.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Report $response */ + $response = $reportServiceClient->getReport($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = ReportServiceClient::reportName('[NETWORK_CODE]', '[REPORT]'); + + get_report_sample($formattedName); +} +// [END admanager_v1_generated_ReportService_GetReport_sync] diff --git a/AdsAdManager/samples/V1/ReportServiceClient/list_reports.php b/AdsAdManager/samples/V1/ReportServiceClient/list_reports.php new file mode 100644 index 000000000000..aa12df99e9cb --- /dev/null +++ b/AdsAdManager/samples/V1/ReportServiceClient/list_reports.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $reportServiceClient->listReports($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = ReportServiceClient::networkName('[NETWORK_CODE]'); + + list_reports_sample($formattedParent); +} +// [END admanager_v1_generated_ReportService_ListReports_sync] diff --git a/AdsAdManager/samples/V1/ReportServiceClient/run_report.php b/AdsAdManager/samples/V1/ReportServiceClient/run_report.php new file mode 100644 index 000000000000..d3e4d98a6ef8 --- /dev/null +++ b/AdsAdManager/samples/V1/ReportServiceClient/run_report.php @@ -0,0 +1,91 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $reportServiceClient->runReport($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var RunReportResponse $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 +{ + $formattedName = ReportServiceClient::reportName('[NETWORK_CODE]', '[REPORT]'); + + run_report_sample($formattedName); +} +// [END admanager_v1_generated_ReportService_RunReport_sync] diff --git a/AdsAdManager/samples/V1/ReportServiceClient/update_report.php b/AdsAdManager/samples/V1/ReportServiceClient/update_report.php new file mode 100644 index 000000000000..84e9e65464c1 --- /dev/null +++ b/AdsAdManager/samples/V1/ReportServiceClient/update_report.php @@ -0,0 +1,101 @@ +setDimensions($reportReportDefinitionDimensions) + ->setMetrics($reportReportDefinitionMetrics) + ->setDateRange($reportReportDefinitionDateRange) + ->setReportType($reportReportDefinitionReportType); + $report = (new Report()) + ->setReportDefinition($reportReportDefinition); + $updateMask = new FieldMask(); + $request = (new UpdateReportRequest()) + ->setReport($report) + ->setUpdateMask($updateMask); + + // Call the API and handle any network failures. + try { + /** @var Report $response */ + $response = $reportServiceClient->updateReport($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $reportReportDefinitionDimensionsElement = Dimension::DIMENSION_UNSPECIFIED; + $reportReportDefinitionMetricsElement = Metric::METRIC_UNSPECIFIED; + $reportReportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED; + + update_report_sample( + $reportReportDefinitionDimensionsElement, + $reportReportDefinitionMetricsElement, + $reportReportDefinitionReportType + ); +} +// [END admanager_v1_generated_ReportService_UpdateReport_sync] diff --git a/AdsAdManager/samples/V1/RoleServiceClient/get_role.php b/AdsAdManager/samples/V1/RoleServiceClient/get_role.php new file mode 100644 index 000000000000..3204222ed446 --- /dev/null +++ b/AdsAdManager/samples/V1/RoleServiceClient/get_role.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Role $response */ + $response = $roleServiceClient->getRole($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = RoleServiceClient::roleName('[NETWORK_CODE]', '[ROLE]'); + + get_role_sample($formattedName); +} +// [END admanager_v1_generated_RoleService_GetRole_sync] diff --git a/AdsAdManager/samples/V1/RoleServiceClient/list_roles.php b/AdsAdManager/samples/V1/RoleServiceClient/list_roles.php new file mode 100644 index 000000000000..d9adaa30e69c --- /dev/null +++ b/AdsAdManager/samples/V1/RoleServiceClient/list_roles.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $roleServiceClient->listRoles($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = RoleServiceClient::networkName('[NETWORK_CODE]'); + + list_roles_sample($formattedParent); +} +// [END admanager_v1_generated_RoleService_ListRoles_sync] diff --git a/AdsAdManager/samples/V1/TaxonomyCategoryServiceClient/get_taxonomy_category.php b/AdsAdManager/samples/V1/TaxonomyCategoryServiceClient/get_taxonomy_category.php new file mode 100644 index 000000000000..b0688bd41755 --- /dev/null +++ b/AdsAdManager/samples/V1/TaxonomyCategoryServiceClient/get_taxonomy_category.php @@ -0,0 +1,75 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var TaxonomyCategory $response */ + $response = $taxonomyCategoryServiceClient->getTaxonomyCategory($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = TaxonomyCategoryServiceClient::taxonomyCategoryName( + '[NETWORK_CODE]', + '[TAXONOMY_CATEGORY]' + ); + + get_taxonomy_category_sample($formattedName); +} +// [END admanager_v1_generated_TaxonomyCategoryService_GetTaxonomyCategory_sync] diff --git a/AdsAdManager/samples/V1/TaxonomyCategoryServiceClient/list_taxonomy_categories.php b/AdsAdManager/samples/V1/TaxonomyCategoryServiceClient/list_taxonomy_categories.php new file mode 100644 index 000000000000..285ee42ebaf4 --- /dev/null +++ b/AdsAdManager/samples/V1/TaxonomyCategoryServiceClient/list_taxonomy_categories.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $taxonomyCategoryServiceClient->listTaxonomyCategories($request); + + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = TaxonomyCategoryServiceClient::networkName('[NETWORK_CODE]'); + + list_taxonomy_categories_sample($formattedParent); +} +// [END admanager_v1_generated_TaxonomyCategoryService_ListTaxonomyCategories_sync] diff --git a/AdsAdManager/samples/V1/UserServiceClient/get_user.php b/AdsAdManager/samples/V1/UserServiceClient/get_user.php new file mode 100644 index 000000000000..fdccc337f748 --- /dev/null +++ b/AdsAdManager/samples/V1/UserServiceClient/get_user.php @@ -0,0 +1,75 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var User $response */ + $response = $userServiceClient->getUser($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = UserServiceClient::userName('[NETWORK_CODE]', '[USER]'); + + get_user_sample($formattedName); +} +// [END admanager_v1_generated_UserService_GetUser_sync] diff --git a/AdsAdManager/src/V1/AdManagerError.php b/AdsAdManager/src/V1/AdManagerError.php new file mode 100644 index 000000000000..2db8e2369455 --- /dev/null +++ b/AdsAdManager/src/V1/AdManagerError.php @@ -0,0 +1,241 @@ +google.ads.admanager.v1.AdManagerError + */ +class AdManagerError extends \Google\Protobuf\Internal\Message +{ + /** + * The unique identifying string for this error. + * + * Generated from protobuf field string error_code = 1; + */ + protected $error_code = ''; + /** + * A publisher appropriate explanation of this error. + * + * Generated from protobuf field string message = 2; + */ + protected $message = ''; + /** + * The field path that triggered this error. + * + * Generated from protobuf field string field_path = 3; + */ + protected $field_path = ''; + /** + * The value that triggered this error. + * + * Generated from protobuf field string trigger = 4; + */ + protected $trigger = ''; + /** + * The stack trace that accompanies this error. + * + * Generated from protobuf field string stack_trace = 5; + */ + protected $stack_trace = ''; + /** + * A list of messages that carry any additional error details. + * + * Generated from protobuf field repeated .google.protobuf.Any details = 6; + */ + private $details; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $error_code + * The unique identifying string for this error. + * @type string $message + * A publisher appropriate explanation of this error. + * @type string $field_path + * The field path that triggered this error. + * @type string $trigger + * The value that triggered this error. + * @type string $stack_trace + * The stack trace that accompanies this error. + * @type array<\Google\Protobuf\Any>|\Google\Protobuf\Internal\RepeatedField $details + * A list of messages that carry any additional error details. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdmanagerError::initOnce(); + parent::__construct($data); + } + + /** + * The unique identifying string for this error. + * + * Generated from protobuf field string error_code = 1; + * @return string + */ + public function getErrorCode() + { + return $this->error_code; + } + + /** + * The unique identifying string for this error. + * + * Generated from protobuf field string error_code = 1; + * @param string $var + * @return $this + */ + public function setErrorCode($var) + { + GPBUtil::checkString($var, True); + $this->error_code = $var; + + return $this; + } + + /** + * A publisher appropriate explanation of this error. + * + * Generated from protobuf field string message = 2; + * @return string + */ + public function getMessage() + { + return $this->message; + } + + /** + * A publisher appropriate explanation of this error. + * + * Generated from protobuf field string message = 2; + * @param string $var + * @return $this + */ + public function setMessage($var) + { + GPBUtil::checkString($var, True); + $this->message = $var; + + return $this; + } + + /** + * The field path that triggered this error. + * + * Generated from protobuf field string field_path = 3; + * @return string + */ + public function getFieldPath() + { + return $this->field_path; + } + + /** + * The field path that triggered this error. + * + * Generated from protobuf field string field_path = 3; + * @param string $var + * @return $this + */ + public function setFieldPath($var) + { + GPBUtil::checkString($var, True); + $this->field_path = $var; + + return $this; + } + + /** + * The value that triggered this error. + * + * Generated from protobuf field string trigger = 4; + * @return string + */ + public function getTrigger() + { + return $this->trigger; + } + + /** + * The value that triggered this error. + * + * Generated from protobuf field string trigger = 4; + * @param string $var + * @return $this + */ + public function setTrigger($var) + { + GPBUtil::checkString($var, True); + $this->trigger = $var; + + return $this; + } + + /** + * The stack trace that accompanies this error. + * + * Generated from protobuf field string stack_trace = 5; + * @return string + */ + public function getStackTrace() + { + return $this->stack_trace; + } + + /** + * The stack trace that accompanies this error. + * + * Generated from protobuf field string stack_trace = 5; + * @param string $var + * @return $this + */ + public function setStackTrace($var) + { + GPBUtil::checkString($var, True); + $this->stack_trace = $var; + + return $this; + } + + /** + * A list of messages that carry any additional error details. + * + * Generated from protobuf field repeated .google.protobuf.Any details = 6; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDetails() + { + return $this->details; + } + + /** + * A list of messages that carry any additional error details. + * + * Generated from protobuf field repeated .google.protobuf.Any details = 6; + * @param array<\Google\Protobuf\Any>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDetails($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Any::class); + $this->details = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/AdUnit.php b/AdsAdManager/src/V1/AdUnit.php new file mode 100644 index 000000000000..143f8778cc75 --- /dev/null +++ b/AdsAdManager/src/V1/AdUnit.php @@ -0,0 +1,1049 @@ +google.ads.admanager.v1.AdUnit + */ +class AdUnit extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. AdUnit ID. + * + * Generated from protobuf field int64 ad_unit_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $ad_unit_id = 0; + /** + * Required. Immutable. The AdUnit's parent. Every ad unit has a parent except + * for the root ad unit, which is created by Google. Format: + * "networks/{network_code}/adUnits/{ad_unit_id}" + * + * Generated from protobuf field string parent_ad_unit = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { + */ + protected $parent_ad_unit = ''; + /** + * Output only. The path to this AdUnit in the ad unit hierarchy represented + * as a list from the root to this ad unit's parent. For root ad units, this + * list is empty. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitParent parent_path = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $parent_path; + /** + * Required. The display name of the ad unit. Its maximum length is 255 + * characters. + * + * Generated from protobuf field string display_name = 9 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $display_name = ''; + /** + * Immutable. A string used to uniquely identify the ad unit for the purposes + * of serving the ad. This attribute is optional and can be set during ad unit + * creation. If it is not provided, it will be assigned by Google based on the + * ad unit ID. + * + * Generated from protobuf field string ad_unit_code = 2 [(.google.api.field_behavior) = IMMUTABLE]; + */ + protected $ad_unit_code = ''; + /** + * Output only. The status of this ad unit. It defaults to ACTIVE. + * + * Generated from protobuf field .google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = 0; + /** + * Optional. The target window directly applied to this AdUnit. + * If this field is not set, this AdUnit uses the target window specified in + * effectiveTargetWindow. + * + * Generated from protobuf field .google.ads.admanager.v1.TargetWindowEnum.TargetWindow applied_target_window = 44 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $applied_target_window = 0; + /** + * Output only. Non-empty default. The target window of this AdUnit. This + * value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit + * in the hierarchy specifies it. + * + * Generated from protobuf field .google.ads.admanager.v1.TargetWindowEnum.TargetWindow effective_target_window = 45 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT, (.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $effective_target_window = 0; + /** + * Optional. The resource names of Teams directly applied to this AdUnit. + * Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $applied_teams; + /** + * Output only. The resource names of all Teams that this AdUnit is on as well + * as those inherited from parent AdUnits. Format: + * "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string teams = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + */ + private $teams; + /** + * Optional. A description of the ad unit. The maximum length is 65,535 + * characters. + * + * Generated from protobuf field string description = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $description = ''; + /** + * Optional. If this field is set to true, then the AdUnit will not be + * implicitly targeted when its parent is. Traffickers must explicitly + * target such an AdUnit or else no line items will serve to it. This + * feature is only available for Ad Manager 360 accounts. + * + * Generated from protobuf field bool explicitly_targeted = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $explicitly_targeted = false; + /** + * Output only. This field is set to true if the ad unit has any children. + * + * Generated from protobuf field bool has_children = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $has_children = false; + /** + * Output only. The time this AdUnit was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. The sizes that can be served inside this ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 14 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $ad_unit_sizes; + /** + * Optional. Determines what set top box video on demand channel this ad unit + * corresponds to in an external set top box ad campaign system. + * + * Generated from protobuf field string external_set_top_box_channel_id = 17 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $external_set_top_box_channel_id = ''; + /** + * Optional. The duration after which an Ad Unit will automatically refresh. + * This is only valid for ad units in mobile apps. If not set, the ad unit + * will not refresh. + * + * Generated from protobuf field .google.protobuf.Duration refresh_delay = 19 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $refresh_delay = null; + /** + * Optional. The set of labels applied directly to this ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 21 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $applied_labels; + /** + * Output only. Contains the set of labels applied directly to the ad unit as + * well as those inherited from the parent ad units. If a label has been + * negated, only the negated label is returned. This field is readonly and is + * assigned by Google. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $effective_applied_labels; + /** + * Optional. The set of label frequency caps applied directly to this ad unit. + * There is a limit of 10 label frequency caps per ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.LabelFrequencyCap applied_label_frequency_caps = 23 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $applied_label_frequency_caps; + /** + * Output only. The label frequency caps applied directly to the ad unit as + * well as those inherited from parent ad units. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.LabelFrequencyCap effective_label_frequency_caps = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $effective_label_frequency_caps; + /** + * Optional. The smart size mode for this ad unit. This attribute is optional + * and defaults to SmartSizeMode.NONE for fixed sizes. + * + * Generated from protobuf field .google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode smart_size_mode = 25 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $smart_size_mode = 0; + /** + * Optional. The value of AdSense enabled directly applied to this ad unit. + * This attribute is optional and if not specified this ad unit will inherit + * the value of effectiveAdsenseEnabled from its ancestors. + * + * Generated from protobuf field optional bool applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $applied_adsense_enabled = null; + /** + * Output only. Specifies whether or not the AdUnit is enabled for serving ads + * from the AdSense content network. This attribute defaults to the ad unit's + * parent or ancestor's setting if one has been set. If no ancestor of the ad + * unit has set appliedAdsenseEnabled, the attribute is defaulted to true. + * + * Generated from protobuf field bool effective_adsense_enabled = 27 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $effective_adsense_enabled = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * @type int|string $ad_unit_id + * Output only. AdUnit ID. + * @type string $parent_ad_unit + * Required. Immutable. The AdUnit's parent. Every ad unit has a parent except + * for the root ad unit, which is created by Google. Format: + * "networks/{network_code}/adUnits/{ad_unit_id}" + * @type array<\Google\Ads\AdManager\V1\AdUnitParent>|\Google\Protobuf\Internal\RepeatedField $parent_path + * Output only. The path to this AdUnit in the ad unit hierarchy represented + * as a list from the root to this ad unit's parent. For root ad units, this + * list is empty. + * @type string $display_name + * Required. The display name of the ad unit. Its maximum length is 255 + * characters. + * @type string $ad_unit_code + * Immutable. A string used to uniquely identify the ad unit for the purposes + * of serving the ad. This attribute is optional and can be set during ad unit + * creation. If it is not provided, it will be assigned by Google based on the + * ad unit ID. + * @type int $status + * Output only. The status of this ad unit. It defaults to ACTIVE. + * @type int $applied_target_window + * Optional. The target window directly applied to this AdUnit. + * If this field is not set, this AdUnit uses the target window specified in + * effectiveTargetWindow. + * @type int $effective_target_window + * Output only. Non-empty default. The target window of this AdUnit. This + * value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit + * in the hierarchy specifies it. + * @type array|\Google\Protobuf\Internal\RepeatedField $applied_teams + * Optional. The resource names of Teams directly applied to this AdUnit. + * Format: "networks/{network_code}/teams/{team_id}" + * @type array|\Google\Protobuf\Internal\RepeatedField $teams + * Output only. The resource names of all Teams that this AdUnit is on as well + * as those inherited from parent AdUnits. Format: + * "networks/{network_code}/teams/{team_id}" + * @type string $description + * Optional. A description of the ad unit. The maximum length is 65,535 + * characters. + * @type bool $explicitly_targeted + * Optional. If this field is set to true, then the AdUnit will not be + * implicitly targeted when its parent is. Traffickers must explicitly + * target such an AdUnit or else no line items will serve to it. This + * feature is only available for Ad Manager 360 accounts. + * @type bool $has_children + * Output only. This field is set to true if the ad unit has any children. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time this AdUnit was last modified. + * @type array<\Google\Ads\AdManager\V1\AdUnitSize>|\Google\Protobuf\Internal\RepeatedField $ad_unit_sizes + * Optional. The sizes that can be served inside this ad unit. + * @type string $external_set_top_box_channel_id + * Optional. Determines what set top box video on demand channel this ad unit + * corresponds to in an external set top box ad campaign system. + * @type \Google\Protobuf\Duration $refresh_delay + * Optional. The duration after which an Ad Unit will automatically refresh. + * This is only valid for ad units in mobile apps. If not set, the ad unit + * will not refresh. + * @type array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $applied_labels + * Optional. The set of labels applied directly to this ad unit. + * @type array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $effective_applied_labels + * Output only. Contains the set of labels applied directly to the ad unit as + * well as those inherited from the parent ad units. If a label has been + * negated, only the negated label is returned. This field is readonly and is + * assigned by Google. + * @type array<\Google\Ads\AdManager\V1\LabelFrequencyCap>|\Google\Protobuf\Internal\RepeatedField $applied_label_frequency_caps + * Optional. The set of label frequency caps applied directly to this ad unit. + * There is a limit of 10 label frequency caps per ad unit. + * @type array<\Google\Ads\AdManager\V1\LabelFrequencyCap>|\Google\Protobuf\Internal\RepeatedField $effective_label_frequency_caps + * Output only. The label frequency caps applied directly to the ad unit as + * well as those inherited from parent ad units. + * @type int $smart_size_mode + * Optional. The smart size mode for this ad unit. This attribute is optional + * and defaults to SmartSizeMode.NONE for fixed sizes. + * @type bool $applied_adsense_enabled + * Optional. The value of AdSense enabled directly applied to this ad unit. + * This attribute is optional and if not specified this ad unit will inherit + * the value of effectiveAdsenseEnabled from its ancestors. + * @type bool $effective_adsense_enabled + * Output only. Specifies whether or not the AdUnit is enabled for serving ads + * from the AdSense content network. This attribute defaults to the ad unit's + * parent or ancestor's setting if one has been set. If no ancestor of the ad + * unit has set appliedAdsenseEnabled, the attribute is defaulted to true. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. AdUnit ID. + * + * Generated from protobuf field int64 ad_unit_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getAdUnitId() + { + return $this->ad_unit_id; + } + + /** + * Output only. AdUnit ID. + * + * Generated from protobuf field int64 ad_unit_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setAdUnitId($var) + { + GPBUtil::checkInt64($var); + $this->ad_unit_id = $var; + + return $this; + } + + /** + * Required. Immutable. The AdUnit's parent. Every ad unit has a parent except + * for the root ad unit, which is created by Google. Format: + * "networks/{network_code}/adUnits/{ad_unit_id}" + * + * Generated from protobuf field string parent_ad_unit = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { + * @return string + */ + public function getParentAdUnit() + { + return $this->parent_ad_unit; + } + + /** + * Required. Immutable. The AdUnit's parent. Every ad unit has a parent except + * for the root ad unit, which is created by Google. Format: + * "networks/{network_code}/adUnits/{ad_unit_id}" + * + * Generated from protobuf field string parent_ad_unit = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParentAdUnit($var) + { + GPBUtil::checkString($var, True); + $this->parent_ad_unit = $var; + + return $this; + } + + /** + * Output only. The path to this AdUnit in the ad unit hierarchy represented + * as a list from the root to this ad unit's parent. For root ad units, this + * list is empty. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitParent parent_path = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getParentPath() + { + return $this->parent_path; + } + + /** + * Output only. The path to this AdUnit in the ad unit hierarchy represented + * as a list from the root to this ad unit's parent. For root ad units, this + * list is empty. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitParent parent_path = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array<\Google\Ads\AdManager\V1\AdUnitParent>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setParentPath($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AdUnitParent::class); + $this->parent_path = $arr; + + return $this; + } + + /** + * Required. The display name of the ad unit. Its maximum length is 255 + * characters. + * + * Generated from protobuf field string display_name = 9 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Required. The display name of the ad unit. Its maximum length is 255 + * characters. + * + * Generated from protobuf field string display_name = 9 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Immutable. A string used to uniquely identify the ad unit for the purposes + * of serving the ad. This attribute is optional and can be set during ad unit + * creation. If it is not provided, it will be assigned by Google based on the + * ad unit ID. + * + * Generated from protobuf field string ad_unit_code = 2 [(.google.api.field_behavior) = IMMUTABLE]; + * @return string + */ + public function getAdUnitCode() + { + return $this->ad_unit_code; + } + + /** + * Immutable. A string used to uniquely identify the ad unit for the purposes + * of serving the ad. This attribute is optional and can be set during ad unit + * creation. If it is not provided, it will be assigned by Google based on the + * ad unit ID. + * + * Generated from protobuf field string ad_unit_code = 2 [(.google.api.field_behavior) = IMMUTABLE]; + * @param string $var + * @return $this + */ + public function setAdUnitCode($var) + { + GPBUtil::checkString($var, True); + $this->ad_unit_code = $var; + + return $this; + } + + /** + * Output only. The status of this ad unit. It defaults to ACTIVE. + * + * Generated from protobuf field .google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getStatus() + { + return $this->status; + } + + /** + * Output only. The status of this ad unit. It defaults to ACTIVE. + * + * Generated from protobuf field .google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\AdUnitStatusEnum\AdUnitStatus::class); + $this->status = $var; + + return $this; + } + + /** + * Optional. The target window directly applied to this AdUnit. + * If this field is not set, this AdUnit uses the target window specified in + * effectiveTargetWindow. + * + * Generated from protobuf field .google.ads.admanager.v1.TargetWindowEnum.TargetWindow applied_target_window = 44 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getAppliedTargetWindow() + { + return $this->applied_target_window; + } + + /** + * Optional. The target window directly applied to this AdUnit. + * If this field is not set, this AdUnit uses the target window specified in + * effectiveTargetWindow. + * + * Generated from protobuf field .google.ads.admanager.v1.TargetWindowEnum.TargetWindow applied_target_window = 44 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setAppliedTargetWindow($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\TargetWindowEnum\TargetWindow::class); + $this->applied_target_window = $var; + + return $this; + } + + /** + * Output only. Non-empty default. The target window of this AdUnit. This + * value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit + * in the hierarchy specifies it. + * + * Generated from protobuf field .google.ads.admanager.v1.TargetWindowEnum.TargetWindow effective_target_window = 45 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getEffectiveTargetWindow() + { + return $this->effective_target_window; + } + + /** + * Output only. Non-empty default. The target window of this AdUnit. This + * value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit + * in the hierarchy specifies it. + * + * Generated from protobuf field .google.ads.admanager.v1.TargetWindowEnum.TargetWindow effective_target_window = 45 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setEffectiveTargetWindow($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\TargetWindowEnum\TargetWindow::class); + $this->effective_target_window = $var; + + return $this; + } + + /** + * Optional. The resource names of Teams directly applied to this AdUnit. + * Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAppliedTeams() + { + return $this->applied_teams; + } + + /** + * Optional. The resource names of Teams directly applied to this AdUnit. + * Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAppliedTeams($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->applied_teams = $arr; + + return $this; + } + + /** + * Output only. The resource names of all Teams that this AdUnit is on as well + * as those inherited from parent AdUnits. Format: + * "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string teams = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTeams() + { + return $this->teams; + } + + /** + * Output only. The resource names of all Teams that this AdUnit is on as well + * as those inherited from parent AdUnits. Format: + * "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string teams = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTeams($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->teams = $arr; + + return $this; + } + + /** + * Optional. A description of the ad unit. The maximum length is 65,535 + * characters. + * + * Generated from protobuf field string description = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDescription() + { + return $this->description; + } + + /** + * Optional. A description of the ad unit. The maximum length is 65,535 + * characters. + * + * Generated from protobuf field string description = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Optional. If this field is set to true, then the AdUnit will not be + * implicitly targeted when its parent is. Traffickers must explicitly + * target such an AdUnit or else no line items will serve to it. This + * feature is only available for Ad Manager 360 accounts. + * + * Generated from protobuf field bool explicitly_targeted = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getExplicitlyTargeted() + { + return $this->explicitly_targeted; + } + + /** + * Optional. If this field is set to true, then the AdUnit will not be + * implicitly targeted when its parent is. Traffickers must explicitly + * target such an AdUnit or else no line items will serve to it. This + * feature is only available for Ad Manager 360 accounts. + * + * Generated from protobuf field bool explicitly_targeted = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setExplicitlyTargeted($var) + { + GPBUtil::checkBool($var); + $this->explicitly_targeted = $var; + + return $this; + } + + /** + * Output only. This field is set to true if the ad unit has any children. + * + * Generated from protobuf field bool has_children = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getHasChildren() + { + return $this->has_children; + } + + /** + * Output only. This field is set to true if the ad unit has any children. + * + * Generated from protobuf field bool has_children = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setHasChildren($var) + { + GPBUtil::checkBool($var); + $this->has_children = $var; + + return $this; + } + + /** + * Output only. The time this AdUnit was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time this AdUnit was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. The sizes that can be served inside this ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAdUnitSizes() + { + return $this->ad_unit_sizes; + } + + /** + * Optional. The sizes that can be served inside this ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\AdUnitSize>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAdUnitSizes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AdUnitSize::class); + $this->ad_unit_sizes = $arr; + + return $this; + } + + /** + * Optional. Determines what set top box video on demand channel this ad unit + * corresponds to in an external set top box ad campaign system. + * + * Generated from protobuf field string external_set_top_box_channel_id = 17 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getExternalSetTopBoxChannelId() + { + return $this->external_set_top_box_channel_id; + } + + /** + * Optional. Determines what set top box video on demand channel this ad unit + * corresponds to in an external set top box ad campaign system. + * + * Generated from protobuf field string external_set_top_box_channel_id = 17 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setExternalSetTopBoxChannelId($var) + { + GPBUtil::checkString($var, True); + $this->external_set_top_box_channel_id = $var; + + return $this; + } + + /** + * Optional. The duration after which an Ad Unit will automatically refresh. + * This is only valid for ad units in mobile apps. If not set, the ad unit + * will not refresh. + * + * Generated from protobuf field .google.protobuf.Duration refresh_delay = 19 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Duration|null + */ + public function getRefreshDelay() + { + return $this->refresh_delay; + } + + public function hasRefreshDelay() + { + return isset($this->refresh_delay); + } + + public function clearRefreshDelay() + { + unset($this->refresh_delay); + } + + /** + * Optional. The duration after which an Ad Unit will automatically refresh. + * This is only valid for ad units in mobile apps. If not set, the ad unit + * will not refresh. + * + * Generated from protobuf field .google.protobuf.Duration refresh_delay = 19 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setRefreshDelay($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->refresh_delay = $var; + + return $this; + } + + /** + * Optional. The set of labels applied directly to this ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAppliedLabels() + { + return $this->applied_labels; + } + + /** + * Optional. The set of labels applied directly to this ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAppliedLabels($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AppliedLabel::class); + $this->applied_labels = $arr; + + return $this; + } + + /** + * Output only. Contains the set of labels applied directly to the ad unit as + * well as those inherited from the parent ad units. If a label has been + * negated, only the negated label is returned. This field is readonly and is + * assigned by Google. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEffectiveAppliedLabels() + { + return $this->effective_applied_labels; + } + + /** + * Output only. Contains the set of labels applied directly to the ad unit as + * well as those inherited from the parent ad units. If a label has been + * negated, only the negated label is returned. This field is readonly and is + * assigned by Google. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEffectiveAppliedLabels($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AppliedLabel::class); + $this->effective_applied_labels = $arr; + + return $this; + } + + /** + * Optional. The set of label frequency caps applied directly to this ad unit. + * There is a limit of 10 label frequency caps per ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.LabelFrequencyCap applied_label_frequency_caps = 23 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAppliedLabelFrequencyCaps() + { + return $this->applied_label_frequency_caps; + } + + /** + * Optional. The set of label frequency caps applied directly to this ad unit. + * There is a limit of 10 label frequency caps per ad unit. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.LabelFrequencyCap applied_label_frequency_caps = 23 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\LabelFrequencyCap>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAppliedLabelFrequencyCaps($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\LabelFrequencyCap::class); + $this->applied_label_frequency_caps = $arr; + + return $this; + } + + /** + * Output only. The label frequency caps applied directly to the ad unit as + * well as those inherited from parent ad units. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.LabelFrequencyCap effective_label_frequency_caps = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEffectiveLabelFrequencyCaps() + { + return $this->effective_label_frequency_caps; + } + + /** + * Output only. The label frequency caps applied directly to the ad unit as + * well as those inherited from parent ad units. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.LabelFrequencyCap effective_label_frequency_caps = 24 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array<\Google\Ads\AdManager\V1\LabelFrequencyCap>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEffectiveLabelFrequencyCaps($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\LabelFrequencyCap::class); + $this->effective_label_frequency_caps = $arr; + + return $this; + } + + /** + * Optional. The smart size mode for this ad unit. This attribute is optional + * and defaults to SmartSizeMode.NONE for fixed sizes. + * + * Generated from protobuf field .google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode smart_size_mode = 25 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSmartSizeMode() + { + return $this->smart_size_mode; + } + + /** + * Optional. The smart size mode for this ad unit. This attribute is optional + * and defaults to SmartSizeMode.NONE for fixed sizes. + * + * Generated from protobuf field .google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode smart_size_mode = 25 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSmartSizeMode($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\SmartSizeModeEnum\SmartSizeMode::class); + $this->smart_size_mode = $var; + + return $this; + } + + /** + * Optional. The value of AdSense enabled directly applied to this ad unit. + * This attribute is optional and if not specified this ad unit will inherit + * the value of effectiveAdsenseEnabled from its ancestors. + * + * Generated from protobuf field optional bool applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAppliedAdsenseEnabled() + { + return isset($this->applied_adsense_enabled) ? $this->applied_adsense_enabled : false; + } + + public function hasAppliedAdsenseEnabled() + { + return isset($this->applied_adsense_enabled); + } + + public function clearAppliedAdsenseEnabled() + { + unset($this->applied_adsense_enabled); + } + + /** + * Optional. The value of AdSense enabled directly applied to this ad unit. + * This attribute is optional and if not specified this ad unit will inherit + * the value of effectiveAdsenseEnabled from its ancestors. + * + * Generated from protobuf field optional bool applied_adsense_enabled = 26 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAppliedAdsenseEnabled($var) + { + GPBUtil::checkBool($var); + $this->applied_adsense_enabled = $var; + + return $this; + } + + /** + * Output only. Specifies whether or not the AdUnit is enabled for serving ads + * from the AdSense content network. This attribute defaults to the ad unit's + * parent or ancestor's setting if one has been set. If no ancestor of the ad + * unit has set appliedAdsenseEnabled, the attribute is defaulted to true. + * + * Generated from protobuf field bool effective_adsense_enabled = 27 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getEffectiveAdsenseEnabled() + { + return $this->effective_adsense_enabled; + } + + /** + * Output only. Specifies whether or not the AdUnit is enabled for serving ads + * from the AdSense content network. This attribute defaults to the ad unit's + * parent or ancestor's setting if one has been set. If no ancestor of the ad + * unit has set appliedAdsenseEnabled, the attribute is defaulted to true. + * + * Generated from protobuf field bool effective_adsense_enabled = 27 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setEffectiveAdsenseEnabled($var) + { + GPBUtil::checkBool($var); + $this->effective_adsense_enabled = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/AdUnitParent.php b/AdsAdManager/src/V1/AdUnitParent.php new file mode 100644 index 000000000000..558682858ed9 --- /dev/null +++ b/AdsAdManager/src/V1/AdUnitParent.php @@ -0,0 +1,143 @@ +google.ads.admanager.v1.AdUnitParent + */ +class AdUnitParent extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The parent of the current AdUnit + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string parent_ad_unit = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + */ + protected $parent_ad_unit = ''; + /** + * Output only. The display name of the parent AdUnit. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $display_name = ''; + /** + * Output only. A string used to uniquely identify the ad unit for the + * purposes of serving the ad. + * + * Generated from protobuf field string ad_unit_code = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $ad_unit_code = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent_ad_unit + * Output only. The parent of the current AdUnit + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * @type string $display_name + * Output only. The display name of the parent AdUnit. + * @type string $ad_unit_code + * Output only. A string used to uniquely identify the ad unit for the + * purposes of serving the ad. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitMessages::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The parent of the current AdUnit + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string parent_ad_unit = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @return string + */ + public function getParentAdUnit() + { + return $this->parent_ad_unit; + } + + /** + * Output only. The parent of the current AdUnit + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string parent_ad_unit = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParentAdUnit($var) + { + GPBUtil::checkString($var, True); + $this->parent_ad_unit = $var; + + return $this; + } + + /** + * Output only. The display name of the parent AdUnit. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Output only. The display name of the parent AdUnit. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Output only. A string used to uniquely identify the ad unit for the + * purposes of serving the ad. + * + * Generated from protobuf field string ad_unit_code = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getAdUnitCode() + { + return $this->ad_unit_code; + } + + /** + * Output only. A string used to uniquely identify the ad unit for the + * purposes of serving the ad. + * + * Generated from protobuf field string ad_unit_code = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setAdUnitCode($var) + { + GPBUtil::checkString($var, True); + $this->ad_unit_code = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/AdUnitSize.php b/AdsAdManager/src/V1/AdUnitSize.php new file mode 100644 index 000000000000..43ee5cd761d8 --- /dev/null +++ b/AdsAdManager/src/V1/AdUnitSize.php @@ -0,0 +1,153 @@ +google.ads.admanager.v1.AdUnitSize + */ +class AdUnitSize extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The Size of the AdUnit. + * + * Generated from protobuf field .google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $size = null; + /** + * Required. The EnvironmentType of the AdUnit + * + * Generated from protobuf field .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $environment_type = 0; + /** + * The companions for this ad unit size. Companions are only valid if the + * environment is + * [VIDEO_PLAYER][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType]. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Size companions = 3; + */ + private $companions; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\Size $size + * Required. The Size of the AdUnit. + * @type int $environment_type + * Required. The EnvironmentType of the AdUnit + * @type array<\Google\Ads\AdManager\V1\Size>|\Google\Protobuf\Internal\RepeatedField $companions + * The companions for this ad unit size. Companions are only valid if the + * environment is + * [VIDEO_PLAYER][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType]. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitMessages::initOnce(); + parent::__construct($data); + } + + /** + * Required. The Size of the AdUnit. + * + * Generated from protobuf field .google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\Size|null + */ + public function getSize() + { + return $this->size; + } + + public function hasSize() + { + return isset($this->size); + } + + public function clearSize() + { + unset($this->size); + } + + /** + * Required. The Size of the AdUnit. + * + * Generated from protobuf field .google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\Size $var + * @return $this + */ + public function setSize($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Size::class); + $this->size = $var; + + return $this; + } + + /** + * Required. The EnvironmentType of the AdUnit + * + * Generated from protobuf field .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getEnvironmentType() + { + return $this->environment_type; + } + + /** + * Required. The EnvironmentType of the AdUnit + * + * Generated from protobuf field .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setEnvironmentType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\EnvironmentTypeEnum\EnvironmentType::class); + $this->environment_type = $var; + + return $this; + } + + /** + * The companions for this ad unit size. Companions are only valid if the + * environment is + * [VIDEO_PLAYER][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType]. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Size companions = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCompanions() + { + return $this->companions; + } + + /** + * The companions for this ad unit size. Companions are only valid if the + * environment is + * [VIDEO_PLAYER][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType]. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Size companions = 3; + * @param array<\Google\Ads\AdManager\V1\Size>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCompanions($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Size::class); + $this->companions = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/AdUnitStatusEnum.php b/AdsAdManager/src/V1/AdUnitStatusEnum.php new file mode 100644 index 000000000000..0b955366976a --- /dev/null +++ b/AdsAdManager/src/V1/AdUnitStatusEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.AdUnitStatusEnum + */ +class AdUnitStatusEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/AdUnitStatusEnum/AdUnitStatus.php b/AdsAdManager/src/V1/AdUnitStatusEnum/AdUnitStatus.php new file mode 100644 index 000000000000..68565e6436c7 --- /dev/null +++ b/AdsAdManager/src/V1/AdUnitStatusEnum/AdUnitStatus.php @@ -0,0 +1,69 @@ +google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus + */ +class AdUnitStatus +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum AD_UNIT_STATUS_UNSPECIFIED = 0; + */ + const AD_UNIT_STATUS_UNSPECIFIED = 0; + /** + * The ad unit is active, available for targeting, and serving. + * + * Generated from protobuf enum ACTIVE = 1; + */ + const ACTIVE = 1; + /** + * The ad unit will be visible in the UI, but ignored by serving. + * + * Generated from protobuf enum INACTIVE = 2; + */ + const INACTIVE = 2; + /** + * The ad unit will be hidden in the UI and ignored by serving. + * + * Generated from protobuf enum ARCHIVED = 3; + */ + const ARCHIVED = 3; + + private static $valueToName = [ + self::AD_UNIT_STATUS_UNSPECIFIED => 'AD_UNIT_STATUS_UNSPECIFIED', + self::ACTIVE => 'ACTIVE', + self::INACTIVE => 'INACTIVE', + self::ARCHIVED => 'ARCHIVED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/AppliedLabel.php b/AdsAdManager/src/V1/AppliedLabel.php new file mode 100644 index 000000000000..1bb8c2533c8d --- /dev/null +++ b/AdsAdManager/src/V1/AppliedLabel.php @@ -0,0 +1,105 @@ +google.ads.admanager.v1.AppliedLabel + */ +class AppliedLabel extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The label to be applied. + * Format: "networks/{network_code}/labels/{label_id}" + * + * Generated from protobuf field string label = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $label = ''; + /** + * Specifies whether or not to negate the effects of the label. + * + * Generated from protobuf field bool negated = 2; + */ + protected $negated = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $label + * Required. The label to be applied. + * Format: "networks/{network_code}/labels/{label_id}" + * @type bool $negated + * Specifies whether or not to negate the effects of the label. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AppliedLabel::initOnce(); + parent::__construct($data); + } + + /** + * Required. The label to be applied. + * Format: "networks/{network_code}/labels/{label_id}" + * + * Generated from protobuf field string label = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getLabel() + { + return $this->label; + } + + /** + * Required. The label to be applied. + * Format: "networks/{network_code}/labels/{label_id}" + * + * Generated from protobuf field string label = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setLabel($var) + { + GPBUtil::checkString($var, True); + $this->label = $var; + + return $this; + } + + /** + * Specifies whether or not to negate the effects of the label. + * + * Generated from protobuf field bool negated = 2; + * @return bool + */ + public function getNegated() + { + return $this->negated; + } + + /** + * Specifies whether or not to negate the effects of the label. + * + * Generated from protobuf field bool negated = 2; + * @param bool $var + * @return $this + */ + public function setNegated($var) + { + GPBUtil::checkBool($var); + $this->negated = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/BatchCreateEntitySignalsMappingsRequest.php b/AdsAdManager/src/V1/BatchCreateEntitySignalsMappingsRequest.php new file mode 100644 index 000000000000..abf061199fc7 --- /dev/null +++ b/AdsAdManager/src/V1/BatchCreateEntitySignalsMappingsRequest.php @@ -0,0 +1,132 @@ +google.ads.admanager.v1.BatchCreateEntitySignalsMappingsRequest + */ +class BatchCreateEntitySignalsMappingsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent resource where `EntitySignalsMappings` will be + * created. Format: `networks/{network_code}` The parent field in the + * CreateEntitySignalsMappingRequest must match this field. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The `EntitySignalsMapping` objects to create. + * A maximum of 100 objects can be created in a batch. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CreateEntitySignalsMappingRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $requests; + + /** + * @param string $parent Required. The parent resource where `EntitySignalsMappings` will be + * created. Format: `networks/{network_code}` The parent field in the + * CreateEntitySignalsMappingRequest must match this field. Please see + * {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field. + * @param \Google\Ads\AdManager\V1\CreateEntitySignalsMappingRequest[] $requests Required. The `EntitySignalsMapping` objects to create. + * A maximum of 100 objects can be created in a batch. + * + * @return \Google\Ads\AdManager\V1\BatchCreateEntitySignalsMappingsRequest + * + * @experimental + */ + public static function build(string $parent, array $requests): self + { + return (new self()) + ->setParent($parent) + ->setRequests($requests); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent resource where `EntitySignalsMappings` will be + * created. Format: `networks/{network_code}` The parent field in the + * CreateEntitySignalsMappingRequest must match this field. + * @type array<\Google\Ads\AdManager\V1\CreateEntitySignalsMappingRequest>|\Google\Protobuf\Internal\RepeatedField $requests + * Required. The `EntitySignalsMapping` objects to create. + * A maximum of 100 objects can be created in a batch. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent resource where `EntitySignalsMappings` will be + * created. Format: `networks/{network_code}` The parent field in the + * CreateEntitySignalsMappingRequest must match this field. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent resource where `EntitySignalsMappings` will be + * created. Format: `networks/{network_code}` The parent field in the + * CreateEntitySignalsMappingRequest must match this field. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The `EntitySignalsMapping` objects to create. + * A maximum of 100 objects can be created in a batch. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CreateEntitySignalsMappingRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRequests() + { + return $this->requests; + } + + /** + * Required. The `EntitySignalsMapping` objects to create. + * A maximum of 100 objects can be created in a batch. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CreateEntitySignalsMappingRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Ads\AdManager\V1\CreateEntitySignalsMappingRequest>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRequests($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\CreateEntitySignalsMappingRequest::class); + $this->requests = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/BatchCreateEntitySignalsMappingsResponse.php b/AdsAdManager/src/V1/BatchCreateEntitySignalsMappingsResponse.php new file mode 100644 index 000000000000..1b346912c6ce --- /dev/null +++ b/AdsAdManager/src/V1/BatchCreateEntitySignalsMappingsResponse.php @@ -0,0 +1,67 @@ +google.ads.admanager.v1.BatchCreateEntitySignalsMappingsResponse + */ +class BatchCreateEntitySignalsMappingsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `EntitySignalsMapping` objects created. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + */ + private $entity_signals_mappings; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\EntitySignalsMapping>|\Google\Protobuf\Internal\RepeatedField $entity_signals_mappings + * The `EntitySignalsMapping` objects created. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * The `EntitySignalsMapping` objects created. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEntitySignalsMappings() + { + return $this->entity_signals_mappings; + } + + /** + * The `EntitySignalsMapping` objects created. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + * @param array<\Google\Ads\AdManager\V1\EntitySignalsMapping>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEntitySignalsMappings($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\EntitySignalsMapping::class); + $this->entity_signals_mappings = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/BatchUpdateEntitySignalsMappingsRequest.php b/AdsAdManager/src/V1/BatchUpdateEntitySignalsMappingsRequest.php new file mode 100644 index 000000000000..546c88476ab6 --- /dev/null +++ b/AdsAdManager/src/V1/BatchUpdateEntitySignalsMappingsRequest.php @@ -0,0 +1,132 @@ +google.ads.admanager.v1.BatchUpdateEntitySignalsMappingsRequest + */ +class BatchUpdateEntitySignalsMappingsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent resource where `EntitySignalsMappings` will be + * updated. Format: `networks/{network_code}` The parent field in the + * UpdateEntitySignalsMappingRequest must match this field. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The `EntitySignalsMapping` objects to update. + * A maximum of 100 objects can be updated in a batch. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.UpdateEntitySignalsMappingRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $requests; + + /** + * @param string $parent Required. The parent resource where `EntitySignalsMappings` will be + * updated. Format: `networks/{network_code}` The parent field in the + * UpdateEntitySignalsMappingRequest must match this field. Please see + * {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field. + * @param \Google\Ads\AdManager\V1\UpdateEntitySignalsMappingRequest[] $requests Required. The `EntitySignalsMapping` objects to update. + * A maximum of 100 objects can be updated in a batch. + * + * @return \Google\Ads\AdManager\V1\BatchUpdateEntitySignalsMappingsRequest + * + * @experimental + */ + public static function build(string $parent, array $requests): self + { + return (new self()) + ->setParent($parent) + ->setRequests($requests); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent resource where `EntitySignalsMappings` will be + * updated. Format: `networks/{network_code}` The parent field in the + * UpdateEntitySignalsMappingRequest must match this field. + * @type array<\Google\Ads\AdManager\V1\UpdateEntitySignalsMappingRequest>|\Google\Protobuf\Internal\RepeatedField $requests + * Required. The `EntitySignalsMapping` objects to update. + * A maximum of 100 objects can be updated in a batch. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent resource where `EntitySignalsMappings` will be + * updated. Format: `networks/{network_code}` The parent field in the + * UpdateEntitySignalsMappingRequest must match this field. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent resource where `EntitySignalsMappings` will be + * updated. Format: `networks/{network_code}` The parent field in the + * UpdateEntitySignalsMappingRequest must match this field. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The `EntitySignalsMapping` objects to update. + * A maximum of 100 objects can be updated in a batch. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.UpdateEntitySignalsMappingRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRequests() + { + return $this->requests; + } + + /** + * Required. The `EntitySignalsMapping` objects to update. + * A maximum of 100 objects can be updated in a batch. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.UpdateEntitySignalsMappingRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Ads\AdManager\V1\UpdateEntitySignalsMappingRequest>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRequests($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\UpdateEntitySignalsMappingRequest::class); + $this->requests = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/BatchUpdateEntitySignalsMappingsResponse.php b/AdsAdManager/src/V1/BatchUpdateEntitySignalsMappingsResponse.php new file mode 100644 index 000000000000..0e3e8a5cff75 --- /dev/null +++ b/AdsAdManager/src/V1/BatchUpdateEntitySignalsMappingsResponse.php @@ -0,0 +1,67 @@ +google.ads.admanager.v1.BatchUpdateEntitySignalsMappingsResponse + */ +class BatchUpdateEntitySignalsMappingsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `EntitySignalsMapping` objects updated. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + */ + private $entity_signals_mappings; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\EntitySignalsMapping>|\Google\Protobuf\Internal\RepeatedField $entity_signals_mappings + * The `EntitySignalsMapping` objects updated. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * The `EntitySignalsMapping` objects updated. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEntitySignalsMappings() + { + return $this->entity_signals_mappings; + } + + /** + * The `EntitySignalsMapping` objects updated. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + * @param array<\Google\Ads\AdManager\V1\EntitySignalsMapping>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEntitySignalsMappings($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\EntitySignalsMapping::class); + $this->entity_signals_mappings = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/Client/AdUnitServiceClient.php b/AdsAdManager/src/V1/Client/AdUnitServiceClient.php new file mode 100644 index 000000000000..238d03d40c37 --- /dev/null +++ b/AdsAdManager/src/V1/Client/AdUnitServiceClient.php @@ -0,0 +1,317 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/ad_unit_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/ad_unit_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/ad_unit_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a ad_unit + * resource. + * + * @param string $networkCode + * @param string $adUnit + * + * @return string The formatted ad_unit resource. + */ + public static function adUnitName(string $networkCode, string $adUnit): string + { + return self::getPathTemplate('adUnit')->render([ + 'network_code' => $networkCode, + 'ad_unit' => $adUnit, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - adUnit: networks/{network_code}/adUnits/{ad_unit} + * - network: networks/{network_code} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve an AdUnit object. + * + * The async variant is {@see AdUnitServiceClient::getAdUnitAsync()} . + * + * @example samples/V1/AdUnitServiceClient/get_ad_unit.php + * + * @param GetAdUnitRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return AdUnit + * + * @throws ApiException Thrown if the API call fails. + */ + public function getAdUnit(GetAdUnitRequest $request, array $callOptions = []): AdUnit + { + return $this->startApiCall('GetAdUnit', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of AdUnitSize objects. + * + * The async variant is {@see AdUnitServiceClient::listAdUnitSizesAsync()} . + * + * @example samples/V1/AdUnitServiceClient/list_ad_unit_sizes.php + * + * @param ListAdUnitSizesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listAdUnitSizes(ListAdUnitSizesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListAdUnitSizes', $request, $callOptions); + } + + /** + * API to retrieve a list of AdUnit objects. + * + * The async variant is {@see AdUnitServiceClient::listAdUnitsAsync()} . + * + * @example samples/V1/AdUnitServiceClient/list_ad_units.php + * + * @param ListAdUnitsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listAdUnits(ListAdUnitsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListAdUnits', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/CompanyServiceClient.php b/AdsAdManager/src/V1/Client/CompanyServiceClient.php new file mode 100644 index 000000000000..03298df70dd2 --- /dev/null +++ b/AdsAdManager/src/V1/Client/CompanyServiceClient.php @@ -0,0 +1,289 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/company_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/company_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/company_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a company + * resource. + * + * @param string $networkCode + * @param string $company + * + * @return string The formatted company resource. + */ + public static function companyName(string $networkCode, string $company): string + { + return self::getPathTemplate('company')->render([ + 'network_code' => $networkCode, + 'company' => $company, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - company: networks/{network_code}/companies/{company} + * - network: networks/{network_code} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a `Company` object. + * + * The async variant is {@see CompanyServiceClient::getCompanyAsync()} . + * + * @example samples/V1/CompanyServiceClient/get_company.php + * + * @param GetCompanyRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Company + * + * @throws ApiException Thrown if the API call fails. + */ + public function getCompany(GetCompanyRequest $request, array $callOptions = []): Company + { + return $this->startApiCall('GetCompany', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `Company` objects. + * + * The async variant is {@see CompanyServiceClient::listCompaniesAsync()} . + * + * @example samples/V1/CompanyServiceClient/list_companies.php + * + * @param ListCompaniesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listCompanies(ListCompaniesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListCompanies', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/CustomFieldServiceClient.php b/AdsAdManager/src/V1/Client/CustomFieldServiceClient.php new file mode 100644 index 000000000000..930c38b922c3 --- /dev/null +++ b/AdsAdManager/src/V1/Client/CustomFieldServiceClient.php @@ -0,0 +1,289 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/custom_field_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/custom_field_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/custom_field_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a custom_field + * resource. + * + * @param string $networkCode + * @param string $customField + * + * @return string The formatted custom_field resource. + */ + public static function customFieldName(string $networkCode, string $customField): string + { + return self::getPathTemplate('customField')->render([ + 'network_code' => $networkCode, + 'custom_field' => $customField, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - customField: networks/{network_code}/customFields/{custom_field} + * - network: networks/{network_code} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a `CustomField` object. + * + * The async variant is {@see CustomFieldServiceClient::getCustomFieldAsync()} . + * + * @example samples/V1/CustomFieldServiceClient/get_custom_field.php + * + * @param GetCustomFieldRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return CustomField + * + * @throws ApiException Thrown if the API call fails. + */ + public function getCustomField(GetCustomFieldRequest $request, array $callOptions = []): CustomField + { + return $this->startApiCall('GetCustomField', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `CustomField` objects. + * + * The async variant is {@see CustomFieldServiceClient::listCustomFieldsAsync()} . + * + * @example samples/V1/CustomFieldServiceClient/list_custom_fields.php + * + * @param ListCustomFieldsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listCustomFields(ListCustomFieldsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListCustomFields', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/CustomTargetingKeyServiceClient.php b/AdsAdManager/src/V1/Client/CustomTargetingKeyServiceClient.php new file mode 100644 index 000000000000..c3b0bc912b1d --- /dev/null +++ b/AdsAdManager/src/V1/Client/CustomTargetingKeyServiceClient.php @@ -0,0 +1,296 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/custom_targeting_key_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/custom_targeting_key_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => + __DIR__ . '/../resources/custom_targeting_key_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a + * custom_targeting_key resource. + * + * @param string $networkCode + * @param string $customTargetingKey + * + * @return string The formatted custom_targeting_key resource. + */ + public static function customTargetingKeyName(string $networkCode, string $customTargetingKey): string + { + return self::getPathTemplate('customTargetingKey')->render([ + 'network_code' => $networkCode, + 'custom_targeting_key' => $customTargetingKey, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - customTargetingKey: networks/{network_code}/customTargetingKeys/{custom_targeting_key} + * - network: networks/{network_code} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a `CustomTargetingKey` object. + * + * The async variant is + * {@see CustomTargetingKeyServiceClient::getCustomTargetingKeyAsync()} . + * + * @example samples/V1/CustomTargetingKeyServiceClient/get_custom_targeting_key.php + * + * @param GetCustomTargetingKeyRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return CustomTargetingKey + * + * @throws ApiException Thrown if the API call fails. + */ + public function getCustomTargetingKey( + GetCustomTargetingKeyRequest $request, + array $callOptions = [] + ): CustomTargetingKey { + return $this->startApiCall('GetCustomTargetingKey', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `CustomTargetingKey` objects. + * + * The async variant is + * {@see CustomTargetingKeyServiceClient::listCustomTargetingKeysAsync()} . + * + * @example samples/V1/CustomTargetingKeyServiceClient/list_custom_targeting_keys.php + * + * @param ListCustomTargetingKeysRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listCustomTargetingKeys( + ListCustomTargetingKeysRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('ListCustomTargetingKeys', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/CustomTargetingValueServiceClient.php b/AdsAdManager/src/V1/Client/CustomTargetingValueServiceClient.php new file mode 100644 index 000000000000..1ce9aabf61d2 --- /dev/null +++ b/AdsAdManager/src/V1/Client/CustomTargetingValueServiceClient.php @@ -0,0 +1,303 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/custom_targeting_value_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/custom_targeting_value_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => + __DIR__ . '/../resources/custom_targeting_value_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a + * custom_targeting_key resource. + * + * @param string $networkCode + * @param string $customTargetingKey + * + * @return string The formatted custom_targeting_key resource. + */ + public static function customTargetingKeyName(string $networkCode, string $customTargetingKey): string + { + return self::getPathTemplate('customTargetingKey')->render([ + 'network_code' => $networkCode, + 'custom_targeting_key' => $customTargetingKey, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * custom_targeting_value resource. + * + * @param string $networkCode + * @param string $customTargetingKey + * @param string $customTargetingValue + * + * @return string The formatted custom_targeting_value resource. + */ + public static function customTargetingValueName( + string $networkCode, + string $customTargetingKey, + string $customTargetingValue + ): string { + return self::getPathTemplate('customTargetingValue')->render([ + 'network_code' => $networkCode, + 'custom_targeting_key' => $customTargetingKey, + 'custom_targeting_value' => $customTargetingValue, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - customTargetingKey: networks/{network_code}/customTargetingKeys/{custom_targeting_key} + * - customTargetingValue: networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a `CustomTargetingValue` object. + * + * The async variant is + * {@see CustomTargetingValueServiceClient::getCustomTargetingValueAsync()} . + * + * @example samples/V1/CustomTargetingValueServiceClient/get_custom_targeting_value.php + * + * @param GetCustomTargetingValueRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return CustomTargetingValue + * + * @throws ApiException Thrown if the API call fails. + */ + public function getCustomTargetingValue( + GetCustomTargetingValueRequest $request, + array $callOptions = [] + ): CustomTargetingValue { + return $this->startApiCall('GetCustomTargetingValue', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `CustomTargetingValue` objects. + * + * The async variant is + * {@see CustomTargetingValueServiceClient::listCustomTargetingValuesAsync()} . + * + * @example samples/V1/CustomTargetingValueServiceClient/list_custom_targeting_values.php + * + * @param ListCustomTargetingValuesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listCustomTargetingValues( + ListCustomTargetingValuesRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('ListCustomTargetingValues', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/EntitySignalsMappingServiceClient.php b/AdsAdManager/src/V1/Client/EntitySignalsMappingServiceClient.php new file mode 100644 index 000000000000..0c1e933d9a92 --- /dev/null +++ b/AdsAdManager/src/V1/Client/EntitySignalsMappingServiceClient.php @@ -0,0 +1,424 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/entity_signals_mapping_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/entity_signals_mapping_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => + __DIR__ . '/../resources/entity_signals_mapping_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a + * entity_signals_mapping resource. + * + * @param string $networkCode + * @param string $entitySignalsMapping + * + * @return string The formatted entity_signals_mapping resource. + */ + public static function entitySignalsMappingName(string $networkCode, string $entitySignalsMapping): string + { + return self::getPathTemplate('entitySignalsMapping')->render([ + 'network_code' => $networkCode, + 'entity_signals_mapping' => $entitySignalsMapping, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - entitySignalsMapping: networks/{network_code}/entitySignalsMappings/{entity_signals_mapping} + * - network: networks/{network_code} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to batch create `EntitySignalsMapping` objects. + * + * The async variant is + * {@see EntitySignalsMappingServiceClient::batchCreateEntitySignalsMappingsAsync()} + * . + * + * @example samples/V1/EntitySignalsMappingServiceClient/batch_create_entity_signals_mappings.php + * + * @param BatchCreateEntitySignalsMappingsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return BatchCreateEntitySignalsMappingsResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function batchCreateEntitySignalsMappings( + BatchCreateEntitySignalsMappingsRequest $request, + array $callOptions = [] + ): BatchCreateEntitySignalsMappingsResponse { + return $this->startApiCall('BatchCreateEntitySignalsMappings', $request, $callOptions)->wait(); + } + + /** + * API to batch update `EntitySignalsMapping` objects. + * + * The async variant is + * {@see EntitySignalsMappingServiceClient::batchUpdateEntitySignalsMappingsAsync()} + * . + * + * @example samples/V1/EntitySignalsMappingServiceClient/batch_update_entity_signals_mappings.php + * + * @param BatchUpdateEntitySignalsMappingsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return BatchUpdateEntitySignalsMappingsResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function batchUpdateEntitySignalsMappings( + BatchUpdateEntitySignalsMappingsRequest $request, + array $callOptions = [] + ): BatchUpdateEntitySignalsMappingsResponse { + return $this->startApiCall('BatchUpdateEntitySignalsMappings', $request, $callOptions)->wait(); + } + + /** + * API to create an `EntitySignalsMapping` object. + * + * The async variant is + * {@see EntitySignalsMappingServiceClient::createEntitySignalsMappingAsync()} . + * + * @example samples/V1/EntitySignalsMappingServiceClient/create_entity_signals_mapping.php + * + * @param CreateEntitySignalsMappingRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return EntitySignalsMapping + * + * @throws ApiException Thrown if the API call fails. + */ + public function createEntitySignalsMapping( + CreateEntitySignalsMappingRequest $request, + array $callOptions = [] + ): EntitySignalsMapping { + return $this->startApiCall('CreateEntitySignalsMapping', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a `EntitySignalsMapping` object. + * + * The async variant is + * {@see EntitySignalsMappingServiceClient::getEntitySignalsMappingAsync()} . + * + * @example samples/V1/EntitySignalsMappingServiceClient/get_entity_signals_mapping.php + * + * @param GetEntitySignalsMappingRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return EntitySignalsMapping + * + * @throws ApiException Thrown if the API call fails. + */ + public function getEntitySignalsMapping( + GetEntitySignalsMappingRequest $request, + array $callOptions = [] + ): EntitySignalsMapping { + return $this->startApiCall('GetEntitySignalsMapping', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `EntitySignalsMapping` objects. + * + * The async variant is + * {@see EntitySignalsMappingServiceClient::listEntitySignalsMappingsAsync()} . + * + * @example samples/V1/EntitySignalsMappingServiceClient/list_entity_signals_mappings.php + * + * @param ListEntitySignalsMappingsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listEntitySignalsMappings( + ListEntitySignalsMappingsRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('ListEntitySignalsMappings', $request, $callOptions); + } + + /** + * API to update an `EntitySignalsMapping` object. + * + * The async variant is + * {@see EntitySignalsMappingServiceClient::updateEntitySignalsMappingAsync()} . + * + * @example samples/V1/EntitySignalsMappingServiceClient/update_entity_signals_mapping.php + * + * @param UpdateEntitySignalsMappingRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return EntitySignalsMapping + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateEntitySignalsMapping( + UpdateEntitySignalsMappingRequest $request, + array $callOptions = [] + ): EntitySignalsMapping { + return $this->startApiCall('UpdateEntitySignalsMapping', $request, $callOptions)->wait(); + } +} diff --git a/AdsAdManager/src/V1/Client/NetworkServiceClient.php b/AdsAdManager/src/V1/Client/NetworkServiceClient.php new file mode 100644 index 000000000000..2e3ae01eb097 --- /dev/null +++ b/AdsAdManager/src/V1/Client/NetworkServiceClient.php @@ -0,0 +1,271 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/network_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/network_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/network_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - network: networks/{network_code} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a Network object. + * + * The async variant is {@see NetworkServiceClient::getNetworkAsync()} . + * + * @example samples/V1/NetworkServiceClient/get_network.php + * + * @param GetNetworkRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Network + * + * @throws ApiException Thrown if the API call fails. + */ + public function getNetwork(GetNetworkRequest $request, array $callOptions = []): Network + { + return $this->startApiCall('GetNetwork', $request, $callOptions)->wait(); + } + + /** + * API to retrieve all the networks the current user has access to. + * + * The async variant is {@see NetworkServiceClient::listNetworksAsync()} . + * + * @example samples/V1/NetworkServiceClient/list_networks.php + * + * @param ListNetworksRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return ListNetworksResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listNetworks(ListNetworksRequest $request, array $callOptions = []): ListNetworksResponse + { + return $this->startApiCall('ListNetworks', $request, $callOptions)->wait(); + } +} diff --git a/AdsAdManager/src/V1/Client/OrderServiceClient.php b/AdsAdManager/src/V1/Client/OrderServiceClient.php new file mode 100644 index 000000000000..6976c12ade0f --- /dev/null +++ b/AdsAdManager/src/V1/Client/OrderServiceClient.php @@ -0,0 +1,294 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/order_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/order_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/order_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a order + * resource. + * + * @param string $networkCode + * @param string $order + * + * @return string The formatted order resource. + */ + public static function orderName(string $networkCode, string $order): string + { + return self::getPathTemplate('order')->render([ + 'network_code' => $networkCode, + 'order' => $order, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - network: networks/{network_code} + * - order: networks/{network_code}/orders/{order} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve an Order object. + * + * The async variant is {@see OrderServiceClient::getOrderAsync()} . + * + * @example samples/V1/OrderServiceClient/get_order.php + * + * @param GetOrderRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Order + * + * @throws ApiException Thrown if the API call fails. + */ + public function getOrder(GetOrderRequest $request, array $callOptions = []): Order + { + return $this->startApiCall('GetOrder', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `Order` objects. + * + * Fields used for literal matching in filter string: + * * `order_id` + * * `display_name` + * * `external_order_id` + * + * The async variant is {@see OrderServiceClient::listOrdersAsync()} . + * + * @example samples/V1/OrderServiceClient/list_orders.php + * + * @param ListOrdersRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listOrders(ListOrdersRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListOrders', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/PlacementServiceClient.php b/AdsAdManager/src/V1/Client/PlacementServiceClient.php new file mode 100644 index 000000000000..f81de1283b7a --- /dev/null +++ b/AdsAdManager/src/V1/Client/PlacementServiceClient.php @@ -0,0 +1,289 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/placement_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/placement_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/placement_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a placement + * resource. + * + * @param string $networkCode + * @param string $placement + * + * @return string The formatted placement resource. + */ + public static function placementName(string $networkCode, string $placement): string + { + return self::getPathTemplate('placement')->render([ + 'network_code' => $networkCode, + 'placement' => $placement, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - network: networks/{network_code} + * - placement: networks/{network_code}/placements/{placement} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a `Placement` object. + * + * The async variant is {@see PlacementServiceClient::getPlacementAsync()} . + * + * @example samples/V1/PlacementServiceClient/get_placement.php + * + * @param GetPlacementRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Placement + * + * @throws ApiException Thrown if the API call fails. + */ + public function getPlacement(GetPlacementRequest $request, array $callOptions = []): Placement + { + return $this->startApiCall('GetPlacement', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `Placement` objects. + * + * The async variant is {@see PlacementServiceClient::listPlacementsAsync()} . + * + * @example samples/V1/PlacementServiceClient/list_placements.php + * + * @param ListPlacementsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listPlacements(ListPlacementsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListPlacements', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/ReportServiceClient.php b/AdsAdManager/src/V1/Client/ReportServiceClient.php new file mode 100644 index 000000000000..20addfcadaea --- /dev/null +++ b/AdsAdManager/src/V1/Client/ReportServiceClient.php @@ -0,0 +1,471 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/report_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/report_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/report_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Return an OperationsClient object with the same endpoint as $this. + * + * @return OperationsClient + */ + public function getOperationsClient() + { + return $this->operationsClient; + } + + /** + * Resume an existing long running operation that was previously started by a long + * running API method. If $methodName is not provided, or does not match a long + * running API method, then the operation can still be resumed, but the + * OperationResponse object will not deserialize the final response. + * + * @param string $operationName The name of the long running operation + * @param string $methodName The name of the method used to start the operation + * + * @return OperationResponse + */ + public function resumeOperation($operationName, $methodName = null) + { + $options = isset($this->descriptors[$methodName]['longRunning']) + ? $this->descriptors[$methodName]['longRunning'] + : []; + $operation = new OperationResponse($operationName, $this->getOperationsClient(), $options); + $operation->reload(); + return $operation; + } + + /** + * Create the default operation client for the service. + * + * @param array $options ClientOptions for the client. + * + * @return OperationsClient + */ + private function createOperationsClient(array $options) + { + // Unset client-specific configuration options + unset($options['serviceName'], $options['clientConfig'], $options['descriptorsConfigPath']); + + if (isset($options['operationsClient'])) { + return $options['operationsClient']; + } + + return new OperationsClient($options); + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a report + * resource. + * + * @param string $networkCode + * @param string $report + * + * @return string The formatted report resource. + */ + public static function reportName(string $networkCode, string $report): string + { + return self::getPathTemplate('report')->render([ + 'network_code' => $networkCode, + 'report' => $report, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - network: networks/{network_code} + * - report: networks/{network_code}/reports/{report} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + $this->operationsClient = $this->createOperationsClient($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to create a `Report` object. + * + * The async variant is {@see ReportServiceClient::createReportAsync()} . + * + * @example samples/V1/ReportServiceClient/create_report.php + * + * @param CreateReportRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Report + * + * @throws ApiException Thrown if the API call fails. + */ + public function createReport(CreateReportRequest $request, array $callOptions = []): Report + { + return $this->startApiCall('CreateReport', $request, $callOptions)->wait(); + } + + /** + * Returns the result rows from a completed report. + * The caller must have previously called `RunReport` and waited for that + * operation to complete. The rows will be returned according to the order + * specified by the `sorts` member of the report definition. + * + * The async variant is {@see ReportServiceClient::fetchReportResultRowsAsync()} . + * + * @example samples/V1/ReportServiceClient/fetch_report_result_rows.php + * + * @param FetchReportResultRowsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return FetchReportResultRowsResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function fetchReportResultRows( + FetchReportResultRowsRequest $request, + array $callOptions = [] + ): FetchReportResultRowsResponse { + return $this->startApiCall('FetchReportResultRows', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a `Report` object. + * + * The async variant is {@see ReportServiceClient::getReportAsync()} . + * + * @example samples/V1/ReportServiceClient/get_report.php + * + * @param GetReportRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Report + * + * @throws ApiException Thrown if the API call fails. + */ + public function getReport(GetReportRequest $request, array $callOptions = []): Report + { + return $this->startApiCall('GetReport', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `Report` objects. + * + * The async variant is {@see ReportServiceClient::listReportsAsync()} . + * + * @example samples/V1/ReportServiceClient/list_reports.php + * + * @param ListReportsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listReports(ListReportsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListReports', $request, $callOptions); + } + + /** + * Initiates the execution of an existing report asynchronously. Users can + * get the report by polling this operation via + * `OperationsService.GetOperation`. + * Poll every 5 seconds initially, with an exponential + * backoff. Once a report is complete, the operation will contain a + * `RunReportResponse` in its response field containing a report_result that + * can be passed to the `FetchReportResultRows` method to retrieve the report + * data. + * + * The async variant is {@see ReportServiceClient::runReportAsync()} . + * + * @example samples/V1/ReportServiceClient/run_report.php + * + * @param RunReportRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function runReport(RunReportRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('RunReport', $request, $callOptions)->wait(); + } + + /** + * API to update a `Report` object. + * + * The async variant is {@see ReportServiceClient::updateReportAsync()} . + * + * @example samples/V1/ReportServiceClient/update_report.php + * + * @param UpdateReportRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Report + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateReport(UpdateReportRequest $request, array $callOptions = []): Report + { + return $this->startApiCall('UpdateReport', $request, $callOptions)->wait(); + } +} diff --git a/AdsAdManager/src/V1/Client/RoleServiceClient.php b/AdsAdManager/src/V1/Client/RoleServiceClient.php new file mode 100644 index 000000000000..ed5f846b6849 --- /dev/null +++ b/AdsAdManager/src/V1/Client/RoleServiceClient.php @@ -0,0 +1,289 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/role_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/role_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/role_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a role + * resource. + * + * @param string $networkCode + * @param string $role + * + * @return string The formatted role resource. + */ + public static function roleName(string $networkCode, string $role): string + { + return self::getPathTemplate('role')->render([ + 'network_code' => $networkCode, + 'role' => $role, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - network: networks/{network_code} + * - role: networks/{network_code}/roles/{role} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a `Role` object. + * + * The async variant is {@see RoleServiceClient::getRoleAsync()} . + * + * @example samples/V1/RoleServiceClient/get_role.php + * + * @param GetRoleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Role + * + * @throws ApiException Thrown if the API call fails. + */ + public function getRole(GetRoleRequest $request, array $callOptions = []): Role + { + return $this->startApiCall('GetRole', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `Role` objects. + * + * The async variant is {@see RoleServiceClient::listRolesAsync()} . + * + * @example samples/V1/RoleServiceClient/list_roles.php + * + * @param ListRolesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listRoles(ListRolesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListRoles', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/TaxonomyCategoryServiceClient.php b/AdsAdManager/src/V1/Client/TaxonomyCategoryServiceClient.php new file mode 100644 index 000000000000..35abfd31fdef --- /dev/null +++ b/AdsAdManager/src/V1/Client/TaxonomyCategoryServiceClient.php @@ -0,0 +1,294 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/taxonomy_category_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/taxonomy_category_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => + __DIR__ . '/../resources/taxonomy_category_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a network + * resource. + * + * @param string $networkCode + * + * @return string The formatted network resource. + */ + public static function networkName(string $networkCode): string + { + return self::getPathTemplate('network')->render([ + 'network_code' => $networkCode, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * taxonomy_category resource. + * + * @param string $networkCode + * @param string $taxonomyCategory + * + * @return string The formatted taxonomy_category resource. + */ + public static function taxonomyCategoryName(string $networkCode, string $taxonomyCategory): string + { + return self::getPathTemplate('taxonomyCategory')->render([ + 'network_code' => $networkCode, + 'taxonomy_category' => $taxonomyCategory, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - network: networks/{network_code} + * - taxonomyCategory: networks/{network_code}/taxonomyCategories/{taxonomy_category} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a `TaxonomyCategory` object. + * + * The async variant is + * {@see TaxonomyCategoryServiceClient::getTaxonomyCategoryAsync()} . + * + * @example samples/V1/TaxonomyCategoryServiceClient/get_taxonomy_category.php + * + * @param GetTaxonomyCategoryRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return TaxonomyCategory + * + * @throws ApiException Thrown if the API call fails. + */ + public function getTaxonomyCategory(GetTaxonomyCategoryRequest $request, array $callOptions = []): TaxonomyCategory + { + return $this->startApiCall('GetTaxonomyCategory', $request, $callOptions)->wait(); + } + + /** + * API to retrieve a list of `TaxonomyCategory` objects. + * + * The async variant is + * {@see TaxonomyCategoryServiceClient::listTaxonomyCategoriesAsync()} . + * + * @example samples/V1/TaxonomyCategoryServiceClient/list_taxonomy_categories.php + * + * @param ListTaxonomyCategoriesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listTaxonomyCategories( + ListTaxonomyCategoriesRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('ListTaxonomyCategories', $request, $callOptions); + } +} diff --git a/AdsAdManager/src/V1/Client/UserServiceClient.php b/AdsAdManager/src/V1/Client/UserServiceClient.php new file mode 100644 index 000000000000..e068fd03184d --- /dev/null +++ b/AdsAdManager/src/V1/Client/UserServiceClient.php @@ -0,0 +1,247 @@ + self::SERVICE_NAME, + 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, + 'clientConfig' => __DIR__ . '/../resources/user_service_client_config.json', + 'descriptorsConfigPath' => __DIR__ . '/../resources/user_service_descriptor_config.php', + 'credentialsConfig' => [ + 'defaultScopes' => self::$serviceScopes, + 'useJwtAccessWithScope' => false, + ], + 'transportConfig' => [ + 'rest' => [ + 'restClientConfigPath' => __DIR__ . '/../resources/user_service_rest_client_config.php', + ], + ], + ]; + } + + /** Implements GapicClientTrait::defaultTransport. */ + private static function defaultTransport() + { + return 'rest'; + } + + /** Implements ClientOptionsTrait::supportedTransports. */ + private static function supportedTransports() + { + return ['rest']; + } + + /** + * Formats a string containing the fully-qualified path to represent a user + * resource. + * + * @param string $networkCode + * @param string $user + * + * @return string The formatted user resource. + */ + public static function userName(string $networkCode, string $user): string + { + return self::getPathTemplate('user')->render([ + 'network_code' => $networkCode, + 'user' => $user, + ]); + } + + /** + * Parses a formatted name string and returns an associative array of the components in the name. + * The following name formats are supported: + * Template: Pattern + * - user: networks/{network_code}/users/{user} + * + * The optional $template argument can be supplied to specify a particular pattern, + * and must match one of the templates listed above. If no $template argument is + * provided, or if the $template argument does not match one of the templates + * listed, then parseName will check each of the supported templates, and return + * the first match. + * + * @param string $formattedName The formatted name string + * @param string $template Optional name of template to match + * + * @return array An associative array from name component IDs to component values. + * + * @throws ValidationException If $formattedName could not be matched. + */ + public static function parseName(string $formattedName, string $template = null): array + { + return self::parseFormattedName($formattedName, $template); + } + + /** + * Constructor. + * + * @param array $options { + * Optional. Options for configuring the service API wrapper. + * + * @type string $apiEndpoint + * The address of the API remote host. May optionally include the port, formatted + * as ":". Default 'admanager.googleapis.com:443'. + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $credentialsConfig + * Options used to configure credentials, including auth token caching, for the + * client. For a full list of supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type bool $disableRetries + * Determines whether or not retries defined by the client configuration should be + * disabled. Defaults to `false`. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. + * @type string|TransportInterface $transport + * The transport used for executing network requests. At the moment, supports only + * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\RestTransport::build()} method for the + * supported options. + * @type callable $clientCertSource + * A callable which returns the client cert as a string. This can be used to + * provide a certificate and private key to the transport layer for mTLS. + * } + * + * @throws ValidationException + */ + public function __construct(array $options = []) + { + $clientOptions = $this->buildClientOptions($options); + $this->setClientOptions($clientOptions); + } + + /** Handles execution of the async variants for each documented method. */ + public function __call($method, $args) + { + if (substr($method, -5) !== 'Async') { + trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR); + } + + array_unshift($args, substr($method, 0, -5)); + return call_user_func_array([$this, 'startAsyncCall'], $args); + } + + /** + * API to retrieve a User object. + * + * To get the current user, the resource name + * `networks/{networkCode}/users/me` can be used. + * + * The async variant is {@see UserServiceClient::getUserAsync()} . + * + * @example samples/V1/UserServiceClient/get_user.php + * + * @param GetUserRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return User + * + * @throws ApiException Thrown if the API call fails. + */ + public function getUser(GetUserRequest $request, array $callOptions = []): User + { + return $this->startApiCall('GetUser', $request, $callOptions)->wait(); + } +} diff --git a/AdsAdManager/src/V1/Company.php b/AdsAdManager/src/V1/Company.php new file mode 100644 index 000000000000..18b9fe0df27a --- /dev/null +++ b/AdsAdManager/src/V1/Company.php @@ -0,0 +1,649 @@ +google.ads.admanager.v1.Company + */ +class Company extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `Company`. + * Format: `networks/{network_code}/companies/{company_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. `Company` ID. + * + * Generated from protobuf field int64 company_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $company_id = 0; + /** + * Required. The display name of the `Company`. + * This value has a maximum length of 127 characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $display_name = ''; + /** + * Required. The type of the `Company`. + * + * Generated from protobuf field .google.ads.admanager.v1.CompanyTypeEnum.CompanyType type = 4 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $type = 0; + /** + * Optional. The address for the `Company`. + * This value has a maximum length of 1024 characters. + * + * Generated from protobuf field string address = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $address = ''; + /** + * Optional. The email for the `Company`. + * This value has a maximum length of 128 characters. + * + * Generated from protobuf field string email = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $email = ''; + /** + * Optional. The fax number for the `Company`. + * This value has a maximum length of 63 characters. + * + * Generated from protobuf field string fax = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $fax = ''; + /** + * Optional. The phone number for the `Company`. + * This value has a maximum length of 63 characters. + * + * Generated from protobuf field string phone = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $phone = ''; + /** + * Optional. The external ID for the `Company`. + * This value has a maximum length of 255 characters. + * + * Generated from protobuf field string external_id = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $external_id = ''; + /** + * Optional. Comments about the `Company`. + * This value has a maximum length of 1024 characters. + * + * Generated from protobuf field string comment = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $comment = ''; + /** + * Optional. The credit status of the `Company`. + * This attribute defaults to `ACTIVE` if basic settings are enabled and + * `ON_HOLD` if advance settings are enabled. + * + * Generated from protobuf field .google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus credit_status = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $credit_status = 0; + /** + * Optional. The labels that are directly applied to the `Company`. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $applied_labels; + /** + * Optional. The resource names of primary Contact of the `Company`. + * Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field optional string primary_contact = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $primary_contact = null; + /** + * Optional. The resource names of Teams that are directly associated with the + * `Company`. Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $applied_teams; + /** + * Output only. The time the `Company` was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. The ID of the Google-recognized canonicalized form of the + * `Company`. + * + * Generated from protobuf field int64 third_party_company_id = 16 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $third_party_company_id = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `Company`. + * Format: `networks/{network_code}/companies/{company_id}` + * @type int|string $company_id + * Output only. `Company` ID. + * @type string $display_name + * Required. The display name of the `Company`. + * This value has a maximum length of 127 characters. + * @type int $type + * Required. The type of the `Company`. + * @type string $address + * Optional. The address for the `Company`. + * This value has a maximum length of 1024 characters. + * @type string $email + * Optional. The email for the `Company`. + * This value has a maximum length of 128 characters. + * @type string $fax + * Optional. The fax number for the `Company`. + * This value has a maximum length of 63 characters. + * @type string $phone + * Optional. The phone number for the `Company`. + * This value has a maximum length of 63 characters. + * @type string $external_id + * Optional. The external ID for the `Company`. + * This value has a maximum length of 255 characters. + * @type string $comment + * Optional. Comments about the `Company`. + * This value has a maximum length of 1024 characters. + * @type int $credit_status + * Optional. The credit status of the `Company`. + * This attribute defaults to `ACTIVE` if basic settings are enabled and + * `ON_HOLD` if advance settings are enabled. + * @type array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $applied_labels + * Optional. The labels that are directly applied to the `Company`. + * @type string $primary_contact + * Optional. The resource names of primary Contact of the `Company`. + * Format: "networks/{network_code}/contacts/{contact_id}" + * @type array|\Google\Protobuf\Internal\RepeatedField $applied_teams + * Optional. The resource names of Teams that are directly associated with the + * `Company`. Format: "networks/{network_code}/teams/{team_id}" + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time the `Company` was last modified. + * @type int|string $third_party_company_id + * Optional. The ID of the Google-recognized canonicalized form of the + * `Company`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CompanyMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `Company`. + * Format: `networks/{network_code}/companies/{company_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `Company`. + * Format: `networks/{network_code}/companies/{company_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. `Company` ID. + * + * Generated from protobuf field int64 company_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getCompanyId() + { + return $this->company_id; + } + + /** + * Output only. `Company` ID. + * + * Generated from protobuf field int64 company_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setCompanyId($var) + { + GPBUtil::checkInt64($var); + $this->company_id = $var; + + return $this; + } + + /** + * Required. The display name of the `Company`. + * This value has a maximum length of 127 characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Required. The display name of the `Company`. + * This value has a maximum length of 127 characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Required. The type of the `Company`. + * + * Generated from protobuf field .google.ads.admanager.v1.CompanyTypeEnum.CompanyType type = 4 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getType() + { + return $this->type; + } + + /** + * Required. The type of the `Company`. + * + * Generated from protobuf field .google.ads.admanager.v1.CompanyTypeEnum.CompanyType type = 4 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CompanyTypeEnum\CompanyType::class); + $this->type = $var; + + return $this; + } + + /** + * Optional. The address for the `Company`. + * This value has a maximum length of 1024 characters. + * + * Generated from protobuf field string address = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getAddress() + { + return $this->address; + } + + /** + * Optional. The address for the `Company`. + * This value has a maximum length of 1024 characters. + * + * Generated from protobuf field string address = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setAddress($var) + { + GPBUtil::checkString($var, True); + $this->address = $var; + + return $this; + } + + /** + * Optional. The email for the `Company`. + * This value has a maximum length of 128 characters. + * + * Generated from protobuf field string email = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEmail() + { + return $this->email; + } + + /** + * Optional. The email for the `Company`. + * This value has a maximum length of 128 characters. + * + * Generated from protobuf field string email = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEmail($var) + { + GPBUtil::checkString($var, True); + $this->email = $var; + + return $this; + } + + /** + * Optional. The fax number for the `Company`. + * This value has a maximum length of 63 characters. + * + * Generated from protobuf field string fax = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFax() + { + return $this->fax; + } + + /** + * Optional. The fax number for the `Company`. + * This value has a maximum length of 63 characters. + * + * Generated from protobuf field string fax = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFax($var) + { + GPBUtil::checkString($var, True); + $this->fax = $var; + + return $this; + } + + /** + * Optional. The phone number for the `Company`. + * This value has a maximum length of 63 characters. + * + * Generated from protobuf field string phone = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPhone() + { + return $this->phone; + } + + /** + * Optional. The phone number for the `Company`. + * This value has a maximum length of 63 characters. + * + * Generated from protobuf field string phone = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPhone($var) + { + GPBUtil::checkString($var, True); + $this->phone = $var; + + return $this; + } + + /** + * Optional. The external ID for the `Company`. + * This value has a maximum length of 255 characters. + * + * Generated from protobuf field string external_id = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getExternalId() + { + return $this->external_id; + } + + /** + * Optional. The external ID for the `Company`. + * This value has a maximum length of 255 characters. + * + * Generated from protobuf field string external_id = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setExternalId($var) + { + GPBUtil::checkString($var, True); + $this->external_id = $var; + + return $this; + } + + /** + * Optional. Comments about the `Company`. + * This value has a maximum length of 1024 characters. + * + * Generated from protobuf field string comment = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getComment() + { + return $this->comment; + } + + /** + * Optional. Comments about the `Company`. + * This value has a maximum length of 1024 characters. + * + * Generated from protobuf field string comment = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setComment($var) + { + GPBUtil::checkString($var, True); + $this->comment = $var; + + return $this; + } + + /** + * Optional. The credit status of the `Company`. + * This attribute defaults to `ACTIVE` if basic settings are enabled and + * `ON_HOLD` if advance settings are enabled. + * + * Generated from protobuf field .google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus credit_status = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getCreditStatus() + { + return $this->credit_status; + } + + /** + * Optional. The credit status of the `Company`. + * This attribute defaults to `ACTIVE` if basic settings are enabled and + * `ON_HOLD` if advance settings are enabled. + * + * Generated from protobuf field .google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus credit_status = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setCreditStatus($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CompanyCreditStatusEnum\CompanyCreditStatus::class); + $this->credit_status = $var; + + return $this; + } + + /** + * Optional. The labels that are directly applied to the `Company`. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAppliedLabels() + { + return $this->applied_labels; + } + + /** + * Optional. The labels that are directly applied to the `Company`. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAppliedLabels($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AppliedLabel::class); + $this->applied_labels = $arr; + + return $this; + } + + /** + * Optional. The resource names of primary Contact of the `Company`. + * Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field optional string primary_contact = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getPrimaryContact() + { + return isset($this->primary_contact) ? $this->primary_contact : ''; + } + + public function hasPrimaryContact() + { + return isset($this->primary_contact); + } + + public function clearPrimaryContact() + { + unset($this->primary_contact); + } + + /** + * Optional. The resource names of primary Contact of the `Company`. + * Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field optional string primary_contact = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setPrimaryContact($var) + { + GPBUtil::checkString($var, True); + $this->primary_contact = $var; + + return $this; + } + + /** + * Optional. The resource names of Teams that are directly associated with the + * `Company`. Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAppliedTeams() + { + return $this->applied_teams; + } + + /** + * Optional. The resource names of Teams that are directly associated with the + * `Company`. Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAppliedTeams($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->applied_teams = $arr; + + return $this; + } + + /** + * Output only. The time the `Company` was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time the `Company` was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. The ID of the Google-recognized canonicalized form of the + * `Company`. + * + * Generated from protobuf field int64 third_party_company_id = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getThirdPartyCompanyId() + { + return $this->third_party_company_id; + } + + /** + * Optional. The ID of the Google-recognized canonicalized form of the + * `Company`. + * + * Generated from protobuf field int64 third_party_company_id = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setThirdPartyCompanyId($var) + { + GPBUtil::checkInt64($var); + $this->third_party_company_id = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CompanyCreditStatusEnum.php b/AdsAdManager/src/V1/CompanyCreditStatusEnum.php new file mode 100644 index 000000000000..07995e4a4bcd --- /dev/null +++ b/AdsAdManager/src/V1/CompanyCreditStatusEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CompanyCreditStatusEnum + */ +class CompanyCreditStatusEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CompanyCreditStatusEnum::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CompanyCreditStatusEnum/CompanyCreditStatus.php b/AdsAdManager/src/V1/CompanyCreditStatusEnum/CompanyCreditStatus.php new file mode 100644 index 000000000000..128dd6e62934 --- /dev/null +++ b/AdsAdManager/src/V1/CompanyCreditStatusEnum/CompanyCreditStatus.php @@ -0,0 +1,117 @@ +google.ads.admanager.v1.CompanyCreditStatusEnum.CompanyCreditStatus + */ +class CompanyCreditStatus +{ + /** + * No value specified + * + * Generated from protobuf enum COMPANY_CREDIT_STATUS_UNSPECIFIED = 0; + */ + const COMPANY_CREDIT_STATUS_UNSPECIFIED = 0; + /** + * The company's credit status is active. + * Line items belonging to the company can serve. + * This credit status is the default for basic settings and is available in + * both basic and advance settings. + * + * Generated from protobuf enum ACTIVE = 1; + */ + const ACTIVE = 1; + /** + * The company's credit status is inactive. + * Line items belonging to the company cannot be activated. However, line + * items that were activated before the credit status changed will remain + * active. New orders or line items belonging to the company cannot be + * created. + * Companies with this credit status will be hidden by default in company + * search results. + * This credit status is available in both basic and advance settings. + * + * Generated from protobuf enum INACTIVE = 2; + */ + const INACTIVE = 2; + /** + * The company's credit status is on hold. + * Line items belonging to the company cannot be activated. However, line + * items that were activated before the credit status changed will remain + * active. New orders or line items belonging to the company can be + * created. + * This credit status is the default in advance settings and is only + * available in advance settings. + * + * Generated from protobuf enum ON_HOLD = 3; + */ + const ON_HOLD = 3; + /** + * The company's credit status is stopped. + * Line items belonging to the company cannot be activated. However, line + * items that were activated before the credit status changed will remain + * active. New orders or line items belonging to the company cannot be + * created. + * This credit status is only available in advance settings. + * + * Generated from protobuf enum STOP = 4; + */ + const STOP = 4; + /** + * The company's credit status is blocked. + * All active line items belonging to the company will stop serving with + * immediate effect. Line items belonging to the company cannot be + * activated, and new orders or line items belonging to the company cannot + * be created. + * This credit status is only available in advance settings. + * + * Generated from protobuf enum BLOCKED = 5; + */ + const BLOCKED = 5; + + private static $valueToName = [ + self::COMPANY_CREDIT_STATUS_UNSPECIFIED => 'COMPANY_CREDIT_STATUS_UNSPECIFIED', + self::ACTIVE => 'ACTIVE', + self::INACTIVE => 'INACTIVE', + self::ON_HOLD => 'ON_HOLD', + self::STOP => 'STOP', + self::BLOCKED => 'BLOCKED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CompanyTypeEnum.php b/AdsAdManager/src/V1/CompanyTypeEnum.php new file mode 100644 index 000000000000..3b9ae1d004ae --- /dev/null +++ b/AdsAdManager/src/V1/CompanyTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CompanyTypeEnum + */ +class CompanyTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CompanyTypeEnum::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CompanyTypeEnum/CompanyType.php b/AdsAdManager/src/V1/CompanyTypeEnum/CompanyType.php new file mode 100644 index 000000000000..9b9078808a50 --- /dev/null +++ b/AdsAdManager/src/V1/CompanyTypeEnum/CompanyType.php @@ -0,0 +1,84 @@ +google.ads.admanager.v1.CompanyTypeEnum.CompanyType + */ +class CompanyType +{ + /** + * No value specified + * + * Generated from protobuf enum COMPANY_TYPE_UNSPECIFIED = 0; + */ + const COMPANY_TYPE_UNSPECIFIED = 0; + /** + * A business entity that purchases ad inventory. + * + * Generated from protobuf enum ADVERTISER = 1; + */ + const ADVERTISER = 1; + /** + * A company representing the publisher's own advertiser for house ads. + * + * Generated from protobuf enum HOUSE_ADVERTISER = 2; + */ + const HOUSE_ADVERTISER = 2; + /** + * An organization that manages ad accounts and offers services, such as ad + * creation, placement, and management to advertisers. + * + * Generated from protobuf enum AGENCY = 3; + */ + const AGENCY = 3; + /** + * A company representing the publisher's own agency. + * + * Generated from protobuf enum HOUSE_AGENCY = 4; + */ + const HOUSE_AGENCY = 4; + /** + * A company representing multiple advertisers and agencies. + * + * Generated from protobuf enum AD_NETWORK = 5; + */ + const AD_NETWORK = 5; + + private static $valueToName = [ + self::COMPANY_TYPE_UNSPECIFIED => 'COMPANY_TYPE_UNSPECIFIED', + self::ADVERTISER => 'ADVERTISER', + self::HOUSE_ADVERTISER => 'HOUSE_ADVERTISER', + self::AGENCY => 'AGENCY', + self::HOUSE_AGENCY => 'HOUSE_AGENCY', + self::AD_NETWORK => 'AD_NETWORK', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Contact.php b/AdsAdManager/src/V1/Contact.php new file mode 100644 index 000000000000..39a061730a07 --- /dev/null +++ b/AdsAdManager/src/V1/Contact.php @@ -0,0 +1,112 @@ +google.ads.admanager.v1.Contact + */ +class Contact extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `Contact`. + * Format: `networks/{network_code}/contacts/{contact_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. The unique ID of the contact. This value is readonly and is + * assigned by Google. + * + * Generated from protobuf field int64 contact_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $contact_id = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `Contact`. + * Format: `networks/{network_code}/contacts/{contact_id}` + * @type int|string $contact_id + * Output only. The unique ID of the contact. This value is readonly and is + * assigned by Google. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ContactMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `Contact`. + * Format: `networks/{network_code}/contacts/{contact_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `Contact`. + * Format: `networks/{network_code}/contacts/{contact_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. The unique ID of the contact. This value is readonly and is + * assigned by Google. + * + * Generated from protobuf field int64 contact_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getContactId() + { + return $this->contact_id; + } + + /** + * Output only. The unique ID of the contact. This value is readonly and is + * assigned by Google. + * + * Generated from protobuf field int64 contact_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setContactId($var) + { + GPBUtil::checkInt64($var); + $this->contact_id = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CreateEntitySignalsMappingRequest.php b/AdsAdManager/src/V1/CreateEntitySignalsMappingRequest.php new file mode 100644 index 000000000000..35f125049dec --- /dev/null +++ b/AdsAdManager/src/V1/CreateEntitySignalsMappingRequest.php @@ -0,0 +1,132 @@ +google.ads.admanager.v1.CreateEntitySignalsMappingRequest + */ +class CreateEntitySignalsMappingRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent resource where this EntitySignalsMapping will be + * created. Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The EntitySignalsMapping object to create. + * + * Generated from protobuf field .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mapping = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $entity_signals_mapping = null; + + /** + * @param string $parent Required. The parent resource where this EntitySignalsMapping will be + * created. Format: `networks/{network_code}` + * Please see {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field. + * @param \Google\Ads\AdManager\V1\EntitySignalsMapping $entitySignalsMapping Required. The EntitySignalsMapping object to create. + * + * @return \Google\Ads\AdManager\V1\CreateEntitySignalsMappingRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Ads\AdManager\V1\EntitySignalsMapping $entitySignalsMapping): self + { + return (new self()) + ->setParent($parent) + ->setEntitySignalsMapping($entitySignalsMapping); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent resource where this EntitySignalsMapping will be + * created. Format: `networks/{network_code}` + * @type \Google\Ads\AdManager\V1\EntitySignalsMapping $entity_signals_mapping + * Required. The EntitySignalsMapping object to create. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent resource where this EntitySignalsMapping will be + * created. Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent resource where this EntitySignalsMapping will be + * created. Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The EntitySignalsMapping object to create. + * + * Generated from protobuf field .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mapping = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\EntitySignalsMapping|null + */ + public function getEntitySignalsMapping() + { + return $this->entity_signals_mapping; + } + + public function hasEntitySignalsMapping() + { + return isset($this->entity_signals_mapping); + } + + public function clearEntitySignalsMapping() + { + unset($this->entity_signals_mapping); + } + + /** + * Required. The EntitySignalsMapping object to create. + * + * Generated from protobuf field .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mapping = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\EntitySignalsMapping $var + * @return $this + */ + public function setEntitySignalsMapping($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\EntitySignalsMapping::class); + $this->entity_signals_mapping = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CreateReportRequest.php b/AdsAdManager/src/V1/CreateReportRequest.php new file mode 100644 index 000000000000..6d466eb38e48 --- /dev/null +++ b/AdsAdManager/src/V1/CreateReportRequest.php @@ -0,0 +1,132 @@ +google.ads.admanager.v1.CreateReportRequest + */ +class CreateReportRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent resource where this `Report` will be created. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The `Report` to create. + * + * Generated from protobuf field .google.ads.admanager.v1.Report report = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $report = null; + + /** + * @param string $parent Required. The parent resource where this `Report` will be created. + * Format: `networks/{network_code}` + * Please see {@see ReportServiceClient::networkName()} for help formatting this field. + * @param \Google\Ads\AdManager\V1\Report $report Required. The `Report` to create. + * + * @return \Google\Ads\AdManager\V1\CreateReportRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Ads\AdManager\V1\Report $report): self + { + return (new self()) + ->setParent($parent) + ->setReport($report); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent resource where this `Report` will be created. + * Format: `networks/{network_code}` + * @type \Google\Ads\AdManager\V1\Report $report + * Required. The `Report` to create. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent resource where this `Report` will be created. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent resource where this `Report` will be created. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The `Report` to create. + * + * Generated from protobuf field .google.ads.admanager.v1.Report report = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\Report|null + */ + public function getReport() + { + return $this->report; + } + + public function hasReport() + { + return isset($this->report); + } + + public function clearReport() + { + unset($this->report); + } + + /** + * Required. The `Report` to create. + * + * Generated from protobuf field .google.ads.admanager.v1.Report report = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\Report $var + * @return $this + */ + public function setReport($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report::class); + $this->report = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CustomField.php b/AdsAdManager/src/V1/CustomField.php new file mode 100644 index 000000000000..a309a4d4b326 --- /dev/null +++ b/AdsAdManager/src/V1/CustomField.php @@ -0,0 +1,355 @@ +google.ads.admanager.v1.CustomField + */ +class CustomField extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `CustomField`. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. Unique ID of the CustomField. This value is readonly and is + * assigned by Google. + * + * Generated from protobuf field int64 custom_field_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $custom_field_id = 0; + /** + * Required. Name of the CustomField. The max length is 127 characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $display_name = ''; + /** + * Optional. A description of the custom field. The maximum length is 511 + * characters. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $description = ''; + /** + * Output only. The status of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = 0; + /** + * Required. The type of entity the `CustomField` can be applied to. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $entity_type = 0; + /** + * Required. The data type of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $data_type = 0; + /** + * Required. The visibility of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $visibility = 0; + /** + * Optional. The drop-down options for the `CustomField`. + * Only applicable for `CustomField` with the drop-down data type. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomFieldOption options = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $options; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `CustomField`. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * @type int|string $custom_field_id + * Output only. Unique ID of the CustomField. This value is readonly and is + * assigned by Google. + * @type string $display_name + * Required. Name of the CustomField. The max length is 127 characters. + * @type string $description + * Optional. A description of the custom field. The maximum length is 511 + * characters. + * @type int $status + * Output only. The status of the `CustomField`. + * @type int $entity_type + * Required. The type of entity the `CustomField` can be applied to. + * @type int $data_type + * Required. The data type of the `CustomField`. + * @type int $visibility + * Required. The visibility of the `CustomField`. + * @type array<\Google\Ads\AdManager\V1\CustomFieldOption>|\Google\Protobuf\Internal\RepeatedField $options + * Optional. The drop-down options for the `CustomField`. + * Only applicable for `CustomField` with the drop-down data type. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `CustomField`. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `CustomField`. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. Unique ID of the CustomField. This value is readonly and is + * assigned by Google. + * + * Generated from protobuf field int64 custom_field_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getCustomFieldId() + { + return $this->custom_field_id; + } + + /** + * Output only. Unique ID of the CustomField. This value is readonly and is + * assigned by Google. + * + * Generated from protobuf field int64 custom_field_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setCustomFieldId($var) + { + GPBUtil::checkInt64($var); + $this->custom_field_id = $var; + + return $this; + } + + /** + * Required. Name of the CustomField. The max length is 127 characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Required. Name of the CustomField. The max length is 127 characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Optional. A description of the custom field. The maximum length is 511 + * characters. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDescription() + { + return $this->description; + } + + /** + * Optional. A description of the custom field. The maximum length is 511 + * characters. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Output only. The status of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getStatus() + { + return $this->status; + } + + /** + * Output only. The status of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomFieldStatusEnum\CustomFieldStatus::class); + $this->status = $var; + + return $this; + } + + /** + * Required. The type of entity the `CustomField` can be applied to. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getEntityType() + { + return $this->entity_type; + } + + /** + * Required. The type of entity the `CustomField` can be applied to. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setEntityType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomFieldEntityTypeEnum\CustomFieldEntityType::class); + $this->entity_type = $var; + + return $this; + } + + /** + * Required. The data type of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getDataType() + { + return $this->data_type; + } + + /** + * Required. The data type of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setDataType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomFieldDataTypeEnum\CustomFieldDataType::class); + $this->data_type = $var; + + return $this; + } + + /** + * Required. The visibility of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getVisibility() + { + return $this->visibility; + } + + /** + * Required. The visibility of the `CustomField`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setVisibility($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomFieldVisibilityEnum\CustomFieldVisibility::class); + $this->visibility = $var; + + return $this; + } + + /** + * Optional. The drop-down options for the `CustomField`. + * Only applicable for `CustomField` with the drop-down data type. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomFieldOption options = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getOptions() + { + return $this->options; + } + + /** + * Optional. The drop-down options for the `CustomField`. + * Only applicable for `CustomField` with the drop-down data type. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomFieldOption options = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\CustomFieldOption>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setOptions($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\CustomFieldOption::class); + $this->options = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CustomFieldDataTypeEnum.php b/AdsAdManager/src/V1/CustomFieldDataTypeEnum.php new file mode 100644 index 000000000000..a9ef8a168597 --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldDataTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomFieldDataTypeEnum + */ +class CustomFieldDataTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomFieldDataTypeEnum/CustomFieldDataType.php b/AdsAdManager/src/V1/CustomFieldDataTypeEnum/CustomFieldDataType.php new file mode 100644 index 000000000000..a3ac30f121bf --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldDataTypeEnum/CustomFieldDataType.php @@ -0,0 +1,77 @@ +google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType + */ +class CustomFieldDataType +{ + /** + * No value specified + * + * Generated from protobuf enum CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED = 0; + */ + const CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED = 0; + /** + * A string field + * The max length is 255 characters. + * + * Generated from protobuf enum STRING = 1; + */ + const STRING = 1; + /** + * A number field. + * + * Generated from protobuf enum NUMBER = 2; + */ + const NUMBER = 2; + /** + * A "Yes" or "No" toggle field. + * + * Generated from protobuf enum TOGGLE = 3; + */ + const TOGGLE = 3; + /** + * A drop-down field. + * + * Generated from protobuf enum DROP_DOWN = 4; + */ + const DROP_DOWN = 4; + + private static $valueToName = [ + self::CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED => 'CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED', + self::STRING => 'STRING', + self::NUMBER => 'NUMBER', + self::TOGGLE => 'TOGGLE', + self::DROP_DOWN => 'DROP_DOWN', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CustomFieldEntityTypeEnum.php b/AdsAdManager/src/V1/CustomFieldEntityTypeEnum.php new file mode 100644 index 000000000000..c37b1c9f4229 --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldEntityTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomFieldEntityTypeEnum + */ +class CustomFieldEntityTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomFieldEntityTypeEnum/CustomFieldEntityType.php b/AdsAdManager/src/V1/CustomFieldEntityTypeEnum/CustomFieldEntityType.php new file mode 100644 index 000000000000..f46d58e9435e --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldEntityTypeEnum/CustomFieldEntityType.php @@ -0,0 +1,83 @@ +google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType + */ +class CustomFieldEntityType +{ + /** + * No value specified + * + * Generated from protobuf enum CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED = 0; + */ + const CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED = 0; + /** + * The CustomField is applied to LineItems. + * + * Generated from protobuf enum LINE_ITEM = 1; + */ + const LINE_ITEM = 1; + /** + * The CustomField is applied to Orders. + * + * Generated from protobuf enum ORDER = 2; + */ + const ORDER = 2; + /** + * The CustomField is applied to Creatives. + * + * Generated from protobuf enum CREATIVE = 3; + */ + const CREATIVE = 3; + /** + * The CustomField is applied to Proposals. + * + * Generated from protobuf enum PROPOSAL = 4; + */ + const PROPOSAL = 4; + /** + * The CustomField is applied to ProposalLineItems. + * + * Generated from protobuf enum PROPOSAL_LINE_ITEM = 5; + */ + const PROPOSAL_LINE_ITEM = 5; + + private static $valueToName = [ + self::CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED => 'CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED', + self::LINE_ITEM => 'LINE_ITEM', + self::ORDER => 'ORDER', + self::CREATIVE => 'CREATIVE', + self::PROPOSAL => 'PROPOSAL', + self::PROPOSAL_LINE_ITEM => 'PROPOSAL_LINE_ITEM', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CustomFieldOption.php b/AdsAdManager/src/V1/CustomFieldOption.php new file mode 100644 index 000000000000..bc0f77c34190 --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldOption.php @@ -0,0 +1,105 @@ +google.ads.admanager.v1.CustomFieldOption + */ +class CustomFieldOption extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. `CustomFieldOption` ID. + * + * Generated from protobuf field int64 custom_field_option_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $custom_field_option_id = 0; + /** + * Required. The display name of the `CustomFieldOption`. + * This value has a maximum length of 127 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $display_name = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $custom_field_option_id + * Output only. `CustomFieldOption` ID. + * @type string $display_name + * Required. The display name of the `CustomFieldOption`. + * This value has a maximum length of 127 characters. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldMessages::initOnce(); + parent::__construct($data); + } + + /** + * Output only. `CustomFieldOption` ID. + * + * Generated from protobuf field int64 custom_field_option_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getCustomFieldOptionId() + { + return $this->custom_field_option_id; + } + + /** + * Output only. `CustomFieldOption` ID. + * + * Generated from protobuf field int64 custom_field_option_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setCustomFieldOptionId($var) + { + GPBUtil::checkInt64($var); + $this->custom_field_option_id = $var; + + return $this; + } + + /** + * Required. The display name of the `CustomFieldOption`. + * This value has a maximum length of 127 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Required. The display name of the `CustomFieldOption`. + * This value has a maximum length of 127 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CustomFieldStatusEnum.php b/AdsAdManager/src/V1/CustomFieldStatusEnum.php new file mode 100644 index 000000000000..0ad861f4eb8f --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldStatusEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomFieldStatusEnum + */ +class CustomFieldStatusEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomFieldStatusEnum/CustomFieldStatus.php b/AdsAdManager/src/V1/CustomFieldStatusEnum/CustomFieldStatus.php new file mode 100644 index 000000000000..3264bc448427 --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldStatusEnum/CustomFieldStatus.php @@ -0,0 +1,62 @@ +google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus + */ +class CustomFieldStatus +{ + /** + * No value specified + * + * Generated from protobuf enum CUSTOM_FIELD_STATUS_UNSPECIFIED = 0; + */ + const CUSTOM_FIELD_STATUS_UNSPECIFIED = 0; + /** + * The CustomField is active. + * + * Generated from protobuf enum ACTIVE = 1; + */ + const ACTIVE = 1; + /** + * The CustomField is inactive. + * + * Generated from protobuf enum INACTIVE = 2; + */ + const INACTIVE = 2; + + private static $valueToName = [ + self::CUSTOM_FIELD_STATUS_UNSPECIFIED => 'CUSTOM_FIELD_STATUS_UNSPECIFIED', + self::ACTIVE => 'ACTIVE', + self::INACTIVE => 'INACTIVE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CustomFieldValue.php b/AdsAdManager/src/V1/CustomFieldValue.php new file mode 100644 index 000000000000..9a40b22f768f --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldValue.php @@ -0,0 +1,115 @@ +google.ads.admanager.v1.CustomFieldValue + */ +class CustomFieldValue extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The custom field for which this is a value. + * Format: "networks/{network_code}/customFields/{custom_field_id}" + * + * Generated from protobuf field string custom_field = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $custom_field = ''; + /** + * Required. A typed value representation of the value. + * + * Generated from protobuf field optional .google.ads.admanager.v1.CustomFieldValue.Value value = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $value = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $custom_field + * Required. The custom field for which this is a value. + * Format: "networks/{network_code}/customFields/{custom_field_id}" + * @type \Google\Ads\AdManager\V1\CustomFieldValue\Value $value + * Required. A typed value representation of the value. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldValue::initOnce(); + parent::__construct($data); + } + + /** + * Required. The custom field for which this is a value. + * Format: "networks/{network_code}/customFields/{custom_field_id}" + * + * Generated from protobuf field string custom_field = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getCustomField() + { + return $this->custom_field; + } + + /** + * Required. The custom field for which this is a value. + * Format: "networks/{network_code}/customFields/{custom_field_id}" + * + * Generated from protobuf field string custom_field = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setCustomField($var) + { + GPBUtil::checkString($var, True); + $this->custom_field = $var; + + return $this; + } + + /** + * Required. A typed value representation of the value. + * + * Generated from protobuf field optional .google.ads.admanager.v1.CustomFieldValue.Value value = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\CustomFieldValue\Value|null + */ + public function getValue() + { + return $this->value; + } + + public function hasValue() + { + return isset($this->value); + } + + public function clearValue() + { + unset($this->value); + } + + /** + * Required. A typed value representation of the value. + * + * Generated from protobuf field optional .google.ads.admanager.v1.CustomFieldValue.Value value = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\CustomFieldValue\Value $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\CustomFieldValue\Value::class); + $this->value = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CustomFieldValue/Value.php b/AdsAdManager/src/V1/CustomFieldValue/Value.php new file mode 100644 index 000000000000..8ef3e954c23d --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldValue/Value.php @@ -0,0 +1,176 @@ +google.ads.admanager.v1.CustomFieldValue.Value + */ +class Value extends \Google\Protobuf\Internal\Message +{ + protected $value; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $dropdown_value + * The custom_field_option_id, if the CustomFieldDataType is DROPDOWN. + * @type string $string_value + * The value, if the CustomFieldDataType is STRING. + * @type float $number_value + * The value, if the CustomFieldDataType is NUMBER. + * @type bool $toggle_value + * The value, if the CustomFieldDataType is TOGGLE. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldValue::initOnce(); + parent::__construct($data); + } + + /** + * The custom_field_option_id, if the CustomFieldDataType is DROPDOWN. + * + * Generated from protobuf field int64 dropdown_value = 1; + * @return int|string + */ + public function getDropdownValue() + { + return $this->readOneof(1); + } + + public function hasDropdownValue() + { + return $this->hasOneof(1); + } + + /** + * The custom_field_option_id, if the CustomFieldDataType is DROPDOWN. + * + * Generated from protobuf field int64 dropdown_value = 1; + * @param int|string $var + * @return $this + */ + public function setDropdownValue($var) + { + GPBUtil::checkInt64($var); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * The value, if the CustomFieldDataType is STRING. + * + * Generated from protobuf field string string_value = 2; + * @return string + */ + public function getStringValue() + { + return $this->readOneof(2); + } + + public function hasStringValue() + { + return $this->hasOneof(2); + } + + /** + * The value, if the CustomFieldDataType is STRING. + * + * Generated from protobuf field string string_value = 2; + * @param string $var + * @return $this + */ + public function setStringValue($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * The value, if the CustomFieldDataType is NUMBER. + * + * Generated from protobuf field double number_value = 3; + * @return float + */ + public function getNumberValue() + { + return $this->readOneof(3); + } + + public function hasNumberValue() + { + return $this->hasOneof(3); + } + + /** + * The value, if the CustomFieldDataType is NUMBER. + * + * Generated from protobuf field double number_value = 3; + * @param float $var + * @return $this + */ + public function setNumberValue($var) + { + GPBUtil::checkDouble($var); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * The value, if the CustomFieldDataType is TOGGLE. + * + * Generated from protobuf field bool toggle_value = 4; + * @return bool + */ + public function getToggleValue() + { + return $this->readOneof(4); + } + + public function hasToggleValue() + { + return $this->hasOneof(4); + } + + /** + * The value, if the CustomFieldDataType is TOGGLE. + * + * Generated from protobuf field bool toggle_value = 4; + * @param bool $var + * @return $this + */ + public function setToggleValue($var) + { + GPBUtil::checkBool($var); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * @return string + */ + public function getValue() + { + return $this->whichOneof("value"); + } + +} + + diff --git a/AdsAdManager/src/V1/CustomFieldVisibilityEnum.php b/AdsAdManager/src/V1/CustomFieldVisibilityEnum.php new file mode 100644 index 000000000000..3b68d3b5e3bb --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldVisibilityEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomFieldVisibilityEnum + */ +class CustomFieldVisibilityEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomFieldVisibilityEnum/CustomFieldVisibility.php b/AdsAdManager/src/V1/CustomFieldVisibilityEnum/CustomFieldVisibility.php new file mode 100644 index 000000000000..317f315358da --- /dev/null +++ b/AdsAdManager/src/V1/CustomFieldVisibilityEnum/CustomFieldVisibility.php @@ -0,0 +1,70 @@ +google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility + */ +class CustomFieldVisibility +{ + /** + * No value specified + * + * Generated from protobuf enum CUSTOM_FIELD_VISIBILITY_UNSPECIFIED = 0; + */ + const CUSTOM_FIELD_VISIBILITY_UNSPECIFIED = 0; + /** + * The CustomField is not visible in the UI and only visible through the + * API. + * + * Generated from protobuf enum HIDDEN = 1; + */ + const HIDDEN = 1; + /** + * The CustomField is visible in the UI and only editable through the API. + * + * Generated from protobuf enum READ_ONLY = 2; + */ + const READ_ONLY = 2; + /** + * The CustomField is visible and editable in both the API and UI. + * + * Generated from protobuf enum EDITABLE = 3; + */ + const EDITABLE = 3; + + private static $valueToName = [ + self::CUSTOM_FIELD_VISIBILITY_UNSPECIFIED => 'CUSTOM_FIELD_VISIBILITY_UNSPECIFIED', + self::HIDDEN => 'HIDDEN', + self::READ_ONLY => 'READ_ONLY', + self::EDITABLE => 'EDITABLE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CustomTargetingKey.php b/AdsAdManager/src/V1/CustomTargetingKey.php new file mode 100644 index 000000000000..c08ea0a5c5f6 --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingKey.php @@ -0,0 +1,295 @@ +google.ads.admanager.v1.CustomTargetingKey + */ +class CustomTargetingKey extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `CustomTargetingKey`. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. `CustomTargetingKey` ID. + * + * Generated from protobuf field int64 custom_targeting_key_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $custom_targeting_key_id = 0; + /** + * Immutable. Name of the key. Keys can contain up to 10 characters each. You + * can use alphanumeric characters and symbols other than the following: + * ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character. + * + * Generated from protobuf field string ad_tag_name = 3 [(.google.api.field_behavior) = IMMUTABLE]; + */ + protected $ad_tag_name = ''; + /** + * Optional. Descriptive name for the `CustomTargetingKey`. + * + * Generated from protobuf field string display_name = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Required. Indicates whether users will select from predefined values or + * create new targeting values, while specifying targeting criteria for a line + * item. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType type = 5 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $type = 0; + /** + * Output only. Status of the `CustomTargetingKey`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = 0; + /** + * Required. Reportable state of the `CustomTargetingKey`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType reportable_type = 7 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $reportable_type = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `CustomTargetingKey`. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * @type int|string $custom_targeting_key_id + * Output only. `CustomTargetingKey` ID. + * @type string $ad_tag_name + * Immutable. Name of the key. Keys can contain up to 10 characters each. You + * can use alphanumeric characters and symbols other than the following: + * ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character. + * @type string $display_name + * Optional. Descriptive name for the `CustomTargetingKey`. + * @type int $type + * Required. Indicates whether users will select from predefined values or + * create new targeting values, while specifying targeting criteria for a line + * item. + * @type int $status + * Output only. Status of the `CustomTargetingKey`. + * @type int $reportable_type + * Required. Reportable state of the `CustomTargetingKey`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingKeyMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `CustomTargetingKey`. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `CustomTargetingKey`. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. `CustomTargetingKey` ID. + * + * Generated from protobuf field int64 custom_targeting_key_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getCustomTargetingKeyId() + { + return $this->custom_targeting_key_id; + } + + /** + * Output only. `CustomTargetingKey` ID. + * + * Generated from protobuf field int64 custom_targeting_key_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setCustomTargetingKeyId($var) + { + GPBUtil::checkInt64($var); + $this->custom_targeting_key_id = $var; + + return $this; + } + + /** + * Immutable. Name of the key. Keys can contain up to 10 characters each. You + * can use alphanumeric characters and symbols other than the following: + * ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character. + * + * Generated from protobuf field string ad_tag_name = 3 [(.google.api.field_behavior) = IMMUTABLE]; + * @return string + */ + public function getAdTagName() + { + return $this->ad_tag_name; + } + + /** + * Immutable. Name of the key. Keys can contain up to 10 characters each. You + * can use alphanumeric characters and symbols other than the following: + * ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character. + * + * Generated from protobuf field string ad_tag_name = 3 [(.google.api.field_behavior) = IMMUTABLE]; + * @param string $var + * @return $this + */ + public function setAdTagName($var) + { + GPBUtil::checkString($var, True); + $this->ad_tag_name = $var; + + return $this; + } + + /** + * Optional. Descriptive name for the `CustomTargetingKey`. + * + * Generated from protobuf field string display_name = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Descriptive name for the `CustomTargetingKey`. + * + * Generated from protobuf field string display_name = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Required. Indicates whether users will select from predefined values or + * create new targeting values, while specifying targeting criteria for a line + * item. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType type = 5 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getType() + { + return $this->type; + } + + /** + * Required. Indicates whether users will select from predefined values or + * create new targeting values, while specifying targeting criteria for a line + * item. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType type = 5 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomTargetingKeyTypeEnum\CustomTargetingKeyType::class); + $this->type = $var; + + return $this; + } + + /** + * Output only. Status of the `CustomTargetingKey`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getStatus() + { + return $this->status; + } + + /** + * Output only. Status of the `CustomTargetingKey`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomTargetingKeyStatusEnum\CustomTargetingKeyStatus::class); + $this->status = $var; + + return $this; + } + + /** + * Required. Reportable state of the `CustomTargetingKey`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType reportable_type = 7 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getReportableType() + { + return $this->reportable_type; + } + + /** + * Required. Reportable state of the `CustomTargetingKey`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType reportable_type = 7 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setReportableType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomTargetingKeyReportableTypeEnum\CustomTargetingKeyReportableType::class); + $this->reportable_type = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CustomTargetingKeyReportableTypeEnum.php b/AdsAdManager/src/V1/CustomTargetingKeyReportableTypeEnum.php new file mode 100644 index 000000000000..b2162fa94cad --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingKeyReportableTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum + */ +class CustomTargetingKeyReportableTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingKeyEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomTargetingKeyReportableTypeEnum/CustomTargetingKeyReportableType.php b/AdsAdManager/src/V1/CustomTargetingKeyReportableTypeEnum/CustomTargetingKeyReportableType.php new file mode 100644 index 000000000000..870ea4304b23 --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingKeyReportableTypeEnum/CustomTargetingKeyReportableType.php @@ -0,0 +1,69 @@ +google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType + */ +class CustomTargetingKeyReportableType +{ + /** + * Not specified value. + * + * Generated from protobuf enum CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED = 0; + */ + const CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED = 0; + /** + * Not available for reporting in the Ad Manager query tool. + * + * Generated from protobuf enum OFF = 1; + */ + const OFF = 1; + /** + * Available for reporting in the Ad Manager query tool. + * + * Generated from protobuf enum ON = 2; + */ + const ON = 2; + /** + * Custom dimension available for reporting in the AdManager query tool. + * + * Generated from protobuf enum CUSTOM_DIMENSION = 3; + */ + const CUSTOM_DIMENSION = 3; + + private static $valueToName = [ + self::CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED => 'CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED', + self::OFF => 'OFF', + self::ON => 'ON', + self::CUSTOM_DIMENSION => 'CUSTOM_DIMENSION', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CustomTargetingKeyStatusEnum.php b/AdsAdManager/src/V1/CustomTargetingKeyStatusEnum.php new file mode 100644 index 000000000000..fa3d998db1df --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingKeyStatusEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomTargetingKeyStatusEnum + */ +class CustomTargetingKeyStatusEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingKeyEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomTargetingKeyStatusEnum/CustomTargetingKeyStatus.php b/AdsAdManager/src/V1/CustomTargetingKeyStatusEnum/CustomTargetingKeyStatus.php new file mode 100644 index 000000000000..431028afa6fb --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingKeyStatusEnum/CustomTargetingKeyStatus.php @@ -0,0 +1,62 @@ +google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus + */ +class CustomTargetingKeyStatus +{ + /** + * Not specified value. + * + * Generated from protobuf enum CUSTOM_TARGETING_KEY_STATUS_UNSPECIFIED = 0; + */ + const CUSTOM_TARGETING_KEY_STATUS_UNSPECIFIED = 0; + /** + * Custom targeting key is active. + * + * Generated from protobuf enum ACTIVE = 1; + */ + const ACTIVE = 1; + /** + * Custom targeting key is inactive. + * + * Generated from protobuf enum INACTIVE = 2; + */ + const INACTIVE = 2; + + private static $valueToName = [ + self::CUSTOM_TARGETING_KEY_STATUS_UNSPECIFIED => 'CUSTOM_TARGETING_KEY_STATUS_UNSPECIFIED', + self::ACTIVE => 'ACTIVE', + self::INACTIVE => 'INACTIVE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CustomTargetingKeyTypeEnum.php b/AdsAdManager/src/V1/CustomTargetingKeyTypeEnum.php new file mode 100644 index 000000000000..5fa9dc725a74 --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingKeyTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomTargetingKeyTypeEnum + */ +class CustomTargetingKeyTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingKeyEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomTargetingKeyTypeEnum/CustomTargetingKeyType.php b/AdsAdManager/src/V1/CustomTargetingKeyTypeEnum/CustomTargetingKeyType.php new file mode 100644 index 000000000000..bbfd1ededc18 --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingKeyTypeEnum/CustomTargetingKeyType.php @@ -0,0 +1,62 @@ +google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType + */ +class CustomTargetingKeyType +{ + /** + * Not specified value. + * + * Generated from protobuf enum CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED = 0; + */ + const CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED = 0; + /** + * Key with a fixed set of values. + * + * Generated from protobuf enum PREDEFINED = 1; + */ + const PREDEFINED = 1; + /** + * Key without a fixed set of values + * + * Generated from protobuf enum FREEFORM = 2; + */ + const FREEFORM = 2; + + private static $valueToName = [ + self::CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED => 'CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED', + self::PREDEFINED => 'PREDEFINED', + self::FREEFORM => 'FREEFORM', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CustomTargetingValue.php b/AdsAdManager/src/V1/CustomTargetingValue.php new file mode 100644 index 000000000000..1e88282d880d --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingValue.php @@ -0,0 +1,231 @@ +google.ads.admanager.v1.CustomTargetingValue + */ +class CustomTargetingValue extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `CustomTargetingValue`. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Immutable. Name of the `CustomTargetingValue`. Values can contain up to 40 + * characters each. You can use alphanumeric characters and symbols other than + * the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are + * not data-specific; all values are treated as strings. For example, instead + * of using "age>=18 AND <=34", try "18-34" + * + * Generated from protobuf field string ad_tag_name = 4 [(.google.api.field_behavior) = IMMUTABLE]; + */ + protected $ad_tag_name = ''; + /** + * Optional. Descriptive name for the `CustomTargetingValue`. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Required. Immutable. The way in which the CustomTargetingValue.name strings + * will be matched. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType match_type = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + */ + protected $match_type = 0; + /** + * Output only. Status of the `CustomTargetingValue`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `CustomTargetingValue`. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * @type string $ad_tag_name + * Immutable. Name of the `CustomTargetingValue`. Values can contain up to 40 + * characters each. You can use alphanumeric characters and symbols other than + * the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are + * not data-specific; all values are treated as strings. For example, instead + * of using "age>=18 AND <=34", try "18-34" + * @type string $display_name + * Optional. Descriptive name for the `CustomTargetingValue`. + * @type int $match_type + * Required. Immutable. The way in which the CustomTargetingValue.name strings + * will be matched. + * @type int $status + * Output only. Status of the `CustomTargetingValue`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingValueMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `CustomTargetingValue`. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `CustomTargetingValue`. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Immutable. Name of the `CustomTargetingValue`. Values can contain up to 40 + * characters each. You can use alphanumeric characters and symbols other than + * the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are + * not data-specific; all values are treated as strings. For example, instead + * of using "age>=18 AND <=34", try "18-34" + * + * Generated from protobuf field string ad_tag_name = 4 [(.google.api.field_behavior) = IMMUTABLE]; + * @return string + */ + public function getAdTagName() + { + return $this->ad_tag_name; + } + + /** + * Immutable. Name of the `CustomTargetingValue`. Values can contain up to 40 + * characters each. You can use alphanumeric characters and symbols other than + * the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are + * not data-specific; all values are treated as strings. For example, instead + * of using "age>=18 AND <=34", try "18-34" + * + * Generated from protobuf field string ad_tag_name = 4 [(.google.api.field_behavior) = IMMUTABLE]; + * @param string $var + * @return $this + */ + public function setAdTagName($var) + { + GPBUtil::checkString($var, True); + $this->ad_tag_name = $var; + + return $this; + } + + /** + * Optional. Descriptive name for the `CustomTargetingValue`. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Descriptive name for the `CustomTargetingValue`. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Required. Immutable. The way in which the CustomTargetingValue.name strings + * will be matched. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType match_type = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getMatchType() + { + return $this->match_type; + } + + /** + * Required. Immutable. The way in which the CustomTargetingValue.name strings + * will be matched. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType match_type = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setMatchType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomTargetingValueMatchTypeEnum\CustomTargetingValueMatchType::class); + $this->match_type = $var; + + return $this; + } + + /** + * Output only. Status of the `CustomTargetingValue`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getStatus() + { + return $this->status; + } + + /** + * Output only. Status of the `CustomTargetingValue`. + * + * Generated from protobuf field .google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\CustomTargetingValueStatusEnum\CustomTargetingValueStatus::class); + $this->status = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/CustomTargetingValueMatchTypeEnum.php b/AdsAdManager/src/V1/CustomTargetingValueMatchTypeEnum.php new file mode 100644 index 000000000000..8889014cf2ac --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingValueMatchTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum + */ +class CustomTargetingValueMatchTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingValueEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomTargetingValueMatchTypeEnum/CustomTargetingValueMatchType.php b/AdsAdManager/src/V1/CustomTargetingValueMatchTypeEnum/CustomTargetingValueMatchType.php new file mode 100644 index 000000000000..63aa5d3325e2 --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingValueMatchTypeEnum/CustomTargetingValueMatchType.php @@ -0,0 +1,111 @@ +google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType + */ +class CustomTargetingValueMatchType +{ + /** + * Not specified value. + * + * Generated from protobuf enum CUSTOM_TARGETING_VALUE_MATCH_TYPE_UNSPECIFIED = 0; + */ + const CUSTOM_TARGETING_VALUE_MATCH_TYPE_UNSPECIFIED = 0; + /** + * Used for exact matching. For example, the targeting value car=honda will + * only match to the ad request car=honda. + * + * Generated from protobuf enum EXACT = 1; + */ + const EXACT = 1; + /** + * Used for lenient matching when at least one of the words in the ad + * request matches the targeted value. The targeting value car=honda will + * match to ad requests containing the word honda. So ad requests car=honda + * or car=honda civic or car=buy honda or car=how much does a honda cost + * will all have the line item delivered. + * This match type can not be used within an audience segment rule. + * + * Generated from protobuf enum BROAD = 2; + */ + const BROAD = 2; + /** + * Used for 'starts with' matching when the first few characters in the ad + * request match all of the characters in the targeted value. The targeting + * value car=honda will match to ad requests car=honda or car=hondas for + * sale but not to car=I want a honda. + * + * Generated from protobuf enum PREFIX = 3; + */ + const PREFIX = 3; + /** + * This is a combination of MatchType#BROAD and MatchType#PREFIX matching. + * The targeting value car=honda will match to ad requests that contain + * words that start with the characters in the targeted value, for example + * with car=civic hondas. + * This match type can not be used within an audience segment rule. + * + * Generated from protobuf enum BROAD_PREFIX = 4; + */ + const BROAD_PREFIX = 4; + /** + * Used for 'ends with' matching when the last characters in the ad request + * match all of the characters in the targeted value. The targeting value + * car=honda will match with ad requests car=honda or car=I want a honda but + * not to car=hondas for sale. + * This match type can not be used within line item targeting. + * + * Generated from protobuf enum SUFFIX = 5; + */ + const SUFFIX = 5; + /** + * Used for 'within' matching when the string in the ad request contains the + * string in the targeted value. The targeting value car=honda will match + * with ad requests car=honda, car=I want a honda, and also with car=hondas + * for sale, but not with car=misspelled hond a. This match type can not be + * used within line item targeting. + * + * Generated from protobuf enum CONTAINS = 6; + */ + const CONTAINS = 6; + + private static $valueToName = [ + self::CUSTOM_TARGETING_VALUE_MATCH_TYPE_UNSPECIFIED => 'CUSTOM_TARGETING_VALUE_MATCH_TYPE_UNSPECIFIED', + self::EXACT => 'EXACT', + self::BROAD => 'BROAD', + self::PREFIX => 'PREFIX', + self::BROAD_PREFIX => 'BROAD_PREFIX', + self::SUFFIX => 'SUFFIX', + self::CONTAINS => 'CONTAINS', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/CustomTargetingValueStatusEnum.php b/AdsAdManager/src/V1/CustomTargetingValueStatusEnum.php new file mode 100644 index 000000000000..43c17351d951 --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingValueStatusEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.CustomTargetingValueStatusEnum + */ +class CustomTargetingValueStatusEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingValueEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/CustomTargetingValueStatusEnum/CustomTargetingValueStatus.php b/AdsAdManager/src/V1/CustomTargetingValueStatusEnum/CustomTargetingValueStatus.php new file mode 100644 index 000000000000..fe193b6b1dea --- /dev/null +++ b/AdsAdManager/src/V1/CustomTargetingValueStatusEnum/CustomTargetingValueStatus.php @@ -0,0 +1,62 @@ +google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatus + */ +class CustomTargetingValueStatus +{ + /** + * Not specified value. + * + * Generated from protobuf enum CUSTOM_TARGETING_VALUE_STATUS_UNSPECIFIED = 0; + */ + const CUSTOM_TARGETING_VALUE_STATUS_UNSPECIFIED = 0; + /** + * Custom targeting value is active. + * + * Generated from protobuf enum ACTIVE = 1; + */ + const ACTIVE = 1; + /** + * Custom targeting value is inactive. + * + * Generated from protobuf enum INACTIVE = 2; + */ + const INACTIVE = 2; + + private static $valueToName = [ + self::CUSTOM_TARGETING_VALUE_STATUS_UNSPECIFIED => 'CUSTOM_TARGETING_VALUE_STATUS_UNSPECIFIED', + self::ACTIVE => 'ACTIVE', + self::INACTIVE => 'INACTIVE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/EntitySignalsMapping.php b/AdsAdManager/src/V1/EntitySignalsMapping.php new file mode 100644 index 000000000000..19526df8672e --- /dev/null +++ b/AdsAdManager/src/V1/EntitySignalsMapping.php @@ -0,0 +1,255 @@ +google.ads.admanager.v1.EntitySignalsMapping + */ +class EntitySignalsMapping extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `EntitySignalsMapping`. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. `EntitySignalsMapping` ID. + * + * Generated from protobuf field int64 entity_signals_mapping_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $entity_signals_mapping_id = 0; + /** + * Required. The IDs of the categories that are associated with the + * referencing entity. + * + * Generated from protobuf field repeated int64 taxonomy_category_ids = 6 [(.google.api.field_behavior) = REQUIRED]; + */ + private $taxonomy_category_ids; + protected $entity; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $audience_segment_id + * ID of an AudienceSegment that this mapping belongs to. + * @type int|string $content_bundle_id + * ID of a ContentBundle that this mapping belongs to. + * @type int|string $custom_targeting_value_id + * ID of a CustomValue that this mapping belongs to. + * @type string $name + * Identifier. The resource name of the `EntitySignalsMapping`. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * @type int|string $entity_signals_mapping_id + * Output only. `EntitySignalsMapping` ID. + * @type array|array|\Google\Protobuf\Internal\RepeatedField $taxonomy_category_ids + * Required. The IDs of the categories that are associated with the + * referencing entity. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingMessages::initOnce(); + parent::__construct($data); + } + + /** + * ID of an AudienceSegment that this mapping belongs to. + * + * Generated from protobuf field int64 audience_segment_id = 3; + * @return int|string + */ + public function getAudienceSegmentId() + { + return $this->readOneof(3); + } + + public function hasAudienceSegmentId() + { + return $this->hasOneof(3); + } + + /** + * ID of an AudienceSegment that this mapping belongs to. + * + * Generated from protobuf field int64 audience_segment_id = 3; + * @param int|string $var + * @return $this + */ + public function setAudienceSegmentId($var) + { + GPBUtil::checkInt64($var); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * ID of a ContentBundle that this mapping belongs to. + * + * Generated from protobuf field int64 content_bundle_id = 4; + * @return int|string + */ + public function getContentBundleId() + { + return $this->readOneof(4); + } + + public function hasContentBundleId() + { + return $this->hasOneof(4); + } + + /** + * ID of a ContentBundle that this mapping belongs to. + * + * Generated from protobuf field int64 content_bundle_id = 4; + * @param int|string $var + * @return $this + */ + public function setContentBundleId($var) + { + GPBUtil::checkInt64($var); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * ID of a CustomValue that this mapping belongs to. + * + * Generated from protobuf field int64 custom_targeting_value_id = 5; + * @return int|string + */ + public function getCustomTargetingValueId() + { + return $this->readOneof(5); + } + + public function hasCustomTargetingValueId() + { + return $this->hasOneof(5); + } + + /** + * ID of a CustomValue that this mapping belongs to. + * + * Generated from protobuf field int64 custom_targeting_value_id = 5; + * @param int|string $var + * @return $this + */ + public function setCustomTargetingValueId($var) + { + GPBUtil::checkInt64($var); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * Identifier. The resource name of the `EntitySignalsMapping`. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `EntitySignalsMapping`. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. `EntitySignalsMapping` ID. + * + * Generated from protobuf field int64 entity_signals_mapping_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getEntitySignalsMappingId() + { + return $this->entity_signals_mapping_id; + } + + /** + * Output only. `EntitySignalsMapping` ID. + * + * Generated from protobuf field int64 entity_signals_mapping_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setEntitySignalsMappingId($var) + { + GPBUtil::checkInt64($var); + $this->entity_signals_mapping_id = $var; + + return $this; + } + + /** + * Required. The IDs of the categories that are associated with the + * referencing entity. + * + * Generated from protobuf field repeated int64 taxonomy_category_ids = 6 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTaxonomyCategoryIds() + { + return $this->taxonomy_category_ids; + } + + /** + * Required. The IDs of the categories that are associated with the + * referencing entity. + * + * Generated from protobuf field repeated int64 taxonomy_category_ids = 6 [(.google.api.field_behavior) = REQUIRED]; + * @param array|array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTaxonomyCategoryIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64); + $this->taxonomy_category_ids = $arr; + + return $this; + } + + /** + * @return string + */ + public function getEntity() + { + return $this->whichOneof("entity"); + } + +} + diff --git a/AdsAdManager/src/V1/EnvironmentTypeEnum.php b/AdsAdManager/src/V1/EnvironmentTypeEnum.php new file mode 100644 index 000000000000..eb19e59df821 --- /dev/null +++ b/AdsAdManager/src/V1/EnvironmentTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.EnvironmentTypeEnum + */ +class EnvironmentTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EnvironmentTypeEnum::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/EnvironmentTypeEnum/EnvironmentType.php b/AdsAdManager/src/V1/EnvironmentTypeEnum/EnvironmentType.php new file mode 100644 index 000000000000..44b2d8a85159 --- /dev/null +++ b/AdsAdManager/src/V1/EnvironmentTypeEnum/EnvironmentType.php @@ -0,0 +1,62 @@ +google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType + */ +class EnvironmentType +{ + /** + * No value specified + * + * Generated from protobuf enum ENVIRONMENT_TYPE_UNSPECIFIED = 0; + */ + const ENVIRONMENT_TYPE_UNSPECIFIED = 0; + /** + * A regular web browser. + * + * Generated from protobuf enum BROWSER = 1; + */ + const BROWSER = 1; + /** + * Video players. + * + * Generated from protobuf enum VIDEO_PLAYER = 2; + */ + const VIDEO_PLAYER = 2; + + private static $valueToName = [ + self::ENVIRONMENT_TYPE_UNSPECIFIED => 'ENVIRONMENT_TYPE_UNSPECIFIED', + self::BROWSER => 'BROWSER', + self::VIDEO_PLAYER => 'VIDEO_PLAYER', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/FetchReportResultRowsRequest.php b/AdsAdManager/src/V1/FetchReportResultRowsRequest.php new file mode 100644 index 000000000000..c12d3c16d43d --- /dev/null +++ b/AdsAdManager/src/V1/FetchReportResultRowsRequest.php @@ -0,0 +1,170 @@ +google.ads.admanager.v1.FetchReportResultRowsRequest + */ +class FetchReportResultRowsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * The report result being fetched. + * Format: + * `networks/{network_code}/reports/{report_id}/results/{report_result_id}` + * + * Generated from protobuf field string name = 1; + */ + protected $name = ''; + /** + * Optional. The maximum number of rows to return. The service may return + * fewer than this value. If unspecified, at most 1,000 rows will be returned. + * The maximum value is 10,000; values above 10,000 will be reduced to 10,000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `FetchReportResultRows` + * call. Provide this to retrieve the second and subsequent batches of rows. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + + /** + * @param string $name The report result being fetched. + * Format: + * `networks/{network_code}/reports/{report_id}/results/{report_result_id}` + * + * @return \Google\Ads\AdManager\V1\FetchReportResultRowsRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * The report result being fetched. + * Format: + * `networks/{network_code}/reports/{report_id}/results/{report_result_id}` + * @type int $page_size + * Optional. The maximum number of rows to return. The service may return + * fewer than this value. If unspecified, at most 1,000 rows will be returned. + * The maximum value is 10,000; values above 10,000 will be reduced to 10,000. + * @type string $page_token + * Optional. A page token, received from a previous `FetchReportResultRows` + * call. Provide this to retrieve the second and subsequent batches of rows. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * The report result being fetched. + * Format: + * `networks/{network_code}/reports/{report_id}/results/{report_result_id}` + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * The report result being fetched. + * Format: + * `networks/{network_code}/reports/{report_id}/results/{report_result_id}` + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. The maximum number of rows to return. The service may return + * fewer than this value. If unspecified, at most 1,000 rows will be returned. + * The maximum value is 10,000; values above 10,000 will be reduced to 10,000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of rows to return. The service may return + * fewer than this value. If unspecified, at most 1,000 rows will be returned. + * The maximum value is 10,000; values above 10,000 will be reduced to 10,000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `FetchReportResultRows` + * call. Provide this to retrieve the second and subsequent batches of rows. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `FetchReportResultRows` + * call. Provide this to retrieve the second and subsequent batches of rows. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/FetchReportResultRowsResponse.php b/AdsAdManager/src/V1/FetchReportResultRowsResponse.php new file mode 100644 index 000000000000..74a9f55c6b63 --- /dev/null +++ b/AdsAdManager/src/V1/FetchReportResultRowsResponse.php @@ -0,0 +1,283 @@ +google.ads.admanager.v1.FetchReportResultRowsResponse + */ +class FetchReportResultRowsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * Up to `page_size` rows of report data. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DataTable.Row rows = 1; + */ + private $rows; + /** + * The time at which the report was scheduled to run. For non-scheduled + * reports, this is the time at which the report was requested to be run. + * + * Generated from protobuf field .google.protobuf.Timestamp run_time = 2; + */ + protected $run_time = null; + /** + * The computed fixed date ranges this report includes. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DateRange.FixedDateRange date_ranges = 3; + */ + private $date_ranges; + /** + * The computed comparison fixed date ranges this report includes. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DateRange.FixedDateRange comparison_date_ranges = 4; + */ + private $comparison_date_ranges; + /** + * The total number of rows available from this report. Useful for + * pagination. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field int32 total_row_count = 5; + */ + protected $total_row_count = 0; + /** + * A token that can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 6; + */ + protected $next_page_token = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Report\DataTable\Row>|\Google\Protobuf\Internal\RepeatedField $rows + * Up to `page_size` rows of report data. + * @type \Google\Protobuf\Timestamp $run_time + * The time at which the report was scheduled to run. For non-scheduled + * reports, this is the time at which the report was requested to be run. + * @type array<\Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange>|\Google\Protobuf\Internal\RepeatedField $date_ranges + * The computed fixed date ranges this report includes. + * Only returned with the first page of results (when page_token is not + * included in the request). + * @type array<\Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange>|\Google\Protobuf\Internal\RepeatedField $comparison_date_ranges + * The computed comparison fixed date ranges this report includes. + * Only returned with the first page of results (when page_token is not + * included in the request). + * @type int $total_row_count + * The total number of rows available from this report. Useful for + * pagination. + * Only returned with the first page of results (when page_token is not + * included in the request). + * @type string $next_page_token + * A token that can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Up to `page_size` rows of report data. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DataTable.Row rows = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRows() + { + return $this->rows; + } + + /** + * Up to `page_size` rows of report data. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DataTable.Row rows = 1; + * @param array<\Google\Ads\AdManager\V1\Report\DataTable\Row>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRows($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\DataTable\Row::class); + $this->rows = $arr; + + return $this; + } + + /** + * The time at which the report was scheduled to run. For non-scheduled + * reports, this is the time at which the report was requested to be run. + * + * Generated from protobuf field .google.protobuf.Timestamp run_time = 2; + * @return \Google\Protobuf\Timestamp|null + */ + public function getRunTime() + { + return $this->run_time; + } + + public function hasRunTime() + { + return isset($this->run_time); + } + + public function clearRunTime() + { + unset($this->run_time); + } + + /** + * The time at which the report was scheduled to run. For non-scheduled + * reports, this is the time at which the report was requested to be run. + * + * Generated from protobuf field .google.protobuf.Timestamp run_time = 2; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setRunTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->run_time = $var; + + return $this; + } + + /** + * The computed fixed date ranges this report includes. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DateRange.FixedDateRange date_ranges = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDateRanges() + { + return $this->date_ranges; + } + + /** + * The computed fixed date ranges this report includes. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DateRange.FixedDateRange date_ranges = 3; + * @param array<\Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDateRanges($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange::class); + $this->date_ranges = $arr; + + return $this; + } + + /** + * The computed comparison fixed date ranges this report includes. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DateRange.FixedDateRange comparison_date_ranges = 4; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getComparisonDateRanges() + { + return $this->comparison_date_ranges; + } + + /** + * The computed comparison fixed date ranges this report includes. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DateRange.FixedDateRange comparison_date_ranges = 4; + * @param array<\Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setComparisonDateRanges($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange::class); + $this->comparison_date_ranges = $arr; + + return $this; + } + + /** + * The total number of rows available from this report. Useful for + * pagination. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field int32 total_row_count = 5; + * @return int + */ + public function getTotalRowCount() + { + return $this->total_row_count; + } + + /** + * The total number of rows available from this report. Useful for + * pagination. + * Only returned with the first page of results (when page_token is not + * included in the request). + * + * Generated from protobuf field int32 total_row_count = 5; + * @param int $var + * @return $this + */ + public function setTotalRowCount($var) + { + GPBUtil::checkInt32($var); + $this->total_row_count = $var; + + return $this; + } + + /** + * A token that can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 6; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token that can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 6; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/FrequencyCap.php b/AdsAdManager/src/V1/FrequencyCap.php new file mode 100644 index 000000000000..168ab1cb5f0c --- /dev/null +++ b/AdsAdManager/src/V1/FrequencyCap.php @@ -0,0 +1,165 @@ +google.ads.admanager.v1.FrequencyCap + */ +class FrequencyCap extends \Google\Protobuf\Internal\Message +{ + /** + * The maximum number of impressions for this frequency cap. + * + * Generated from protobuf field optional int64 max_impressions = 1; + */ + protected $max_impressions = null; + /** + * The number of time units over which the frequency cap is effective. + * + * Generated from protobuf field optional int64 time_amount = 2; + */ + protected $time_amount = null; + /** + * The units of time of this frequency cap. + * + * Generated from protobuf field optional .google.ads.admanager.v1.TimeUnitEnum.TimeUnit time_unit = 3; + */ + protected $time_unit = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $max_impressions + * The maximum number of impressions for this frequency cap. + * @type int|string $time_amount + * The number of time units over which the frequency cap is effective. + * @type int $time_unit + * The units of time of this frequency cap. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\FrequencyCap::initOnce(); + parent::__construct($data); + } + + /** + * The maximum number of impressions for this frequency cap. + * + * Generated from protobuf field optional int64 max_impressions = 1; + * @return int|string + */ + public function getMaxImpressions() + { + return isset($this->max_impressions) ? $this->max_impressions : 0; + } + + public function hasMaxImpressions() + { + return isset($this->max_impressions); + } + + public function clearMaxImpressions() + { + unset($this->max_impressions); + } + + /** + * The maximum number of impressions for this frequency cap. + * + * Generated from protobuf field optional int64 max_impressions = 1; + * @param int|string $var + * @return $this + */ + public function setMaxImpressions($var) + { + GPBUtil::checkInt64($var); + $this->max_impressions = $var; + + return $this; + } + + /** + * The number of time units over which the frequency cap is effective. + * + * Generated from protobuf field optional int64 time_amount = 2; + * @return int|string + */ + public function getTimeAmount() + { + return isset($this->time_amount) ? $this->time_amount : 0; + } + + public function hasTimeAmount() + { + return isset($this->time_amount); + } + + public function clearTimeAmount() + { + unset($this->time_amount); + } + + /** + * The number of time units over which the frequency cap is effective. + * + * Generated from protobuf field optional int64 time_amount = 2; + * @param int|string $var + * @return $this + */ + public function setTimeAmount($var) + { + GPBUtil::checkInt64($var); + $this->time_amount = $var; + + return $this; + } + + /** + * The units of time of this frequency cap. + * + * Generated from protobuf field optional .google.ads.admanager.v1.TimeUnitEnum.TimeUnit time_unit = 3; + * @return int + */ + public function getTimeUnit() + { + return isset($this->time_unit) ? $this->time_unit : 0; + } + + public function hasTimeUnit() + { + return isset($this->time_unit); + } + + public function clearTimeUnit() + { + unset($this->time_unit); + } + + /** + * The units of time of this frequency cap. + * + * Generated from protobuf field optional .google.ads.admanager.v1.TimeUnitEnum.TimeUnit time_unit = 3; + * @param int $var + * @return $this + */ + public function setTimeUnit($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\TimeUnitEnum\TimeUnit::class); + $this->time_unit = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetAdUnitRequest.php b/AdsAdManager/src/V1/GetAdUnitRequest.php new file mode 100644 index 000000000000..a359f1d3acaf --- /dev/null +++ b/AdsAdManager/src/V1/GetAdUnitRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetAdUnitRequest + */ +class GetAdUnitRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetAdUnitRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the AdUnit. + * Format: `networks/{network_code}/adUnits/{ad_unit_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetCompanyRequest.php b/AdsAdManager/src/V1/GetCompanyRequest.php new file mode 100644 index 000000000000..6fe5c202376a --- /dev/null +++ b/AdsAdManager/src/V1/GetCompanyRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetCompanyRequest + */ +class GetCompanyRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the Company. + * Format: `networks/{network_code}/companies/{company_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the Company. + * Format: `networks/{network_code}/companies/{company_id}` + * Please see {@see CompanyServiceClient::companyName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetCompanyRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the Company. + * Format: `networks/{network_code}/companies/{company_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CompanyService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the Company. + * Format: `networks/{network_code}/companies/{company_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the Company. + * Format: `networks/{network_code}/companies/{company_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetCustomFieldRequest.php b/AdsAdManager/src/V1/GetCustomFieldRequest.php new file mode 100644 index 000000000000..493ec5fcc0d9 --- /dev/null +++ b/AdsAdManager/src/V1/GetCustomFieldRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetCustomFieldRequest + */ +class GetCustomFieldRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the CustomField. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the CustomField. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * Please see {@see CustomFieldServiceClient::customFieldName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetCustomFieldRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the CustomField. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the CustomField. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the CustomField. + * Format: `networks/{network_code}/customFields/{custom_field_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetCustomTargetingKeyRequest.php b/AdsAdManager/src/V1/GetCustomTargetingKeyRequest.php new file mode 100644 index 000000000000..9499837ddb77 --- /dev/null +++ b/AdsAdManager/src/V1/GetCustomTargetingKeyRequest.php @@ -0,0 +1,91 @@ +google.ads.admanager.v1.GetCustomTargetingKeyRequest + */ +class GetCustomTargetingKeyRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the CustomTargetingKey. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the CustomTargetingKey. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * Please see {@see CustomTargetingKeyServiceClient::customTargetingKeyName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetCustomTargetingKeyRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the CustomTargetingKey. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingKeyService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the CustomTargetingKey. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the CustomTargetingKey. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetCustomTargetingValueRequest.php b/AdsAdManager/src/V1/GetCustomTargetingValueRequest.php new file mode 100644 index 000000000000..e87b9ad62c0e --- /dev/null +++ b/AdsAdManager/src/V1/GetCustomTargetingValueRequest.php @@ -0,0 +1,91 @@ +google.ads.admanager.v1.GetCustomTargetingValueRequest + */ +class GetCustomTargetingValueRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the CustomTargetingValue. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the CustomTargetingValue. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * Please see {@see CustomTargetingValueServiceClient::customTargetingValueName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetCustomTargetingValueRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the CustomTargetingValue. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingValueService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the CustomTargetingValue. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the CustomTargetingValue. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetEntitySignalsMappingRequest.php b/AdsAdManager/src/V1/GetEntitySignalsMappingRequest.php new file mode 100644 index 000000000000..f0b13fadda72 --- /dev/null +++ b/AdsAdManager/src/V1/GetEntitySignalsMappingRequest.php @@ -0,0 +1,91 @@ +google.ads.admanager.v1.GetEntitySignalsMappingRequest + */ +class GetEntitySignalsMappingRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the EntitySignalsMapping. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the EntitySignalsMapping. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * Please see {@see EntitySignalsMappingServiceClient::entitySignalsMappingName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetEntitySignalsMappingRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the EntitySignalsMapping. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the EntitySignalsMapping. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the EntitySignalsMapping. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetNetworkRequest.php b/AdsAdManager/src/V1/GetNetworkRequest.php new file mode 100644 index 000000000000..f091d5459079 --- /dev/null +++ b/AdsAdManager/src/V1/GetNetworkRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetNetworkRequest + */ +class GetNetworkRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Resource name of Network. + * Format: networks/{network_code} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. Resource name of Network. + * Format: networks/{network_code} + * Please see {@see NetworkServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetNetworkRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. Resource name of Network. + * Format: networks/{network_code} + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\NetworkService::initOnce(); + parent::__construct($data); + } + + /** + * Required. Resource name of Network. + * Format: networks/{network_code} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Resource name of Network. + * Format: networks/{network_code} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetOrderRequest.php b/AdsAdManager/src/V1/GetOrderRequest.php new file mode 100644 index 000000000000..b2ad956f8023 --- /dev/null +++ b/AdsAdManager/src/V1/GetOrderRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetOrderRequest + */ +class GetOrderRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the Order. + * Format: `networks/{network_code}/orders/{order_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the Order. + * Format: `networks/{network_code}/orders/{order_id}` + * Please see {@see OrderServiceClient::orderName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetOrderRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the Order. + * Format: `networks/{network_code}/orders/{order_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\OrderService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the Order. + * Format: `networks/{network_code}/orders/{order_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the Order. + * Format: `networks/{network_code}/orders/{order_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetPlacementRequest.php b/AdsAdManager/src/V1/GetPlacementRequest.php new file mode 100644 index 000000000000..dc0b6f37f542 --- /dev/null +++ b/AdsAdManager/src/V1/GetPlacementRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetPlacementRequest + */ +class GetPlacementRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the Placement. + * Format: `networks/{network_code}/placements/{placement_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the Placement. + * Format: `networks/{network_code}/placements/{placement_id}` + * Please see {@see PlacementServiceClient::placementName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetPlacementRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the Placement. + * Format: `networks/{network_code}/placements/{placement_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\PlacementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the Placement. + * Format: `networks/{network_code}/placements/{placement_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the Placement. + * Format: `networks/{network_code}/placements/{placement_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetReportRequest.php b/AdsAdManager/src/V1/GetReportRequest.php new file mode 100644 index 000000000000..796bc7046179 --- /dev/null +++ b/AdsAdManager/src/V1/GetReportRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetReportRequest + */ +class GetReportRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the report. + * Format: `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the report. + * Format: `networks/{network_code}/reports/{report_id}` + * Please see {@see ReportServiceClient::reportName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetReportRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the report. + * Format: `networks/{network_code}/reports/{report_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the report. + * Format: `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the report. + * Format: `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetRoleRequest.php b/AdsAdManager/src/V1/GetRoleRequest.php new file mode 100644 index 000000000000..5b5ef57b0bc8 --- /dev/null +++ b/AdsAdManager/src/V1/GetRoleRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetRoleRequest + */ +class GetRoleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the Role. + * Format: `networks/{network_code}/roles/{role_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the Role. + * Format: `networks/{network_code}/roles/{role_id}` + * Please see {@see RoleServiceClient::roleName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetRoleRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the Role. + * Format: `networks/{network_code}/roles/{role_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\RoleService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the Role. + * Format: `networks/{network_code}/roles/{role_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the Role. + * Format: `networks/{network_code}/roles/{role_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetTaxonomyCategoryRequest.php b/AdsAdManager/src/V1/GetTaxonomyCategoryRequest.php new file mode 100644 index 000000000000..b0e943d63698 --- /dev/null +++ b/AdsAdManager/src/V1/GetTaxonomyCategoryRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetTaxonomyCategoryRequest + */ +class GetTaxonomyCategoryRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the TaxonomyCategory. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the TaxonomyCategory. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * Please see {@see TaxonomyCategoryServiceClient::taxonomyCategoryName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetTaxonomyCategoryRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the TaxonomyCategory. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\TaxonomyCategoryService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the TaxonomyCategory. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the TaxonomyCategory. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/GetUserRequest.php b/AdsAdManager/src/V1/GetUserRequest.php new file mode 100644 index 000000000000..602f87ff62d3 --- /dev/null +++ b/AdsAdManager/src/V1/GetUserRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.GetUserRequest + */ +class GetUserRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * Please see {@see UserServiceClient::userName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\GetUserRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\UserService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/Label.php b/AdsAdManager/src/V1/Label.php new file mode 100644 index 000000000000..246b02a2b2c7 --- /dev/null +++ b/AdsAdManager/src/V1/Label.php @@ -0,0 +1,71 @@ +google.ads.admanager.v1.Label + */ +class Label extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `Label`. + * Format: `networks/{network_code}/labels/{label_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `Label`. + * Format: `networks/{network_code}/labels/{label_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\LabelMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `Label`. + * Format: `networks/{network_code}/labels/{label_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `Label`. + * Format: `networks/{network_code}/labels/{label_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/LabelFrequencyCap.php b/AdsAdManager/src/V1/LabelFrequencyCap.php new file mode 100644 index 000000000000..114c8b3e3776 --- /dev/null +++ b/AdsAdManager/src/V1/LabelFrequencyCap.php @@ -0,0 +1,115 @@ +google.ads.admanager.v1.LabelFrequencyCap + */ +class LabelFrequencyCap extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The label to used for frequency capping. + * Format: "networks/{network_code}/labels/{label_id}" + * + * Generated from protobuf field string label = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $label = ''; + /** + * The frequency cap. + * + * Generated from protobuf field .google.ads.admanager.v1.FrequencyCap frequency_cap = 2; + */ + protected $frequency_cap = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $label + * Required. The label to used for frequency capping. + * Format: "networks/{network_code}/labels/{label_id}" + * @type \Google\Ads\AdManager\V1\FrequencyCap $frequency_cap + * The frequency cap. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitMessages::initOnce(); + parent::__construct($data); + } + + /** + * Required. The label to used for frequency capping. + * Format: "networks/{network_code}/labels/{label_id}" + * + * Generated from protobuf field string label = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getLabel() + { + return $this->label; + } + + /** + * Required. The label to used for frequency capping. + * Format: "networks/{network_code}/labels/{label_id}" + * + * Generated from protobuf field string label = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setLabel($var) + { + GPBUtil::checkString($var, True); + $this->label = $var; + + return $this; + } + + /** + * The frequency cap. + * + * Generated from protobuf field .google.ads.admanager.v1.FrequencyCap frequency_cap = 2; + * @return \Google\Ads\AdManager\V1\FrequencyCap|null + */ + public function getFrequencyCap() + { + return $this->frequency_cap; + } + + public function hasFrequencyCap() + { + return isset($this->frequency_cap); + } + + public function clearFrequencyCap() + { + unset($this->frequency_cap); + } + + /** + * The frequency cap. + * + * Generated from protobuf field .google.ads.admanager.v1.FrequencyCap frequency_cap = 2; + * @param \Google\Ads\AdManager\V1\FrequencyCap $var + * @return $this + */ + public function setFrequencyCap($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\FrequencyCap::class); + $this->frequency_cap = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListAdUnitSizesRequest.php b/AdsAdManager/src/V1/ListAdUnitSizesRequest.php new file mode 100644 index 000000000000..14020cd4f7ef --- /dev/null +++ b/AdsAdManager/src/V1/ListAdUnitSizesRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListAdUnitSizesRequest + */ +class ListAdUnitSizesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of AdUnitSizes. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of AdUnitSizes to return. The service may + * return fewer than this value. If unspecified, at most 50 ad unit sizes will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListAdUnitSizes` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListAdUnitSizes` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of AdUnitSizes. + * Format: `networks/{network_code}` + * Please see {@see AdUnitServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListAdUnitSizesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of AdUnitSizes. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of AdUnitSizes to return. The service may + * return fewer than this value. If unspecified, at most 50 ad unit sizes will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListAdUnitSizes` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListAdUnitSizes` must + * match the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of AdUnitSizes. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of AdUnitSizes. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of AdUnitSizes to return. The service may + * return fewer than this value. If unspecified, at most 50 ad unit sizes will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of AdUnitSizes to return. The service may + * return fewer than this value. If unspecified, at most 50 ad unit sizes will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListAdUnitSizes` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListAdUnitSizes` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListAdUnitSizes` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListAdUnitSizes` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListAdUnitSizesResponse.php b/AdsAdManager/src/V1/ListAdUnitSizesResponse.php new file mode 100644 index 000000000000..c9b275f95ca0 --- /dev/null +++ b/AdsAdManager/src/V1/ListAdUnitSizesResponse.php @@ -0,0 +1,171 @@ +google.ads.admanager.v1.ListAdUnitSizesResponse + */ +class ListAdUnitSizesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The AdUnitSizes from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 1; + */ + private $ad_unit_sizes; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of AdUnitSizes. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\AdUnitSize>|\Google\Protobuf\Internal\RepeatedField $ad_unit_sizes + * The AdUnitSizes from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of AdUnitSizes. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitService::initOnce(); + parent::__construct($data); + } + + /** + * The AdUnitSizes from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAdUnitSizes() + { + return $this->ad_unit_sizes; + } + + /** + * The AdUnitSizes from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnitSize ad_unit_sizes = 1; + * @param array<\Google\Ads\AdManager\V1\AdUnitSize>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAdUnitSizes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AdUnitSize::class); + $this->ad_unit_sizes = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of AdUnitSizes. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of AdUnitSizes. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListAdUnitsRequest.php b/AdsAdManager/src/V1/ListAdUnitsRequest.php new file mode 100644 index 000000000000..a026663a9637 --- /dev/null +++ b/AdsAdManager/src/V1/ListAdUnitsRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListAdUnitsRequest + */ +class ListAdUnitsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of AdUnits. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of AdUnits to return. The service may return + * fewer than this value. If unspecified, at most 50 ad units will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListAdUnits` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListAdUnits` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of AdUnits. + * Format: `networks/{network_code}` + * Please see {@see AdUnitServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListAdUnitsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of AdUnits. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of AdUnits to return. The service may return + * fewer than this value. If unspecified, at most 50 ad units will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListAdUnits` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListAdUnits` must match + * the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of AdUnits. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of AdUnits. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of AdUnits to return. The service may return + * fewer than this value. If unspecified, at most 50 ad units will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of AdUnits to return. The service may return + * fewer than this value. If unspecified, at most 50 ad units will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListAdUnits` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListAdUnits` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListAdUnits` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListAdUnits` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListAdUnitsResponse.php b/AdsAdManager/src/V1/ListAdUnitsResponse.php new file mode 100644 index 000000000000..455e35caede7 --- /dev/null +++ b/AdsAdManager/src/V1/ListAdUnitsResponse.php @@ -0,0 +1,171 @@ +google.ads.admanager.v1.ListAdUnitsResponse + */ +class ListAdUnitsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The AdUnit from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnit ad_units = 1; + */ + private $ad_units; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of AdUnits. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\AdUnit>|\Google\Protobuf\Internal\RepeatedField $ad_units + * The AdUnit from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of AdUnits. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitService::initOnce(); + parent::__construct($data); + } + + /** + * The AdUnit from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnit ad_units = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAdUnits() + { + return $this->ad_units; + } + + /** + * The AdUnit from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AdUnit ad_units = 1; + * @param array<\Google\Ads\AdManager\V1\AdUnit>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAdUnits($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AdUnit::class); + $this->ad_units = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of AdUnits. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of AdUnits. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListCompaniesRequest.php b/AdsAdManager/src/V1/ListCompaniesRequest.php new file mode 100644 index 000000000000..92854e1e909c --- /dev/null +++ b/AdsAdManager/src/V1/ListCompaniesRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListCompaniesRequest + */ +class ListCompaniesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of Companies. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `Companies` to return. The service may + * return fewer than this value. If unspecified, at most 50 `Companies` will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListCompanies` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCompanies` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of Companies. + * Format: `networks/{network_code}` + * Please see {@see CompanyServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListCompaniesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of Companies. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `Companies` to return. The service may + * return fewer than this value. If unspecified, at most 50 `Companies` will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListCompanies` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCompanies` must + * match the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CompanyService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of Companies. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of Companies. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `Companies` to return. The service may + * return fewer than this value. If unspecified, at most 50 `Companies` will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `Companies` to return. The service may + * return fewer than this value. If unspecified, at most 50 `Companies` will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListCompanies` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCompanies` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListCompanies` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCompanies` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListCompaniesResponse.php b/AdsAdManager/src/V1/ListCompaniesResponse.php new file mode 100644 index 000000000000..2dc511fcdc1e --- /dev/null +++ b/AdsAdManager/src/V1/ListCompaniesResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListCompaniesResponse + */ +class ListCompaniesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `Company` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Company companies = 1; + */ + private $companies; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `Company` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Company>|\Google\Protobuf\Internal\RepeatedField $companies + * The `Company` objects from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `Company` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CompanyService::initOnce(); + parent::__construct($data); + } + + /** + * The `Company` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Company companies = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCompanies() + { + return $this->companies; + } + + /** + * The `Company` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Company companies = 1; + * @param array<\Google\Ads\AdManager\V1\Company>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCompanies($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Company::class); + $this->companies = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `Company` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `Company` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListCustomFieldsRequest.php b/AdsAdManager/src/V1/ListCustomFieldsRequest.php new file mode 100644 index 000000000000..503b26124a12 --- /dev/null +++ b/AdsAdManager/src/V1/ListCustomFieldsRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListCustomFieldsRequest + */ +class ListCustomFieldsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of CustomFields. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `CustomFields` to return. The service may + * return fewer than this value. If unspecified, at most 50 `CustomFields` + * will be returned. The maximum value is 1000; values above 1000 will be + * coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListCustomFields` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCustomFields` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of CustomFields. + * Format: `networks/{network_code}` + * Please see {@see CustomFieldServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListCustomFieldsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of CustomFields. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `CustomFields` to return. The service may + * return fewer than this value. If unspecified, at most 50 `CustomFields` + * will be returned. The maximum value is 1000; values above 1000 will be + * coerced to 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListCustomFields` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCustomFields` must + * match the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of CustomFields. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of CustomFields. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `CustomFields` to return. The service may + * return fewer than this value. If unspecified, at most 50 `CustomFields` + * will be returned. The maximum value is 1000; values above 1000 will be + * coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `CustomFields` to return. The service may + * return fewer than this value. If unspecified, at most 50 `CustomFields` + * will be returned. The maximum value is 1000; values above 1000 will be + * coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListCustomFields` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCustomFields` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListCustomFields` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCustomFields` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListCustomFieldsResponse.php b/AdsAdManager/src/V1/ListCustomFieldsResponse.php new file mode 100644 index 000000000000..0309c4dbb01a --- /dev/null +++ b/AdsAdManager/src/V1/ListCustomFieldsResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListCustomFieldsResponse + */ +class ListCustomFieldsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `CustomField` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomField custom_fields = 1; + */ + private $custom_fields; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `CustomField` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\CustomField>|\Google\Protobuf\Internal\RepeatedField $custom_fields + * The `CustomField` objects from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `CustomField` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomFieldService::initOnce(); + parent::__construct($data); + } + + /** + * The `CustomField` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomField custom_fields = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCustomFields() + { + return $this->custom_fields; + } + + /** + * The `CustomField` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomField custom_fields = 1; + * @param array<\Google\Ads\AdManager\V1\CustomField>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCustomFields($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\CustomField::class); + $this->custom_fields = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `CustomField` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `CustomField` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListCustomTargetingKeysRequest.php b/AdsAdManager/src/V1/ListCustomTargetingKeysRequest.php new file mode 100644 index 000000000000..bf474f6a2a8f --- /dev/null +++ b/AdsAdManager/src/V1/ListCustomTargetingKeysRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListCustomTargetingKeysRequest + */ +class ListCustomTargetingKeysRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of CustomTargetingKeys. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `CustomTargetingKeys` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `CustomTargetingKeys` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListCustomTargetingKeys` + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCustomTargetingKeys` + * must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of CustomTargetingKeys. + * Format: `networks/{network_code}` + * Please see {@see CustomTargetingKeyServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListCustomTargetingKeysRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of CustomTargetingKeys. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `CustomTargetingKeys` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `CustomTargetingKeys` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListCustomTargetingKeys` + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCustomTargetingKeys` + * must match the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingKeyService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of CustomTargetingKeys. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of CustomTargetingKeys. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `CustomTargetingKeys` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `CustomTargetingKeys` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `CustomTargetingKeys` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `CustomTargetingKeys` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListCustomTargetingKeys` + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCustomTargetingKeys` + * must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListCustomTargetingKeys` + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListCustomTargetingKeys` + * must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListCustomTargetingKeysResponse.php b/AdsAdManager/src/V1/ListCustomTargetingKeysResponse.php new file mode 100644 index 000000000000..891f1e3aff20 --- /dev/null +++ b/AdsAdManager/src/V1/ListCustomTargetingKeysResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListCustomTargetingKeysResponse + */ +class ListCustomTargetingKeysResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `CustomTargetingKey` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomTargetingKey custom_targeting_keys = 1; + */ + private $custom_targeting_keys; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `CustomTargetingKey` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\CustomTargetingKey>|\Google\Protobuf\Internal\RepeatedField $custom_targeting_keys + * The `CustomTargetingKey` objects from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `CustomTargetingKey` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingKeyService::initOnce(); + parent::__construct($data); + } + + /** + * The `CustomTargetingKey` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomTargetingKey custom_targeting_keys = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCustomTargetingKeys() + { + return $this->custom_targeting_keys; + } + + /** + * The `CustomTargetingKey` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomTargetingKey custom_targeting_keys = 1; + * @param array<\Google\Ads\AdManager\V1\CustomTargetingKey>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCustomTargetingKeys($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\CustomTargetingKey::class); + $this->custom_targeting_keys = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `CustomTargetingKey` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `CustomTargetingKey` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListCustomTargetingValuesRequest.php b/AdsAdManager/src/V1/ListCustomTargetingValuesRequest.php new file mode 100644 index 000000000000..8c2c089c1da0 --- /dev/null +++ b/AdsAdManager/src/V1/ListCustomTargetingValuesRequest.php @@ -0,0 +1,309 @@ +google.ads.admanager.v1.ListCustomTargetingValuesRequest + */ +class ListCustomTargetingValuesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of CustomTargetingValues. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `CustomTargetingValues` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `CustomTargetingValues` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous + * `ListCustomTargetingValues` call. Provide this to retrieve the subsequent + * page. + * When paginating, all other parameters provided to + * `ListCustomTargetingValues` must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of CustomTargetingValues. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * Please see {@see CustomTargetingValueServiceClient::customTargetingKeyName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListCustomTargetingValuesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of CustomTargetingValues. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * @type int $page_size + * Optional. The maximum number of `CustomTargetingValues` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `CustomTargetingValues` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * @type string $page_token + * Optional. A page token, received from a previous + * `ListCustomTargetingValues` call. Provide this to retrieve the subsequent + * page. + * When paginating, all other parameters provided to + * `ListCustomTargetingValues` must match the call that provided the page + * token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingValueService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of CustomTargetingValues. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of CustomTargetingValues. + * Format: + * `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `CustomTargetingValues` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `CustomTargetingValues` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `CustomTargetingValues` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `CustomTargetingValues` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous + * `ListCustomTargetingValues` call. Provide this to retrieve the subsequent + * page. + * When paginating, all other parameters provided to + * `ListCustomTargetingValues` must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous + * `ListCustomTargetingValues` call. Provide this to retrieve the subsequent + * page. + * When paginating, all other parameters provided to + * `ListCustomTargetingValues` must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListCustomTargetingValuesResponse.php b/AdsAdManager/src/V1/ListCustomTargetingValuesResponse.php new file mode 100644 index 000000000000..e1711c0af28f --- /dev/null +++ b/AdsAdManager/src/V1/ListCustomTargetingValuesResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListCustomTargetingValuesResponse + */ +class ListCustomTargetingValuesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `CustomTargetingValue` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomTargetingValue custom_targeting_values = 1; + */ + private $custom_targeting_values; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `CustomTargetingValue` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\CustomTargetingValue>|\Google\Protobuf\Internal\RepeatedField $custom_targeting_values + * The `CustomTargetingValue` objects from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `CustomTargetingValue` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\CustomTargetingValueService::initOnce(); + parent::__construct($data); + } + + /** + * The `CustomTargetingValue` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomTargetingValue custom_targeting_values = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCustomTargetingValues() + { + return $this->custom_targeting_values; + } + + /** + * The `CustomTargetingValue` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomTargetingValue custom_targeting_values = 1; + * @param array<\Google\Ads\AdManager\V1\CustomTargetingValue>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCustomTargetingValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\CustomTargetingValue::class); + $this->custom_targeting_values = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `CustomTargetingValue` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `CustomTargetingValue` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListEntitySignalsMappingsRequest.php b/AdsAdManager/src/V1/ListEntitySignalsMappingsRequest.php new file mode 100644 index 000000000000..a4a2945b87fe --- /dev/null +++ b/AdsAdManager/src/V1/ListEntitySignalsMappingsRequest.php @@ -0,0 +1,304 @@ +google.ads.admanager.v1.ListEntitySignalsMappingsRequest + */ +class ListEntitySignalsMappingsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of EntitySignalsMappings. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `EntitySignalsMappings` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `EntitySignalsMappings` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous + * `ListEntitySignalsMappings` call. Provide this to retrieve the subsequent + * page. + * When paginating, all other parameters provided to + * `ListEntitySignalsMappings` must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of EntitySignalsMappings. + * Format: `networks/{network_code}` + * Please see {@see EntitySignalsMappingServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListEntitySignalsMappingsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of EntitySignalsMappings. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `EntitySignalsMappings` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `EntitySignalsMappings` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * @type string $page_token + * Optional. A page token, received from a previous + * `ListEntitySignalsMappings` call. Provide this to retrieve the subsequent + * page. + * When paginating, all other parameters provided to + * `ListEntitySignalsMappings` must match the call that provided the page + * token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of EntitySignalsMappings. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of EntitySignalsMappings. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `EntitySignalsMappings` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `EntitySignalsMappings` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `EntitySignalsMappings` to return. The + * service may return fewer than this value. If unspecified, at most 50 + * `EntitySignalsMappings` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous + * `ListEntitySignalsMappings` call. Provide this to retrieve the subsequent + * page. + * When paginating, all other parameters provided to + * `ListEntitySignalsMappings` must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous + * `ListEntitySignalsMappings` call. Provide this to retrieve the subsequent + * page. + * When paginating, all other parameters provided to + * `ListEntitySignalsMappings` must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListEntitySignalsMappingsResponse.php b/AdsAdManager/src/V1/ListEntitySignalsMappingsResponse.php new file mode 100644 index 000000000000..9cd5bb39eea0 --- /dev/null +++ b/AdsAdManager/src/V1/ListEntitySignalsMappingsResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListEntitySignalsMappingsResponse + */ +class ListEntitySignalsMappingsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `EntitySignalsMapping` from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + */ + private $entity_signals_mappings; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `EntitySignalsMappings`. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\EntitySignalsMapping>|\Google\Protobuf\Internal\RepeatedField $entity_signals_mappings + * The `EntitySignalsMapping` from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `EntitySignalsMappings`. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * The `EntitySignalsMapping` from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEntitySignalsMappings() + { + return $this->entity_signals_mappings; + } + + /** + * The `EntitySignalsMapping` from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mappings = 1; + * @param array<\Google\Ads\AdManager\V1\EntitySignalsMapping>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEntitySignalsMappings($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\EntitySignalsMapping::class); + $this->entity_signals_mappings = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `EntitySignalsMappings`. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `EntitySignalsMappings`. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListNetworksRequest.php b/AdsAdManager/src/V1/ListNetworksRequest.php new file mode 100644 index 000000000000..533cdfe2486e --- /dev/null +++ b/AdsAdManager/src/V1/ListNetworksRequest.php @@ -0,0 +1,33 @@ +google.ads.admanager.v1.ListNetworksRequest + */ +class ListNetworksRequest extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\NetworkService::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/ListNetworksResponse.php b/AdsAdManager/src/V1/ListNetworksResponse.php new file mode 100644 index 000000000000..0e19406e6bf5 --- /dev/null +++ b/AdsAdManager/src/V1/ListNetworksResponse.php @@ -0,0 +1,67 @@ +google.ads.admanager.v1.ListNetworksResponse + */ +class ListNetworksResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `Network`s a user has access to. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Network networks = 1; + */ + private $networks; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Network>|\Google\Protobuf\Internal\RepeatedField $networks + * The `Network`s a user has access to. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\NetworkService::initOnce(); + parent::__construct($data); + } + + /** + * The `Network`s a user has access to. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Network networks = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getNetworks() + { + return $this->networks; + } + + /** + * The `Network`s a user has access to. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Network networks = 1; + * @param array<\Google\Ads\AdManager\V1\Network>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setNetworks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Network::class); + $this->networks = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListOrdersRequest.php b/AdsAdManager/src/V1/ListOrdersRequest.php new file mode 100644 index 000000000000..3aad5cd01b81 --- /dev/null +++ b/AdsAdManager/src/V1/ListOrdersRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListOrdersRequest + */ +class ListOrdersRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of Orders. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `Orders` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Orders` will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListOrders` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListOrders` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of Orders. + * Format: `networks/{network_code}` + * Please see {@see OrderServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListOrdersRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of Orders. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `Orders` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Orders` will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListOrders` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListOrders` must match + * the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\OrderService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of Orders. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of Orders. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `Orders` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Orders` will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `Orders` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Orders` will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListOrders` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListOrders` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListOrders` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListOrders` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListOrdersResponse.php b/AdsAdManager/src/V1/ListOrdersResponse.php new file mode 100644 index 000000000000..d8f3a73eeeee --- /dev/null +++ b/AdsAdManager/src/V1/ListOrdersResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListOrdersResponse + */ +class ListOrdersResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `Order` from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Order orders = 1; + */ + private $orders; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `Orders`. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Order>|\Google\Protobuf\Internal\RepeatedField $orders + * The `Order` from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `Orders`. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\OrderService::initOnce(); + parent::__construct($data); + } + + /** + * The `Order` from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Order orders = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getOrders() + { + return $this->orders; + } + + /** + * The `Order` from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Order orders = 1; + * @param array<\Google\Ads\AdManager\V1\Order>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setOrders($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Order::class); + $this->orders = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `Orders`. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `Orders`. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListPlacementsRequest.php b/AdsAdManager/src/V1/ListPlacementsRequest.php new file mode 100644 index 000000000000..0c728e44c3de --- /dev/null +++ b/AdsAdManager/src/V1/ListPlacementsRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListPlacementsRequest + */ +class ListPlacementsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of Placements. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `Placements` to return. The service may + * return fewer than this value. If unspecified, at most 50 `Placements` will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListPlacements` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListPlacements` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of Placements. + * Format: `networks/{network_code}` + * Please see {@see PlacementServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListPlacementsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of Placements. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `Placements` to return. The service may + * return fewer than this value. If unspecified, at most 50 `Placements` will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListPlacements` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListPlacements` must + * match the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\PlacementService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of Placements. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of Placements. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `Placements` to return. The service may + * return fewer than this value. If unspecified, at most 50 `Placements` will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `Placements` to return. The service may + * return fewer than this value. If unspecified, at most 50 `Placements` will + * be returned. The maximum value is 1000; values above 1000 will be coerced + * to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListPlacements` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListPlacements` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListPlacements` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListPlacements` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListPlacementsResponse.php b/AdsAdManager/src/V1/ListPlacementsResponse.php new file mode 100644 index 000000000000..0d509198484e --- /dev/null +++ b/AdsAdManager/src/V1/ListPlacementsResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListPlacementsResponse + */ +class ListPlacementsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `Placement` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Placement placements = 1; + */ + private $placements; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `Placement` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Placement>|\Google\Protobuf\Internal\RepeatedField $placements + * The `Placement` objects from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `Placement` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\PlacementService::initOnce(); + parent::__construct($data); + } + + /** + * The `Placement` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Placement placements = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPlacements() + { + return $this->placements; + } + + /** + * The `Placement` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Placement placements = 1; + * @param array<\Google\Ads\AdManager\V1\Placement>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPlacements($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Placement::class); + $this->placements = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `Placement` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `Placement` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListReportsRequest.php b/AdsAdManager/src/V1/ListReportsRequest.php new file mode 100644 index 000000000000..4f9ef229c9d0 --- /dev/null +++ b/AdsAdManager/src/V1/ListReportsRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListReportsRequest + */ +class ListReportsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of reports. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `Reports` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Reports` will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListReports` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListReports` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of reports. + * Format: `networks/{network_code}` + * Please see {@see ReportServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListReportsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of reports. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `Reports` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Reports` will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListReports` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListReports` must + * match the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of reports. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of reports. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `Reports` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Reports` will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `Reports` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Reports` will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListReports` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListReports` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListReports` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListReports` must + * match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListReportsResponse.php b/AdsAdManager/src/V1/ListReportsResponse.php new file mode 100644 index 000000000000..7acc7238699f --- /dev/null +++ b/AdsAdManager/src/V1/ListReportsResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListReportsResponse + */ +class ListReportsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `Report` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report reports = 1; + */ + private $reports; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `Report` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Report>|\Google\Protobuf\Internal\RepeatedField $reports + * The `Report` objects from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `Report` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * The `Report` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report reports = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getReports() + { + return $this->reports; + } + + /** + * The `Report` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report reports = 1; + * @param array<\Google\Ads\AdManager\V1\Report>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setReports($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report::class); + $this->reports = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `Report` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `Report` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListRolesRequest.php b/AdsAdManager/src/V1/ListRolesRequest.php new file mode 100644 index 000000000000..ae086b8ea872 --- /dev/null +++ b/AdsAdManager/src/V1/ListRolesRequest.php @@ -0,0 +1,292 @@ +google.ads.admanager.v1.ListRolesRequest + */ +class ListRolesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of Roles. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `Roles` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Roles` will be returned. + * The maximum value is 1000; values above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListRoles` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListRoles` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of Roles. + * Format: `networks/{network_code}` + * Please see {@see RoleServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListRolesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of Roles. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `Roles` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Roles` will be returned. + * The maximum value is 1000; values above 1000 will be coerced to 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListRoles` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListRoles` must match + * the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\RoleService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of Roles. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of Roles. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `Roles` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Roles` will be returned. + * The maximum value is 1000; values above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `Roles` to return. The service may return + * fewer than this value. If unspecified, at most 50 `Roles` will be returned. + * The maximum value is 1000; values above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListRoles` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListRoles` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListRoles` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListRoles` must match + * the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListRolesResponse.php b/AdsAdManager/src/V1/ListRolesResponse.php new file mode 100644 index 000000000000..6eb4ef45ab2c --- /dev/null +++ b/AdsAdManager/src/V1/ListRolesResponse.php @@ -0,0 +1,171 @@ +google.ads.admanager.v1.ListRolesResponse + */ +class ListRolesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `Role` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Role roles = 1; + */ + private $roles; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `Role` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Role>|\Google\Protobuf\Internal\RepeatedField $roles + * The `Role` objects from the specified network. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `Role` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\RoleService::initOnce(); + parent::__construct($data); + } + + /** + * The `Role` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Role roles = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRoles() + { + return $this->roles; + } + + /** + * The `Role` objects from the specified network. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Role roles = 1; + * @param array<\Google\Ads\AdManager\V1\Role>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRoles($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Role::class); + $this->roles = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `Role` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `Role` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListTaxonomyCategoriesRequest.php b/AdsAdManager/src/V1/ListTaxonomyCategoriesRequest.php new file mode 100644 index 000000000000..fcbb1bb1167d --- /dev/null +++ b/AdsAdManager/src/V1/ListTaxonomyCategoriesRequest.php @@ -0,0 +1,296 @@ +google.ads.admanager.v1.ListTaxonomyCategoriesRequest + */ +class ListTaxonomyCategoriesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent, which owns this collection of TaxonomyCategories. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of `TaxonomyCategories` to return. The service + * may return fewer than this value. If unspecified, at most 50 + * `TaxonomyCategories` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. A page token, received from a previous `ListTaxonomyCategories` + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListTaxonomyCategories` + * must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $skip = 0; + + /** + * @param string $parent Required. The parent, which owns this collection of TaxonomyCategories. + * Format: `networks/{network_code}` + * Please see {@see TaxonomyCategoryServiceClient::networkName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\ListTaxonomyCategoriesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent, which owns this collection of TaxonomyCategories. + * Format: `networks/{network_code}` + * @type int $page_size + * Optional. The maximum number of `TaxonomyCategories` to return. The service + * may return fewer than this value. If unspecified, at most 50 + * `TaxonomyCategories` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * @type string $page_token + * Optional. A page token, received from a previous `ListTaxonomyCategories` + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListTaxonomyCategories` + * must match the call that provided the page token. + * @type string $filter + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * @type string $order_by + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * @type int $skip + * Optional. Number of individual resources to skip while paginating. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\TaxonomyCategoryService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent, which owns this collection of TaxonomyCategories. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent, which owns this collection of TaxonomyCategories. + * Format: `networks/{network_code}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of `TaxonomyCategories` to return. The service + * may return fewer than this value. If unspecified, at most 50 + * `TaxonomyCategories` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of `TaxonomyCategories` to return. The service + * may return fewer than this value. If unspecified, at most 50 + * `TaxonomyCategories` will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. A page token, received from a previous `ListTaxonomyCategories` + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListTaxonomyCategories` + * must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. A page token, received from a previous `ListTaxonomyCategories` + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to `ListTaxonomyCategories` + * must match the call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Expression to filter the response. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. Expression to specify sorting order. + * See syntax details at + * https://developers.google.com/ad-manager/api/beta/filters#order + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getSkip() + { + return $this->skip; + } + + /** + * Optional. Number of individual resources to skip while paginating. + * + * Generated from protobuf field int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setSkip($var) + { + GPBUtil::checkInt32($var); + $this->skip = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ListTaxonomyCategoriesResponse.php b/AdsAdManager/src/V1/ListTaxonomyCategoriesResponse.php new file mode 100644 index 000000000000..66c311184902 --- /dev/null +++ b/AdsAdManager/src/V1/ListTaxonomyCategoriesResponse.php @@ -0,0 +1,172 @@ +google.ads.admanager.v1.ListTaxonomyCategoriesResponse + */ +class ListTaxonomyCategoriesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The `TaxonomyCategory` objects. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.TaxonomyCategory taxonomy_categories = 1; + */ + private $taxonomy_categories; + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Total number of `TaxonomyCategory` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + */ + protected $total_size = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\TaxonomyCategory>|\Google\Protobuf\Internal\RepeatedField $taxonomy_categories + * The `TaxonomyCategory` objects. + * @type string $next_page_token + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * @type int $total_size + * Total number of `TaxonomyCategory` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\TaxonomyCategoryService::initOnce(); + parent::__construct($data); + } + + /** + * The `TaxonomyCategory` objects. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.TaxonomyCategory taxonomy_categories = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTaxonomyCategories() + { + return $this->taxonomy_categories; + } + + /** + * The `TaxonomyCategory` objects. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.TaxonomyCategory taxonomy_categories = 1; + * @param array<\Google\Ads\AdManager\V1\TaxonomyCategory>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTaxonomyCategories($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\TaxonomyCategory::class); + $this->taxonomy_categories = $arr; + + return $this; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token, which can be sent as `page_token` to retrieve the next page. + * If this field is omitted, there are no subsequent pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Total number of `TaxonomyCategory` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @return int + */ + public function getTotalSize() + { + return $this->total_size; + } + + /** + * Total number of `TaxonomyCategory` objects. + * If a filter was included in the request, this reflects the total number + * after the filtering is applied. + * `total_size` will not be calculated in the response unless it has been + * included in a response field mask. The response field mask can be provided + * to the method by using the URL parameter `$fields` or `fields`, or by using + * the HTTP/gRPC header `X-Goog-FieldMask`. + * For more information, see + * https://developers.google.com/ad-manager/api/beta/field-masks + * + * Generated from protobuf field int32 total_size = 3; + * @param int $var + * @return $this + */ + public function setTotalSize($var) + { + GPBUtil::checkInt32($var); + $this->total_size = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/Network.php b/AdsAdManager/src/V1/Network.php new file mode 100644 index 000000000000..b4bb7bf928fe --- /dev/null +++ b/AdsAdManager/src/V1/Network.php @@ -0,0 +1,393 @@ +google.ads.admanager.v1.Network + */ +class Network extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the Network. + * Format: networks/{network_code} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Optional. Display name for Network. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Output only. Network Code. + * + * Generated from protobuf field string network_code = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $network_code = ''; + /** + * Output only. Property code. + * + * Generated from protobuf field string property_code = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $property_code = ''; + /** + * Output only. Time zone associated with the delivery of orders and + * reporting. + * + * Generated from protobuf field string time_zone = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $time_zone = ''; + /** + * Output only. Primary currency code, in ISO-4217 format. + * + * Generated from protobuf field string currency_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $currency_code = ''; + /** + * Optional. Currency codes that can be used as an alternative to the primary + * currency code for trafficking Line Items. + * + * Generated from protobuf field repeated string secondary_currency_codes = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $secondary_currency_codes; + /** + * Output only. Top most [Ad Unit](google.ads.admanager.v1.AdUnit) to which + * descendant Ad Units can be added. + * Format: networks/{network_code}/adUnit/{ad_unit_id} + * + * Generated from protobuf field string effective_root_ad_unit = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + */ + protected $effective_root_ad_unit = ''; + /** + * Output only. Whether this is a test network. + * + * Generated from protobuf field bool test_network = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $test_network = false; + /** + * Output only. Network ID. + * + * Generated from protobuf field int64 network_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $network_id = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the Network. + * Format: networks/{network_code} + * @type string $display_name + * Optional. Display name for Network. + * @type string $network_code + * Output only. Network Code. + * @type string $property_code + * Output only. Property code. + * @type string $time_zone + * Output only. Time zone associated with the delivery of orders and + * reporting. + * @type string $currency_code + * Output only. Primary currency code, in ISO-4217 format. + * @type array|\Google\Protobuf\Internal\RepeatedField $secondary_currency_codes + * Optional. Currency codes that can be used as an alternative to the primary + * currency code for trafficking Line Items. + * @type string $effective_root_ad_unit + * Output only. Top most [Ad Unit](google.ads.admanager.v1.AdUnit) to which + * descendant Ad Units can be added. + * Format: networks/{network_code}/adUnit/{ad_unit_id} + * @type bool $test_network + * Output only. Whether this is a test network. + * @type int|string $network_id + * Output only. Network ID. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\NetworkMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the Network. + * Format: networks/{network_code} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the Network. + * Format: networks/{network_code} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. Display name for Network. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Display name for Network. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Output only. Network Code. + * + * Generated from protobuf field string network_code = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getNetworkCode() + { + return $this->network_code; + } + + /** + * Output only. Network Code. + * + * Generated from protobuf field string network_code = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setNetworkCode($var) + { + GPBUtil::checkString($var, True); + $this->network_code = $var; + + return $this; + } + + /** + * Output only. Property code. + * + * Generated from protobuf field string property_code = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getPropertyCode() + { + return $this->property_code; + } + + /** + * Output only. Property code. + * + * Generated from protobuf field string property_code = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setPropertyCode($var) + { + GPBUtil::checkString($var, True); + $this->property_code = $var; + + return $this; + } + + /** + * Output only. Time zone associated with the delivery of orders and + * reporting. + * + * Generated from protobuf field string time_zone = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getTimeZone() + { + return $this->time_zone; + } + + /** + * Output only. Time zone associated with the delivery of orders and + * reporting. + * + * Generated from protobuf field string time_zone = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setTimeZone($var) + { + GPBUtil::checkString($var, True); + $this->time_zone = $var; + + return $this; + } + + /** + * Output only. Primary currency code, in ISO-4217 format. + * + * Generated from protobuf field string currency_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getCurrencyCode() + { + return $this->currency_code; + } + + /** + * Output only. Primary currency code, in ISO-4217 format. + * + * Generated from protobuf field string currency_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setCurrencyCode($var) + { + GPBUtil::checkString($var, True); + $this->currency_code = $var; + + return $this; + } + + /** + * Optional. Currency codes that can be used as an alternative to the primary + * currency code for trafficking Line Items. + * + * Generated from protobuf field repeated string secondary_currency_codes = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSecondaryCurrencyCodes() + { + return $this->secondary_currency_codes; + } + + /** + * Optional. Currency codes that can be used as an alternative to the primary + * currency code for trafficking Line Items. + * + * Generated from protobuf field repeated string secondary_currency_codes = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSecondaryCurrencyCodes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->secondary_currency_codes = $arr; + + return $this; + } + + /** + * Output only. Top most [Ad Unit](google.ads.admanager.v1.AdUnit) to which + * descendant Ad Units can be added. + * Format: networks/{network_code}/adUnit/{ad_unit_id} + * + * Generated from protobuf field string effective_root_ad_unit = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @return string + */ + public function getEffectiveRootAdUnit() + { + return $this->effective_root_ad_unit; + } + + /** + * Output only. Top most [Ad Unit](google.ads.admanager.v1.AdUnit) to which + * descendant Ad Units can be added. + * Format: networks/{network_code}/adUnit/{ad_unit_id} + * + * Generated from protobuf field string effective_root_ad_unit = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setEffectiveRootAdUnit($var) + { + GPBUtil::checkString($var, True); + $this->effective_root_ad_unit = $var; + + return $this; + } + + /** + * Output only. Whether this is a test network. + * + * Generated from protobuf field bool test_network = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getTestNetwork() + { + return $this->test_network; + } + + /** + * Output only. Whether this is a test network. + * + * Generated from protobuf field bool test_network = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setTestNetwork($var) + { + GPBUtil::checkBool($var); + $this->test_network = $var; + + return $this; + } + + /** + * Output only. Network ID. + * + * Generated from protobuf field int64 network_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getNetworkId() + { + return $this->network_id; + } + + /** + * Output only. Network ID. + * + * Generated from protobuf field int64 network_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setNetworkId($var) + { + GPBUtil::checkInt64($var); + $this->network_id = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/Order.php b/AdsAdManager/src/V1/Order.php new file mode 100644 index 000000000000..e6925980903c --- /dev/null +++ b/AdsAdManager/src/V1/Order.php @@ -0,0 +1,1169 @@ +google.ads.admanager.v1.Order + */ +class Order extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `Order`. + * Format: `networks/{network_code}/orders/{order_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. Order ID. + * + * Generated from protobuf field int64 order_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $order_id = 0; + /** + * Required. The display name of the Order. This value has a maximum length + * of 255 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $display_name = ''; + /** + * Optional. Specifies whether or not the Order is a programmatic order. + * + * Generated from protobuf field bool programmatic = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $programmatic = false; + /** + * Required. The resource name of the User responsible for trafficking the + * Order. Format: "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string trafficker = 23 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $trafficker = ''; + /** + * Optional. The resource names of Contacts from the advertiser of this Order. + * Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $advertiser_contacts; + /** + * Required. The resource name of the Company, which is of type + * Company.Type.ADVERTISER, to which this order belongs. Format: + * "networks/{network_code}/companies/{company_id}" + * + * Generated from protobuf field string advertiser = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $advertiser = ''; + /** + * Optional. The resource names of Contacts from the advertising Agency of + * this Order. Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $agency_contacts; + /** + * Optional. The resource name of the Company, which is of type + * Company.Type.AGENCY, with which this order is associated. Format: + * "networks/{network_code}/companies/{company_id}" + * + * Generated from protobuf field string agency = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $agency = ''; + /** + * Optional. The resource names of Teams directly applied to this Order. + * Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $applied_teams; + /** + * Output only. The resource names of Teams applied to this Order including + * inherited values. Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + */ + private $effective_teams; + /** + * Output only. The resource name of the User who created the Order on behalf + * of the advertiser. This value is assigned by Google. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + */ + protected $creator = ''; + /** + * Output only. The ISO 4217 3-letter currency code for the currency used by + * the Order. This value is the network's currency code. + * + * Generated from protobuf field string currency_code = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $currency_code = ''; + /** + * Output only. The instant at which the Order and its associated line items + * are eligible to begin serving. This attribute is derived from the line item + * of the order that has the earliest LineItem.start_time. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $start_time = null; + /** + * Output only. The instant at which the Order and its associated line items + * stop being served. This attribute is derived from the line item of the + * order that has the latest LineItem.end_time. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $end_time = null; + /** + * Output only. Indicates whether or not this Order has an end time. + * + * Generated from protobuf field bool unlimited_end_time = 45 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $unlimited_end_time = false; + /** + * Optional. An arbitrary ID to associate to the Order, which can be used as a + * key to an external system. + * + * Generated from protobuf field int64 external_order_id = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $external_order_id = 0; + /** + * Output only. The archival status of the Order. + * + * Generated from protobuf field bool archived = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $archived = false; + /** + * Output only. The application which modified this order. This attribute is + * assigned by Google. + * + * Generated from protobuf field string last_modified_by_app = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $last_modified_by_app = ''; + /** + * Output only. The instant this Order was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. Provides any additional notes that may annotate the Order. This + * attribute has a maximum length of 65,535 characters. + * + * Generated from protobuf field string notes = 17 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $notes = ''; + /** + * Optional. The purchase order number for the Order. This value has a maximum + * length of 63 characters. + * + * Generated from protobuf field string po_number = 18 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $po_number = ''; + /** + * Output only. The status of the Order. + * + * Generated from protobuf field .google.ads.admanager.v1.OrderStatusEnum.OrderStatus status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = 0; + /** + * Optional. The resource name of the User responsible for the sales of the + * Order. Format: "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string salesperson = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $salesperson = ''; + /** + * Optional. Unordered list. The resource names of the secondary salespeople + * associated with the order. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { + */ + private $secondary_salespeople; + /** + * Optional. Unordered list. The resource names of the secondary traffickers + * associated with the order. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { + */ + private $secondary_traffickers; + /** + * Optional. The set of labels applied directly to this order. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $applied_labels; + /** + * Output only. Contains the set of labels applied directly to the order as + * well as those inherited from the company that owns the order. If a label + * has been negated, only the negated label is returned. This field is + * assigned by Google. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $effective_applied_labels; + /** + * Optional. The set of custom field values to this order. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $custom_field_values; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `Order`. + * Format: `networks/{network_code}/orders/{order_id}` + * @type int|string $order_id + * Output only. Order ID. + * @type string $display_name + * Required. The display name of the Order. This value has a maximum length + * of 255 characters. + * @type bool $programmatic + * Optional. Specifies whether or not the Order is a programmatic order. + * @type string $trafficker + * Required. The resource name of the User responsible for trafficking the + * Order. Format: "networks/{network_code}/users/{user_id}" + * @type array|\Google\Protobuf\Internal\RepeatedField $advertiser_contacts + * Optional. The resource names of Contacts from the advertiser of this Order. + * Format: "networks/{network_code}/contacts/{contact_id}" + * @type string $advertiser + * Required. The resource name of the Company, which is of type + * Company.Type.ADVERTISER, to which this order belongs. Format: + * "networks/{network_code}/companies/{company_id}" + * @type array|\Google\Protobuf\Internal\RepeatedField $agency_contacts + * Optional. The resource names of Contacts from the advertising Agency of + * this Order. Format: "networks/{network_code}/contacts/{contact_id}" + * @type string $agency + * Optional. The resource name of the Company, which is of type + * Company.Type.AGENCY, with which this order is associated. Format: + * "networks/{network_code}/companies/{company_id}" + * @type array|\Google\Protobuf\Internal\RepeatedField $applied_teams + * Optional. The resource names of Teams directly applied to this Order. + * Format: "networks/{network_code}/teams/{team_id}" + * @type array|\Google\Protobuf\Internal\RepeatedField $effective_teams + * Output only. The resource names of Teams applied to this Order including + * inherited values. Format: "networks/{network_code}/teams/{team_id}" + * @type string $creator + * Output only. The resource name of the User who created the Order on behalf + * of the advertiser. This value is assigned by Google. Format: + * "networks/{network_code}/users/{user_id}" + * @type string $currency_code + * Output only. The ISO 4217 3-letter currency code for the currency used by + * the Order. This value is the network's currency code. + * @type \Google\Protobuf\Timestamp $start_time + * Output only. The instant at which the Order and its associated line items + * are eligible to begin serving. This attribute is derived from the line item + * of the order that has the earliest LineItem.start_time. + * @type \Google\Protobuf\Timestamp $end_time + * Output only. The instant at which the Order and its associated line items + * stop being served. This attribute is derived from the line item of the + * order that has the latest LineItem.end_time. + * @type bool $unlimited_end_time + * Output only. Indicates whether or not this Order has an end time. + * @type int|string $external_order_id + * Optional. An arbitrary ID to associate to the Order, which can be used as a + * key to an external system. + * @type bool $archived + * Output only. The archival status of the Order. + * @type string $last_modified_by_app + * Output only. The application which modified this order. This attribute is + * assigned by Google. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The instant this Order was last modified. + * @type string $notes + * Optional. Provides any additional notes that may annotate the Order. This + * attribute has a maximum length of 65,535 characters. + * @type string $po_number + * Optional. The purchase order number for the Order. This value has a maximum + * length of 63 characters. + * @type int $status + * Output only. The status of the Order. + * @type string $salesperson + * Optional. The resource name of the User responsible for the sales of the + * Order. Format: "networks/{network_code}/users/{user_id}" + * @type array|\Google\Protobuf\Internal\RepeatedField $secondary_salespeople + * Optional. Unordered list. The resource names of the secondary salespeople + * associated with the order. Format: + * "networks/{network_code}/users/{user_id}" + * @type array|\Google\Protobuf\Internal\RepeatedField $secondary_traffickers + * Optional. Unordered list. The resource names of the secondary traffickers + * associated with the order. Format: + * "networks/{network_code}/users/{user_id}" + * @type array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $applied_labels + * Optional. The set of labels applied directly to this order. + * @type array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $effective_applied_labels + * Output only. Contains the set of labels applied directly to the order as + * well as those inherited from the company that owns the order. If a label + * has been negated, only the negated label is returned. This field is + * assigned by Google. + * @type array<\Google\Ads\AdManager\V1\CustomFieldValue>|\Google\Protobuf\Internal\RepeatedField $custom_field_values + * Optional. The set of custom field values to this order. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\OrderMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `Order`. + * Format: `networks/{network_code}/orders/{order_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `Order`. + * Format: `networks/{network_code}/orders/{order_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. Order ID. + * + * Generated from protobuf field int64 order_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getOrderId() + { + return $this->order_id; + } + + /** + * Output only. Order ID. + * + * Generated from protobuf field int64 order_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setOrderId($var) + { + GPBUtil::checkInt64($var); + $this->order_id = $var; + + return $this; + } + + /** + * Required. The display name of the Order. This value has a maximum length + * of 255 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Required. The display name of the Order. This value has a maximum length + * of 255 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Optional. Specifies whether or not the Order is a programmatic order. + * + * Generated from protobuf field bool programmatic = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getProgrammatic() + { + return $this->programmatic; + } + + /** + * Optional. Specifies whether or not the Order is a programmatic order. + * + * Generated from protobuf field bool programmatic = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setProgrammatic($var) + { + GPBUtil::checkBool($var); + $this->programmatic = $var; + + return $this; + } + + /** + * Required. The resource name of the User responsible for trafficking the + * Order. Format: "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string trafficker = 23 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getTrafficker() + { + return $this->trafficker; + } + + /** + * Required. The resource name of the User responsible for trafficking the + * Order. Format: "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string trafficker = 23 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setTrafficker($var) + { + GPBUtil::checkString($var, True); + $this->trafficker = $var; + + return $this; + } + + /** + * Optional. The resource names of Contacts from the advertiser of this Order. + * Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAdvertiserContacts() + { + return $this->advertiser_contacts; + } + + /** + * Optional. The resource names of Contacts from the advertiser of this Order. + * Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAdvertiserContacts($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->advertiser_contacts = $arr; + + return $this; + } + + /** + * Required. The resource name of the Company, which is of type + * Company.Type.ADVERTISER, to which this order belongs. Format: + * "networks/{network_code}/companies/{company_id}" + * + * Generated from protobuf field string advertiser = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getAdvertiser() + { + return $this->advertiser; + } + + /** + * Required. The resource name of the Company, which is of type + * Company.Type.ADVERTISER, to which this order belongs. Format: + * "networks/{network_code}/companies/{company_id}" + * + * Generated from protobuf field string advertiser = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setAdvertiser($var) + { + GPBUtil::checkString($var, True); + $this->advertiser = $var; + + return $this; + } + + /** + * Optional. The resource names of Contacts from the advertising Agency of + * this Order. Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAgencyContacts() + { + return $this->agency_contacts; + } + + /** + * Optional. The resource names of Contacts from the advertising Agency of + * this Order. Format: "networks/{network_code}/contacts/{contact_id}" + * + * Generated from protobuf field repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAgencyContacts($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->agency_contacts = $arr; + + return $this; + } + + /** + * Optional. The resource name of the Company, which is of type + * Company.Type.AGENCY, with which this order is associated. Format: + * "networks/{network_code}/companies/{company_id}" + * + * Generated from protobuf field string agency = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getAgency() + { + return $this->agency; + } + + /** + * Optional. The resource name of the Company, which is of type + * Company.Type.AGENCY, with which this order is associated. Format: + * "networks/{network_code}/companies/{company_id}" + * + * Generated from protobuf field string agency = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setAgency($var) + { + GPBUtil::checkString($var, True); + $this->agency = $var; + + return $this; + } + + /** + * Optional. The resource names of Teams directly applied to this Order. + * Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAppliedTeams() + { + return $this->applied_teams; + } + + /** + * Optional. The resource names of Teams directly applied to this Order. + * Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAppliedTeams($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->applied_teams = $arr; + + return $this; + } + + /** + * Output only. The resource names of Teams applied to this Order including + * inherited values. Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEffectiveTeams() + { + return $this->effective_teams; + } + + /** + * Output only. The resource names of Teams applied to this Order including + * inherited values. Format: "networks/{network_code}/teams/{team_id}" + * + * Generated from protobuf field repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEffectiveTeams($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->effective_teams = $arr; + + return $this; + } + + /** + * Output only. The resource name of the User who created the Order on behalf + * of the advertiser. This value is assigned by Google. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @return string + */ + public function getCreator() + { + return $this->creator; + } + + /** + * Output only. The resource name of the User who created the Order on behalf + * of the advertiser. This value is assigned by Google. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setCreator($var) + { + GPBUtil::checkString($var, True); + $this->creator = $var; + + return $this; + } + + /** + * Output only. The ISO 4217 3-letter currency code for the currency used by + * the Order. This value is the network's currency code. + * + * Generated from protobuf field string currency_code = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getCurrencyCode() + { + return $this->currency_code; + } + + /** + * Output only. The ISO 4217 3-letter currency code for the currency used by + * the Order. This value is the network's currency code. + * + * Generated from protobuf field string currency_code = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setCurrencyCode($var) + { + GPBUtil::checkString($var, True); + $this->currency_code = $var; + + return $this; + } + + /** + * Output only. The instant at which the Order and its associated line items + * are eligible to begin serving. This attribute is derived from the line item + * of the order that has the earliest LineItem.start_time. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getStartTime() + { + return $this->start_time; + } + + public function hasStartTime() + { + return isset($this->start_time); + } + + public function clearStartTime() + { + unset($this->start_time); + } + + /** + * Output only. The instant at which the Order and its associated line items + * are eligible to begin serving. This attribute is derived from the line item + * of the order that has the earliest LineItem.start_time. + * + * Generated from protobuf field .google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setStartTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->start_time = $var; + + return $this; + } + + /** + * Output only. The instant at which the Order and its associated line items + * stop being served. This attribute is derived from the line item of the + * order that has the latest LineItem.end_time. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getEndTime() + { + return $this->end_time; + } + + public function hasEndTime() + { + return isset($this->end_time); + } + + public function clearEndTime() + { + unset($this->end_time); + } + + /** + * Output only. The instant at which the Order and its associated line items + * stop being served. This attribute is derived from the line item of the + * order that has the latest LineItem.end_time. + * + * Generated from protobuf field .google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setEndTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->end_time = $var; + + return $this; + } + + /** + * Output only. Indicates whether or not this Order has an end time. + * + * Generated from protobuf field bool unlimited_end_time = 45 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getUnlimitedEndTime() + { + return $this->unlimited_end_time; + } + + /** + * Output only. Indicates whether or not this Order has an end time. + * + * Generated from protobuf field bool unlimited_end_time = 45 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setUnlimitedEndTime($var) + { + GPBUtil::checkBool($var); + $this->unlimited_end_time = $var; + + return $this; + } + + /** + * Optional. An arbitrary ID to associate to the Order, which can be used as a + * key to an external system. + * + * Generated from protobuf field int64 external_order_id = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return int|string + */ + public function getExternalOrderId() + { + return $this->external_order_id; + } + + /** + * Optional. An arbitrary ID to associate to the Order, which can be used as a + * key to an external system. + * + * Generated from protobuf field int64 external_order_id = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param int|string $var + * @return $this + */ + public function setExternalOrderId($var) + { + GPBUtil::checkInt64($var); + $this->external_order_id = $var; + + return $this; + } + + /** + * Output only. The archival status of the Order. + * + * Generated from protobuf field bool archived = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getArchived() + { + return $this->archived; + } + + /** + * Output only. The archival status of the Order. + * + * Generated from protobuf field bool archived = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setArchived($var) + { + GPBUtil::checkBool($var); + $this->archived = $var; + + return $this; + } + + /** + * Output only. The application which modified this order. This attribute is + * assigned by Google. + * + * Generated from protobuf field string last_modified_by_app = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getLastModifiedByApp() + { + return $this->last_modified_by_app; + } + + /** + * Output only. The application which modified this order. This attribute is + * assigned by Google. + * + * Generated from protobuf field string last_modified_by_app = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setLastModifiedByApp($var) + { + GPBUtil::checkString($var, True); + $this->last_modified_by_app = $var; + + return $this; + } + + /** + * Output only. The instant this Order was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The instant this Order was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. Provides any additional notes that may annotate the Order. This + * attribute has a maximum length of 65,535 characters. + * + * Generated from protobuf field string notes = 17 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getNotes() + { + return $this->notes; + } + + /** + * Optional. Provides any additional notes that may annotate the Order. This + * attribute has a maximum length of 65,535 characters. + * + * Generated from protobuf field string notes = 17 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setNotes($var) + { + GPBUtil::checkString($var, True); + $this->notes = $var; + + return $this; + } + + /** + * Optional. The purchase order number for the Order. This value has a maximum + * length of 63 characters. + * + * Generated from protobuf field string po_number = 18 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPoNumber() + { + return $this->po_number; + } + + /** + * Optional. The purchase order number for the Order. This value has a maximum + * length of 63 characters. + * + * Generated from protobuf field string po_number = 18 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPoNumber($var) + { + GPBUtil::checkString($var, True); + $this->po_number = $var; + + return $this; + } + + /** + * Output only. The status of the Order. + * + * Generated from protobuf field .google.ads.admanager.v1.OrderStatusEnum.OrderStatus status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getStatus() + { + return $this->status; + } + + /** + * Output only. The status of the Order. + * + * Generated from protobuf field .google.ads.admanager.v1.OrderStatusEnum.OrderStatus status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\OrderStatusEnum\OrderStatus::class); + $this->status = $var; + + return $this; + } + + /** + * Optional. The resource name of the User responsible for the sales of the + * Order. Format: "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string salesperson = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getSalesperson() + { + return $this->salesperson; + } + + /** + * Optional. The resource name of the User responsible for the sales of the + * Order. Format: "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field string salesperson = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setSalesperson($var) + { + GPBUtil::checkString($var, True); + $this->salesperson = $var; + + return $this; + } + + /** + * Optional. Unordered list. The resource names of the secondary salespeople + * associated with the order. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSecondarySalespeople() + { + return $this->secondary_salespeople; + } + + /** + * Optional. Unordered list. The resource names of the secondary salespeople + * associated with the order. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSecondarySalespeople($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->secondary_salespeople = $arr; + + return $this; + } + + /** + * Optional. Unordered list. The resource names of the secondary traffickers + * associated with the order. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSecondaryTraffickers() + { + return $this->secondary_traffickers; + } + + /** + * Optional. Unordered list. The resource names of the secondary traffickers + * associated with the order. Format: + * "networks/{network_code}/users/{user_id}" + * + * Generated from protobuf field repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSecondaryTraffickers($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->secondary_traffickers = $arr; + + return $this; + } + + /** + * Optional. The set of labels applied directly to this order. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAppliedLabels() + { + return $this->applied_labels; + } + + /** + * Optional. The set of labels applied directly to this order. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAppliedLabels($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AppliedLabel::class); + $this->applied_labels = $arr; + + return $this; + } + + /** + * Output only. Contains the set of labels applied directly to the order as + * well as those inherited from the company that owns the order. If a label + * has been negated, only the negated label is returned. This field is + * assigned by Google. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEffectiveAppliedLabels() + { + return $this->effective_applied_labels; + } + + /** + * Output only. Contains the set of labels applied directly to the order as + * well as those inherited from the company that owns the order. If a label + * has been negated, only the negated label is returned. This field is + * assigned by Google. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array<\Google\Ads\AdManager\V1\AppliedLabel>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEffectiveAppliedLabels($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\AppliedLabel::class); + $this->effective_applied_labels = $arr; + + return $this; + } + + /** + * Optional. The set of custom field values to this order. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCustomFieldValues() + { + return $this->custom_field_values; + } + + /** + * Optional. The set of custom field values to this order. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\CustomFieldValue>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCustomFieldValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\CustomFieldValue::class); + $this->custom_field_values = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/OrderStatusEnum.php b/AdsAdManager/src/V1/OrderStatusEnum.php new file mode 100644 index 000000000000..4ba75691537a --- /dev/null +++ b/AdsAdManager/src/V1/OrderStatusEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.OrderStatusEnum + */ +class OrderStatusEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\OrderEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/OrderStatusEnum/OrderStatus.php b/AdsAdManager/src/V1/OrderStatusEnum/OrderStatus.php new file mode 100644 index 000000000000..fa1c3dbeca5f --- /dev/null +++ b/AdsAdManager/src/V1/OrderStatusEnum/OrderStatus.php @@ -0,0 +1,100 @@ +google.ads.admanager.v1.OrderStatusEnum.OrderStatus + */ +class OrderStatus +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum ORDER_STATUS_UNSPECIFIED = 0; + */ + const ORDER_STATUS_UNSPECIFIED = 0; + /** + * Indicates that the Order has just been created but no approval has been + * requested yet. + * + * Generated from protobuf enum DRAFT = 2; + */ + const DRAFT = 2; + /** + * Indicates that a request for approval for the Order has been made. + * + * Generated from protobuf enum PENDING_APPROVAL = 3; + */ + const PENDING_APPROVAL = 3; + /** + * Indicates that the Order has been approved and is ready to serve. + * + * Generated from protobuf enum APPROVED = 4; + */ + const APPROVED = 4; + /** + * Indicates that the Order has been disapproved and is not eligible to + * serve. + * + * Generated from protobuf enum DISAPPROVED = 5; + */ + const DISAPPROVED = 5; + /** + * This is a legacy state. Paused status should be checked on LineItems + * within the order. + * + * Generated from protobuf enum PAUSED = 6; + */ + const PAUSED = 6; + /** + * Indicates that the Order has been canceled and cannot serve. + * + * Generated from protobuf enum CANCELED = 7; + */ + const CANCELED = 7; + /** + * Indicates that the Order has been deleted. + * + * Generated from protobuf enum DELETED = 8; + */ + const DELETED = 8; + + private static $valueToName = [ + self::ORDER_STATUS_UNSPECIFIED => 'ORDER_STATUS_UNSPECIFIED', + self::DRAFT => 'DRAFT', + self::PENDING_APPROVAL => 'PENDING_APPROVAL', + self::APPROVED => 'APPROVED', + self::DISAPPROVED => 'DISAPPROVED', + self::PAUSED => 'PAUSED', + self::CANCELED => 'CANCELED', + self::DELETED => 'DELETED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Placement.php b/AdsAdManager/src/V1/Placement.php new file mode 100644 index 000000000000..fe7d0b835a1b --- /dev/null +++ b/AdsAdManager/src/V1/Placement.php @@ -0,0 +1,339 @@ +google.ads.admanager.v1.Placement + */ +class Placement extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `Placement`. + * Format: `networks/{network_code}/placements/{placement_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. `Placement` ID. + * + * Generated from protobuf field int64 placement_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $placement_id = 0; + /** + * Required. The display name of the placement. Its maximum length is 255 + * characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $display_name = ''; + /** + * Optional. A description of the Placement. This value is optional and its + * maximum length is 65,535 characters. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $description = ''; + /** + * Output only. A string used to uniquely identify the Placement for purposes + * of serving the ad. This attribute is read-only and is assigned by Google + * when a placement is created. + * + * Generated from protobuf field string placement_code = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $placement_code = ''; + /** + * Output only. The status of the Placement. This attribute is read-only. + * + * Generated from protobuf field .google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = 0; + /** + * Optional. The resource names of AdUnits that constitute the Placement. + * Format: "networks/{network_code}/adUnits/{ad_unit_id}" + * + * Generated from protobuf field repeated string targeted_ad_units = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $targeted_ad_units; + /** + * Output only. The instant this Placement was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `Placement`. + * Format: `networks/{network_code}/placements/{placement_id}` + * @type int|string $placement_id + * Output only. `Placement` ID. + * @type string $display_name + * Required. The display name of the placement. Its maximum length is 255 + * characters. + * @type string $description + * Optional. A description of the Placement. This value is optional and its + * maximum length is 65,535 characters. + * @type string $placement_code + * Output only. A string used to uniquely identify the Placement for purposes + * of serving the ad. This attribute is read-only and is assigned by Google + * when a placement is created. + * @type int $status + * Output only. The status of the Placement. This attribute is read-only. + * @type array|\Google\Protobuf\Internal\RepeatedField $targeted_ad_units + * Optional. The resource names of AdUnits that constitute the Placement. + * Format: "networks/{network_code}/adUnits/{ad_unit_id}" + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The instant this Placement was last modified. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\PlacementMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `Placement`. + * Format: `networks/{network_code}/placements/{placement_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `Placement`. + * Format: `networks/{network_code}/placements/{placement_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. `Placement` ID. + * + * Generated from protobuf field int64 placement_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getPlacementId() + { + return $this->placement_id; + } + + /** + * Output only. `Placement` ID. + * + * Generated from protobuf field int64 placement_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setPlacementId($var) + { + GPBUtil::checkInt64($var); + $this->placement_id = $var; + + return $this; + } + + /** + * Required. The display name of the placement. Its maximum length is 255 + * characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Required. The display name of the placement. Its maximum length is 255 + * characters. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Optional. A description of the Placement. This value is optional and its + * maximum length is 65,535 characters. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDescription() + { + return $this->description; + } + + /** + * Optional. A description of the Placement. This value is optional and its + * maximum length is 65,535 characters. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Output only. A string used to uniquely identify the Placement for purposes + * of serving the ad. This attribute is read-only and is assigned by Google + * when a placement is created. + * + * Generated from protobuf field string placement_code = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getPlacementCode() + { + return $this->placement_code; + } + + /** + * Output only. A string used to uniquely identify the Placement for purposes + * of serving the ad. This attribute is read-only and is assigned by Google + * when a placement is created. + * + * Generated from protobuf field string placement_code = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setPlacementCode($var) + { + GPBUtil::checkString($var, True); + $this->placement_code = $var; + + return $this; + } + + /** + * Output only. The status of the Placement. This attribute is read-only. + * + * Generated from protobuf field .google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getStatus() + { + return $this->status; + } + + /** + * Output only. The status of the Placement. This attribute is read-only. + * + * Generated from protobuf field .google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\PlacementStatusEnum\PlacementStatus::class); + $this->status = $var; + + return $this; + } + + /** + * Optional. The resource names of AdUnits that constitute the Placement. + * Format: "networks/{network_code}/adUnits/{ad_unit_id}" + * + * Generated from protobuf field repeated string targeted_ad_units = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTargetedAdUnits() + { + return $this->targeted_ad_units; + } + + /** + * Optional. The resource names of AdUnits that constitute the Placement. + * Format: "networks/{network_code}/adUnits/{ad_unit_id}" + * + * Generated from protobuf field repeated string targeted_ad_units = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTargetedAdUnits($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->targeted_ad_units = $arr; + + return $this; + } + + /** + * Output only. The instant this Placement was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The instant this Placement was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/PlacementStatusEnum.php b/AdsAdManager/src/V1/PlacementStatusEnum.php new file mode 100644 index 000000000000..08bc6de84382 --- /dev/null +++ b/AdsAdManager/src/V1/PlacementStatusEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.PlacementStatusEnum + */ +class PlacementStatusEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\PlacementEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/PlacementStatusEnum/PlacementStatus.php b/AdsAdManager/src/V1/PlacementStatusEnum/PlacementStatus.php new file mode 100644 index 000000000000..2d158e2c81e5 --- /dev/null +++ b/AdsAdManager/src/V1/PlacementStatusEnum/PlacementStatus.php @@ -0,0 +1,69 @@ +google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus + */ +class PlacementStatus +{ + /** + * Not specified value. + * + * Generated from protobuf enum PLACEMENT_STATUS_UNSPECIFIED = 0; + */ + const PLACEMENT_STATUS_UNSPECIFIED = 0; + /** + * Stats are collected, user-visible. + * + * Generated from protobuf enum ACTIVE = 1; + */ + const ACTIVE = 1; + /** + * No stats collected, not user-visible. + * + * Generated from protobuf enum INACTIVE = 2; + */ + const INACTIVE = 2; + /** + * No stats collected, user-visible. + * + * Generated from protobuf enum ARCHIVED = 3; + */ + const ARCHIVED = 3; + + private static $valueToName = [ + self::PLACEMENT_STATUS_UNSPECIFIED => 'PLACEMENT_STATUS_UNSPECIFIED', + self::ACTIVE => 'ACTIVE', + self::INACTIVE => 'INACTIVE', + self::ARCHIVED => 'ARCHIVED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Report.php b/AdsAdManager/src/V1/Report.php new file mode 100644 index 000000000000..b8cd8e12c83b --- /dev/null +++ b/AdsAdManager/src/V1/Report.php @@ -0,0 +1,391 @@ +google.ads.admanager.v1.Report + */ +class Report extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the report. + * Report resource name have the form: + * `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. Report ID. + * + * Generated from protobuf field int64 report_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $report_id = 0; + /** + * Optional. The visibility of a report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Visibility visibility = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $visibility = 0; + /** + * Required. The report definition of the report. + * + * Generated from protobuf field .google.ads.admanager.v1.ReportDefinition report_definition = 4 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $report_definition = null; + /** + * Optional. Display name for the report. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Output only. The instant this report was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Output only. The instant this report was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The locale of this report. Locale is set from the user's + * locale at the time of the request. Locale can not be modified. + * + * Generated from protobuf field string locale = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $locale = ''; + /** + * Optional. The schedule options of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.ScheduleOptions schedule_options = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $schedule_options = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the report. + * Report resource name have the form: + * `networks/{network_code}/reports/{report_id}` + * @type int|string $report_id + * Output only. Report ID. + * @type int $visibility + * Optional. The visibility of a report. + * @type \Google\Ads\AdManager\V1\ReportDefinition $report_definition + * Required. The report definition of the report. + * @type string $display_name + * Optional. Display name for the report. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The instant this report was last modified. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The instant this report was created. + * @type string $locale + * Output only. The locale of this report. Locale is set from the user's + * locale at the time of the request. Locale can not be modified. + * @type \Google\Ads\AdManager\V1\ScheduleOptions $schedule_options + * Optional. The schedule options of this report. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the report. + * Report resource name have the form: + * `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the report. + * Report resource name have the form: + * `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. Report ID. + * + * Generated from protobuf field int64 report_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getReportId() + { + return $this->report_id; + } + + /** + * Output only. Report ID. + * + * Generated from protobuf field int64 report_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setReportId($var) + { + GPBUtil::checkInt64($var); + $this->report_id = $var; + + return $this; + } + + /** + * Optional. The visibility of a report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Visibility visibility = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getVisibility() + { + return $this->visibility; + } + + /** + * Optional. The visibility of a report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Visibility visibility = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setVisibility($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\Visibility::class); + $this->visibility = $var; + + return $this; + } + + /** + * Required. The report definition of the report. + * + * Generated from protobuf field .google.ads.admanager.v1.ReportDefinition report_definition = 4 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\ReportDefinition|null + */ + public function getReportDefinition() + { + return $this->report_definition; + } + + public function hasReportDefinition() + { + return isset($this->report_definition); + } + + public function clearReportDefinition() + { + unset($this->report_definition); + } + + /** + * Required. The report definition of the report. + * + * Generated from protobuf field .google.ads.admanager.v1.ReportDefinition report_definition = 4 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\ReportDefinition $var + * @return $this + */ + public function setReportDefinition($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\ReportDefinition::class); + $this->report_definition = $var; + + return $this; + } + + /** + * Optional. Display name for the report. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Display name for the report. + * + * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Output only. The instant this report was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The instant this report was last modified. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Output only. The instant this report was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The instant this report was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The locale of this report. Locale is set from the user's + * locale at the time of the request. Locale can not be modified. + * + * Generated from protobuf field string locale = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getLocale() + { + return $this->locale; + } + + /** + * Output only. The locale of this report. Locale is set from the user's + * locale at the time of the request. Locale can not be modified. + * + * Generated from protobuf field string locale = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setLocale($var) + { + GPBUtil::checkString($var, True); + $this->locale = $var; + + return $this; + } + + /** + * Optional. The schedule options of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.ScheduleOptions schedule_options = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Ads\AdManager\V1\ScheduleOptions|null + */ + public function getScheduleOptions() + { + return $this->schedule_options; + } + + public function hasScheduleOptions() + { + return isset($this->schedule_options); + } + + public function clearScheduleOptions() + { + unset($this->schedule_options); + } + + /** + * Optional. The schedule options of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.ScheduleOptions schedule_options = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Ads\AdManager\V1\ScheduleOptions $var + * @return $this + */ + public function setScheduleOptions($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\ScheduleOptions::class); + $this->schedule_options = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/Report/DataTable.php b/AdsAdManager/src/V1/Report/DataTable.php new file mode 100644 index 000000000000..753d6b5fecc3 --- /dev/null +++ b/AdsAdManager/src/V1/Report/DataTable.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.Report.DataTable + */ +class DataTable extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + +} + + diff --git a/AdsAdManager/src/V1/Report/DataTable/MetricValueGroup.php b/AdsAdManager/src/V1/Report/DataTable/MetricValueGroup.php new file mode 100644 index 000000000000..2188d6ab1d43 --- /dev/null +++ b/AdsAdManager/src/V1/Report/DataTable/MetricValueGroup.php @@ -0,0 +1,287 @@ +google.ads.admanager.v1.Report.DataTable.MetricValueGroup + */ +class MetricValueGroup extends \Google\Protobuf\Internal\Message +{ + /** + * Data for the PRIMARY MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value primary_values = 1; + */ + private $primary_values; + /** + * Data for the PRIMARY_PERCENT_OF_TOTAL MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value primary_percent_of_total_values = 2; + */ + private $primary_percent_of_total_values; + /** + * Data for the COMPARISON MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value comparison_values = 3; + */ + private $comparison_values; + /** + * Data for the COMPARISON_PERCENT_OF_TOTAL MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value comparison_percent_of_total_values = 4; + */ + private $comparison_percent_of_total_values; + /** + * Data for the ABSOLUTE_CHANGE MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value absolute_change_values = 5; + */ + private $absolute_change_values; + /** + * Data for the RELATIVE_CHANGE MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value relative_change_values = 6; + */ + private $relative_change_values; + /** + * If true, the flag's conditions are met. If false, the flag's + * conditions are not met. flag_values has the same length as + * flags and index i of flag_values represents the flag at index i + * of flags. + * + * Generated from protobuf field repeated bool flag_values = 7; + */ + private $flag_values; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $primary_values + * Data for the PRIMARY MetricValueType. + * @type array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $primary_percent_of_total_values + * Data for the PRIMARY_PERCENT_OF_TOTAL MetricValueType. + * @type array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $comparison_values + * Data for the COMPARISON MetricValueType. + * @type array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $comparison_percent_of_total_values + * Data for the COMPARISON_PERCENT_OF_TOTAL MetricValueType. + * @type array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $absolute_change_values + * Data for the ABSOLUTE_CHANGE MetricValueType. + * @type array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $relative_change_values + * Data for the RELATIVE_CHANGE MetricValueType. + * @type array|\Google\Protobuf\Internal\RepeatedField $flag_values + * If true, the flag's conditions are met. If false, the flag's + * conditions are not met. flag_values has the same length as + * flags and index i of flag_values represents the flag at index i + * of flags. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Data for the PRIMARY MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value primary_values = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPrimaryValues() + { + return $this->primary_values; + } + + /** + * Data for the PRIMARY MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value primary_values = 1; + * @param array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPrimaryValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Value::class); + $this->primary_values = $arr; + + return $this; + } + + /** + * Data for the PRIMARY_PERCENT_OF_TOTAL MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value primary_percent_of_total_values = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPrimaryPercentOfTotalValues() + { + return $this->primary_percent_of_total_values; + } + + /** + * Data for the PRIMARY_PERCENT_OF_TOTAL MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value primary_percent_of_total_values = 2; + * @param array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPrimaryPercentOfTotalValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Value::class); + $this->primary_percent_of_total_values = $arr; + + return $this; + } + + /** + * Data for the COMPARISON MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value comparison_values = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getComparisonValues() + { + return $this->comparison_values; + } + + /** + * Data for the COMPARISON MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value comparison_values = 3; + * @param array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setComparisonValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Value::class); + $this->comparison_values = $arr; + + return $this; + } + + /** + * Data for the COMPARISON_PERCENT_OF_TOTAL MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value comparison_percent_of_total_values = 4; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getComparisonPercentOfTotalValues() + { + return $this->comparison_percent_of_total_values; + } + + /** + * Data for the COMPARISON_PERCENT_OF_TOTAL MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value comparison_percent_of_total_values = 4; + * @param array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setComparisonPercentOfTotalValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Value::class); + $this->comparison_percent_of_total_values = $arr; + + return $this; + } + + /** + * Data for the ABSOLUTE_CHANGE MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value absolute_change_values = 5; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAbsoluteChangeValues() + { + return $this->absolute_change_values; + } + + /** + * Data for the ABSOLUTE_CHANGE MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value absolute_change_values = 5; + * @param array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAbsoluteChangeValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Value::class); + $this->absolute_change_values = $arr; + + return $this; + } + + /** + * Data for the RELATIVE_CHANGE MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value relative_change_values = 6; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRelativeChangeValues() + { + return $this->relative_change_values; + } + + /** + * Data for the RELATIVE_CHANGE MetricValueType. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value relative_change_values = 6; + * @param array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRelativeChangeValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Value::class); + $this->relative_change_values = $arr; + + return $this; + } + + /** + * If true, the flag's conditions are met. If false, the flag's + * conditions are not met. flag_values has the same length as + * flags and index i of flag_values represents the flag at index i + * of flags. + * + * Generated from protobuf field repeated bool flag_values = 7; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getFlagValues() + { + return $this->flag_values; + } + + /** + * If true, the flag's conditions are met. If false, the flag's + * conditions are not met. flag_values has the same length as + * flags and index i of flag_values represents the flag at index i + * of flags. + * + * Generated from protobuf field repeated bool flag_values = 7; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setFlagValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::BOOL); + $this->flag_values = $arr; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/DataTable/Row.php b/AdsAdManager/src/V1/Report/DataTable/Row.php new file mode 100644 index 000000000000..1894770a3f50 --- /dev/null +++ b/AdsAdManager/src/V1/Report/DataTable/Row.php @@ -0,0 +1,134 @@ +google.ads.admanager.v1.Report.DataTable.Row + */ +class Row extends \Google\Protobuf\Internal\Message +{ + /** + * The order of the dimension values is the same as the order of the + * dimensions specified in the request. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value dimension_values = 1; + */ + private $dimension_values; + /** + * The length of the metric_value_groups + * field will be equal to the length of the date_ranges field in the + * fetch response. The metric_value_groups field is + * ordered such that each index corresponds to the date_range at the same + * index. For example, given date_ranges [x, y], metric_value_groups will + * have a length of two. The first entry in metric_value_groups represents + * the metrics for date x and the second entry in metric_value_groups + * represents the metrics for date y. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DataTable.MetricValueGroup metric_value_groups = 2; + */ + private $metric_value_groups; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $dimension_values + * The order of the dimension values is the same as the order of the + * dimensions specified in the request. + * @type array<\Google\Ads\AdManager\V1\Report\DataTable\MetricValueGroup>|\Google\Protobuf\Internal\RepeatedField $metric_value_groups + * The length of the metric_value_groups + * field will be equal to the length of the date_ranges field in the + * fetch response. The metric_value_groups field is + * ordered such that each index corresponds to the date_range at the same + * index. For example, given date_ranges [x, y], metric_value_groups will + * have a length of two. The first entry in metric_value_groups represents + * the metrics for date x and the second entry in metric_value_groups + * represents the metrics for date y. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * The order of the dimension values is the same as the order of the + * dimensions specified in the request. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value dimension_values = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDimensionValues() + { + return $this->dimension_values; + } + + /** + * The order of the dimension values is the same as the order of the + * dimensions specified in the request. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value dimension_values = 1; + * @param array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDimensionValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Value::class); + $this->dimension_values = $arr; + + return $this; + } + + /** + * The length of the metric_value_groups + * field will be equal to the length of the date_ranges field in the + * fetch response. The metric_value_groups field is + * ordered such that each index corresponds to the date_range at the same + * index. For example, given date_ranges [x, y], metric_value_groups will + * have a length of two. The first entry in metric_value_groups represents + * the metrics for date x and the second entry in metric_value_groups + * represents the metrics for date y. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DataTable.MetricValueGroup metric_value_groups = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMetricValueGroups() + { + return $this->metric_value_groups; + } + + /** + * The length of the metric_value_groups + * field will be equal to the length of the date_ranges field in the + * fetch response. The metric_value_groups field is + * ordered such that each index corresponds to the date_range at the same + * index. For example, given date_ranges [x, y], metric_value_groups will + * have a length of two. The first entry in metric_value_groups represents + * the metrics for date x and the second entry in metric_value_groups + * represents the metrics for date y. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.DataTable.MetricValueGroup metric_value_groups = 2; + * @param array<\Google\Ads\AdManager\V1\Report\DataTable\MetricValueGroup>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMetricValueGroups($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\DataTable\MetricValueGroup::class); + $this->metric_value_groups = $arr; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/DateRange.php b/AdsAdManager/src/V1/Report/DateRange.php new file mode 100644 index 000000000000..87e60b4346a9 --- /dev/null +++ b/AdsAdManager/src/V1/Report/DateRange.php @@ -0,0 +1,109 @@ +google.ads.admanager.v1.Report.DateRange + */ +class DateRange extends \Google\Protobuf\Internal\Message +{ + protected $date_range_type; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange $fixed + * A fixed date range. + * @type int $relative + * A relative date range. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * A fixed date range. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.DateRange.FixedDateRange fixed = 1; + * @return \Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange|null + */ + public function getFixed() + { + return $this->readOneof(1); + } + + public function hasFixed() + { + return $this->hasOneof(1); + } + + /** + * A fixed date range. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.DateRange.FixedDateRange fixed = 1; + * @param \Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange $var + * @return $this + */ + public function setFixed($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\DateRange\FixedDateRange::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * A relative date range. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.DateRange.RelativeDateRange relative = 2; + * @return int + */ + public function getRelative() + { + return $this->readOneof(2); + } + + public function hasRelative() + { + return $this->hasOneof(2); + } + + /** + * A relative date range. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.DateRange.RelativeDateRange relative = 2; + * @param int $var + * @return $this + */ + public function setRelative($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\DateRange\RelativeDateRange::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * @return string + */ + public function getDateRangeType() + { + return $this->whichOneof("date_range_type"); + } + +} + + diff --git a/AdsAdManager/src/V1/Report/DateRange/FixedDateRange.php b/AdsAdManager/src/V1/Report/DateRange/FixedDateRange.php new file mode 100644 index 000000000000..9cdfe0f4ab53 --- /dev/null +++ b/AdsAdManager/src/V1/Report/DateRange/FixedDateRange.php @@ -0,0 +1,122 @@ +google.ads.admanager.v1.Report.DateRange.FixedDateRange + */ +class FixedDateRange extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The start date of this date range. + * + * Generated from protobuf field .google.type.Date start_date = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $start_date = null; + /** + * Required. The end date (inclusive) of this date range. + * + * Generated from protobuf field .google.type.Date end_date = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $end_date = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Type\Date $start_date + * Required. The start date of this date range. + * @type \Google\Type\Date $end_date + * Required. The end date (inclusive) of this date range. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The start date of this date range. + * + * Generated from protobuf field .google.type.Date start_date = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Type\Date|null + */ + public function getStartDate() + { + return $this->start_date; + } + + public function hasStartDate() + { + return isset($this->start_date); + } + + public function clearStartDate() + { + unset($this->start_date); + } + + /** + * Required. The start date of this date range. + * + * Generated from protobuf field .google.type.Date start_date = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Type\Date $var + * @return $this + */ + public function setStartDate($var) + { + GPBUtil::checkMessage($var, \Google\Type\Date::class); + $this->start_date = $var; + + return $this; + } + + /** + * Required. The end date (inclusive) of this date range. + * + * Generated from protobuf field .google.type.Date end_date = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Type\Date|null + */ + public function getEndDate() + { + return $this->end_date; + } + + public function hasEndDate() + { + return isset($this->end_date); + } + + public function clearEndDate() + { + unset($this->end_date); + } + + /** + * Required. The end date (inclusive) of this date range. + * + * Generated from protobuf field .google.type.Date end_date = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Type\Date $var + * @return $this + */ + public function setEndDate($var) + { + GPBUtil::checkMessage($var, \Google\Type\Date::class); + $this->end_date = $var; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/DateRange/RelativeDateRange.php b/AdsAdManager/src/V1/Report/DateRange/RelativeDateRange.php new file mode 100644 index 000000000000..c896e0fd85c9 --- /dev/null +++ b/AdsAdManager/src/V1/Report/DateRange/RelativeDateRange.php @@ -0,0 +1,276 @@ +google.ads.admanager.v1.Report.DateRange.RelativeDateRange + */ +class RelativeDateRange +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum RELATIVE_DATE_RANGE_UNSPECIFIED = 0; + */ + const RELATIVE_DATE_RANGE_UNSPECIFIED = 0; + /** + * The date the report is run. + * + * Generated from protobuf enum TODAY = 1; + */ + const TODAY = 1; + /** + * The date a day before the date that the report is run. + * + * Generated from protobuf enum YESTERDAY = 2; + */ + const YESTERDAY = 2; + /** + * The full week in which this report is run. Could include dates in + * the future. + * + * Generated from protobuf enum THIS_WEEK = 3; + */ + const THIS_WEEK = 3; + /** + * From the beginning of the calendar week (Monday to Sunday) in which the + * up to and including the day the report is run. + * + * Generated from protobuf enum THIS_WEEK_TO_DATE = 29; + */ + const THIS_WEEK_TO_DATE = 29; + /** + * The full month in which this report is run. Could include dates in + * the future. + * + * Generated from protobuf enum THIS_MONTH = 4; + */ + const THIS_MONTH = 4; + /** + * From the beginning of the calendar month in which the report is run, to + * up to and including the day the report is run. + * + * Generated from protobuf enum THIS_MONTH_TO_DATE = 26; + */ + const THIS_MONTH_TO_DATE = 26; + /** + * The full quarter in which this report is run. Could include dates + * in the future. + * + * Generated from protobuf enum THIS_QUARTER = 5; + */ + const THIS_QUARTER = 5; + /** + * From the beginning of the calendar quarter in which the report is run, + * up to and including the day the report is run. + * + * Generated from protobuf enum THIS_QUARTER_TO_DATE = 27; + */ + const THIS_QUARTER_TO_DATE = 27; + /** + * The full year in which this report is run. Could include dates in + * the future. + * + * Generated from protobuf enum THIS_YEAR = 6; + */ + const THIS_YEAR = 6; + /** + * From the beginning of the calendar year in which the report is run, to + * up to and including the day the report is run. + * + * Generated from protobuf enum THIS_YEAR_TO_DATE = 28; + */ + const THIS_YEAR_TO_DATE = 28; + /** + * The entire previous calendar week, Monday to Sunday (inclusive), + * preceding the calendar week the report is run. + * + * Generated from protobuf enum LAST_WEEK = 7; + */ + const LAST_WEEK = 7; + /** + * The entire previous calendar month preceding the calendar month the + * report is run. + * + * Generated from protobuf enum LAST_MONTH = 8; + */ + const LAST_MONTH = 8; + /** + * The entire previous calendar quarter preceding the calendar quarter the + * report is run. + * + * Generated from protobuf enum LAST_QUARTER = 9; + */ + const LAST_QUARTER = 9; + /** + * The entire previous calendar year preceding the calendar year the + * report is run. + * + * Generated from protobuf enum LAST_YEAR = 10; + */ + const LAST_YEAR = 10; + /** + * The 7 days preceding the day the report is run. + * + * Generated from protobuf enum LAST_7_DAYS = 11; + */ + const LAST_7_DAYS = 11; + /** + * The 30 days preceding the day the report is run. + * + * Generated from protobuf enum LAST_30_DAYS = 12; + */ + const LAST_30_DAYS = 12; + /** + * The 60 days preceding the day the report is run. + * + * Generated from protobuf enum LAST_60_DAYS = 13; + */ + const LAST_60_DAYS = 13; + /** + * The 90 days preceding the day the report is run. + * + * Generated from protobuf enum LAST_90_DAYS = 14; + */ + const LAST_90_DAYS = 14; + /** + * The 180 days preceding the day the report is run. + * + * Generated from protobuf enum LAST_180_DAYS = 15; + */ + const LAST_180_DAYS = 15; + /** + * The 360 days preceding the day the report is run. + * + * Generated from protobuf enum LAST_360_DAYS = 16; + */ + const LAST_360_DAYS = 16; + /** + * The 365 days preceding the day the report is run. + * + * Generated from protobuf enum LAST_365_DAYS = 17; + */ + const LAST_365_DAYS = 17; + /** + * The entire previous 3 calendar months preceding the calendar month the + * report is run. + * + * Generated from protobuf enum LAST_3_MONTHS = 18; + */ + const LAST_3_MONTHS = 18; + /** + * The entire previous 6 calendar months preceding the calendar month the + * report is run. + * + * Generated from protobuf enum LAST_6_MONTHS = 19; + */ + const LAST_6_MONTHS = 19; + /** + * The entire previous 6 calendar months preceding the calendar month the + * report is run. + * + * Generated from protobuf enum LAST_12_MONTHS = 20; + */ + const LAST_12_MONTHS = 20; + /** + * From 3 years before the report is run, to the day before the report is + * run, inclusive. + * + * Generated from protobuf enum ALL_AVAILABLE = 21; + */ + const ALL_AVAILABLE = 21; + /** + * Only valid when used in the comparison_date_range field. The complete + * period preceding the date period provided in date_range. + * In the case where date_range is a FixedDateRange of N days, this will + * be a period of N days where the end date is the date preceding the + * start date of the date_range. + * In the case where date_range is a RelativeDateRange, this will be a + * period of the same time frame preceding the date_range. In the case + * where the date_range does not capture the full period because a report + * is run in the middle of that period, this will still be the full + * preceding period. For example, if date_range is THIS_WEEK, but the + * report is run on a Wednesday, THIS_WEEK will be Monday - Wednesday, but + * PREVIOUS_PERIOD will be Monday - Sunday. + * + * Generated from protobuf enum PREVIOUS_PERIOD = 22; + */ + const PREVIOUS_PERIOD = 22; + /** + * Only valid when used in the comparison_date_range field. The period + * starting 1 year prior to the date period provided in date_range. + * In the case where date_range is a FixedDateRange, this will be a date + * range starting 1 year prior to the date_range start date and ending 1 + * year prior to the date_range end date. + * In the case where date_range is a RelativeDateRange, this will be a + * period of the same time frame exactly 1 year prior to the date_range. + * In the case where the date_range does not capture the full period + * because a report is run in the middle of that period, this will still + * be the full period 1 year prior. For example, if date range is + * THIS_WEEK, but the report is run on a Wednesday, THIS_WEEK will be + * Monday - Wednesday, but SAME_PERIOD_PREVIOUS_YEAR will be Monday - + * Sunday. + * + * Generated from protobuf enum SAME_PERIOD_PREVIOUS_YEAR = 24; + */ + const SAME_PERIOD_PREVIOUS_YEAR = 24; + + private static $valueToName = [ + self::RELATIVE_DATE_RANGE_UNSPECIFIED => 'RELATIVE_DATE_RANGE_UNSPECIFIED', + self::TODAY => 'TODAY', + self::YESTERDAY => 'YESTERDAY', + self::THIS_WEEK => 'THIS_WEEK', + self::THIS_WEEK_TO_DATE => 'THIS_WEEK_TO_DATE', + self::THIS_MONTH => 'THIS_MONTH', + self::THIS_MONTH_TO_DATE => 'THIS_MONTH_TO_DATE', + self::THIS_QUARTER => 'THIS_QUARTER', + self::THIS_QUARTER_TO_DATE => 'THIS_QUARTER_TO_DATE', + self::THIS_YEAR => 'THIS_YEAR', + self::THIS_YEAR_TO_DATE => 'THIS_YEAR_TO_DATE', + self::LAST_WEEK => 'LAST_WEEK', + self::LAST_MONTH => 'LAST_MONTH', + self::LAST_QUARTER => 'LAST_QUARTER', + self::LAST_YEAR => 'LAST_YEAR', + self::LAST_7_DAYS => 'LAST_7_DAYS', + self::LAST_30_DAYS => 'LAST_30_DAYS', + self::LAST_60_DAYS => 'LAST_60_DAYS', + self::LAST_90_DAYS => 'LAST_90_DAYS', + self::LAST_180_DAYS => 'LAST_180_DAYS', + self::LAST_360_DAYS => 'LAST_360_DAYS', + self::LAST_365_DAYS => 'LAST_365_DAYS', + self::LAST_3_MONTHS => 'LAST_3_MONTHS', + self::LAST_6_MONTHS => 'LAST_6_MONTHS', + self::LAST_12_MONTHS => 'LAST_12_MONTHS', + self::ALL_AVAILABLE => 'ALL_AVAILABLE', + self::PREVIOUS_PERIOD => 'PREVIOUS_PERIOD', + self::SAME_PERIOD_PREVIOUS_YEAR => 'SAME_PERIOD_PREVIOUS_YEAR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Report/Dimension.php b/AdsAdManager/src/V1/Report/Dimension.php new file mode 100644 index 000000000000..c9d11ec8cb70 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Dimension.php @@ -0,0 +1,4169 @@ +google.ads.admanager.v1.Report.Dimension + */ +class Dimension +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum DIMENSION_UNSPECIFIED = 0; + */ + const DIMENSION_UNSPECIFIED = 0; + /** + * The domain name of the advertiser. + * + * Generated from protobuf enum ADVERTISER_DOMAIN_NAME = 242; + */ + const ADVERTISER_DOMAIN_NAME = 242; + /** + * The ID used in an external system for advertiser identification + * + * Generated from protobuf enum ADVERTISER_EXTERNAL_ID = 228; + */ + const ADVERTISER_EXTERNAL_ID = 228; + /** + * The ID of an advertiser company assigned to an order + * + * Generated from protobuf enum ADVERTISER_ID = 131; + */ + const ADVERTISER_ID = 131; + /** + * Labels applied to the advertiser + * can be used for either competitive exclusion or ad exclusion + * + * Generated from protobuf enum ADVERTISER_LABELS = 230; + */ + const ADVERTISER_LABELS = 230; + /** + * Label ids applied to the advertiser + * can be used for either competitive exclusion or ad exclusion + * + * Generated from protobuf enum ADVERTISER_LABEL_IDS = 229; + */ + const ADVERTISER_LABEL_IDS = 229; + /** + * The name of an advertiser company assigned to an order + * + * Generated from protobuf enum ADVERTISER_NAME = 132; + */ + const ADVERTISER_NAME = 132; + /** + * The name of the contact associated with an advertiser company + * + * Generated from protobuf enum ADVERTISER_PRIMARY_CONTACT = 227; + */ + const ADVERTISER_PRIMARY_CONTACT = 227; + /** + * Shows an ENUM value describing whether a given piece of publisher + * inventory was above (ATF) or below the fold (BTF) of a page. + * + * Generated from protobuf enum AD_LOCATION = 390; + */ + const AD_LOCATION = 390; + /** + * Shows a localized string describing whether a given piece of publisher + * inventory was above (ATF) or below the fold (BTF) of a page. + * + * Generated from protobuf enum AD_LOCATION_NAME = 391; + */ + const AD_LOCATION_NAME = 391; + /** + * The code of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_CODE = 64; + */ + const AD_UNIT_CODE = 64; + /** + * The code of the first level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_1 = 65; + */ + const AD_UNIT_CODE_LEVEL_1 = 65; + /** + * The code of the tenth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_10 = 74; + */ + const AD_UNIT_CODE_LEVEL_10 = 74; + /** + * The code of the eleventh level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_11 = 75; + */ + const AD_UNIT_CODE_LEVEL_11 = 75; + /** + * The code of the twelfth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_12 = 76; + */ + const AD_UNIT_CODE_LEVEL_12 = 76; + /** + * The code of the thirteenth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_13 = 77; + */ + const AD_UNIT_CODE_LEVEL_13 = 77; + /** + * The code of the fourteenth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_14 = 78; + */ + const AD_UNIT_CODE_LEVEL_14 = 78; + /** + * The code of the fifteenth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_15 = 79; + */ + const AD_UNIT_CODE_LEVEL_15 = 79; + /** + * The code of the sixteenth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_16 = 80; + */ + const AD_UNIT_CODE_LEVEL_16 = 80; + /** + * The code of the second level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_2 = 66; + */ + const AD_UNIT_CODE_LEVEL_2 = 66; + /** + * The code of the third level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_3 = 67; + */ + const AD_UNIT_CODE_LEVEL_3 = 67; + /** + * The code of the fourth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_4 = 68; + */ + const AD_UNIT_CODE_LEVEL_4 = 68; + /** + * The code of the fifth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_5 = 69; + */ + const AD_UNIT_CODE_LEVEL_5 = 69; + /** + * The code of the sixth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_6 = 70; + */ + const AD_UNIT_CODE_LEVEL_6 = 70; + /** + * The code of the seventh level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_7 = 71; + */ + const AD_UNIT_CODE_LEVEL_7 = 71; + /** + * The code of the eighth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_8 = 72; + */ + const AD_UNIT_CODE_LEVEL_8 = 72; + /** + * The code of the ninth level ad unit of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_CODE_LEVEL_9 = 73; + */ + const AD_UNIT_CODE_LEVEL_9 = 73; + /** + * The depth of the ad unit's hierarchy + * + * Generated from protobuf enum AD_UNIT_DEPTH = 101; + */ + const AD_UNIT_DEPTH = 101; + /** + * The ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID = 25; + */ + const AD_UNIT_ID = 25; + /** + * The full hierarchy of ad unit IDs where the ad was requested, from + * root to leaf, excluding the root ad unit ID. + * + * Generated from protobuf enum AD_UNIT_ID_ALL_LEVEL = 27; + */ + const AD_UNIT_ID_ALL_LEVEL = 27; + /** + * The first level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_1 = 30; + */ + const AD_UNIT_ID_LEVEL_1 = 30; + /** + * The tenth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_10 = 48; + */ + const AD_UNIT_ID_LEVEL_10 = 48; + /** + * The eleventh level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_11 = 50; + */ + const AD_UNIT_ID_LEVEL_11 = 50; + /** + * The twelfth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_12 = 52; + */ + const AD_UNIT_ID_LEVEL_12 = 52; + /** + * The thirteenth level ad unit ID of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_13 = 54; + */ + const AD_UNIT_ID_LEVEL_13 = 54; + /** + * The fourteenth level ad unit ID of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_14 = 56; + */ + const AD_UNIT_ID_LEVEL_14 = 56; + /** + * The fifteenth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_15 = 58; + */ + const AD_UNIT_ID_LEVEL_15 = 58; + /** + * The sixteenth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_16 = 60; + */ + const AD_UNIT_ID_LEVEL_16 = 60; + /** + * The second level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_2 = 32; + */ + const AD_UNIT_ID_LEVEL_2 = 32; + /** + * The third level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_3 = 34; + */ + const AD_UNIT_ID_LEVEL_3 = 34; + /** + * The fourth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_4 = 36; + */ + const AD_UNIT_ID_LEVEL_4 = 36; + /** + * The fifth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_5 = 38; + */ + const AD_UNIT_ID_LEVEL_5 = 38; + /** + * The sixth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_6 = 40; + */ + const AD_UNIT_ID_LEVEL_6 = 40; + /** + * The seventh level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_7 = 42; + */ + const AD_UNIT_ID_LEVEL_7 = 42; + /** + * The eighth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_8 = 44; + */ + const AD_UNIT_ID_LEVEL_8 = 44; + /** + * The ninth level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_LEVEL_9 = 46; + */ + const AD_UNIT_ID_LEVEL_9 = 46; + /** + * The top-level ad unit ID of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_ID_TOP_LEVEL = 142; + */ + const AD_UNIT_ID_TOP_LEVEL = 142; + /** + * The name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME = 26; + */ + const AD_UNIT_NAME = 26; + /** + * The full hierarchy of ad unit names where the ad was requested, from + * root to leaf, excluding the root ad unit name. + * + * Generated from protobuf enum AD_UNIT_NAME_ALL_LEVEL = 29; + */ + const AD_UNIT_NAME_ALL_LEVEL = 29; + /** + * The first level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_1 = 31; + */ + const AD_UNIT_NAME_LEVEL_1 = 31; + /** + * The tenth level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_10 = 49; + */ + const AD_UNIT_NAME_LEVEL_10 = 49; + /** + * The eleventh level ad unit name of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_11 = 51; + */ + const AD_UNIT_NAME_LEVEL_11 = 51; + /** + * The twelfth level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_12 = 53; + */ + const AD_UNIT_NAME_LEVEL_12 = 53; + /** + * The thirteenth level ad unit name of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_13 = 55; + */ + const AD_UNIT_NAME_LEVEL_13 = 55; + /** + * The fourteenth level ad unit name of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_14 = 57; + */ + const AD_UNIT_NAME_LEVEL_14 = 57; + /** + * The fifteenth level ad unit name of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_15 = 59; + */ + const AD_UNIT_NAME_LEVEL_15 = 59; + /** + * The sixteenth level ad unit name of the ad unit where the ad was + * requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_16 = 61; + */ + const AD_UNIT_NAME_LEVEL_16 = 61; + /** + * The second level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_2 = 33; + */ + const AD_UNIT_NAME_LEVEL_2 = 33; + /** + * The third level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_3 = 35; + */ + const AD_UNIT_NAME_LEVEL_3 = 35; + /** + * The fourth level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_4 = 37; + */ + const AD_UNIT_NAME_LEVEL_4 = 37; + /** + * The fifth level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_5 = 39; + */ + const AD_UNIT_NAME_LEVEL_5 = 39; + /** + * The sixth level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_6 = 41; + */ + const AD_UNIT_NAME_LEVEL_6 = 41; + /** + * The seventh level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_7 = 43; + */ + const AD_UNIT_NAME_LEVEL_7 = 43; + /** + * The eighth level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_8 = 45; + */ + const AD_UNIT_NAME_LEVEL_8 = 45; + /** + * The ninth level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_LEVEL_9 = 47; + */ + const AD_UNIT_NAME_LEVEL_9 = 47; + /** + * The top-level ad unit name of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_NAME_TOP_LEVEL = 143; + */ + const AD_UNIT_NAME_TOP_LEVEL = 143; + /** + * The reward amount of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_REWARD_AMOUNT = 63; + */ + const AD_UNIT_REWARD_AMOUNT = 63; + /** + * The reward type of the ad unit where the ad was requested. + * + * Generated from protobuf enum AD_UNIT_REWARD_TYPE = 62; + */ + const AD_UNIT_REWARD_TYPE = 62; + /** + * The status of the ad unit + * + * Generated from protobuf enum AD_UNIT_STATUS = 206; + */ + const AD_UNIT_STATUS = 206; + /** + * The name of the status of the ad unit + * + * Generated from protobuf enum AD_UNIT_STATUS_NAME = 207; + */ + const AD_UNIT_STATUS_NAME = 207; + /** + * The app version. + * + * Generated from protobuf enum APP_VERSION = 392; + */ + const APP_VERSION = 392; + /** + * The ID used in an external system for advertiser identification + * + * Generated from protobuf enum BACKFILL_ADVERTISER_EXTERNAL_ID = 349; + */ + const BACKFILL_ADVERTISER_EXTERNAL_ID = 349; + /** + * The ID of an advertiser company assigned to a backfill order + * + * Generated from protobuf enum BACKFILL_ADVERTISER_ID = 346; + */ + const BACKFILL_ADVERTISER_ID = 346; + /** + * Labels applied to the advertiser + * can be used for either competitive exclusion or ad exclusion + * + * Generated from protobuf enum BACKFILL_ADVERTISER_LABELS = 351; + */ + const BACKFILL_ADVERTISER_LABELS = 351; + /** + * Label ids applied to the advertiser + * can be used for either competitive exclusion or ad exclusion + * + * Generated from protobuf enum BACKFILL_ADVERTISER_LABEL_IDS = 350; + */ + const BACKFILL_ADVERTISER_LABEL_IDS = 350; + /** + * The name of an advertiser company assigned to a backfill order + * + * Generated from protobuf enum BACKFILL_ADVERTISER_NAME = 347; + */ + const BACKFILL_ADVERTISER_NAME = 347; + /** + * The name of the contact associated with an advertiser company + * + * Generated from protobuf enum BACKFILL_ADVERTISER_PRIMARY_CONTACT = 348; + */ + const BACKFILL_ADVERTISER_PRIMARY_CONTACT = 348; + /** + * Enum value of Backfill creative billing type + * + * Generated from protobuf enum BACKFILL_CREATIVE_BILLING_TYPE = 378; + */ + const BACKFILL_CREATIVE_BILLING_TYPE = 378; + /** + * Localized string value of Backfill creative billing type + * + * Generated from protobuf enum BACKFILL_CREATIVE_BILLING_TYPE_NAME = 379; + */ + const BACKFILL_CREATIVE_BILLING_TYPE_NAME = 379; + /** + * Represents the click-through URL of a Backfill creative + * + * Generated from protobuf enum BACKFILL_CREATIVE_CLICK_THROUGH_URL = 376; + */ + const BACKFILL_CREATIVE_CLICK_THROUGH_URL = 376; + /** + * The ID of a Backfill creative + * + * Generated from protobuf enum BACKFILL_CREATIVE_ID = 370; + */ + const BACKFILL_CREATIVE_ID = 370; + /** + * Backfill creative name + * + * Generated from protobuf enum BACKFILL_CREATIVE_NAME = 371; + */ + const BACKFILL_CREATIVE_NAME = 371; + /** + * Third party vendor name of a Backfill creative + * + * Generated from protobuf enum BACKFILL_CREATIVE_THIRD_PARTY_VENDOR = 377; + */ + const BACKFILL_CREATIVE_THIRD_PARTY_VENDOR = 377; + /** + * Enum value of Backfill creative type + * + * Generated from protobuf enum BACKFILL_CREATIVE_TYPE = 374; + */ + const BACKFILL_CREATIVE_TYPE = 374; + /** + * Localized string name of Backfill creative type + * + * Generated from protobuf enum BACKFILL_CREATIVE_TYPE_NAME = 375; + */ + const BACKFILL_CREATIVE_TYPE_NAME = 375; + /** + * Whether a Backfill line item is archived. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_ARCHIVED = 278; + */ + const BACKFILL_LINE_ITEM_ARCHIVED = 278; + /** + * Backfill line item comanion delivery option ENUM value. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION = 258; + */ + const BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION = 258; + /** + * Localized Backfill line item comanion delivery option name. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME = 259; + */ + const BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME = 259; + /** + * The computed status of the BackfillLineItem. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_COMPUTED_STATUS = 296; + */ + const BACKFILL_LINE_ITEM_COMPUTED_STATUS = 296; + /** + * The localized name of the computed status of the BackfillLineItem. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_COMPUTED_STATUS_NAME = 297; + */ + const BACKFILL_LINE_ITEM_COMPUTED_STATUS_NAME = 297; + /** + * The contracted units bought for the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CONTRACTED_QUANTITY = 280; + */ + const BACKFILL_LINE_ITEM_CONTRACTED_QUANTITY = 280; + /** + * The cost per unit of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_COST_PER_UNIT = 272; + */ + const BACKFILL_LINE_ITEM_COST_PER_UNIT = 272; + /** + * Backfill line item cost type ENUM value. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_COST_TYPE = 264; + */ + const BACKFILL_LINE_ITEM_COST_TYPE = 264; + /** + * Localized Backfill line item cost type name. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_COST_TYPE_NAME = 265; + */ + const BACKFILL_LINE_ITEM_COST_TYPE_NAME = 265; + /** + * Represent the end date of a Backfill creative associated with a Backfill + * line item + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CREATIVE_END_DATE = 381; + */ + const BACKFILL_LINE_ITEM_CREATIVE_END_DATE = 381; + /** + * The creative rotation type of the BackfillLineItem. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE = 290; + */ + const BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE = 290; + /** + * The localized name of the creative rotation type of the BackfillLineItem. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME = 291; + */ + const BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME = 291; + /** + * Represent the start date of a Backfill creative associated with a + * Backfill line item + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CREATIVE_START_DATE = 380; + */ + const BACKFILL_LINE_ITEM_CREATIVE_START_DATE = 380; + /** + * The 3 letter currency code of the Backfill line item + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CURRENCY_CODE = 288; + */ + const BACKFILL_LINE_ITEM_CURRENCY_CODE = 288; + /** + * The progress made for the delivery of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_DELIVERY_INDICATOR = 274; + */ + const BACKFILL_LINE_ITEM_DELIVERY_INDICATOR = 274; + /** + * The delivery rate type of the BackfillLineItem. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE = 292; + */ + const BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE = 292; + /** + * The localized name of the delivery rate type of the BackfillLineItem. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE_NAME = 293; + */ + const BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE_NAME = 293; + /** + * The discount of the BackfillLineItem in whole units in the + * BackfillLineItem's currency code, or if unspecified the Network's + * currency code. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_DISCOUNT_ABSOLUTE = 294; + */ + const BACKFILL_LINE_ITEM_DISCOUNT_ABSOLUTE = 294; + /** + * The discount of the BackfillLineItem in percentage. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_DISCOUNT_PERCENTAGE = 295; + */ + const BACKFILL_LINE_ITEM_DISCOUNT_PERCENTAGE = 295; + /** + * The end date of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_END_DATE = 267; + */ + const BACKFILL_LINE_ITEM_END_DATE = 267; + /** + * The end date and time of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_END_DATE_TIME = 269; + */ + const BACKFILL_LINE_ITEM_END_DATE_TIME = 269; + /** + * The ENUM value of the environment a Backfill line item is targeting. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE = 302; + */ + const BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE = 302; + /** + * The localized name of the environment a Backfill line item is targeting. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE_NAME = 257; + */ + const BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE_NAME = 257; + /** + * The deal ID of the Backfill line item. Set for Programmatic Direct + * campaigns. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_EXTERNAL_DEAL_ID = 285; + */ + const BACKFILL_LINE_ITEM_EXTERNAL_DEAL_ID = 285; + /** + * The external ID of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_EXTERNAL_ID = 273; + */ + const BACKFILL_LINE_ITEM_EXTERNAL_ID = 273; + /** + * The frequency cap of the Backfill line item (descriptive string). + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_FREQUENCY_CAP = 303; + */ + const BACKFILL_LINE_ITEM_FREQUENCY_CAP = 303; + /** + * Backfill line item ID. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_ID = 298; + */ + const BACKFILL_LINE_ITEM_ID = 298; + /** + * The application that last modified the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_LAST_MODIFIED_BY_APP = 289; + */ + const BACKFILL_LINE_ITEM_LAST_MODIFIED_BY_APP = 289; + /** + * The total number of clicks delivered of the lifetime of the Backfill line + * item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_LIFETIME_CLICKS = 283; + */ + const BACKFILL_LINE_ITEM_LIFETIME_CLICKS = 283; + /** + * The total number of impressions delivered over the lifetime of the + * Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_LIFETIME_IMPRESSIONS = 282; + */ + const BACKFILL_LINE_ITEM_LIFETIME_IMPRESSIONS = 282; + /** + * The total number of viewable impressions delivered over the lifetime of + * the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS = 284; + */ + const BACKFILL_LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS = 284; + /** + * Whether or not the Backfill line item is Makegood. Makegood refers to + * free inventory offered to buyers to compensate for mistakes or + * under-delivery in the original campaigns. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_MAKEGOOD = 276; + */ + const BACKFILL_LINE_ITEM_MAKEGOOD = 276; + /** + * Backfill line item name. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_NAME = 299; + */ + const BACKFILL_LINE_ITEM_NAME = 299; + /** + * The cost of booking for the Backfill line item (non-CPD). + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_NON_CPD_BOOKED_REVENUE = 286; + */ + const BACKFILL_LINE_ITEM_NON_CPD_BOOKED_REVENUE = 286; + /** + * Whether a Backfill line item is eligible for opitimization. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_OPTIMIZABLE = 277; + */ + const BACKFILL_LINE_ITEM_OPTIMIZABLE = 277; + /** + * Goal type ENUM value of the primary goal of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE = 262; + */ + const BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE = 262; + /** + * Localized goal type name of the primary goal of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE_NAME = 263; + */ + const BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE_NAME = 263; + /** + * Unit type ENUM value of the primary goal of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE = 260; + */ + const BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE = 260; + /** + * Localized unit type name of the primary goal of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME = 261; + */ + const BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME = 261; + /** + * The priority of this Backfill line item as a value between 1 and 16. + * In general, a lower priority means more serving priority for the + * Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_PRIORITY = 266; + */ + const BACKFILL_LINE_ITEM_PRIORITY = 266; + /** + * ENUM value describing the state of inventory reservation for the + * BackfillLineItem. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_RESERVATION_STATUS = 306; + */ + const BACKFILL_LINE_ITEM_RESERVATION_STATUS = 306; + /** + * Localized string describing the state of inventory reservation for the + * BackfillLineItem. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_RESERVATION_STATUS_NAME = 307; + */ + const BACKFILL_LINE_ITEM_RESERVATION_STATUS_NAME = 307; + /** + * The start date of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_START_DATE = 268; + */ + const BACKFILL_LINE_ITEM_START_DATE = 268; + /** + * The start date and time of the Backfill line item. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_START_DATE_TIME = 270; + */ + const BACKFILL_LINE_ITEM_START_DATE_TIME = 270; + /** + * Backfill line item type ENUM value. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_TYPE = 300; + */ + const BACKFILL_LINE_ITEM_TYPE = 300; + /** + * Localized Backfill line item type name. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_TYPE_NAME = 301; + */ + const BACKFILL_LINE_ITEM_TYPE_NAME = 301; + /** + * Whether the Backfill line item end time and end date is set to + * effectively never end. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_UNLIMITED_END = 271; + */ + const BACKFILL_LINE_ITEM_UNLIMITED_END = 271; + /** + * The artificial cost per unit used by the Ad server to help rank + * inventory. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_VALUE_COST_PER_UNIT = 275; + */ + const BACKFILL_LINE_ITEM_VALUE_COST_PER_UNIT = 275; + /** + * The web property code used for dynamic allocation Backfill line items. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_WEB_PROPERTY_CODE = 287; + */ + const BACKFILL_LINE_ITEM_WEB_PROPERTY_CODE = 287; + /** + * The ID of Backfill creative, includes regular creatives, and master and + * companions in case of creative sets + * + * Generated from protobuf enum BACKFILL_MASTER_COMPANION_CREATIVE_ID = 372; + */ + const BACKFILL_MASTER_COMPANION_CREATIVE_ID = 372; + /** + * Name of Backfill creative, includes regular creatives, and master and + * companions in case of creative sets + * + * Generated from protobuf enum BACKFILL_MASTER_COMPANION_CREATIVE_NAME = 373; + */ + const BACKFILL_MASTER_COMPANION_CREATIVE_NAME = 373; + /** + * Backfill order agency. + * + * Generated from protobuf enum BACKFILL_ORDER_AGENCY = 313; + */ + const BACKFILL_ORDER_AGENCY = 313; + /** + * Backfill order agency ID. + * + * Generated from protobuf enum BACKFILL_ORDER_AGENCY_ID = 314; + */ + const BACKFILL_ORDER_AGENCY_ID = 314; + /** + * Backfill order booked CPC. + * + * Generated from protobuf enum BACKFILL_ORDER_BOOKED_CPC = 315; + */ + const BACKFILL_ORDER_BOOKED_CPC = 315; + /** + * Backfill order booked CPM. + * + * Generated from protobuf enum BACKFILL_ORDER_BOOKED_CPM = 316; + */ + const BACKFILL_ORDER_BOOKED_CPM = 316; + /** + * Backfill order delivery status ENUM value. + * + * Generated from protobuf enum BACKFILL_ORDER_DELIVERY_STATUS = 340; + */ + const BACKFILL_ORDER_DELIVERY_STATUS = 340; + /** + * Backfill order delivery status localized name. + * + * Generated from protobuf enum BACKFILL_ORDER_DELIVERY_STATUS_NAME = 341; + */ + const BACKFILL_ORDER_DELIVERY_STATUS_NAME = 341; + /** + * Backfill order end date. + * + * Generated from protobuf enum BACKFILL_ORDER_END_DATE = 317; + */ + const BACKFILL_ORDER_END_DATE = 317; + /** + * Backfill order end date and time. + * + * Generated from protobuf enum BACKFILL_ORDER_END_DATE_TIME = 319; + */ + const BACKFILL_ORDER_END_DATE_TIME = 319; + /** + * Backfill order external ID. + * + * Generated from protobuf enum BACKFILL_ORDER_EXTERNAL_ID = 320; + */ + const BACKFILL_ORDER_EXTERNAL_ID = 320; + /** + * Backfill order id. + * + * Generated from protobuf enum BACKFILL_ORDER_ID = 338; + */ + const BACKFILL_ORDER_ID = 338; + /** + * Backfill order labels. + * + * Generated from protobuf enum BACKFILL_ORDER_LABELS = 334; + */ + const BACKFILL_ORDER_LABELS = 334; + /** + * Backfill order labels IDs. + * + * Generated from protobuf enum BACKFILL_ORDER_LABEL_IDS = 335; + */ + const BACKFILL_ORDER_LABEL_IDS = 335; + /** + * Backfill order lifetime clicks. + * + * Generated from protobuf enum BACKFILL_ORDER_LIFETIME_CLICKS = 322; + */ + const BACKFILL_ORDER_LIFETIME_CLICKS = 322; + /** + * Backfill order lifetime impressions. + * + * Generated from protobuf enum BACKFILL_ORDER_LIFETIME_IMPRESSIONS = 323; + */ + const BACKFILL_ORDER_LIFETIME_IMPRESSIONS = 323; + /** + * Backfill order name. + * + * Generated from protobuf enum BACKFILL_ORDER_NAME = 339; + */ + const BACKFILL_ORDER_NAME = 339; + /** + * Backfill order PO number. + * + * Generated from protobuf enum BACKFILL_ORDER_PO_NUMBER = 324; + */ + const BACKFILL_ORDER_PO_NUMBER = 324; + /** + * Whether the Backfill order is programmatic. + * + * Generated from protobuf enum BACKFILL_ORDER_PROGRAMMATIC = 321; + */ + const BACKFILL_ORDER_PROGRAMMATIC = 321; + /** + * Backfill order sales person. + * + * Generated from protobuf enum BACKFILL_ORDER_SALESPERSON = 325; + */ + const BACKFILL_ORDER_SALESPERSON = 325; + /** + * Backfill order secondary sales people. + * + * Generated from protobuf enum BACKFILL_ORDER_SECONDARY_SALESPEOPLE = 329; + */ + const BACKFILL_ORDER_SECONDARY_SALESPEOPLE = 329; + /** + * Backfill order secondary sales people ID. + * + * Generated from protobuf enum BACKFILL_ORDER_SECONDARY_SALESPEOPLE_ID = 328; + */ + const BACKFILL_ORDER_SECONDARY_SALESPEOPLE_ID = 328; + /** + * Backfill order secondary traffickers. + * + * Generated from protobuf enum BACKFILL_ORDER_SECONDARY_TRAFFICKERS = 331; + */ + const BACKFILL_ORDER_SECONDARY_TRAFFICKERS = 331; + /** + * Backfill order secondary traffickers ID. + * + * Generated from protobuf enum BACKFILL_ORDER_SECONDARY_TRAFFICKERS_ID = 330; + */ + const BACKFILL_ORDER_SECONDARY_TRAFFICKERS_ID = 330; + /** + * Backfill order start date. + * + * Generated from protobuf enum BACKFILL_ORDER_START_DATE = 332; + */ + const BACKFILL_ORDER_START_DATE = 332; + /** + * Backfill order start date and time. + * + * Generated from protobuf enum BACKFILL_ORDER_START_DATE_TIME = 333; + */ + const BACKFILL_ORDER_START_DATE_TIME = 333; + /** + * Backfill order trafficker. + * + * Generated from protobuf enum BACKFILL_ORDER_TRAFFICKER = 326; + */ + const BACKFILL_ORDER_TRAFFICKER = 326; + /** + * Backfill order trafficker ID. + * + * Generated from protobuf enum BACKFILL_ORDER_TRAFFICKER_ID = 327; + */ + const BACKFILL_ORDER_TRAFFICKER_ID = 327; + /** + * Whether the Backfill order end time and end date is set to effectively + * never end. + * + * Generated from protobuf enum BACKFILL_ORDER_UNLIMITED_END = 318; + */ + const BACKFILL_ORDER_UNLIMITED_END = 318; + /** + * The ID of the buyer on a backfill programmatic proposal. + * + * Generated from protobuf enum BACKFILL_PROGRAMMATIC_BUYER_ID = 336; + */ + const BACKFILL_PROGRAMMATIC_BUYER_ID = 336; + /** + * The name of the buyer on a backfill programmatic proposal. + * + * Generated from protobuf enum BACKFILL_PROGRAMMATIC_BUYER_NAME = 337; + */ + const BACKFILL_PROGRAMMATIC_BUYER_NAME = 337; + /** + * The amount of information about the Publisher's page sent to the buyer + * who purchased the impressions. + * + * Generated from protobuf enum BRANDING_TYPE = 383; + */ + const BRANDING_TYPE = 383; + /** + * The localized version of branding type, the amount of information about + * the Publisher's page sent to the buyer who purchased the impressions. + * + * Generated from protobuf enum BRANDING_TYPE_NAME = 384; + */ + const BRANDING_TYPE_NAME = 384; + /** + * Browser category. + * + * Generated from protobuf enum BROWSER_CATEGORY = 119; + */ + const BROWSER_CATEGORY = 119; + /** + * Browser category name. + * + * Generated from protobuf enum BROWSER_CATEGORY_NAME = 120; + */ + const BROWSER_CATEGORY_NAME = 120; + /** + * The ID of the browser. + * + * Generated from protobuf enum BROWSER_ID = 235; + */ + const BROWSER_ID = 235; + /** + * The name of the browser. + * + * Generated from protobuf enum BROWSER_NAME = 236; + */ + const BROWSER_NAME = 236; + /** + * Mobile carrier ID. + * + * Generated from protobuf enum CARRIER_ID = 369; + */ + const CARRIER_ID = 369; + /** + * Name of the mobile carrier. + * + * Generated from protobuf enum CARRIER_NAME = 368; + */ + const CARRIER_NAME = 368; + /** + * The ID of an advertiser, classified by Google, associated with a creative + * transacted + * + * Generated from protobuf enum CLASSIFIED_ADVERTISER_ID = 133; + */ + const CLASSIFIED_ADVERTISER_ID = 133; + /** + * The name of an advertiser, classified by Google, associated with a + * creative transacted + * + * Generated from protobuf enum CLASSIFIED_ADVERTISER_NAME = 134; + */ + const CLASSIFIED_ADVERTISER_NAME = 134; + /** + * ID of the brand, as classified by Google, + * + * Generated from protobuf enum CLASSIFIED_BRAND_ID = 243; + */ + const CLASSIFIED_BRAND_ID = 243; + /** + * Name of the brand, as classified by Google, + * + * Generated from protobuf enum CLASSIFIED_BRAND_NAME = 244; + */ + const CLASSIFIED_BRAND_NAME = 244; + /** + * ID of the video content served. + * + * Generated from protobuf enum CONTENT_ID = 246; + */ + const CONTENT_ID = 246; + /** + * Name of the video content served. + * + * Generated from protobuf enum CONTENT_NAME = 247; + */ + const CONTENT_NAME = 247; + /** + * The criteria ID of the country in which the ad served. + * + * Generated from protobuf enum COUNTRY_ID = 11; + */ + const COUNTRY_ID = 11; + /** + * The name of the country in which the ad served. + * + * Generated from protobuf enum COUNTRY_NAME = 12; + */ + const COUNTRY_NAME = 12; + /** + * Enum value of creative billing type + * + * Generated from protobuf enum CREATIVE_BILLING_TYPE = 366; + */ + const CREATIVE_BILLING_TYPE = 366; + /** + * Localized string value of creative billing type + * + * Generated from protobuf enum CREATIVE_BILLING_TYPE_NAME = 367; + */ + const CREATIVE_BILLING_TYPE_NAME = 367; + /** + * Represents the click-through URL of a creative + * + * Generated from protobuf enum CREATIVE_CLICK_THROUGH_URL = 174; + */ + const CREATIVE_CLICK_THROUGH_URL = 174; + /** + * The ID of a creative + * + * Generated from protobuf enum CREATIVE_ID = 138; + */ + const CREATIVE_ID = 138; + /** + * Creative name + * + * Generated from protobuf enum CREATIVE_NAME = 139; + */ + const CREATIVE_NAME = 139; + /** + * Creative technology ENUM + * + * Generated from protobuf enum CREATIVE_TECHNOLOGY = 148; + */ + const CREATIVE_TECHNOLOGY = 148; + /** + * Creative technology locallized name + * + * Generated from protobuf enum CREATIVE_TECHNOLOGY_NAME = 149; + */ + const CREATIVE_TECHNOLOGY_NAME = 149; + /** + * Third party vendor name of a creative + * + * Generated from protobuf enum CREATIVE_THIRD_PARTY_VENDOR = 361; + */ + const CREATIVE_THIRD_PARTY_VENDOR = 361; + /** + * Enum value of creative type + * + * Generated from protobuf enum CREATIVE_TYPE = 344; + */ + const CREATIVE_TYPE = 344; + /** + * Localized string name of creative type + * + * Generated from protobuf enum CREATIVE_TYPE_NAME = 345; + */ + const CREATIVE_TYPE_NAME = 345; + /** + * Breaks down reporting data by date. + * + * Generated from protobuf enum DATE = 3; + */ + const DATE = 3; + /** + * Breaks down reporting data by day of the week. Monday is 1 and 7 is + * Sunday. + * + * Generated from protobuf enum DAY_OF_WEEK = 4; + */ + const DAY_OF_WEEK = 4; + /** + * Demand channel. + * + * Generated from protobuf enum DEMAND_CHANNEL = 9; + */ + const DEMAND_CHANNEL = 9; + /** + * Demand channel name. + * + * Generated from protobuf enum DEMAND_CHANNEL_NAME = 10; + */ + const DEMAND_CHANNEL_NAME = 10; + /** + * Demand subchannel. + * + * Generated from protobuf enum DEMAND_SUBCHANNEL = 22; + */ + const DEMAND_SUBCHANNEL = 22; + /** + * Demand subchannel name. + * + * Generated from protobuf enum DEMAND_SUBCHANNEL_NAME = 23; + */ + const DEMAND_SUBCHANNEL_NAME = 23; + /** + * The device on which an ad was served. + * + * Generated from protobuf enum DEVICE = 226; + */ + const DEVICE = 226; + /** + * The device category to which an ad is being targeted. + * + * Generated from protobuf enum DEVICE_CATEGORY = 15; + */ + const DEVICE_CATEGORY = 15; + /** + * The name of the category of device (smartphone, feature phone, tablet, or + * desktop) to which an ad is being targeted. + * + * Generated from protobuf enum DEVICE_CATEGORY_NAME = 16; + */ + const DEVICE_CATEGORY_NAME = 16; + /** + * The localized name of the device on which an ad was served. + * + * Generated from protobuf enum DEVICE_NAME = 225; + */ + const DEVICE_NAME = 225; + /** + * ID of the yield partner as classified by Google + * + * Generated from protobuf enum EXCHANGE_THIRD_PARTY_COMPANY_ID = 185; + */ + const EXCHANGE_THIRD_PARTY_COMPANY_ID = 185; + /** + * Name of the yield partner as classified by Google + * + * Generated from protobuf enum EXCHANGE_THIRD_PARTY_COMPANY_NAME = 186; + */ + const EXCHANGE_THIRD_PARTY_COMPANY_NAME = 186; + /** + * The ID of the first look pricing rule. + * + * Generated from protobuf enum FIRST_LOOK_PRICING_RULE_ID = 248; + */ + const FIRST_LOOK_PRICING_RULE_ID = 248; + /** + * The name of the first look pricing rule. + * + * Generated from protobuf enum FIRST_LOOK_PRICING_RULE_NAME = 249; + */ + const FIRST_LOOK_PRICING_RULE_NAME = 249; + /** + * Breaks down reporting data by hour in one day. + * + * Generated from protobuf enum HOUR = 100; + */ + const HOUR = 100; + /** + * The interaction type of an ad. + * + * Generated from protobuf enum INTERACTION_TYPE = 223; + */ + const INTERACTION_TYPE = 223; + /** + * The localized name of the interaction type of an ad. + * + * Generated from protobuf enum INTERACTION_TYPE_NAME = 224; + */ + const INTERACTION_TYPE_NAME = 224; + /** + * Inventory format. + * The format of the ad unit (e.g, banner) where the ad was requested. + * + * Generated from protobuf enum INVENTORY_FORMAT = 17; + */ + const INVENTORY_FORMAT = 17; + /** + * Inventory format name. + * The format of the ad unit (e.g, banner) where the ad was requested. + * + * Generated from protobuf enum INVENTORY_FORMAT_NAME = 18; + */ + const INVENTORY_FORMAT_NAME = 18; + /** + * Inventory type. + * The kind of web page or device where the ad was requested. + * + * Generated from protobuf enum INVENTORY_TYPE = 19; + */ + const INVENTORY_TYPE = 19; + /** + * Inventory type name. + * The kind of web page or device where the ad was requested. + * + * Generated from protobuf enum INVENTORY_TYPE_NAME = 20; + */ + const INVENTORY_TYPE_NAME = 20; + /** + * Whether traffic is Adx Direct. + * + * Generated from protobuf enum IS_ADX_DIRECT = 382; + */ + const IS_ADX_DIRECT = 382; + /** + * Whether traffic is First Look. + * + * Generated from protobuf enum IS_FIRST_LOOK_DEAL = 401; + */ + const IS_FIRST_LOOK_DEAL = 401; + /** + * The Custom Targeting Value ID + * + * Generated from protobuf enum KEY_VALUES_ID = 214; + */ + const KEY_VALUES_ID = 214; + /** + * The Custom Targeting Value formatted like = + * + * Generated from protobuf enum KEY_VALUES_NAME = 215; + */ + const KEY_VALUES_NAME = 215; + /** + * Whether a Line item is archived. + * + * Generated from protobuf enum LINE_ITEM_ARCHIVED = 188; + */ + const LINE_ITEM_ARCHIVED = 188; + /** + * Line item comanion delivery option ENUM value. + * + * Generated from protobuf enum LINE_ITEM_COMPANION_DELIVERY_OPTION = 204; + */ + const LINE_ITEM_COMPANION_DELIVERY_OPTION = 204; + /** + * Localized line item comanion delivery option name. + * + * Generated from protobuf enum LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME = 205; + */ + const LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME = 205; + /** + * The computed status of the LineItem. + * + * Generated from protobuf enum LINE_ITEM_COMPUTED_STATUS = 250; + */ + const LINE_ITEM_COMPUTED_STATUS = 250; + /** + * The localized name of the computed status of the LineItem. + * + * Generated from protobuf enum LINE_ITEM_COMPUTED_STATUS_NAME = 251; + */ + const LINE_ITEM_COMPUTED_STATUS_NAME = 251; + /** + * The contracted units bought for the Line item. + * + * Generated from protobuf enum LINE_ITEM_CONTRACTED_QUANTITY = 92; + */ + const LINE_ITEM_CONTRACTED_QUANTITY = 92; + /** + * The cost per unit of the Line item. + * + * Generated from protobuf enum LINE_ITEM_COST_PER_UNIT = 85; + */ + const LINE_ITEM_COST_PER_UNIT = 85; + /** + * Line item cost type ENUM value. + * + * Generated from protobuf enum LINE_ITEM_COST_TYPE = 212; + */ + const LINE_ITEM_COST_TYPE = 212; + /** + * Localized line item cost type name. + * + * Generated from protobuf enum LINE_ITEM_COST_TYPE_NAME = 213; + */ + const LINE_ITEM_COST_TYPE_NAME = 213; + /** + * Represent the end date of a creative associated with line item + * + * Generated from protobuf enum LINE_ITEM_CREATIVE_END_DATE = 176; + */ + const LINE_ITEM_CREATIVE_END_DATE = 176; + /** + * The creative rotation type of the LineItem. + * + * Generated from protobuf enum LINE_ITEM_CREATIVE_ROTATION_TYPE = 189; + */ + const LINE_ITEM_CREATIVE_ROTATION_TYPE = 189; + /** + * The localized name of the creative rotation type of the LineItem. + * + * Generated from protobuf enum LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME = 190; + */ + const LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME = 190; + /** + * Represent the start date of a creative associated with line item + * + * Generated from protobuf enum LINE_ITEM_CREATIVE_START_DATE = 175; + */ + const LINE_ITEM_CREATIVE_START_DATE = 175; + /** + * The 3 letter currency code of the Line Item + * + * Generated from protobuf enum LINE_ITEM_CURRENCY_CODE = 180; + */ + const LINE_ITEM_CURRENCY_CODE = 180; + /** + * The progress made for the delivery of the Line item. + * + * Generated from protobuf enum LINE_ITEM_DELIVERY_INDICATOR = 87; + */ + const LINE_ITEM_DELIVERY_INDICATOR = 87; + /** + * The delivery rate type of the LineItem. + * + * Generated from protobuf enum LINE_ITEM_DELIVERY_RATE_TYPE = 191; + */ + const LINE_ITEM_DELIVERY_RATE_TYPE = 191; + /** + * The localized name of the delivery rate type of the LineItem. + * + * Generated from protobuf enum LINE_ITEM_DELIVERY_RATE_TYPE_NAME = 192; + */ + const LINE_ITEM_DELIVERY_RATE_TYPE_NAME = 192; + /** + * The discount of the LineItem in whole units in the LineItem's currency + * code, or if unspecified the Network's currency code. + * + * Generated from protobuf enum LINE_ITEM_DISCOUNT_ABSOLUTE = 195; + */ + const LINE_ITEM_DISCOUNT_ABSOLUTE = 195; + /** + * The discount of the LineItem in percentage. + * + * Generated from protobuf enum LINE_ITEM_DISCOUNT_PERCENTAGE = 196; + */ + const LINE_ITEM_DISCOUNT_PERCENTAGE = 196; + /** + * The end date of the Line item. + * + * Generated from protobuf enum LINE_ITEM_END_DATE = 81; + */ + const LINE_ITEM_END_DATE = 81; + /** + * The end date and time of the Line item. + * + * Generated from protobuf enum LINE_ITEM_END_DATE_TIME = 83; + */ + const LINE_ITEM_END_DATE_TIME = 83; + /** + * The ENUM value of the environment a LineItem is targeting. + * + * Generated from protobuf enum LINE_ITEM_ENVIRONMENT_TYPE = 201; + */ + const LINE_ITEM_ENVIRONMENT_TYPE = 201; + /** + * The localized name of the environment a LineItem is targeting. + * + * Generated from protobuf enum LINE_ITEM_ENVIRONMENT_TYPE_NAME = 202; + */ + const LINE_ITEM_ENVIRONMENT_TYPE_NAME = 202; + /** + * The deal ID of the Line item. Set for Programmatic Direct campaigns. + * + * Generated from protobuf enum LINE_ITEM_EXTERNAL_DEAL_ID = 97; + */ + const LINE_ITEM_EXTERNAL_DEAL_ID = 97; + /** + * The external ID of the Line item. + * + * Generated from protobuf enum LINE_ITEM_EXTERNAL_ID = 86; + */ + const LINE_ITEM_EXTERNAL_ID = 86; + /** + * The frequency cap of the Line item (descriptive string). + * + * Generated from protobuf enum LINE_ITEM_FREQUENCY_CAP = 256; + */ + const LINE_ITEM_FREQUENCY_CAP = 256; + /** + * Line item ID. + * + * Generated from protobuf enum LINE_ITEM_ID = 1; + */ + const LINE_ITEM_ID = 1; + /** + * The application that last modified the Line Item. + * + * Generated from protobuf enum LINE_ITEM_LAST_MODIFIED_BY_APP = 181; + */ + const LINE_ITEM_LAST_MODIFIED_BY_APP = 181; + /** + * The total number of clicks delivered of the lifetime of the Line item. + * + * Generated from protobuf enum LINE_ITEM_LIFETIME_CLICKS = 95; + */ + const LINE_ITEM_LIFETIME_CLICKS = 95; + /** + * The total number of impressions delivered over the lifetime of the + * Line item. + * + * Generated from protobuf enum LINE_ITEM_LIFETIME_IMPRESSIONS = 94; + */ + const LINE_ITEM_LIFETIME_IMPRESSIONS = 94; + /** + * The total number of viewable impressions delivered over the lifetime of + * the Line item. + * + * Generated from protobuf enum LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS = 96; + */ + const LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS = 96; + /** + * Whether or not the Line item is Makegood. Makegood refers to free + * inventory offered to buyers to compensate for mistakes or under-delivery + * in the original campaigns. + * + * Generated from protobuf enum LINE_ITEM_MAKEGOOD = 89; + */ + const LINE_ITEM_MAKEGOOD = 89; + /** + * Line item Name. + * + * Generated from protobuf enum LINE_ITEM_NAME = 2; + */ + const LINE_ITEM_NAME = 2; + /** + * The cost of booking for the Line item (non-CPD). + * + * Generated from protobuf enum LINE_ITEM_NON_CPD_BOOKED_REVENUE = 98; + */ + const LINE_ITEM_NON_CPD_BOOKED_REVENUE = 98; + /** + * Whether a Line item is eligible for opitimization. + * + * Generated from protobuf enum LINE_ITEM_OPTIMIZABLE = 90; + */ + const LINE_ITEM_OPTIMIZABLE = 90; + /** + * Goal type ENUM value of the primary goal of the line item. + * + * Generated from protobuf enum LINE_ITEM_PRIMARY_GOAL_TYPE = 210; + */ + const LINE_ITEM_PRIMARY_GOAL_TYPE = 210; + /** + * Localized goal type name of the primary goal of the line item. + * + * Generated from protobuf enum LINE_ITEM_PRIMARY_GOAL_TYPE_NAME = 211; + */ + const LINE_ITEM_PRIMARY_GOAL_TYPE_NAME = 211; + /** + * The total number of impressions or clicks that are reserved for a + * line item. For line items of type BULK or PRICE_PRIORITY, this represents + * the number of remaining impressions reserved. If the line item has an + * impression cap goal, this represents the number of impressions or + * conversions that the line item will stop serving at if reached. + * + * Generated from protobuf enum LINE_ITEM_PRIMARY_GOAL_UNITS_ABSOLUTE = 93; + */ + const LINE_ITEM_PRIMARY_GOAL_UNITS_ABSOLUTE = 93; + /** + * The percentage of impressions or clicks that are reserved for a + * line item. For line items of type SPONSORSHIP, this represents the + * percentage of available impressions reserved. For line items of type + * NETWORK or HOUSE, this represents the percentage of remaining impressions + * reserved. + * + * Generated from protobuf enum LINE_ITEM_PRIMARY_GOAL_UNITS_PERCENTAGE = 396; + */ + const LINE_ITEM_PRIMARY_GOAL_UNITS_PERCENTAGE = 396; + /** + * Unit type ENUM value of the primary goal of the line item. + * + * Generated from protobuf enum LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE = 208; + */ + const LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE = 208; + /** + * Localized unit type name of the primary goal of the line item. + * + * Generated from protobuf enum LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME = 209; + */ + const LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME = 209; + /** + * The priority of this Line item as a value between 1 and 16. + * In general, a lower priority means more serving priority for the + * Line item. + * + * Generated from protobuf enum LINE_ITEM_PRIORITY = 24; + */ + const LINE_ITEM_PRIORITY = 24; + /** + * ENUM value describing the state of inventory reservation for the + * LineItem. + * + * Generated from protobuf enum LINE_ITEM_RESERVATION_STATUS = 304; + */ + const LINE_ITEM_RESERVATION_STATUS = 304; + /** + * Localized string describing the state of inventory reservation for the + * LineItem. + * + * Generated from protobuf enum LINE_ITEM_RESERVATION_STATUS_NAME = 305; + */ + const LINE_ITEM_RESERVATION_STATUS_NAME = 305; + /** + * The start date of the Line item. + * + * Generated from protobuf enum LINE_ITEM_START_DATE = 82; + */ + const LINE_ITEM_START_DATE = 82; + /** + * The start date and time of the Line item. + * + * Generated from protobuf enum LINE_ITEM_START_DATE_TIME = 84; + */ + const LINE_ITEM_START_DATE_TIME = 84; + /** + * Line item type ENUM value. + * + * Generated from protobuf enum LINE_ITEM_TYPE = 193; + */ + const LINE_ITEM_TYPE = 193; + /** + * Localized line item type name. + * + * Generated from protobuf enum LINE_ITEM_TYPE_NAME = 194; + */ + const LINE_ITEM_TYPE_NAME = 194; + /** + * Whether the Line item end time and end date is set to effectively never + * end. + * + * Generated from protobuf enum LINE_ITEM_UNLIMITED_END = 187; + */ + const LINE_ITEM_UNLIMITED_END = 187; + /** + * The artificial cost per unit used by the Ad server to help rank + * inventory. + * + * Generated from protobuf enum LINE_ITEM_VALUE_COST_PER_UNIT = 88; + */ + const LINE_ITEM_VALUE_COST_PER_UNIT = 88; + /** + * The web property code used for dynamic allocation Line Items. + * + * Generated from protobuf enum LINE_ITEM_WEB_PROPERTY_CODE = 179; + */ + const LINE_ITEM_WEB_PROPERTY_CODE = 179; + /** + * The ID of creative, includes regular creatives, and master and companions + * in case of creative sets + * + * Generated from protobuf enum MASTER_COMPANION_CREATIVE_ID = 140; + */ + const MASTER_COMPANION_CREATIVE_ID = 140; + /** + * Name of creative, includes regular creatives, and master and companions + * in case of creative sets + * + * Generated from protobuf enum MASTER_COMPANION_CREATIVE_NAME = 141; + */ + const MASTER_COMPANION_CREATIVE_NAME = 141; + /** + * Whether the mobile app is free. + * + * Generated from protobuf enum MOBILE_APP_FREE = 128; + */ + const MOBILE_APP_FREE = 128; + /** + * URL of app icon for the mobile app. + * + * Generated from protobuf enum MOBILE_APP_ICON_URL = 129; + */ + const MOBILE_APP_ICON_URL = 129; + /** + * The ID of the Mobile App. + * + * Generated from protobuf enum MOBILE_APP_ID = 123; + */ + const MOBILE_APP_ID = 123; + /** + * The name of the mobile app. + * + * Generated from protobuf enum MOBILE_APP_NAME = 127; + */ + const MOBILE_APP_NAME = 127; + /** + * Ownership status of the mobile app. + * + * Generated from protobuf enum MOBILE_APP_OWNERSHIP_STATUS = 311; + */ + const MOBILE_APP_OWNERSHIP_STATUS = 311; + /** + * Ownership status of the mobile app. + * + * Generated from protobuf enum MOBILE_APP_OWNERSHIP_STATUS_NAME = 312; + */ + const MOBILE_APP_OWNERSHIP_STATUS_NAME = 312; + /** + * The App Store of the mobile app. + * + * Generated from protobuf enum MOBILE_APP_STORE = 125; + */ + const MOBILE_APP_STORE = 125; + /** + * The localized name of the mobile app store. + * + * Generated from protobuf enum MOBILE_APP_STORE_NAME = 245; + */ + const MOBILE_APP_STORE_NAME = 245; + /** + * Mobile inventory type. + * Identifies whether a mobile ad came from a regular web page, an AMP web + * page, or a mobile app. + * Values match the Inventory type dimension available in the Overview Home + * dashboard. Note: Video takes precedence over any other value, for + * example, if there is an in-stream video impression on a desktop device, + * it will be attributed to in-stream video and not desktop web. + * + * Generated from protobuf enum MOBILE_INVENTORY_TYPE = 99; + */ + const MOBILE_INVENTORY_TYPE = 99; + /** + * Mobile inventory type name. + * Identifies whether a mobile ad came from a regular web page, an AMP web + * page, or a mobile app. + * + * Generated from protobuf enum MOBILE_INVENTORY_TYPE_NAME = 21; + */ + const MOBILE_INVENTORY_TYPE_NAME = 21; + /** + * SDK version of the mobile device. + * + * Generated from protobuf enum MOBILE_SDK_VERSION_NAME = 130; + */ + const MOBILE_SDK_VERSION_NAME = 130; + /** + * Breaks down reporting data by month and year. + * + * Generated from protobuf enum MONTH_YEAR = 6; + */ + const MONTH_YEAR = 6; + /** + * Native ad format ID. + * + * Generated from protobuf enum NATIVE_AD_FORMAT_ID = 255; + */ + const NATIVE_AD_FORMAT_ID = 255; + /** + * Native ad format name. + * + * Generated from protobuf enum NATIVE_AD_FORMAT_NAME = 254; + */ + const NATIVE_AD_FORMAT_NAME = 254; + /** + * Native style ID. + * + * Generated from protobuf enum NATIVE_STYLE_ID = 253; + */ + const NATIVE_STYLE_ID = 253; + /** + * Native style name. + * + * Generated from protobuf enum NATIVE_STYLE_NAME = 252; + */ + const NATIVE_STYLE_NAME = 252; + /** + * Operating system category. + * + * Generated from protobuf enum OPERATING_SYSTEM_CATEGORY = 117; + */ + const OPERATING_SYSTEM_CATEGORY = 117; + /** + * Operating system category name. + * + * Generated from protobuf enum OPERATING_SYSTEM_CATEGORY_NAME = 118; + */ + const OPERATING_SYSTEM_CATEGORY_NAME = 118; + /** + * ID of the operating system version. + * + * Generated from protobuf enum OPERATING_SYSTEM_VERSION_ID = 238; + */ + const OPERATING_SYSTEM_VERSION_ID = 238; + /** + * Details of the operating system, including version. + * + * Generated from protobuf enum OPERATING_SYSTEM_VERSION_NAME = 237; + */ + const OPERATING_SYSTEM_VERSION_NAME = 237; + /** + * Order agency. + * + * Generated from protobuf enum ORDER_AGENCY = 150; + */ + const ORDER_AGENCY = 150; + /** + * Order agency ID. + * + * Generated from protobuf enum ORDER_AGENCY_ID = 151; + */ + const ORDER_AGENCY_ID = 151; + /** + * Order booked CPC. + * + * Generated from protobuf enum ORDER_BOOKED_CPC = 152; + */ + const ORDER_BOOKED_CPC = 152; + /** + * Order booked CPM. + * + * Generated from protobuf enum ORDER_BOOKED_CPM = 153; + */ + const ORDER_BOOKED_CPM = 153; + /** + * Order delivery status ENUM value. + * + * Generated from protobuf enum ORDER_DELIVERY_STATUS = 231; + */ + const ORDER_DELIVERY_STATUS = 231; + /** + * Order delivery status localized name. + * + * Generated from protobuf enum ORDER_DELIVERY_STATUS_NAME = 239; + */ + const ORDER_DELIVERY_STATUS_NAME = 239; + /** + * Order end date. + * + * Generated from protobuf enum ORDER_END_DATE = 154; + */ + const ORDER_END_DATE = 154; + /** + * Order end date and time. + * + * Generated from protobuf enum ORDER_END_DATE_TIME = 155; + */ + const ORDER_END_DATE_TIME = 155; + /** + * Order external ID. + * + * Generated from protobuf enum ORDER_EXTERNAL_ID = 156; + */ + const ORDER_EXTERNAL_ID = 156; + /** + * Order id. + * + * Generated from protobuf enum ORDER_ID = 7; + */ + const ORDER_ID = 7; + /** + * Order labels. + * + * Generated from protobuf enum ORDER_LABELS = 170; + */ + const ORDER_LABELS = 170; + /** + * Order labels IDs. + * + * Generated from protobuf enum ORDER_LABEL_IDS = 171; + */ + const ORDER_LABEL_IDS = 171; + /** + * Order lifetime clicks. + * + * Generated from protobuf enum ORDER_LIFETIME_CLICKS = 158; + */ + const ORDER_LIFETIME_CLICKS = 158; + /** + * Order lifetime impressions. + * + * Generated from protobuf enum ORDER_LIFETIME_IMPRESSIONS = 159; + */ + const ORDER_LIFETIME_IMPRESSIONS = 159; + /** + * Order name. + * + * Generated from protobuf enum ORDER_NAME = 8; + */ + const ORDER_NAME = 8; + /** + * Order PO number. + * + * Generated from protobuf enum ORDER_PO_NUMBER = 160; + */ + const ORDER_PO_NUMBER = 160; + /** + * Whether the Order is programmatic. + * + * Generated from protobuf enum ORDER_PROGRAMMATIC = 157; + */ + const ORDER_PROGRAMMATIC = 157; + /** + * Order sales person. + * + * Generated from protobuf enum ORDER_SALESPERSON = 161; + */ + const ORDER_SALESPERSON = 161; + /** + * Order secondary sales people. + * + * Generated from protobuf enum ORDER_SECONDARY_SALESPEOPLE = 164; + */ + const ORDER_SECONDARY_SALESPEOPLE = 164; + /** + * Order secondary sales people ID. + * + * Generated from protobuf enum ORDER_SECONDARY_SALESPEOPLE_ID = 165; + */ + const ORDER_SECONDARY_SALESPEOPLE_ID = 165; + /** + * Order secondary traffickers. + * + * Generated from protobuf enum ORDER_SECONDARY_TRAFFICKERS = 166; + */ + const ORDER_SECONDARY_TRAFFICKERS = 166; + /** + * Order secondary traffickers ID. + * + * Generated from protobuf enum ORDER_SECONDARY_TRAFFICKERS_ID = 167; + */ + const ORDER_SECONDARY_TRAFFICKERS_ID = 167; + /** + * Order start date. + * + * Generated from protobuf enum ORDER_START_DATE = 168; + */ + const ORDER_START_DATE = 168; + /** + * Order start date and time. + * + * Generated from protobuf enum ORDER_START_DATE_TIME = 169; + */ + const ORDER_START_DATE_TIME = 169; + /** + * Order trafficker. + * + * Generated from protobuf enum ORDER_TRAFFICKER = 162; + */ + const ORDER_TRAFFICKER = 162; + /** + * Order trafficker ID. + * + * Generated from protobuf enum ORDER_TRAFFICKER_ID = 163; + */ + const ORDER_TRAFFICKER_ID = 163; + /** + * Whether the Order end time and end date is set to effectively never + * end. + * + * Generated from protobuf enum ORDER_UNLIMITED_END = 203; + */ + const ORDER_UNLIMITED_END = 203; + /** + * Placement ID + * + * Generated from protobuf enum PLACEMENT_ID = 113; + */ + const PLACEMENT_ID = 113; + /** + * The full list of placement IDs associated with the ad unit. + * + * Generated from protobuf enum PLACEMENT_ID_ALL = 144; + */ + const PLACEMENT_ID_ALL = 144; + /** + * Placement name + * + * Generated from protobuf enum PLACEMENT_NAME = 114; + */ + const PLACEMENT_NAME = 114; + /** + * The full list of placement names associated with the ad unit. + * + * Generated from protobuf enum PLACEMENT_NAME_ALL = 145; + */ + const PLACEMENT_NAME_ALL = 145; + /** + * Placement status ENUM value + * + * Generated from protobuf enum PLACEMENT_STATUS = 362; + */ + const PLACEMENT_STATUS = 362; + /** + * The full list of placement status ENUM values associated with the ad + * unit. + * + * Generated from protobuf enum PLACEMENT_STATUS_ALL = 363; + */ + const PLACEMENT_STATUS_ALL = 363; + /** + * Localized placement status name. + * + * Generated from protobuf enum PLACEMENT_STATUS_NAME = 364; + */ + const PLACEMENT_STATUS_NAME = 364; + /** + * The full list of localized placement status names associated with the ad + * unit. + * + * Generated from protobuf enum PLACEMENT_STATUS_NAME_ALL = 365; + */ + const PLACEMENT_STATUS_NAME_ALL = 365; + /** + * The ID of the buyer on a programmatic proposal. + * + * Generated from protobuf enum PROGRAMMATIC_BUYER_ID = 240; + */ + const PROGRAMMATIC_BUYER_ID = 240; + /** + * The name of the buyer on a programmatic proposal. + * + * Generated from protobuf enum PROGRAMMATIC_BUYER_NAME = 241; + */ + const PROGRAMMATIC_BUYER_NAME = 241; + /** + * Programmatic channel. + * The type of transaction that occurred in Ad Exchange. + * + * Generated from protobuf enum PROGRAMMATIC_CHANNEL = 13; + */ + const PROGRAMMATIC_CHANNEL = 13; + /** + * Programmatic channel name. + * The type of transaction that occurred in Ad Exchange. + * + * Generated from protobuf enum PROGRAMMATIC_CHANNEL_NAME = 14; + */ + const PROGRAMMATIC_CHANNEL_NAME = 14; + /** + * The size of a rendered creative, It can differ with the creative's size + * if a creative is shown in an ad slot of a different size. + * + * Generated from protobuf enum RENDERED_CREATIVE_SIZE = 343; + */ + const RENDERED_CREATIVE_SIZE = 343; + /** + * Inventory Requested Ad Sizes dimension + * + * Generated from protobuf enum REQUESTED_AD_SIZES = 352; + */ + const REQUESTED_AD_SIZES = 352; + /** + * Request type ENUM + * + * Generated from protobuf enum REQUEST_TYPE = 146; + */ + const REQUEST_TYPE = 146; + /** + * Request type locallized name + * + * Generated from protobuf enum REQUEST_TYPE_NAME = 147; + */ + const REQUEST_TYPE_NAME = 147; + /** + * Information about domain or subdomains. + * + * Generated from protobuf enum SITE = 387; + */ + const SITE = 387; + /** + * The ID of the browser, device or other environment into which a line item + * or creative was served. + * + * Generated from protobuf enum TARGETING_ID = 232; + */ + const TARGETING_ID = 232; + /** + * Information about the browser, device and other environments into which + * a line item or creative was served. + * + * Generated from protobuf enum TARGETING_NAME = 233; + */ + const TARGETING_NAME = 233; + /** + * The way in which advertisers targeted their ads. + * + * Generated from protobuf enum TARGETING_TYPE = 385; + */ + const TARGETING_TYPE = 385; + /** + * The localized name of the way in which advertisers targeted their ads. + * + * Generated from protobuf enum TARGETING_TYPE_NAME = 386; + */ + const TARGETING_TYPE_NAME = 386; + /** + * Inventory Traffic source dimension + * + * Generated from protobuf enum TRAFFIC_SOURCE = 388; + */ + const TRAFFIC_SOURCE = 388; + /** + * Inventory Traffic source dimension name + * + * Generated from protobuf enum TRAFFIC_SOURCE_NAME = 389; + */ + const TRAFFIC_SOURCE_NAME = 389; + /** + * Unified pricing rule ID dimension + * + * Generated from protobuf enum UNIFIED_PRICING_RULE_ID = 393; + */ + const UNIFIED_PRICING_RULE_ID = 393; + /** + * Unified pricing rule name dimension + * + * Generated from protobuf enum UNIFIED_PRICING_RULE_NAME = 394; + */ + const UNIFIED_PRICING_RULE_NAME = 394; + /** + * The video placement enum as defined by ADCOM 1.0-202303. + * + * Generated from protobuf enum VIDEO_PLCMT = 172; + */ + const VIDEO_PLCMT = 172; + /** + * The localized name of the video placement as defined by ADCOM 1.0-202303. + * + * Generated from protobuf enum VIDEO_PLCMT_NAME = 173; + */ + const VIDEO_PLCMT_NAME = 173; + /** + * Breaks down reporting data by week of the year. + * + * Generated from protobuf enum WEEK = 5; + */ + const WEEK = 5; + /** + * Name of the company within a yield group + * + * Generated from protobuf enum YIELD_GROUP_BUYER_NAME = 184; + */ + const YIELD_GROUP_BUYER_NAME = 184; + /** + * ID of the group of ad networks or exchanges used for Mediation and Open + * Bidding + * + * Generated from protobuf enum YIELD_GROUP_ID = 182; + */ + const YIELD_GROUP_ID = 182; + /** + * Name of the group of ad networks or exchanges used for Mediation and Open + * Bidding + * + * Generated from protobuf enum YIELD_GROUP_NAME = 183; + */ + const YIELD_GROUP_NAME = 183; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 0 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID = 10000; + */ + const LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID = 10000; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 1 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID = 10001; + */ + const LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID = 10001; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 2 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID = 10002; + */ + const LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID = 10002; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 3 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID = 10003; + */ + const LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID = 10003; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 4 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID = 10004; + */ + const LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID = 10004; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 5 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID = 10005; + */ + const LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID = 10005; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 6 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID = 10006; + */ + const LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID = 10006; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 7 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID = 10007; + */ + const LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID = 10007; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 8 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID = 10008; + */ + const LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID = 10008; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 9 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID = 10009; + */ + const LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID = 10009; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 10 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID = 10010; + */ + const LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID = 10010; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 11 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID = 10011; + */ + const LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID = 10011; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 12 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID = 10012; + */ + const LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID = 10012; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 13 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID = 10013; + */ + const LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID = 10013; + /** + * Custom field option ID for Line Item with custom field ID equal to the ID + * in index 14 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID = 10014; + */ + const LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID = 10014; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 0 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_0_VALUE = 11000; + */ + const LINE_ITEM_CUSTOM_FIELD_0_VALUE = 11000; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 1 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_1_VALUE = 11001; + */ + const LINE_ITEM_CUSTOM_FIELD_1_VALUE = 11001; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 2 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_2_VALUE = 11002; + */ + const LINE_ITEM_CUSTOM_FIELD_2_VALUE = 11002; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 3 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_3_VALUE = 11003; + */ + const LINE_ITEM_CUSTOM_FIELD_3_VALUE = 11003; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 4 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_4_VALUE = 11004; + */ + const LINE_ITEM_CUSTOM_FIELD_4_VALUE = 11004; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 5 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_5_VALUE = 11005; + */ + const LINE_ITEM_CUSTOM_FIELD_5_VALUE = 11005; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 6 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_6_VALUE = 11006; + */ + const LINE_ITEM_CUSTOM_FIELD_6_VALUE = 11006; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 7 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_7_VALUE = 11007; + */ + const LINE_ITEM_CUSTOM_FIELD_7_VALUE = 11007; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 8 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_8_VALUE = 11008; + */ + const LINE_ITEM_CUSTOM_FIELD_8_VALUE = 11008; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 9 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_9_VALUE = 11009; + */ + const LINE_ITEM_CUSTOM_FIELD_9_VALUE = 11009; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 10 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_10_VALUE = 11010; + */ + const LINE_ITEM_CUSTOM_FIELD_10_VALUE = 11010; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 11 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_11_VALUE = 11011; + */ + const LINE_ITEM_CUSTOM_FIELD_11_VALUE = 11011; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 12 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_12_VALUE = 11012; + */ + const LINE_ITEM_CUSTOM_FIELD_12_VALUE = 11012; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 13 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_13_VALUE = 11013; + */ + const LINE_ITEM_CUSTOM_FIELD_13_VALUE = 11013; + /** + * Custom field value for Line Item with custom field ID equal to the ID + * in index 14 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum LINE_ITEM_CUSTOM_FIELD_14_VALUE = 11014; + */ + const LINE_ITEM_CUSTOM_FIELD_14_VALUE = 11014; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 0 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_0_OPTION_ID = 12000; + */ + const ORDER_CUSTOM_FIELD_0_OPTION_ID = 12000; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 1 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_1_OPTION_ID = 12001; + */ + const ORDER_CUSTOM_FIELD_1_OPTION_ID = 12001; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 2 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_2_OPTION_ID = 12002; + */ + const ORDER_CUSTOM_FIELD_2_OPTION_ID = 12002; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 3 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_3_OPTION_ID = 12003; + */ + const ORDER_CUSTOM_FIELD_3_OPTION_ID = 12003; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 4 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_4_OPTION_ID = 12004; + */ + const ORDER_CUSTOM_FIELD_4_OPTION_ID = 12004; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 5 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_5_OPTION_ID = 12005; + */ + const ORDER_CUSTOM_FIELD_5_OPTION_ID = 12005; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 6 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_6_OPTION_ID = 12006; + */ + const ORDER_CUSTOM_FIELD_6_OPTION_ID = 12006; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 7 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_7_OPTION_ID = 12007; + */ + const ORDER_CUSTOM_FIELD_7_OPTION_ID = 12007; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 8 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_8_OPTION_ID = 12008; + */ + const ORDER_CUSTOM_FIELD_8_OPTION_ID = 12008; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 9 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_9_OPTION_ID = 12009; + */ + const ORDER_CUSTOM_FIELD_9_OPTION_ID = 12009; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 10 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_10_OPTION_ID = 12010; + */ + const ORDER_CUSTOM_FIELD_10_OPTION_ID = 12010; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 11 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_11_OPTION_ID = 12011; + */ + const ORDER_CUSTOM_FIELD_11_OPTION_ID = 12011; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 12 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_12_OPTION_ID = 12012; + */ + const ORDER_CUSTOM_FIELD_12_OPTION_ID = 12012; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 13 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_13_OPTION_ID = 12013; + */ + const ORDER_CUSTOM_FIELD_13_OPTION_ID = 12013; + /** + * Custom field option ID for Order with custom field ID equal to the ID + * in index 14 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_14_OPTION_ID = 12014; + */ + const ORDER_CUSTOM_FIELD_14_OPTION_ID = 12014; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 0 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_0_VALUE = 13000; + */ + const ORDER_CUSTOM_FIELD_0_VALUE = 13000; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 1 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_1_VALUE = 13001; + */ + const ORDER_CUSTOM_FIELD_1_VALUE = 13001; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 2 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_2_VALUE = 13002; + */ + const ORDER_CUSTOM_FIELD_2_VALUE = 13002; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 3 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_3_VALUE = 13003; + */ + const ORDER_CUSTOM_FIELD_3_VALUE = 13003; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 4 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_4_VALUE = 13004; + */ + const ORDER_CUSTOM_FIELD_4_VALUE = 13004; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 5 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_5_VALUE = 13005; + */ + const ORDER_CUSTOM_FIELD_5_VALUE = 13005; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 6 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_6_VALUE = 13006; + */ + const ORDER_CUSTOM_FIELD_6_VALUE = 13006; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 7 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_7_VALUE = 13007; + */ + const ORDER_CUSTOM_FIELD_7_VALUE = 13007; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 8 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_8_VALUE = 13008; + */ + const ORDER_CUSTOM_FIELD_8_VALUE = 13008; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 9 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_9_VALUE = 13009; + */ + const ORDER_CUSTOM_FIELD_9_VALUE = 13009; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 10 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_10_VALUE = 13010; + */ + const ORDER_CUSTOM_FIELD_10_VALUE = 13010; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 11 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_11_VALUE = 13011; + */ + const ORDER_CUSTOM_FIELD_11_VALUE = 13011; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 12 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_12_VALUE = 13012; + */ + const ORDER_CUSTOM_FIELD_12_VALUE = 13012; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 13 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_13_VALUE = 13013; + */ + const ORDER_CUSTOM_FIELD_13_VALUE = 13013; + /** + * Custom field value for Order with custom field ID equal to the ID + * in index 14 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum ORDER_CUSTOM_FIELD_14_VALUE = 13014; + */ + const ORDER_CUSTOM_FIELD_14_VALUE = 13014; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 0 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_0_OPTION_ID = 14000; + */ + const CREATIVE_CUSTOM_FIELD_0_OPTION_ID = 14000; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 1 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_1_OPTION_ID = 14001; + */ + const CREATIVE_CUSTOM_FIELD_1_OPTION_ID = 14001; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 2 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_2_OPTION_ID = 14002; + */ + const CREATIVE_CUSTOM_FIELD_2_OPTION_ID = 14002; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 3 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_3_OPTION_ID = 14003; + */ + const CREATIVE_CUSTOM_FIELD_3_OPTION_ID = 14003; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 4 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_4_OPTION_ID = 14004; + */ + const CREATIVE_CUSTOM_FIELD_4_OPTION_ID = 14004; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 5 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_5_OPTION_ID = 14005; + */ + const CREATIVE_CUSTOM_FIELD_5_OPTION_ID = 14005; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 6 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_6_OPTION_ID = 14006; + */ + const CREATIVE_CUSTOM_FIELD_6_OPTION_ID = 14006; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 7 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_7_OPTION_ID = 14007; + */ + const CREATIVE_CUSTOM_FIELD_7_OPTION_ID = 14007; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 8 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_8_OPTION_ID = 14008; + */ + const CREATIVE_CUSTOM_FIELD_8_OPTION_ID = 14008; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 9 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_9_OPTION_ID = 14009; + */ + const CREATIVE_CUSTOM_FIELD_9_OPTION_ID = 14009; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 10 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_10_OPTION_ID = 14010; + */ + const CREATIVE_CUSTOM_FIELD_10_OPTION_ID = 14010; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 11 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_11_OPTION_ID = 14011; + */ + const CREATIVE_CUSTOM_FIELD_11_OPTION_ID = 14011; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 12 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_12_OPTION_ID = 14012; + */ + const CREATIVE_CUSTOM_FIELD_12_OPTION_ID = 14012; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 13 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_13_OPTION_ID = 14013; + */ + const CREATIVE_CUSTOM_FIELD_13_OPTION_ID = 14013; + /** + * Custom field option ID for Creative with custom field ID equal to the ID + * in index 14 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_14_OPTION_ID = 14014; + */ + const CREATIVE_CUSTOM_FIELD_14_OPTION_ID = 14014; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 0 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_0_VALUE = 15000; + */ + const CREATIVE_CUSTOM_FIELD_0_VALUE = 15000; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 1 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_1_VALUE = 15001; + */ + const CREATIVE_CUSTOM_FIELD_1_VALUE = 15001; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 2 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_2_VALUE = 15002; + */ + const CREATIVE_CUSTOM_FIELD_2_VALUE = 15002; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 3 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_3_VALUE = 15003; + */ + const CREATIVE_CUSTOM_FIELD_3_VALUE = 15003; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 4 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_4_VALUE = 15004; + */ + const CREATIVE_CUSTOM_FIELD_4_VALUE = 15004; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 5 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_5_VALUE = 15005; + */ + const CREATIVE_CUSTOM_FIELD_5_VALUE = 15005; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 6 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_6_VALUE = 15006; + */ + const CREATIVE_CUSTOM_FIELD_6_VALUE = 15006; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 7 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_7_VALUE = 15007; + */ + const CREATIVE_CUSTOM_FIELD_7_VALUE = 15007; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 8 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_8_VALUE = 15008; + */ + const CREATIVE_CUSTOM_FIELD_8_VALUE = 15008; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 9 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_9_VALUE = 15009; + */ + const CREATIVE_CUSTOM_FIELD_9_VALUE = 15009; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 10 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_10_VALUE = 15010; + */ + const CREATIVE_CUSTOM_FIELD_10_VALUE = 15010; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 11 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_11_VALUE = 15011; + */ + const CREATIVE_CUSTOM_FIELD_11_VALUE = 15011; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 12 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_12_VALUE = 15012; + */ + const CREATIVE_CUSTOM_FIELD_12_VALUE = 15012; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 13 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_13_VALUE = 15013; + */ + const CREATIVE_CUSTOM_FIELD_13_VALUE = 15013; + /** + * Custom field value for Creative with custom field ID equal to the ID + * in index 14 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum CREATIVE_CUSTOM_FIELD_14_VALUE = 15014; + */ + const CREATIVE_CUSTOM_FIELD_14_VALUE = 15014; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 0 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID = 16000; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID = 16000; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 1 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID = 16001; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID = 16001; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 2 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID = 16002; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID = 16002; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 3 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID = 16003; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID = 16003; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 4 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID = 16004; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID = 16004; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 5 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID = 16005; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID = 16005; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 6 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID = 16006; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID = 16006; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 7 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID = 16007; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID = 16007; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 8 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID = 16008; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID = 16008; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 9 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID = 16009; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID = 16009; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 10 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID = 16010; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID = 16010; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 11 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID = 16011; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID = 16011; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 12 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID = 16012; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID = 16012; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 13 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID = 16013; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID = 16013; + /** + * Custom field option ID for Backfill line item with custom field ID equal + * to the ID in index 14 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID = 16014; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID = 16014; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 0 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_VALUE = 17000; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_VALUE = 17000; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 1 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_VALUE = 17001; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_VALUE = 17001; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 2 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_VALUE = 17002; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_VALUE = 17002; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 3 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_VALUE = 17003; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_VALUE = 17003; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 4 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_VALUE = 17004; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_VALUE = 17004; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 5 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_VALUE = 17005; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_VALUE = 17005; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 6 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_VALUE = 17006; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_VALUE = 17006; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 7 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_VALUE = 17007; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_VALUE = 17007; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 8 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_VALUE = 17008; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_VALUE = 17008; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 9 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_VALUE = 17009; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_VALUE = 17009; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 10 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_VALUE = 17010; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_VALUE = 17010; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 11 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_VALUE = 17011; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_VALUE = 17011; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 12 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_VALUE = 17012; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_VALUE = 17012; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 13 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_VALUE = 17013; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_VALUE = 17013; + /** + * Custom field value for Backfill line item with custom field ID equal to + * the ID in index 14 of `ReportDefinition.line_item_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_VALUE = 17014; + */ + const BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_VALUE = 17014; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 0 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_0_OPTION_ID = 18000; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_0_OPTION_ID = 18000; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 1 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_1_OPTION_ID = 18001; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_1_OPTION_ID = 18001; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 2 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_2_OPTION_ID = 18002; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_2_OPTION_ID = 18002; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 3 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_3_OPTION_ID = 18003; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_3_OPTION_ID = 18003; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 4 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_4_OPTION_ID = 18004; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_4_OPTION_ID = 18004; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 5 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_5_OPTION_ID = 18005; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_5_OPTION_ID = 18005; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 6 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_6_OPTION_ID = 18006; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_6_OPTION_ID = 18006; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 7 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_7_OPTION_ID = 18007; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_7_OPTION_ID = 18007; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 8 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_8_OPTION_ID = 18008; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_8_OPTION_ID = 18008; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 9 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_9_OPTION_ID = 18009; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_9_OPTION_ID = 18009; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 10 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_10_OPTION_ID = 18010; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_10_OPTION_ID = 18010; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 11 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_11_OPTION_ID = 18011; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_11_OPTION_ID = 18011; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 12 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_12_OPTION_ID = 18012; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_12_OPTION_ID = 18012; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 13 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_13_OPTION_ID = 18013; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_13_OPTION_ID = 18013; + /** + * Custom field option ID for Backfill order with custom field ID equal to + * the ID in index 14 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_14_OPTION_ID = 18014; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_14_OPTION_ID = 18014; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 0 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_0_VALUE = 19000; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_0_VALUE = 19000; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 1 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_1_VALUE = 19001; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_1_VALUE = 19001; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 2 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_2_VALUE = 19002; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_2_VALUE = 19002; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 3 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_3_VALUE = 19003; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_3_VALUE = 19003; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 4 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_4_VALUE = 19004; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_4_VALUE = 19004; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 5 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_5_VALUE = 19005; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_5_VALUE = 19005; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 6 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_6_VALUE = 19006; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_6_VALUE = 19006; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 7 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_7_VALUE = 19007; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_7_VALUE = 19007; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 8 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_8_VALUE = 19008; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_8_VALUE = 19008; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 9 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_9_VALUE = 19009; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_9_VALUE = 19009; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 10 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_10_VALUE = 19010; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_10_VALUE = 19010; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 11 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_11_VALUE = 19011; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_11_VALUE = 19011; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 12 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_12_VALUE = 19012; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_12_VALUE = 19012; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 13 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_13_VALUE = 19013; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_13_VALUE = 19013; + /** + * Custom field value for Backfill order with custom field ID equal to the + * ID in index 14 of `ReportDefinition.order_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_ORDER_CUSTOM_FIELD_14_VALUE = 19014; + */ + const BACKFILL_ORDER_CUSTOM_FIELD_14_VALUE = 19014; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 0 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_0_OPTION_ID = 20000; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_0_OPTION_ID = 20000; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 1 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_1_OPTION_ID = 20001; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_1_OPTION_ID = 20001; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 2 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_2_OPTION_ID = 20002; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_2_OPTION_ID = 20002; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 3 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_3_OPTION_ID = 20003; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_3_OPTION_ID = 20003; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 4 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_4_OPTION_ID = 20004; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_4_OPTION_ID = 20004; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 5 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_5_OPTION_ID = 20005; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_5_OPTION_ID = 20005; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 6 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_6_OPTION_ID = 20006; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_6_OPTION_ID = 20006; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 7 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_7_OPTION_ID = 20007; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_7_OPTION_ID = 20007; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 8 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_8_OPTION_ID = 20008; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_8_OPTION_ID = 20008; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 9 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_9_OPTION_ID = 20009; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_9_OPTION_ID = 20009; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 10 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_10_OPTION_ID = 20010; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_10_OPTION_ID = 20010; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 11 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_11_OPTION_ID = 20011; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_11_OPTION_ID = 20011; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 12 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_12_OPTION_ID = 20012; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_12_OPTION_ID = 20012; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 13 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_13_OPTION_ID = 20013; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_13_OPTION_ID = 20013; + /** + * Custom field option ID for Backfill creative with custom field ID equal + * to the ID in index 14 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_14_OPTION_ID = 20014; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_14_OPTION_ID = 20014; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 0 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_0_VALUE = 21000; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_0_VALUE = 21000; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 1 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_1_VALUE = 21001; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_1_VALUE = 21001; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 2 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_2_VALUE = 21002; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_2_VALUE = 21002; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 3 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_3_VALUE = 21003; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_3_VALUE = 21003; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 4 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_4_VALUE = 21004; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_4_VALUE = 21004; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 5 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_5_VALUE = 21005; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_5_VALUE = 21005; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 6 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_6_VALUE = 21006; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_6_VALUE = 21006; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 7 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_7_VALUE = 21007; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_7_VALUE = 21007; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 8 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_8_VALUE = 21008; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_8_VALUE = 21008; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 9 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_9_VALUE = 21009; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_9_VALUE = 21009; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 10 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_10_VALUE = 21010; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_10_VALUE = 21010; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 11 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_11_VALUE = 21011; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_11_VALUE = 21011; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 12 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_12_VALUE = 21012; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_12_VALUE = 21012; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 13 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_13_VALUE = 21013; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_13_VALUE = 21013; + /** + * Custom field value for Backfill creative with custom field ID equal to + * the ID in index 14 of `ReportDefinition.creative_custom_field_ids`. + * + * Generated from protobuf enum BACKFILL_CREATIVE_CUSTOM_FIELD_14_VALUE = 21014; + */ + const BACKFILL_CREATIVE_CUSTOM_FIELD_14_VALUE = 21014; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 0 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_0_VALUE_ID = 100000; + */ + const CUSTOM_DIMENSION_0_VALUE_ID = 100000; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 1 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_1_VALUE_ID = 100001; + */ + const CUSTOM_DIMENSION_1_VALUE_ID = 100001; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 2 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_2_VALUE_ID = 100002; + */ + const CUSTOM_DIMENSION_2_VALUE_ID = 100002; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 3 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_3_VALUE_ID = 100003; + */ + const CUSTOM_DIMENSION_3_VALUE_ID = 100003; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 4 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_4_VALUE_ID = 100004; + */ + const CUSTOM_DIMENSION_4_VALUE_ID = 100004; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 5 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_5_VALUE_ID = 100005; + */ + const CUSTOM_DIMENSION_5_VALUE_ID = 100005; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 6 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_6_VALUE_ID = 100006; + */ + const CUSTOM_DIMENSION_6_VALUE_ID = 100006; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 9 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_7_VALUE_ID = 100007; + */ + const CUSTOM_DIMENSION_7_VALUE_ID = 100007; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 8 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_8_VALUE_ID = 100008; + */ + const CUSTOM_DIMENSION_8_VALUE_ID = 100008; + /** + * Custom Dimension Value ID for Custom Dimension with key equal to the key + * in index 9 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_9_VALUE_ID = 100009; + */ + const CUSTOM_DIMENSION_9_VALUE_ID = 100009; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 0 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_0_VALUE = 101000; + */ + const CUSTOM_DIMENSION_0_VALUE = 101000; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 1 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_1_VALUE = 101001; + */ + const CUSTOM_DIMENSION_1_VALUE = 101001; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 2 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_2_VALUE = 101002; + */ + const CUSTOM_DIMENSION_2_VALUE = 101002; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 3 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_3_VALUE = 101003; + */ + const CUSTOM_DIMENSION_3_VALUE = 101003; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 4 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_4_VALUE = 101004; + */ + const CUSTOM_DIMENSION_4_VALUE = 101004; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 5 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_5_VALUE = 101005; + */ + const CUSTOM_DIMENSION_5_VALUE = 101005; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 6 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_6_VALUE = 101006; + */ + const CUSTOM_DIMENSION_6_VALUE = 101006; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 7 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_7_VALUE = 101007; + */ + const CUSTOM_DIMENSION_7_VALUE = 101007; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 8 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_8_VALUE = 101008; + */ + const CUSTOM_DIMENSION_8_VALUE = 101008; + /** + * Custom Dimension Value name for Custom Dimension with key equal to the + * id in index 9 of `ReportDefinition.custom_dimension_key_ids`. + * + * Generated from protobuf enum CUSTOM_DIMENSION_9_VALUE = 101009; + */ + const CUSTOM_DIMENSION_9_VALUE = 101009; + + private static $valueToName = [ + self::DIMENSION_UNSPECIFIED => 'DIMENSION_UNSPECIFIED', + self::ADVERTISER_DOMAIN_NAME => 'ADVERTISER_DOMAIN_NAME', + self::ADVERTISER_EXTERNAL_ID => 'ADVERTISER_EXTERNAL_ID', + self::ADVERTISER_ID => 'ADVERTISER_ID', + self::ADVERTISER_LABELS => 'ADVERTISER_LABELS', + self::ADVERTISER_LABEL_IDS => 'ADVERTISER_LABEL_IDS', + self::ADVERTISER_NAME => 'ADVERTISER_NAME', + self::ADVERTISER_PRIMARY_CONTACT => 'ADVERTISER_PRIMARY_CONTACT', + self::AD_LOCATION => 'AD_LOCATION', + self::AD_LOCATION_NAME => 'AD_LOCATION_NAME', + self::AD_UNIT_CODE => 'AD_UNIT_CODE', + self::AD_UNIT_CODE_LEVEL_1 => 'AD_UNIT_CODE_LEVEL_1', + self::AD_UNIT_CODE_LEVEL_10 => 'AD_UNIT_CODE_LEVEL_10', + self::AD_UNIT_CODE_LEVEL_11 => 'AD_UNIT_CODE_LEVEL_11', + self::AD_UNIT_CODE_LEVEL_12 => 'AD_UNIT_CODE_LEVEL_12', + self::AD_UNIT_CODE_LEVEL_13 => 'AD_UNIT_CODE_LEVEL_13', + self::AD_UNIT_CODE_LEVEL_14 => 'AD_UNIT_CODE_LEVEL_14', + self::AD_UNIT_CODE_LEVEL_15 => 'AD_UNIT_CODE_LEVEL_15', + self::AD_UNIT_CODE_LEVEL_16 => 'AD_UNIT_CODE_LEVEL_16', + self::AD_UNIT_CODE_LEVEL_2 => 'AD_UNIT_CODE_LEVEL_2', + self::AD_UNIT_CODE_LEVEL_3 => 'AD_UNIT_CODE_LEVEL_3', + self::AD_UNIT_CODE_LEVEL_4 => 'AD_UNIT_CODE_LEVEL_4', + self::AD_UNIT_CODE_LEVEL_5 => 'AD_UNIT_CODE_LEVEL_5', + self::AD_UNIT_CODE_LEVEL_6 => 'AD_UNIT_CODE_LEVEL_6', + self::AD_UNIT_CODE_LEVEL_7 => 'AD_UNIT_CODE_LEVEL_7', + self::AD_UNIT_CODE_LEVEL_8 => 'AD_UNIT_CODE_LEVEL_8', + self::AD_UNIT_CODE_LEVEL_9 => 'AD_UNIT_CODE_LEVEL_9', + self::AD_UNIT_DEPTH => 'AD_UNIT_DEPTH', + self::AD_UNIT_ID => 'AD_UNIT_ID', + self::AD_UNIT_ID_ALL_LEVEL => 'AD_UNIT_ID_ALL_LEVEL', + self::AD_UNIT_ID_LEVEL_1 => 'AD_UNIT_ID_LEVEL_1', + self::AD_UNIT_ID_LEVEL_10 => 'AD_UNIT_ID_LEVEL_10', + self::AD_UNIT_ID_LEVEL_11 => 'AD_UNIT_ID_LEVEL_11', + self::AD_UNIT_ID_LEVEL_12 => 'AD_UNIT_ID_LEVEL_12', + self::AD_UNIT_ID_LEVEL_13 => 'AD_UNIT_ID_LEVEL_13', + self::AD_UNIT_ID_LEVEL_14 => 'AD_UNIT_ID_LEVEL_14', + self::AD_UNIT_ID_LEVEL_15 => 'AD_UNIT_ID_LEVEL_15', + self::AD_UNIT_ID_LEVEL_16 => 'AD_UNIT_ID_LEVEL_16', + self::AD_UNIT_ID_LEVEL_2 => 'AD_UNIT_ID_LEVEL_2', + self::AD_UNIT_ID_LEVEL_3 => 'AD_UNIT_ID_LEVEL_3', + self::AD_UNIT_ID_LEVEL_4 => 'AD_UNIT_ID_LEVEL_4', + self::AD_UNIT_ID_LEVEL_5 => 'AD_UNIT_ID_LEVEL_5', + self::AD_UNIT_ID_LEVEL_6 => 'AD_UNIT_ID_LEVEL_6', + self::AD_UNIT_ID_LEVEL_7 => 'AD_UNIT_ID_LEVEL_7', + self::AD_UNIT_ID_LEVEL_8 => 'AD_UNIT_ID_LEVEL_8', + self::AD_UNIT_ID_LEVEL_9 => 'AD_UNIT_ID_LEVEL_9', + self::AD_UNIT_ID_TOP_LEVEL => 'AD_UNIT_ID_TOP_LEVEL', + self::AD_UNIT_NAME => 'AD_UNIT_NAME', + self::AD_UNIT_NAME_ALL_LEVEL => 'AD_UNIT_NAME_ALL_LEVEL', + self::AD_UNIT_NAME_LEVEL_1 => 'AD_UNIT_NAME_LEVEL_1', + self::AD_UNIT_NAME_LEVEL_10 => 'AD_UNIT_NAME_LEVEL_10', + self::AD_UNIT_NAME_LEVEL_11 => 'AD_UNIT_NAME_LEVEL_11', + self::AD_UNIT_NAME_LEVEL_12 => 'AD_UNIT_NAME_LEVEL_12', + self::AD_UNIT_NAME_LEVEL_13 => 'AD_UNIT_NAME_LEVEL_13', + self::AD_UNIT_NAME_LEVEL_14 => 'AD_UNIT_NAME_LEVEL_14', + self::AD_UNIT_NAME_LEVEL_15 => 'AD_UNIT_NAME_LEVEL_15', + self::AD_UNIT_NAME_LEVEL_16 => 'AD_UNIT_NAME_LEVEL_16', + self::AD_UNIT_NAME_LEVEL_2 => 'AD_UNIT_NAME_LEVEL_2', + self::AD_UNIT_NAME_LEVEL_3 => 'AD_UNIT_NAME_LEVEL_3', + self::AD_UNIT_NAME_LEVEL_4 => 'AD_UNIT_NAME_LEVEL_4', + self::AD_UNIT_NAME_LEVEL_5 => 'AD_UNIT_NAME_LEVEL_5', + self::AD_UNIT_NAME_LEVEL_6 => 'AD_UNIT_NAME_LEVEL_6', + self::AD_UNIT_NAME_LEVEL_7 => 'AD_UNIT_NAME_LEVEL_7', + self::AD_UNIT_NAME_LEVEL_8 => 'AD_UNIT_NAME_LEVEL_8', + self::AD_UNIT_NAME_LEVEL_9 => 'AD_UNIT_NAME_LEVEL_9', + self::AD_UNIT_NAME_TOP_LEVEL => 'AD_UNIT_NAME_TOP_LEVEL', + self::AD_UNIT_REWARD_AMOUNT => 'AD_UNIT_REWARD_AMOUNT', + self::AD_UNIT_REWARD_TYPE => 'AD_UNIT_REWARD_TYPE', + self::AD_UNIT_STATUS => 'AD_UNIT_STATUS', + self::AD_UNIT_STATUS_NAME => 'AD_UNIT_STATUS_NAME', + self::APP_VERSION => 'APP_VERSION', + self::BACKFILL_ADVERTISER_EXTERNAL_ID => 'BACKFILL_ADVERTISER_EXTERNAL_ID', + self::BACKFILL_ADVERTISER_ID => 'BACKFILL_ADVERTISER_ID', + self::BACKFILL_ADVERTISER_LABELS => 'BACKFILL_ADVERTISER_LABELS', + self::BACKFILL_ADVERTISER_LABEL_IDS => 'BACKFILL_ADVERTISER_LABEL_IDS', + self::BACKFILL_ADVERTISER_NAME => 'BACKFILL_ADVERTISER_NAME', + self::BACKFILL_ADVERTISER_PRIMARY_CONTACT => 'BACKFILL_ADVERTISER_PRIMARY_CONTACT', + self::BACKFILL_CREATIVE_BILLING_TYPE => 'BACKFILL_CREATIVE_BILLING_TYPE', + self::BACKFILL_CREATIVE_BILLING_TYPE_NAME => 'BACKFILL_CREATIVE_BILLING_TYPE_NAME', + self::BACKFILL_CREATIVE_CLICK_THROUGH_URL => 'BACKFILL_CREATIVE_CLICK_THROUGH_URL', + self::BACKFILL_CREATIVE_ID => 'BACKFILL_CREATIVE_ID', + self::BACKFILL_CREATIVE_NAME => 'BACKFILL_CREATIVE_NAME', + self::BACKFILL_CREATIVE_THIRD_PARTY_VENDOR => 'BACKFILL_CREATIVE_THIRD_PARTY_VENDOR', + self::BACKFILL_CREATIVE_TYPE => 'BACKFILL_CREATIVE_TYPE', + self::BACKFILL_CREATIVE_TYPE_NAME => 'BACKFILL_CREATIVE_TYPE_NAME', + self::BACKFILL_LINE_ITEM_ARCHIVED => 'BACKFILL_LINE_ITEM_ARCHIVED', + self::BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION => 'BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION', + self::BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME => 'BACKFILL_LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME', + self::BACKFILL_LINE_ITEM_COMPUTED_STATUS => 'BACKFILL_LINE_ITEM_COMPUTED_STATUS', + self::BACKFILL_LINE_ITEM_COMPUTED_STATUS_NAME => 'BACKFILL_LINE_ITEM_COMPUTED_STATUS_NAME', + self::BACKFILL_LINE_ITEM_CONTRACTED_QUANTITY => 'BACKFILL_LINE_ITEM_CONTRACTED_QUANTITY', + self::BACKFILL_LINE_ITEM_COST_PER_UNIT => 'BACKFILL_LINE_ITEM_COST_PER_UNIT', + self::BACKFILL_LINE_ITEM_COST_TYPE => 'BACKFILL_LINE_ITEM_COST_TYPE', + self::BACKFILL_LINE_ITEM_COST_TYPE_NAME => 'BACKFILL_LINE_ITEM_COST_TYPE_NAME', + self::BACKFILL_LINE_ITEM_CREATIVE_END_DATE => 'BACKFILL_LINE_ITEM_CREATIVE_END_DATE', + self::BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE => 'BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE', + self::BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME => 'BACKFILL_LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME', + self::BACKFILL_LINE_ITEM_CREATIVE_START_DATE => 'BACKFILL_LINE_ITEM_CREATIVE_START_DATE', + self::BACKFILL_LINE_ITEM_CURRENCY_CODE => 'BACKFILL_LINE_ITEM_CURRENCY_CODE', + self::BACKFILL_LINE_ITEM_DELIVERY_INDICATOR => 'BACKFILL_LINE_ITEM_DELIVERY_INDICATOR', + self::BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE => 'BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE', + self::BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE_NAME => 'BACKFILL_LINE_ITEM_DELIVERY_RATE_TYPE_NAME', + self::BACKFILL_LINE_ITEM_DISCOUNT_ABSOLUTE => 'BACKFILL_LINE_ITEM_DISCOUNT_ABSOLUTE', + self::BACKFILL_LINE_ITEM_DISCOUNT_PERCENTAGE => 'BACKFILL_LINE_ITEM_DISCOUNT_PERCENTAGE', + self::BACKFILL_LINE_ITEM_END_DATE => 'BACKFILL_LINE_ITEM_END_DATE', + self::BACKFILL_LINE_ITEM_END_DATE_TIME => 'BACKFILL_LINE_ITEM_END_DATE_TIME', + self::BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE => 'BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE', + self::BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE_NAME => 'BACKFILL_LINE_ITEM_ENVIRONMENT_TYPE_NAME', + self::BACKFILL_LINE_ITEM_EXTERNAL_DEAL_ID => 'BACKFILL_LINE_ITEM_EXTERNAL_DEAL_ID', + self::BACKFILL_LINE_ITEM_EXTERNAL_ID => 'BACKFILL_LINE_ITEM_EXTERNAL_ID', + self::BACKFILL_LINE_ITEM_FREQUENCY_CAP => 'BACKFILL_LINE_ITEM_FREQUENCY_CAP', + self::BACKFILL_LINE_ITEM_ID => 'BACKFILL_LINE_ITEM_ID', + self::BACKFILL_LINE_ITEM_LAST_MODIFIED_BY_APP => 'BACKFILL_LINE_ITEM_LAST_MODIFIED_BY_APP', + self::BACKFILL_LINE_ITEM_LIFETIME_CLICKS => 'BACKFILL_LINE_ITEM_LIFETIME_CLICKS', + self::BACKFILL_LINE_ITEM_LIFETIME_IMPRESSIONS => 'BACKFILL_LINE_ITEM_LIFETIME_IMPRESSIONS', + self::BACKFILL_LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS => 'BACKFILL_LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS', + self::BACKFILL_LINE_ITEM_MAKEGOOD => 'BACKFILL_LINE_ITEM_MAKEGOOD', + self::BACKFILL_LINE_ITEM_NAME => 'BACKFILL_LINE_ITEM_NAME', + self::BACKFILL_LINE_ITEM_NON_CPD_BOOKED_REVENUE => 'BACKFILL_LINE_ITEM_NON_CPD_BOOKED_REVENUE', + self::BACKFILL_LINE_ITEM_OPTIMIZABLE => 'BACKFILL_LINE_ITEM_OPTIMIZABLE', + self::BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE => 'BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE', + self::BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE_NAME => 'BACKFILL_LINE_ITEM_PRIMARY_GOAL_TYPE_NAME', + self::BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE => 'BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE', + self::BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME => 'BACKFILL_LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME', + self::BACKFILL_LINE_ITEM_PRIORITY => 'BACKFILL_LINE_ITEM_PRIORITY', + self::BACKFILL_LINE_ITEM_RESERVATION_STATUS => 'BACKFILL_LINE_ITEM_RESERVATION_STATUS', + self::BACKFILL_LINE_ITEM_RESERVATION_STATUS_NAME => 'BACKFILL_LINE_ITEM_RESERVATION_STATUS_NAME', + self::BACKFILL_LINE_ITEM_START_DATE => 'BACKFILL_LINE_ITEM_START_DATE', + self::BACKFILL_LINE_ITEM_START_DATE_TIME => 'BACKFILL_LINE_ITEM_START_DATE_TIME', + self::BACKFILL_LINE_ITEM_TYPE => 'BACKFILL_LINE_ITEM_TYPE', + self::BACKFILL_LINE_ITEM_TYPE_NAME => 'BACKFILL_LINE_ITEM_TYPE_NAME', + self::BACKFILL_LINE_ITEM_UNLIMITED_END => 'BACKFILL_LINE_ITEM_UNLIMITED_END', + self::BACKFILL_LINE_ITEM_VALUE_COST_PER_UNIT => 'BACKFILL_LINE_ITEM_VALUE_COST_PER_UNIT', + self::BACKFILL_LINE_ITEM_WEB_PROPERTY_CODE => 'BACKFILL_LINE_ITEM_WEB_PROPERTY_CODE', + self::BACKFILL_MASTER_COMPANION_CREATIVE_ID => 'BACKFILL_MASTER_COMPANION_CREATIVE_ID', + self::BACKFILL_MASTER_COMPANION_CREATIVE_NAME => 'BACKFILL_MASTER_COMPANION_CREATIVE_NAME', + self::BACKFILL_ORDER_AGENCY => 'BACKFILL_ORDER_AGENCY', + self::BACKFILL_ORDER_AGENCY_ID => 'BACKFILL_ORDER_AGENCY_ID', + self::BACKFILL_ORDER_BOOKED_CPC => 'BACKFILL_ORDER_BOOKED_CPC', + self::BACKFILL_ORDER_BOOKED_CPM => 'BACKFILL_ORDER_BOOKED_CPM', + self::BACKFILL_ORDER_DELIVERY_STATUS => 'BACKFILL_ORDER_DELIVERY_STATUS', + self::BACKFILL_ORDER_DELIVERY_STATUS_NAME => 'BACKFILL_ORDER_DELIVERY_STATUS_NAME', + self::BACKFILL_ORDER_END_DATE => 'BACKFILL_ORDER_END_DATE', + self::BACKFILL_ORDER_END_DATE_TIME => 'BACKFILL_ORDER_END_DATE_TIME', + self::BACKFILL_ORDER_EXTERNAL_ID => 'BACKFILL_ORDER_EXTERNAL_ID', + self::BACKFILL_ORDER_ID => 'BACKFILL_ORDER_ID', + self::BACKFILL_ORDER_LABELS => 'BACKFILL_ORDER_LABELS', + self::BACKFILL_ORDER_LABEL_IDS => 'BACKFILL_ORDER_LABEL_IDS', + self::BACKFILL_ORDER_LIFETIME_CLICKS => 'BACKFILL_ORDER_LIFETIME_CLICKS', + self::BACKFILL_ORDER_LIFETIME_IMPRESSIONS => 'BACKFILL_ORDER_LIFETIME_IMPRESSIONS', + self::BACKFILL_ORDER_NAME => 'BACKFILL_ORDER_NAME', + self::BACKFILL_ORDER_PO_NUMBER => 'BACKFILL_ORDER_PO_NUMBER', + self::BACKFILL_ORDER_PROGRAMMATIC => 'BACKFILL_ORDER_PROGRAMMATIC', + self::BACKFILL_ORDER_SALESPERSON => 'BACKFILL_ORDER_SALESPERSON', + self::BACKFILL_ORDER_SECONDARY_SALESPEOPLE => 'BACKFILL_ORDER_SECONDARY_SALESPEOPLE', + self::BACKFILL_ORDER_SECONDARY_SALESPEOPLE_ID => 'BACKFILL_ORDER_SECONDARY_SALESPEOPLE_ID', + self::BACKFILL_ORDER_SECONDARY_TRAFFICKERS => 'BACKFILL_ORDER_SECONDARY_TRAFFICKERS', + self::BACKFILL_ORDER_SECONDARY_TRAFFICKERS_ID => 'BACKFILL_ORDER_SECONDARY_TRAFFICKERS_ID', + self::BACKFILL_ORDER_START_DATE => 'BACKFILL_ORDER_START_DATE', + self::BACKFILL_ORDER_START_DATE_TIME => 'BACKFILL_ORDER_START_DATE_TIME', + self::BACKFILL_ORDER_TRAFFICKER => 'BACKFILL_ORDER_TRAFFICKER', + self::BACKFILL_ORDER_TRAFFICKER_ID => 'BACKFILL_ORDER_TRAFFICKER_ID', + self::BACKFILL_ORDER_UNLIMITED_END => 'BACKFILL_ORDER_UNLIMITED_END', + self::BACKFILL_PROGRAMMATIC_BUYER_ID => 'BACKFILL_PROGRAMMATIC_BUYER_ID', + self::BACKFILL_PROGRAMMATIC_BUYER_NAME => 'BACKFILL_PROGRAMMATIC_BUYER_NAME', + self::BRANDING_TYPE => 'BRANDING_TYPE', + self::BRANDING_TYPE_NAME => 'BRANDING_TYPE_NAME', + self::BROWSER_CATEGORY => 'BROWSER_CATEGORY', + self::BROWSER_CATEGORY_NAME => 'BROWSER_CATEGORY_NAME', + self::BROWSER_ID => 'BROWSER_ID', + self::BROWSER_NAME => 'BROWSER_NAME', + self::CARRIER_ID => 'CARRIER_ID', + self::CARRIER_NAME => 'CARRIER_NAME', + self::CLASSIFIED_ADVERTISER_ID => 'CLASSIFIED_ADVERTISER_ID', + self::CLASSIFIED_ADVERTISER_NAME => 'CLASSIFIED_ADVERTISER_NAME', + self::CLASSIFIED_BRAND_ID => 'CLASSIFIED_BRAND_ID', + self::CLASSIFIED_BRAND_NAME => 'CLASSIFIED_BRAND_NAME', + self::CONTENT_ID => 'CONTENT_ID', + self::CONTENT_NAME => 'CONTENT_NAME', + self::COUNTRY_ID => 'COUNTRY_ID', + self::COUNTRY_NAME => 'COUNTRY_NAME', + self::CREATIVE_BILLING_TYPE => 'CREATIVE_BILLING_TYPE', + self::CREATIVE_BILLING_TYPE_NAME => 'CREATIVE_BILLING_TYPE_NAME', + self::CREATIVE_CLICK_THROUGH_URL => 'CREATIVE_CLICK_THROUGH_URL', + self::CREATIVE_ID => 'CREATIVE_ID', + self::CREATIVE_NAME => 'CREATIVE_NAME', + self::CREATIVE_TECHNOLOGY => 'CREATIVE_TECHNOLOGY', + self::CREATIVE_TECHNOLOGY_NAME => 'CREATIVE_TECHNOLOGY_NAME', + self::CREATIVE_THIRD_PARTY_VENDOR => 'CREATIVE_THIRD_PARTY_VENDOR', + self::CREATIVE_TYPE => 'CREATIVE_TYPE', + self::CREATIVE_TYPE_NAME => 'CREATIVE_TYPE_NAME', + self::DATE => 'DATE', + self::DAY_OF_WEEK => 'DAY_OF_WEEK', + self::DEMAND_CHANNEL => 'DEMAND_CHANNEL', + self::DEMAND_CHANNEL_NAME => 'DEMAND_CHANNEL_NAME', + self::DEMAND_SUBCHANNEL => 'DEMAND_SUBCHANNEL', + self::DEMAND_SUBCHANNEL_NAME => 'DEMAND_SUBCHANNEL_NAME', + self::DEVICE => 'DEVICE', + self::DEVICE_CATEGORY => 'DEVICE_CATEGORY', + self::DEVICE_CATEGORY_NAME => 'DEVICE_CATEGORY_NAME', + self::DEVICE_NAME => 'DEVICE_NAME', + self::EXCHANGE_THIRD_PARTY_COMPANY_ID => 'EXCHANGE_THIRD_PARTY_COMPANY_ID', + self::EXCHANGE_THIRD_PARTY_COMPANY_NAME => 'EXCHANGE_THIRD_PARTY_COMPANY_NAME', + self::FIRST_LOOK_PRICING_RULE_ID => 'FIRST_LOOK_PRICING_RULE_ID', + self::FIRST_LOOK_PRICING_RULE_NAME => 'FIRST_LOOK_PRICING_RULE_NAME', + self::HOUR => 'HOUR', + self::INTERACTION_TYPE => 'INTERACTION_TYPE', + self::INTERACTION_TYPE_NAME => 'INTERACTION_TYPE_NAME', + self::INVENTORY_FORMAT => 'INVENTORY_FORMAT', + self::INVENTORY_FORMAT_NAME => 'INVENTORY_FORMAT_NAME', + self::INVENTORY_TYPE => 'INVENTORY_TYPE', + self::INVENTORY_TYPE_NAME => 'INVENTORY_TYPE_NAME', + self::IS_ADX_DIRECT => 'IS_ADX_DIRECT', + self::IS_FIRST_LOOK_DEAL => 'IS_FIRST_LOOK_DEAL', + self::KEY_VALUES_ID => 'KEY_VALUES_ID', + self::KEY_VALUES_NAME => 'KEY_VALUES_NAME', + self::LINE_ITEM_ARCHIVED => 'LINE_ITEM_ARCHIVED', + self::LINE_ITEM_COMPANION_DELIVERY_OPTION => 'LINE_ITEM_COMPANION_DELIVERY_OPTION', + self::LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME => 'LINE_ITEM_COMPANION_DELIVERY_OPTION_NAME', + self::LINE_ITEM_COMPUTED_STATUS => 'LINE_ITEM_COMPUTED_STATUS', + self::LINE_ITEM_COMPUTED_STATUS_NAME => 'LINE_ITEM_COMPUTED_STATUS_NAME', + self::LINE_ITEM_CONTRACTED_QUANTITY => 'LINE_ITEM_CONTRACTED_QUANTITY', + self::LINE_ITEM_COST_PER_UNIT => 'LINE_ITEM_COST_PER_UNIT', + self::LINE_ITEM_COST_TYPE => 'LINE_ITEM_COST_TYPE', + self::LINE_ITEM_COST_TYPE_NAME => 'LINE_ITEM_COST_TYPE_NAME', + self::LINE_ITEM_CREATIVE_END_DATE => 'LINE_ITEM_CREATIVE_END_DATE', + self::LINE_ITEM_CREATIVE_ROTATION_TYPE => 'LINE_ITEM_CREATIVE_ROTATION_TYPE', + self::LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME => 'LINE_ITEM_CREATIVE_ROTATION_TYPE_NAME', + self::LINE_ITEM_CREATIVE_START_DATE => 'LINE_ITEM_CREATIVE_START_DATE', + self::LINE_ITEM_CURRENCY_CODE => 'LINE_ITEM_CURRENCY_CODE', + self::LINE_ITEM_DELIVERY_INDICATOR => 'LINE_ITEM_DELIVERY_INDICATOR', + self::LINE_ITEM_DELIVERY_RATE_TYPE => 'LINE_ITEM_DELIVERY_RATE_TYPE', + self::LINE_ITEM_DELIVERY_RATE_TYPE_NAME => 'LINE_ITEM_DELIVERY_RATE_TYPE_NAME', + self::LINE_ITEM_DISCOUNT_ABSOLUTE => 'LINE_ITEM_DISCOUNT_ABSOLUTE', + self::LINE_ITEM_DISCOUNT_PERCENTAGE => 'LINE_ITEM_DISCOUNT_PERCENTAGE', + self::LINE_ITEM_END_DATE => 'LINE_ITEM_END_DATE', + self::LINE_ITEM_END_DATE_TIME => 'LINE_ITEM_END_DATE_TIME', + self::LINE_ITEM_ENVIRONMENT_TYPE => 'LINE_ITEM_ENVIRONMENT_TYPE', + self::LINE_ITEM_ENVIRONMENT_TYPE_NAME => 'LINE_ITEM_ENVIRONMENT_TYPE_NAME', + self::LINE_ITEM_EXTERNAL_DEAL_ID => 'LINE_ITEM_EXTERNAL_DEAL_ID', + self::LINE_ITEM_EXTERNAL_ID => 'LINE_ITEM_EXTERNAL_ID', + self::LINE_ITEM_FREQUENCY_CAP => 'LINE_ITEM_FREQUENCY_CAP', + self::LINE_ITEM_ID => 'LINE_ITEM_ID', + self::LINE_ITEM_LAST_MODIFIED_BY_APP => 'LINE_ITEM_LAST_MODIFIED_BY_APP', + self::LINE_ITEM_LIFETIME_CLICKS => 'LINE_ITEM_LIFETIME_CLICKS', + self::LINE_ITEM_LIFETIME_IMPRESSIONS => 'LINE_ITEM_LIFETIME_IMPRESSIONS', + self::LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS => 'LINE_ITEM_LIFETIME_VIEWABLE_IMPRESSIONS', + self::LINE_ITEM_MAKEGOOD => 'LINE_ITEM_MAKEGOOD', + self::LINE_ITEM_NAME => 'LINE_ITEM_NAME', + self::LINE_ITEM_NON_CPD_BOOKED_REVENUE => 'LINE_ITEM_NON_CPD_BOOKED_REVENUE', + self::LINE_ITEM_OPTIMIZABLE => 'LINE_ITEM_OPTIMIZABLE', + self::LINE_ITEM_PRIMARY_GOAL_TYPE => 'LINE_ITEM_PRIMARY_GOAL_TYPE', + self::LINE_ITEM_PRIMARY_GOAL_TYPE_NAME => 'LINE_ITEM_PRIMARY_GOAL_TYPE_NAME', + self::LINE_ITEM_PRIMARY_GOAL_UNITS_ABSOLUTE => 'LINE_ITEM_PRIMARY_GOAL_UNITS_ABSOLUTE', + self::LINE_ITEM_PRIMARY_GOAL_UNITS_PERCENTAGE => 'LINE_ITEM_PRIMARY_GOAL_UNITS_PERCENTAGE', + self::LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE => 'LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE', + self::LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME => 'LINE_ITEM_PRIMARY_GOAL_UNIT_TYPE_NAME', + self::LINE_ITEM_PRIORITY => 'LINE_ITEM_PRIORITY', + self::LINE_ITEM_RESERVATION_STATUS => 'LINE_ITEM_RESERVATION_STATUS', + self::LINE_ITEM_RESERVATION_STATUS_NAME => 'LINE_ITEM_RESERVATION_STATUS_NAME', + self::LINE_ITEM_START_DATE => 'LINE_ITEM_START_DATE', + self::LINE_ITEM_START_DATE_TIME => 'LINE_ITEM_START_DATE_TIME', + self::LINE_ITEM_TYPE => 'LINE_ITEM_TYPE', + self::LINE_ITEM_TYPE_NAME => 'LINE_ITEM_TYPE_NAME', + self::LINE_ITEM_UNLIMITED_END => 'LINE_ITEM_UNLIMITED_END', + self::LINE_ITEM_VALUE_COST_PER_UNIT => 'LINE_ITEM_VALUE_COST_PER_UNIT', + self::LINE_ITEM_WEB_PROPERTY_CODE => 'LINE_ITEM_WEB_PROPERTY_CODE', + self::MASTER_COMPANION_CREATIVE_ID => 'MASTER_COMPANION_CREATIVE_ID', + self::MASTER_COMPANION_CREATIVE_NAME => 'MASTER_COMPANION_CREATIVE_NAME', + self::MOBILE_APP_FREE => 'MOBILE_APP_FREE', + self::MOBILE_APP_ICON_URL => 'MOBILE_APP_ICON_URL', + self::MOBILE_APP_ID => 'MOBILE_APP_ID', + self::MOBILE_APP_NAME => 'MOBILE_APP_NAME', + self::MOBILE_APP_OWNERSHIP_STATUS => 'MOBILE_APP_OWNERSHIP_STATUS', + self::MOBILE_APP_OWNERSHIP_STATUS_NAME => 'MOBILE_APP_OWNERSHIP_STATUS_NAME', + self::MOBILE_APP_STORE => 'MOBILE_APP_STORE', + self::MOBILE_APP_STORE_NAME => 'MOBILE_APP_STORE_NAME', + self::MOBILE_INVENTORY_TYPE => 'MOBILE_INVENTORY_TYPE', + self::MOBILE_INVENTORY_TYPE_NAME => 'MOBILE_INVENTORY_TYPE_NAME', + self::MOBILE_SDK_VERSION_NAME => 'MOBILE_SDK_VERSION_NAME', + self::MONTH_YEAR => 'MONTH_YEAR', + self::NATIVE_AD_FORMAT_ID => 'NATIVE_AD_FORMAT_ID', + self::NATIVE_AD_FORMAT_NAME => 'NATIVE_AD_FORMAT_NAME', + self::NATIVE_STYLE_ID => 'NATIVE_STYLE_ID', + self::NATIVE_STYLE_NAME => 'NATIVE_STYLE_NAME', + self::OPERATING_SYSTEM_CATEGORY => 'OPERATING_SYSTEM_CATEGORY', + self::OPERATING_SYSTEM_CATEGORY_NAME => 'OPERATING_SYSTEM_CATEGORY_NAME', + self::OPERATING_SYSTEM_VERSION_ID => 'OPERATING_SYSTEM_VERSION_ID', + self::OPERATING_SYSTEM_VERSION_NAME => 'OPERATING_SYSTEM_VERSION_NAME', + self::ORDER_AGENCY => 'ORDER_AGENCY', + self::ORDER_AGENCY_ID => 'ORDER_AGENCY_ID', + self::ORDER_BOOKED_CPC => 'ORDER_BOOKED_CPC', + self::ORDER_BOOKED_CPM => 'ORDER_BOOKED_CPM', + self::ORDER_DELIVERY_STATUS => 'ORDER_DELIVERY_STATUS', + self::ORDER_DELIVERY_STATUS_NAME => 'ORDER_DELIVERY_STATUS_NAME', + self::ORDER_END_DATE => 'ORDER_END_DATE', + self::ORDER_END_DATE_TIME => 'ORDER_END_DATE_TIME', + self::ORDER_EXTERNAL_ID => 'ORDER_EXTERNAL_ID', + self::ORDER_ID => 'ORDER_ID', + self::ORDER_LABELS => 'ORDER_LABELS', + self::ORDER_LABEL_IDS => 'ORDER_LABEL_IDS', + self::ORDER_LIFETIME_CLICKS => 'ORDER_LIFETIME_CLICKS', + self::ORDER_LIFETIME_IMPRESSIONS => 'ORDER_LIFETIME_IMPRESSIONS', + self::ORDER_NAME => 'ORDER_NAME', + self::ORDER_PO_NUMBER => 'ORDER_PO_NUMBER', + self::ORDER_PROGRAMMATIC => 'ORDER_PROGRAMMATIC', + self::ORDER_SALESPERSON => 'ORDER_SALESPERSON', + self::ORDER_SECONDARY_SALESPEOPLE => 'ORDER_SECONDARY_SALESPEOPLE', + self::ORDER_SECONDARY_SALESPEOPLE_ID => 'ORDER_SECONDARY_SALESPEOPLE_ID', + self::ORDER_SECONDARY_TRAFFICKERS => 'ORDER_SECONDARY_TRAFFICKERS', + self::ORDER_SECONDARY_TRAFFICKERS_ID => 'ORDER_SECONDARY_TRAFFICKERS_ID', + self::ORDER_START_DATE => 'ORDER_START_DATE', + self::ORDER_START_DATE_TIME => 'ORDER_START_DATE_TIME', + self::ORDER_TRAFFICKER => 'ORDER_TRAFFICKER', + self::ORDER_TRAFFICKER_ID => 'ORDER_TRAFFICKER_ID', + self::ORDER_UNLIMITED_END => 'ORDER_UNLIMITED_END', + self::PLACEMENT_ID => 'PLACEMENT_ID', + self::PLACEMENT_ID_ALL => 'PLACEMENT_ID_ALL', + self::PLACEMENT_NAME => 'PLACEMENT_NAME', + self::PLACEMENT_NAME_ALL => 'PLACEMENT_NAME_ALL', + self::PLACEMENT_STATUS => 'PLACEMENT_STATUS', + self::PLACEMENT_STATUS_ALL => 'PLACEMENT_STATUS_ALL', + self::PLACEMENT_STATUS_NAME => 'PLACEMENT_STATUS_NAME', + self::PLACEMENT_STATUS_NAME_ALL => 'PLACEMENT_STATUS_NAME_ALL', + self::PROGRAMMATIC_BUYER_ID => 'PROGRAMMATIC_BUYER_ID', + self::PROGRAMMATIC_BUYER_NAME => 'PROGRAMMATIC_BUYER_NAME', + self::PROGRAMMATIC_CHANNEL => 'PROGRAMMATIC_CHANNEL', + self::PROGRAMMATIC_CHANNEL_NAME => 'PROGRAMMATIC_CHANNEL_NAME', + self::RENDERED_CREATIVE_SIZE => 'RENDERED_CREATIVE_SIZE', + self::REQUESTED_AD_SIZES => 'REQUESTED_AD_SIZES', + self::REQUEST_TYPE => 'REQUEST_TYPE', + self::REQUEST_TYPE_NAME => 'REQUEST_TYPE_NAME', + self::SITE => 'SITE', + self::TARGETING_ID => 'TARGETING_ID', + self::TARGETING_NAME => 'TARGETING_NAME', + self::TARGETING_TYPE => 'TARGETING_TYPE', + self::TARGETING_TYPE_NAME => 'TARGETING_TYPE_NAME', + self::TRAFFIC_SOURCE => 'TRAFFIC_SOURCE', + self::TRAFFIC_SOURCE_NAME => 'TRAFFIC_SOURCE_NAME', + self::UNIFIED_PRICING_RULE_ID => 'UNIFIED_PRICING_RULE_ID', + self::UNIFIED_PRICING_RULE_NAME => 'UNIFIED_PRICING_RULE_NAME', + self::VIDEO_PLCMT => 'VIDEO_PLCMT', + self::VIDEO_PLCMT_NAME => 'VIDEO_PLCMT_NAME', + self::WEEK => 'WEEK', + self::YIELD_GROUP_BUYER_NAME => 'YIELD_GROUP_BUYER_NAME', + self::YIELD_GROUP_ID => 'YIELD_GROUP_ID', + self::YIELD_GROUP_NAME => 'YIELD_GROUP_NAME', + self::LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID => 'LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID', + self::LINE_ITEM_CUSTOM_FIELD_0_VALUE => 'LINE_ITEM_CUSTOM_FIELD_0_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_1_VALUE => 'LINE_ITEM_CUSTOM_FIELD_1_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_2_VALUE => 'LINE_ITEM_CUSTOM_FIELD_2_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_3_VALUE => 'LINE_ITEM_CUSTOM_FIELD_3_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_4_VALUE => 'LINE_ITEM_CUSTOM_FIELD_4_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_5_VALUE => 'LINE_ITEM_CUSTOM_FIELD_5_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_6_VALUE => 'LINE_ITEM_CUSTOM_FIELD_6_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_7_VALUE => 'LINE_ITEM_CUSTOM_FIELD_7_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_8_VALUE => 'LINE_ITEM_CUSTOM_FIELD_8_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_9_VALUE => 'LINE_ITEM_CUSTOM_FIELD_9_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_10_VALUE => 'LINE_ITEM_CUSTOM_FIELD_10_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_11_VALUE => 'LINE_ITEM_CUSTOM_FIELD_11_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_12_VALUE => 'LINE_ITEM_CUSTOM_FIELD_12_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_13_VALUE => 'LINE_ITEM_CUSTOM_FIELD_13_VALUE', + self::LINE_ITEM_CUSTOM_FIELD_14_VALUE => 'LINE_ITEM_CUSTOM_FIELD_14_VALUE', + self::ORDER_CUSTOM_FIELD_0_OPTION_ID => 'ORDER_CUSTOM_FIELD_0_OPTION_ID', + self::ORDER_CUSTOM_FIELD_1_OPTION_ID => 'ORDER_CUSTOM_FIELD_1_OPTION_ID', + self::ORDER_CUSTOM_FIELD_2_OPTION_ID => 'ORDER_CUSTOM_FIELD_2_OPTION_ID', + self::ORDER_CUSTOM_FIELD_3_OPTION_ID => 'ORDER_CUSTOM_FIELD_3_OPTION_ID', + self::ORDER_CUSTOM_FIELD_4_OPTION_ID => 'ORDER_CUSTOM_FIELD_4_OPTION_ID', + self::ORDER_CUSTOM_FIELD_5_OPTION_ID => 'ORDER_CUSTOM_FIELD_5_OPTION_ID', + self::ORDER_CUSTOM_FIELD_6_OPTION_ID => 'ORDER_CUSTOM_FIELD_6_OPTION_ID', + self::ORDER_CUSTOM_FIELD_7_OPTION_ID => 'ORDER_CUSTOM_FIELD_7_OPTION_ID', + self::ORDER_CUSTOM_FIELD_8_OPTION_ID => 'ORDER_CUSTOM_FIELD_8_OPTION_ID', + self::ORDER_CUSTOM_FIELD_9_OPTION_ID => 'ORDER_CUSTOM_FIELD_9_OPTION_ID', + self::ORDER_CUSTOM_FIELD_10_OPTION_ID => 'ORDER_CUSTOM_FIELD_10_OPTION_ID', + self::ORDER_CUSTOM_FIELD_11_OPTION_ID => 'ORDER_CUSTOM_FIELD_11_OPTION_ID', + self::ORDER_CUSTOM_FIELD_12_OPTION_ID => 'ORDER_CUSTOM_FIELD_12_OPTION_ID', + self::ORDER_CUSTOM_FIELD_13_OPTION_ID => 'ORDER_CUSTOM_FIELD_13_OPTION_ID', + self::ORDER_CUSTOM_FIELD_14_OPTION_ID => 'ORDER_CUSTOM_FIELD_14_OPTION_ID', + self::ORDER_CUSTOM_FIELD_0_VALUE => 'ORDER_CUSTOM_FIELD_0_VALUE', + self::ORDER_CUSTOM_FIELD_1_VALUE => 'ORDER_CUSTOM_FIELD_1_VALUE', + self::ORDER_CUSTOM_FIELD_2_VALUE => 'ORDER_CUSTOM_FIELD_2_VALUE', + self::ORDER_CUSTOM_FIELD_3_VALUE => 'ORDER_CUSTOM_FIELD_3_VALUE', + self::ORDER_CUSTOM_FIELD_4_VALUE => 'ORDER_CUSTOM_FIELD_4_VALUE', + self::ORDER_CUSTOM_FIELD_5_VALUE => 'ORDER_CUSTOM_FIELD_5_VALUE', + self::ORDER_CUSTOM_FIELD_6_VALUE => 'ORDER_CUSTOM_FIELD_6_VALUE', + self::ORDER_CUSTOM_FIELD_7_VALUE => 'ORDER_CUSTOM_FIELD_7_VALUE', + self::ORDER_CUSTOM_FIELD_8_VALUE => 'ORDER_CUSTOM_FIELD_8_VALUE', + self::ORDER_CUSTOM_FIELD_9_VALUE => 'ORDER_CUSTOM_FIELD_9_VALUE', + self::ORDER_CUSTOM_FIELD_10_VALUE => 'ORDER_CUSTOM_FIELD_10_VALUE', + self::ORDER_CUSTOM_FIELD_11_VALUE => 'ORDER_CUSTOM_FIELD_11_VALUE', + self::ORDER_CUSTOM_FIELD_12_VALUE => 'ORDER_CUSTOM_FIELD_12_VALUE', + self::ORDER_CUSTOM_FIELD_13_VALUE => 'ORDER_CUSTOM_FIELD_13_VALUE', + self::ORDER_CUSTOM_FIELD_14_VALUE => 'ORDER_CUSTOM_FIELD_14_VALUE', + self::CREATIVE_CUSTOM_FIELD_0_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_0_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_1_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_1_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_2_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_2_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_3_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_3_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_4_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_4_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_5_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_5_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_6_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_6_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_7_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_7_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_8_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_8_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_9_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_9_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_10_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_10_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_11_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_11_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_12_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_12_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_13_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_13_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_14_OPTION_ID => 'CREATIVE_CUSTOM_FIELD_14_OPTION_ID', + self::CREATIVE_CUSTOM_FIELD_0_VALUE => 'CREATIVE_CUSTOM_FIELD_0_VALUE', + self::CREATIVE_CUSTOM_FIELD_1_VALUE => 'CREATIVE_CUSTOM_FIELD_1_VALUE', + self::CREATIVE_CUSTOM_FIELD_2_VALUE => 'CREATIVE_CUSTOM_FIELD_2_VALUE', + self::CREATIVE_CUSTOM_FIELD_3_VALUE => 'CREATIVE_CUSTOM_FIELD_3_VALUE', + self::CREATIVE_CUSTOM_FIELD_4_VALUE => 'CREATIVE_CUSTOM_FIELD_4_VALUE', + self::CREATIVE_CUSTOM_FIELD_5_VALUE => 'CREATIVE_CUSTOM_FIELD_5_VALUE', + self::CREATIVE_CUSTOM_FIELD_6_VALUE => 'CREATIVE_CUSTOM_FIELD_6_VALUE', + self::CREATIVE_CUSTOM_FIELD_7_VALUE => 'CREATIVE_CUSTOM_FIELD_7_VALUE', + self::CREATIVE_CUSTOM_FIELD_8_VALUE => 'CREATIVE_CUSTOM_FIELD_8_VALUE', + self::CREATIVE_CUSTOM_FIELD_9_VALUE => 'CREATIVE_CUSTOM_FIELD_9_VALUE', + self::CREATIVE_CUSTOM_FIELD_10_VALUE => 'CREATIVE_CUSTOM_FIELD_10_VALUE', + self::CREATIVE_CUSTOM_FIELD_11_VALUE => 'CREATIVE_CUSTOM_FIELD_11_VALUE', + self::CREATIVE_CUSTOM_FIELD_12_VALUE => 'CREATIVE_CUSTOM_FIELD_12_VALUE', + self::CREATIVE_CUSTOM_FIELD_13_VALUE => 'CREATIVE_CUSTOM_FIELD_13_VALUE', + self::CREATIVE_CUSTOM_FIELD_14_VALUE => 'CREATIVE_CUSTOM_FIELD_14_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_OPTION_ID', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_0_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_1_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_2_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_3_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_4_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_5_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_6_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_7_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_8_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_9_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_10_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_11_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_12_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_13_VALUE', + self::BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_VALUE => 'BACKFILL_LINE_ITEM_CUSTOM_FIELD_14_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_0_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_0_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_1_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_1_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_2_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_2_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_3_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_3_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_4_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_4_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_5_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_5_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_6_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_6_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_7_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_7_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_8_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_8_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_9_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_9_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_10_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_10_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_11_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_11_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_12_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_12_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_13_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_13_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_14_OPTION_ID => 'BACKFILL_ORDER_CUSTOM_FIELD_14_OPTION_ID', + self::BACKFILL_ORDER_CUSTOM_FIELD_0_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_0_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_1_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_1_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_2_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_2_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_3_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_3_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_4_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_4_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_5_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_5_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_6_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_6_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_7_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_7_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_8_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_8_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_9_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_9_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_10_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_10_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_11_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_11_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_12_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_12_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_13_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_13_VALUE', + self::BACKFILL_ORDER_CUSTOM_FIELD_14_VALUE => 'BACKFILL_ORDER_CUSTOM_FIELD_14_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_0_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_0_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_1_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_1_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_2_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_2_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_3_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_3_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_4_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_4_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_5_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_5_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_6_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_6_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_7_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_7_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_8_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_8_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_9_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_9_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_10_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_10_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_11_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_11_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_12_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_12_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_13_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_13_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_14_OPTION_ID => 'BACKFILL_CREATIVE_CUSTOM_FIELD_14_OPTION_ID', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_0_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_0_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_1_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_1_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_2_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_2_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_3_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_3_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_4_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_4_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_5_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_5_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_6_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_6_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_7_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_7_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_8_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_8_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_9_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_9_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_10_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_10_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_11_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_11_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_12_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_12_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_13_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_13_VALUE', + self::BACKFILL_CREATIVE_CUSTOM_FIELD_14_VALUE => 'BACKFILL_CREATIVE_CUSTOM_FIELD_14_VALUE', + self::CUSTOM_DIMENSION_0_VALUE_ID => 'CUSTOM_DIMENSION_0_VALUE_ID', + self::CUSTOM_DIMENSION_1_VALUE_ID => 'CUSTOM_DIMENSION_1_VALUE_ID', + self::CUSTOM_DIMENSION_2_VALUE_ID => 'CUSTOM_DIMENSION_2_VALUE_ID', + self::CUSTOM_DIMENSION_3_VALUE_ID => 'CUSTOM_DIMENSION_3_VALUE_ID', + self::CUSTOM_DIMENSION_4_VALUE_ID => 'CUSTOM_DIMENSION_4_VALUE_ID', + self::CUSTOM_DIMENSION_5_VALUE_ID => 'CUSTOM_DIMENSION_5_VALUE_ID', + self::CUSTOM_DIMENSION_6_VALUE_ID => 'CUSTOM_DIMENSION_6_VALUE_ID', + self::CUSTOM_DIMENSION_7_VALUE_ID => 'CUSTOM_DIMENSION_7_VALUE_ID', + self::CUSTOM_DIMENSION_8_VALUE_ID => 'CUSTOM_DIMENSION_8_VALUE_ID', + self::CUSTOM_DIMENSION_9_VALUE_ID => 'CUSTOM_DIMENSION_9_VALUE_ID', + self::CUSTOM_DIMENSION_0_VALUE => 'CUSTOM_DIMENSION_0_VALUE', + self::CUSTOM_DIMENSION_1_VALUE => 'CUSTOM_DIMENSION_1_VALUE', + self::CUSTOM_DIMENSION_2_VALUE => 'CUSTOM_DIMENSION_2_VALUE', + self::CUSTOM_DIMENSION_3_VALUE => 'CUSTOM_DIMENSION_3_VALUE', + self::CUSTOM_DIMENSION_4_VALUE => 'CUSTOM_DIMENSION_4_VALUE', + self::CUSTOM_DIMENSION_5_VALUE => 'CUSTOM_DIMENSION_5_VALUE', + self::CUSTOM_DIMENSION_6_VALUE => 'CUSTOM_DIMENSION_6_VALUE', + self::CUSTOM_DIMENSION_7_VALUE => 'CUSTOM_DIMENSION_7_VALUE', + self::CUSTOM_DIMENSION_8_VALUE => 'CUSTOM_DIMENSION_8_VALUE', + self::CUSTOM_DIMENSION_9_VALUE => 'CUSTOM_DIMENSION_9_VALUE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Report/Field.php b/AdsAdManager/src/V1/Report/Field.php new file mode 100644 index 000000000000..18b4a58903b3 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Field.php @@ -0,0 +1,109 @@ +google.ads.admanager.v1.Report.Field + */ +class Field extends \Google\Protobuf\Internal\Message +{ + protected $field; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $dimension + * The dimension this field represents. + * @type int $metric + * The metric this field represents. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * The dimension this field represents. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Dimension dimension = 1; + * @return int + */ + public function getDimension() + { + return $this->readOneof(1); + } + + public function hasDimension() + { + return $this->hasOneof(1); + } + + /** + * The dimension this field represents. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Dimension dimension = 1; + * @param int $var + * @return $this + */ + public function setDimension($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\Dimension::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * The metric this field represents. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Metric metric = 2; + * @return int + */ + public function getMetric() + { + return $this->readOneof(2); + } + + public function hasMetric() + { + return $this->hasOneof(2); + } + + /** + * The metric this field represents. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Metric metric = 2; + * @param int $var + * @return $this + */ + public function setMetric($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\Metric::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * @return string + */ + public function getField() + { + return $this->whichOneof("field"); + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Filter.php b/AdsAdManager/src/V1/Report/Filter.php new file mode 100644 index 000000000000..15586cbbd0e7 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Filter.php @@ -0,0 +1,175 @@ +google.ads.admanager.v1.Report.Filter + */ +class Filter extends \Google\Protobuf\Internal\Message +{ + protected $type; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\Report\Filter\FieldFilter $field_filter + * A filter on a single field. + * @type \Google\Ads\AdManager\V1\Report\Filter $not_filter + * A filter whose result is negated. + * @type \Google\Ads\AdManager\V1\Report\Filter\FilterList $and_filter + * A list of filters whose results are AND-ed. + * @type \Google\Ads\AdManager\V1\Report\Filter\FilterList $or_filter + * A list of filters whose results are OR-ed. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * A filter on a single field. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.FieldFilter field_filter = 1; + * @return \Google\Ads\AdManager\V1\Report\Filter\FieldFilter|null + */ + public function getFieldFilter() + { + return $this->readOneof(1); + } + + public function hasFieldFilter() + { + return $this->hasOneof(1); + } + + /** + * A filter on a single field. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.FieldFilter field_filter = 1; + * @param \Google\Ads\AdManager\V1\Report\Filter\FieldFilter $var + * @return $this + */ + public function setFieldFilter($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Filter\FieldFilter::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * A filter whose result is negated. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter not_filter = 2; + * @return \Google\Ads\AdManager\V1\Report\Filter|null + */ + public function getNotFilter() + { + return $this->readOneof(2); + } + + public function hasNotFilter() + { + return $this->hasOneof(2); + } + + /** + * A filter whose result is negated. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter not_filter = 2; + * @param \Google\Ads\AdManager\V1\Report\Filter $var + * @return $this + */ + public function setNotFilter($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Filter::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * A list of filters whose results are AND-ed. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.FilterList and_filter = 3; + * @return \Google\Ads\AdManager\V1\Report\Filter\FilterList|null + */ + public function getAndFilter() + { + return $this->readOneof(3); + } + + public function hasAndFilter() + { + return $this->hasOneof(3); + } + + /** + * A list of filters whose results are AND-ed. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.FilterList and_filter = 3; + * @param \Google\Ads\AdManager\V1\Report\Filter\FilterList $var + * @return $this + */ + public function setAndFilter($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Filter\FilterList::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * A list of filters whose results are OR-ed. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.FilterList or_filter = 4; + * @return \Google\Ads\AdManager\V1\Report\Filter\FilterList|null + */ + public function getOrFilter() + { + return $this->readOneof(4); + } + + public function hasOrFilter() + { + return $this->hasOneof(4); + } + + /** + * A list of filters whose results are OR-ed. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.FilterList or_filter = 4; + * @param \Google\Ads\AdManager\V1\Report\Filter\FilterList $var + * @return $this + */ + public function setOrFilter($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Filter\FilterList::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * @return string + */ + public function getType() + { + return $this->whichOneof("type"); + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Filter/FieldFilter.php b/AdsAdManager/src/V1/Report/Filter/FieldFilter.php new file mode 100644 index 000000000000..c4f05e8d1a11 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Filter/FieldFilter.php @@ -0,0 +1,286 @@ +google.ads.admanager.v1.Report.Filter.FieldFilter + */ +class FieldFilter extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The field to filter on. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $field = null; + /** + * Required. The operation of this filter. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $operation = 0; + /** + * Required. Values to filter to. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + private $values; + /** + * Optional. Use to filter on a specific slice of data. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $slice = null; + /** + * Optional. When using time period columns, use this to filter on a + * specific column. + * + * Generated from protobuf field optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $time_period_index = null; + /** + * Optional. Use to specify which metric value type to filter on. Defaults + * to PRIMARY. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $metric_value_type = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\Report\Field $field + * Required. The field to filter on. + * @type int $operation + * Required. The operation of this filter. + * @type array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $values + * Required. Values to filter to. + * @type \Google\Ads\AdManager\V1\Report\Slice $slice + * Optional. Use to filter on a specific slice of data. + * @type int $time_period_index + * Optional. When using time period columns, use this to filter on a + * specific column. + * @type int $metric_value_type + * Optional. Use to specify which metric value type to filter on. Defaults + * to PRIMARY. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The field to filter on. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\Report\Field|null + */ + public function getField() + { + return $this->field; + } + + public function hasField() + { + return isset($this->field); + } + + public function clearField() + { + unset($this->field); + } + + /** + * Required. The field to filter on. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\Report\Field $var + * @return $this + */ + public function setField($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Field::class); + $this->field = $var; + + return $this; + } + + /** + * Required. The operation of this filter. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getOperation() + { + return $this->operation; + } + + /** + * Required. The operation of this filter. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setOperation($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\Filter\Operation::class); + $this->operation = $var; + + return $this; + } + + /** + * Required. Values to filter to. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getValues() + { + return $this->values; + } + + /** + * Required. Values to filter to. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Ads\AdManager\V1\Report\Value>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Value::class); + $this->values = $arr; + + return $this; + } + + /** + * Optional. Use to filter on a specific slice of data. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Ads\AdManager\V1\Report\Slice|null + */ + public function getSlice() + { + return $this->slice; + } + + public function hasSlice() + { + return isset($this->slice); + } + + public function clearSlice() + { + unset($this->slice); + } + + /** + * Optional. Use to filter on a specific slice of data. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Ads\AdManager\V1\Report\Slice $var + * @return $this + */ + public function setSlice($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Slice::class); + $this->slice = $var; + + return $this; + } + + /** + * Optional. When using time period columns, use this to filter on a + * specific column. + * + * Generated from protobuf field optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getTimePeriodIndex() + { + return isset($this->time_period_index) ? $this->time_period_index : 0; + } + + public function hasTimePeriodIndex() + { + return isset($this->time_period_index); + } + + public function clearTimePeriodIndex() + { + unset($this->time_period_index); + } + + /** + * Optional. When using time period columns, use this to filter on a + * specific column. + * + * Generated from protobuf field optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setTimePeriodIndex($var) + { + GPBUtil::checkInt32($var); + $this->time_period_index = $var; + + return $this; + } + + /** + * Optional. Use to specify which metric value type to filter on. Defaults + * to PRIMARY. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getMetricValueType() + { + return isset($this->metric_value_type) ? $this->metric_value_type : 0; + } + + public function hasMetricValueType() + { + return isset($this->metric_value_type); + } + + public function clearMetricValueType() + { + unset($this->metric_value_type); + } + + /** + * Optional. Use to specify which metric value type to filter on. Defaults + * to PRIMARY. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setMetricValueType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\MetricValueType::class); + $this->metric_value_type = $var; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Filter/FilterList.php b/AdsAdManager/src/V1/Report/Filter/FilterList.php new file mode 100644 index 000000000000..18b3bd6ef52f --- /dev/null +++ b/AdsAdManager/src/V1/Report/Filter/FilterList.php @@ -0,0 +1,68 @@ +google.ads.admanager.v1.Report.Filter.FilterList + */ +class FilterList extends \Google\Protobuf\Internal\Message +{ + /** + * Required. A list of filters. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $filters; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Report\Filter>|\Google\Protobuf\Internal\RepeatedField $filters + * Required. A list of filters. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. A list of filters. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getFilters() + { + return $this->filters; + } + + /** + * Required. A list of filters. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Ads\AdManager\V1\Report\Filter>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setFilters($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Filter::class); + $this->filters = $arr; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Filter/Operation.php b/AdsAdManager/src/V1/Report/Filter/Operation.php new file mode 100644 index 000000000000..460971cb6667 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Filter/Operation.php @@ -0,0 +1,132 @@ +google.ads.admanager.v1.Report.Filter.Operation + */ +class Operation +{ + /** + * For scalar operands, checks if the operand is in the set of provided + * filter values. + * For list operands, checks if any element in the operand is in the set + * of provided filter values. + * Default value. + * + * Generated from protobuf enum IN = 0; + */ + const IN = 0; + /** + * For scalar operands, checks that the operand is not in the set of + * provided filter values. + * For list operands, checks that none of the elements in the operand + * is in the set of provided filter values. + * + * Generated from protobuf enum NOT_IN = 1; + */ + const NOT_IN = 1; + /** + * For scalar string operands, checks if the operand contains any of the + * provided filter substrings. + * For string list operands, checks if any string in the operand contains + * any of the provided filter substrings. + * + * Generated from protobuf enum CONTAINS = 2; + */ + const CONTAINS = 2; + /** + * For scalar string operands, checks that the operand contains none of + * the provided filter substrings. + * For string list operands, checks that none of the strings in the + * operand contain none of the provided filter substrings. + * + * Generated from protobuf enum NOT_CONTAINS = 3; + */ + const NOT_CONTAINS = 3; + /** + * Operand is less than the provided filter value. + * + * Generated from protobuf enum LESS_THAN = 4; + */ + const LESS_THAN = 4; + /** + * Operand is less than or equal to provided filter value. + * + * Generated from protobuf enum LESS_THAN_EQUALS = 5; + */ + const LESS_THAN_EQUALS = 5; + /** + * Operand is greater than provided filter value. + * + * Generated from protobuf enum GREATER_THAN = 6; + */ + const GREATER_THAN = 6; + /** + * Operand is greater than or equal to provided filter value. + * + * Generated from protobuf enum GREATER_THAN_EQUALS = 7; + */ + const GREATER_THAN_EQUALS = 7; + /** + * Operand is between provided filter values. + * + * Generated from protobuf enum BETWEEN = 8; + */ + const BETWEEN = 8; + /** + * Operand matches against a regex or set of regexes (one must match) + * + * Generated from protobuf enum MATCHES = 9; + */ + const MATCHES = 9; + /** + * Operand negative matches against a regex or set of regexes (none must + * match) + * + * Generated from protobuf enum NOT_MATCHES = 10; + */ + const NOT_MATCHES = 10; + + private static $valueToName = [ + self::IN => 'IN', + self::NOT_IN => 'NOT_IN', + self::CONTAINS => 'CONTAINS', + self::NOT_CONTAINS => 'NOT_CONTAINS', + self::LESS_THAN => 'LESS_THAN', + self::LESS_THAN_EQUALS => 'LESS_THAN_EQUALS', + self::GREATER_THAN => 'GREATER_THAN', + self::GREATER_THAN_EQUALS => 'GREATER_THAN_EQUALS', + self::BETWEEN => 'BETWEEN', + self::MATCHES => 'MATCHES', + self::NOT_MATCHES => 'NOT_MATCHES', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Report/Flag.php b/AdsAdManager/src/V1/Report/Flag.php new file mode 100644 index 000000000000..25920744cd5a --- /dev/null +++ b/AdsAdManager/src/V1/Report/Flag.php @@ -0,0 +1,118 @@ +google.ads.admanager.v1.Report.Flag + */ +class Flag extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Filters to apply for the flag. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $filters; + /** + * Optional. Name of the flag. + * The flag names RED, YELLOW, GREEN, BLUE, PURPLE, and GREY correspond to + * the colored flags that appear in the UI. The UI will not display flags + * with other names, but they are available for use by API clients. + * + * Generated from protobuf field string name = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $name = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Ads\AdManager\V1\Report\Filter>|\Google\Protobuf\Internal\RepeatedField $filters + * Required. Filters to apply for the flag. + * @type string $name + * Optional. Name of the flag. + * The flag names RED, YELLOW, GREEN, BLUE, PURPLE, and GREY correspond to + * the colored flags that appear in the UI. The UI will not display flags + * with other names, but they are available for use by API clients. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. Filters to apply for the flag. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getFilters() + { + return $this->filters; + } + + /** + * Required. Filters to apply for the flag. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Ads\AdManager\V1\Report\Filter>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setFilters($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Filter::class); + $this->filters = $arr; + + return $this; + } + + /** + * Optional. Name of the flag. + * The flag names RED, YELLOW, GREEN, BLUE, PURPLE, and GREY correspond to + * the colored flags that appear in the UI. The UI will not display flags + * with other names, but they are available for use by API clients. + * + * Generated from protobuf field string name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Optional. Name of the flag. + * The flag names RED, YELLOW, GREEN, BLUE, PURPLE, and GREY correspond to + * the colored flags that appear in the UI. The UI will not display flags + * with other names, but they are available for use by API clients. + * + * Generated from protobuf field string name = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Metric.php b/AdsAdManager/src/V1/Report/Metric.php new file mode 100644 index 000000000000..eced4d9adff3 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Metric.php @@ -0,0 +1,1306 @@ +google.ads.admanager.v1.Report.Metric + */ +class Metric +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum METRIC_UNSPECIFIED = 0; + */ + const METRIC_UNSPECIFIED = 0; + /** + * Active View total average time in seconds that specific impressions are + * reported as being viewable. + * + * Generated from protobuf enum ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME = 61; + */ + const ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME = 61; + /** + * Total number of impressions that were eligible to measure viewability. + * + * Generated from protobuf enum ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS = 58; + */ + const ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS = 58; + /** + * The total number of impressions that were sampled and measured by active + * view. + * + * Generated from protobuf enum ACTIVE_VIEW_MEASURABLE_IMPRESSIONS = 57; + */ + const ACTIVE_VIEW_MEASURABLE_IMPRESSIONS = 57; + /** + * The percentage of total impressions that were measurable by active view + * (out of all the total impressions sampled for active view). + * + * Generated from protobuf enum ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE = 60; + */ + const ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE = 60; + /** + * The total number of impressions viewed on the user's screen. + * + * Generated from protobuf enum ACTIVE_VIEW_VIEWABLE_IMPRESSIONS = 56; + */ + const ACTIVE_VIEW_VIEWABLE_IMPRESSIONS = 56; + /** + * The percentage of total impressions viewed on the user's screen (out of + * the total impressions measurable by active view). + * + * Generated from protobuf enum ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE = 59; + */ + const ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE = 59; + /** + * Active View AdSense average time in seconds that specific impressions are + * reported as being viewable. + * + * Generated from protobuf enum ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME = 73; + */ + const ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME = 73; + /** + * Total number of impressions delivered by AdSense that were eligible to + * measure viewability. + * + * Generated from protobuf enum ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS = 70; + */ + const ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS = 70; + /** + * The number of impressions delivered by AdSense that were sampled, and + * measurable by active view. + * + * Generated from protobuf enum ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS = 69; + */ + const ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS = 69; + /** + * The percentage of impressions delivered by AdSense that were measurable + * by active view (out of all AdSense impressions sampled for active view). + * + * Generated from protobuf enum ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE = 72; + */ + const ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE = 72; + /** + * The number of impressions delivered by AdSense viewed on the user's + * screen. + * + * Generated from protobuf enum ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS = 68; + */ + const ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS = 68; + /** + * The percentage of impressions delivered by AdSense viewed on the user's + * screen (out of AdSense impressions measurable by active view). + * + * Generated from protobuf enum ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE = 71; + */ + const ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE = 71; + /** + * The average effective cost-per-thousand-impressions earned from the ads + * delivered by AdSense through line item dynamic allocation. + * + * Generated from protobuf enum ADSENSE_AVERAGE_ECPM = 26; + */ + const ADSENSE_AVERAGE_ECPM = 26; + /** + * Number of clicks delivered by AdSense demand channel. + * + * Generated from protobuf enum ADSENSE_CLICKS = 23; + */ + const ADSENSE_CLICKS = 23; + /** + * The ratio of impressions served by AdSense that resulted in users + * clicking on an ad. The clickthrough rate (CTR) is updated nightly. The + * AdSense CTR is calculated as: (AdSense clicks / AdSense impressions). + * + * Generated from protobuf enum ADSENSE_CTR = 24; + */ + const ADSENSE_CTR = 24; + /** + * Total impressions delivered by AdSense. + * + * Generated from protobuf enum ADSENSE_IMPRESSIONS = 22; + */ + const ADSENSE_IMPRESSIONS = 22; + /** + * Ratio of clicks delivered by AdSense through line item dynamic allocation + * in relation to the total clicks delivered. + * + * Generated from protobuf enum ADSENSE_PERCENT_CLICKS = 28; + */ + const ADSENSE_PERCENT_CLICKS = 28; + /** + * Ratio of impressions delivered by AdSense through line item dynamic + * allocation in relation to the total impressions delivered. + * + * Generated from protobuf enum ADSENSE_PERCENT_IMPRESSIONS = 27; + */ + const ADSENSE_PERCENT_IMPRESSIONS = 27; + /** + * Ratio of revenue generated by AdSense through line item dynamic + * allocation in relation to the total revenue. + * + * Generated from protobuf enum ADSENSE_PERCENT_REVENUE = 29; + */ + const ADSENSE_PERCENT_REVENUE = 29; + /** + * Ratio of revenue generated by AdSense through line item dynamic + * allocation in relation to the total revenue (excluding CPD). + * + * Generated from protobuf enum ADSENSE_PERCENT_REVENUE_WITHOUT_CPD = 30; + */ + const ADSENSE_PERCENT_REVENUE_WITHOUT_CPD = 30; + /** + * The total number of times that an AdSense ad is delivered. + * + * Generated from protobuf enum ADSENSE_RESPONSES_SERVED = 41; + */ + const ADSENSE_RESPONSES_SERVED = 41; + /** + * Revenue generated from AdSense through line item dynamic allocation, + * calculated in the network's currency and time zone. + * + * Generated from protobuf enum ADSENSE_REVENUE = 25; + */ + const ADSENSE_REVENUE = 25; + /** + * Active View AdExchange average time in seconds that specific impressions + * are reported as being viewable. + * + * Generated from protobuf enum AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME = 79; + */ + const AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME = 79; + /** + * Total number of impressions delivered by Ad Exchange that were eligible + * to measure viewability. + * + * Generated from protobuf enum AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS = 76; + */ + const AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS = 76; + /** + * The number of impressions delivered by Ad Exchange that were sampled, and + * measurable by active view. + * + * Generated from protobuf enum AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS = 75; + */ + const AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS = 75; + /** + * The percentage of impressions delivered by Ad Exchange that were + * measurable by active view (out of all Ad Exchange impressions sampled for + * active view). + * + * Generated from protobuf enum AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE = 78; + */ + const AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE = 78; + /** + * The number of impressions delivered by Ad Exchange viewed on the user's + * screen. + * + * Generated from protobuf enum AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS = 74; + */ + const AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS = 74; + /** + * The percentage of impressions delivered by Ad Exchange viewed on the + * user's screen (out of Ad Exchange impressions measurable by active view). + * + * Generated from protobuf enum AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE = 77; + */ + const AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE = 77; + /** + * The average effective cost-per-thousand-impressions earned from the ads + * delivered by Ad Exchange through line item dynamic allocation. + * + * Generated from protobuf enum AD_EXCHANGE_AVERAGE_ECPM = 18; + */ + const AD_EXCHANGE_AVERAGE_ECPM = 18; + /** + * Number of clicks delivered by the Ad Exchange. + * + * Generated from protobuf enum AD_EXCHANGE_CLICKS = 15; + */ + const AD_EXCHANGE_CLICKS = 15; + /** + * The ratio of impressions served by the Ad Exchange that resulted in users + * clicking on an ad. The clickthrough rate (CTR) is updated nightly. Ad + * Exchange CTR is calculated as: (Ad Exchange clicks / Ad Exchange + * impressions). + * + * Generated from protobuf enum AD_EXCHANGE_CTR = 16; + */ + const AD_EXCHANGE_CTR = 16; + /** + * Total impressions delivered by the Ad Exchange. + * + * Generated from protobuf enum AD_EXCHANGE_IMPRESSIONS = 14; + */ + const AD_EXCHANGE_IMPRESSIONS = 14; + /** + * Ratio of clicks delivered by Ad Exchange through line item dynamic + * allocation in relation to the total clicks delivered. + * + * Generated from protobuf enum AD_EXCHANGE_PERCENT_CLICKS = 20; + */ + const AD_EXCHANGE_PERCENT_CLICKS = 20; + /** + * Ratio of impressions delivered by Ad Exchange through line item dynamic + * allocation in relation to the total impressions delivered. + * + * Generated from protobuf enum AD_EXCHANGE_PERCENT_IMPRESSIONS = 19; + */ + const AD_EXCHANGE_PERCENT_IMPRESSIONS = 19; + /** + * Ratio of revenue generated by Ad Exchange through line item dynamic + * allocation in relation to the total revenue. + * + * Generated from protobuf enum AD_EXCHANGE_PERCENT_REVENUE = 21; + */ + const AD_EXCHANGE_PERCENT_REVENUE = 21; + /** + * Ratio of revenue generated by Ad Exchange through line item dynamic + * allocation in relation to the total revenue (excluding CPD). + * + * Generated from protobuf enum AD_EXCHANGE_PERCENT_REVENUE_WITHOUT_CPD = 31; + */ + const AD_EXCHANGE_PERCENT_REVENUE_WITHOUT_CPD = 31; + /** + * The total number of times that an Ad Exchange ad is delivered. + * + * Generated from protobuf enum AD_EXCHANGE_RESPONSES_SERVED = 42; + */ + const AD_EXCHANGE_RESPONSES_SERVED = 42; + /** + * Revenue generated from the Ad Exchange through line item dynamic + * allocation, calculated in your network's currency and time zone. + * + * Generated from protobuf enum AD_EXCHANGE_REVENUE = 17; + */ + const AD_EXCHANGE_REVENUE = 17; + /** + * The total number of times that an ad request is sent to the ad server + * including dynamic allocation. + * + * Generated from protobuf enum AD_REQUESTS = 38; + */ + const AD_REQUESTS = 38; + /** + * Active View ad server average time in seconds that specific impressions + * are reported as being viewable. + * + * Generated from protobuf enum AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME = 67; + */ + const AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME = 67; + /** + * Total number of impressions delivered by the ad server that were eligible + * to measure viewability. + * + * Generated from protobuf enum AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS = 64; + */ + const AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS = 64; + /** + * The number of impressions delivered by the ad server that were sampled, + * and measurable by active view. + * + * Generated from protobuf enum AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS = 63; + */ + const AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS = 63; + /** + * The percentage of impressions delivered by the ad server that were + * measurable by active view (out of all the ad server impressions sampled + * for active view). + * + * Generated from protobuf enum AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE = 66; + */ + const AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE = 66; + /** + * The number of impressions delivered by the ad server viewed on the user's + * screen. + * + * Generated from protobuf enum AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS = 62; + */ + const AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS = 62; + /** + * The percentage of impressions delivered by the ad server viewed on the + * user's screen (out of the ad server impressions measurable by active + * view). + * + * Generated from protobuf enum AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE = 65; + */ + const AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE = 65; + /** + * Average effective cost-per-thousand-impressions earned from the ads + * delivered by the Google Ad Manager server. + * + * Generated from protobuf enum AD_SERVER_AVERAGE_ECPM = 34; + */ + const AD_SERVER_AVERAGE_ECPM = 34; + /** + * Average effective cost-per-thousand-impressions earned from the ads + * delivered by the Google Ad Manager server, excluding CPD value. + * + * Generated from protobuf enum AD_SERVER_AVERAGE_ECPM_WITHOUT_CPD = 10; + */ + const AD_SERVER_AVERAGE_ECPM_WITHOUT_CPD = 10; + /** + * Total clicks served by the Google Ad Manager server. It usually takes + * about 30 minutes for new clicks to be recorded and added to the total + * displayed in reporting. + * + * Generated from protobuf enum AD_SERVER_CLICKS = 7; + */ + const AD_SERVER_CLICKS = 7; + /** + * CPD revenue earned, calculated in your network's currency, for + * the ads delivered by the Google Ad Manager server. Sum of all booked + * revenue. + * + * Generated from protobuf enum AD_SERVER_CPD_REVENUE = 32; + */ + const AD_SERVER_CPD_REVENUE = 32; + /** + * Ratio of impressions served by the Google Ad Manager server that resulted + * in users clicking on an ad. The clickthrough rate (CTR) is updated + * nightly. The ad server CTR is calculated as: (Ad server clicks / Ad + * server impressions). + * + * Generated from protobuf enum AD_SERVER_CTR = 8; + */ + const AD_SERVER_CTR = 8; + /** + * Total impressions delivered by the Ad Server. + * + * Generated from protobuf enum AD_SERVER_IMPRESSIONS = 6; + */ + const AD_SERVER_IMPRESSIONS = 6; + /** + * Ratio of clicks delivered by the Google Ad Manager server in relation to + * the total clicks delivered. + * + * Generated from protobuf enum AD_SERVER_PERCENT_CLICKS = 12; + */ + const AD_SERVER_PERCENT_CLICKS = 12; + /** + * Ratio of impressions delivered by the Google Ad Manager server in + * relation to the total impressions delivered. + * + * Generated from protobuf enum AD_SERVER_PERCENT_IMPRESSIONS = 11; + */ + const AD_SERVER_PERCENT_IMPRESSIONS = 11; + /** + * Ratio of revenue generated by the Google Ad Manager server in relation + * to the total revenue. + * + * Generated from protobuf enum AD_SERVER_PERCENT_REVENUE = 35; + */ + const AD_SERVER_PERCENT_REVENUE = 35; + /** + * Ratio of revenue generated by the Google Ad Manager server (excluding + * CPD) in relation to the total revenue. + * + * Generated from protobuf enum AD_SERVER_PERCENT_REVENUE_WITHOUT_CPD = 13; + */ + const AD_SERVER_PERCENT_REVENUE_WITHOUT_CPD = 13; + /** + * The total number of times that an ad is served by the ad server. + * + * Generated from protobuf enum AD_SERVER_RESPONSES_SERVED = 40; + */ + const AD_SERVER_RESPONSES_SERVED = 40; + /** + * All CPM, CPC, and CPD revenue earned, calculated in your network's + * currency, for the ads delivered by the Google Ad Manager server. + * Sum of all booked revenue. + * + * Generated from protobuf enum AD_SERVER_REVENUE = 33; + */ + const AD_SERVER_REVENUE = 33; + /** + * Revenue (excluding CPD) earned, calculated in your network's currency, + * for the ads delivered by the Google Ad Manager server. Sum of all booked + * revenue. + * + * Generated from protobuf enum AD_SERVER_REVENUE_WITHOUT_CPD = 9; + */ + const AD_SERVER_REVENUE_WITHOUT_CPD = 9; + /** + * Number of winning bids received from Open Bidding buyers, even when the + * winning bid is placed at the end of a mediation for mobile apps chain. + * + * Generated from protobuf enum AUCTIONS_WON = 80; + */ + const AUCTIONS_WON = 80; + /** + * eCPM averaged across the Google Ad Manager server, AdSense, + * and Ad Exchange. + * + * Generated from protobuf enum AVERAGE_ECPM = 37; + */ + const AVERAGE_ECPM = 37; + /** + * eCPM averaged across the Google Ad Manager server (excluding CPD), + * AdSense, and Ad Exchange. + * + * Generated from protobuf enum AVERAGE_ECPM_WITHOUT_CPD = 5; + */ + const AVERAGE_ECPM_WITHOUT_CPD = 5; + /** + * Number of bids received from Open Bidding buyers, regardless of whether + * the returned bid competes in an auction. + * + * Generated from protobuf enum BIDS = 81; + */ + const BIDS = 81; + /** + * Number of bids received from Open Bidding buyers that competed in + * the auction. + * + * Generated from protobuf enum BIDS_IN_AUCTION = 82; + */ + const BIDS_IN_AUCTION = 82; + /** + * Number of times a yield partner is asked to return bid to fill + * a yield group request. + * + * Generated from protobuf enum CALLOUTS = 83; + */ + const CALLOUTS = 83; + /** + * The number of times a user clicked on an ad. + * + * Generated from protobuf enum CLICKS = 2; + */ + const CLICKS = 2; + /** + * The total number of times that the code for an ad is served by the ad + * server including dynamic allocation. + * + * Generated from protobuf enum CODE_SERVED_COUNT = 44; + */ + const CODE_SERVED_COUNT = 44; + /** + * For standard ads, your ad clickthrough rate (CTR) is the number of ad + * clicks divided by the number of individual ad impressions expressed as a + * fraction. Ad CTR = Clicks / Ad impressions. + * + * Generated from protobuf enum CTR = 3; + */ + const CTR = 3; + /** + * The number of coviewed impressions sold by Google in partner sales. + * + * Generated from protobuf enum GOOGLE_SOLD_AUCTION_COVIEWED_IMPRESSIONS = 129; + */ + const GOOGLE_SOLD_AUCTION_COVIEWED_IMPRESSIONS = 129; + /** + * The number of auction impressions sold by Google in partner sales. + * + * Generated from protobuf enum GOOGLE_SOLD_AUCTION_IMPRESSIONS = 128; + */ + const GOOGLE_SOLD_AUCTION_IMPRESSIONS = 128; + /** + * The number of coviewed impressions sold by Google in partner sales. + * + * Generated from protobuf enum GOOGLE_SOLD_COVIEWED_IMPRESSIONS = 131; + */ + const GOOGLE_SOLD_COVIEWED_IMPRESSIONS = 131; + /** + * The number of impressions sold by Google in partner sales. + * + * Generated from protobuf enum GOOGLE_SOLD_IMPRESSIONS = 130; + */ + const GOOGLE_SOLD_IMPRESSIONS = 130; + /** + * The number of coviewed impressions sold by Google in partner sales. + * + * Generated from protobuf enum GOOGLE_SOLD_RESERVATION_COVIEWED_IMPRESSIONS = 127; + */ + const GOOGLE_SOLD_RESERVATION_COVIEWED_IMPRESSIONS = 127; + /** + * The number of reservation impressions sold by Google in partner sales. + * + * Generated from protobuf enum GOOGLE_SOLD_RESERVATION_IMPRESSIONS = 126; + */ + const GOOGLE_SOLD_RESERVATION_IMPRESSIONS = 126; + /** + * Total impressions from the Google Ad Manager server, AdSense, + * Ad Exchange, and yield group partners. + * + * Generated from protobuf enum IMPRESSIONS = 1; + */ + const IMPRESSIONS = 1; + /** + * The number of filled pod requests (filled by partner or Google) in + * partner sales. + * + * Generated from protobuf enum PARTNER_SALES_FILLED_POD_REQUESTS = 135; + */ + const PARTNER_SALES_FILLED_POD_REQUESTS = 135; + /** + * The percent of filled requests to total ad requests in + * partner sales. + * + * Generated from protobuf enum PARTNER_SALES_FILL_RATE = 136; + */ + const PARTNER_SALES_FILL_RATE = 136; + /** + * The percent of partner filled requests to total ad requests + * in partner sales. + * + * Generated from protobuf enum PARTNER_SALES_PARTNER_MATCH_RATE = 137; + */ + const PARTNER_SALES_PARTNER_MATCH_RATE = 137; + /** + * The number of queries eligible for partner sales. + * + * Generated from protobuf enum PARTNER_SALES_QUERIES = 132; + */ + const PARTNER_SALES_QUERIES = 132; + /** + * The number of partner unfilled impressions in partner sales. + * If a pod request is not filled by partner but filled by Google, this + * metric will still count 1. + * + * Generated from protobuf enum PARTNER_SALES_UNFILLED_IMPRESSIONS = 133; + */ + const PARTNER_SALES_UNFILLED_IMPRESSIONS = 133; + /** + * The number of partner unmatched queries in partner sales. + * If an ad request is not filled by partner but filled by Google, this + * metric will still count 1. + * + * Generated from protobuf enum PARTNER_SALES_UNMATCHED_QUERIES = 134; + */ + const PARTNER_SALES_UNMATCHED_QUERIES = 134; + /** + * The number of code served sold by partner in partner sales. + * + * Generated from protobuf enum PARTNER_SOLD_CODE_SERVED = 125; + */ + const PARTNER_SOLD_CODE_SERVED = 125; + /** + * The number of coviewed impressions sold by partner in partner sales. + * + * Generated from protobuf enum PARTNER_SOLD_COVIEWED_IMPRESSIONS = 124; + */ + const PARTNER_SOLD_COVIEWED_IMPRESSIONS = 124; + /** + * The number of impressions sold by partner in partner sales. + * + * Generated from protobuf enum PARTNER_SOLD_IMPRESSIONS = 123; + */ + const PARTNER_SOLD_IMPRESSIONS = 123; + /** + * The total number of ad requests eligible for programmatic inventory, + * including Programmatic Guaranteed, Preferred Deals, backfill, and open + * auction. + * + * Generated from protobuf enum PROGRAMMATIC_ELIGIBLE_AD_REQUESTS = 177; + */ + const PROGRAMMATIC_ELIGIBLE_AD_REQUESTS = 177; + /** + * The number of programmatic responses served divided by the number of + * programmatic eligible ad requests. Includes Ad Exchange, Open Bidding, + * and Preferred Deals. + * + * Generated from protobuf enum PROGRAMMATIC_MATCH_RATE = 178; + */ + const PROGRAMMATIC_MATCH_RATE = 178; + /** + * Total number of ad responses served from programmatic demand sources. + * Includes Ad Exchange, Open Bidding, and Preferred Deals. + * Differs from AD_EXCHANGE_RESPONSES_SERVED, which doesn't include Open + * Bidding ad requests. + * + * Generated from protobuf enum PROGRAMMATIC_RESPONSES_SERVED = 176; + */ + const PROGRAMMATIC_RESPONSES_SERVED = 176; + /** + * The total number of times that an ad is served by the ad server including + * dynamic allocation. + * + * Generated from protobuf enum RESPONSES_SERVED = 39; + */ + const RESPONSES_SERVED = 39; + /** + * Total amount of CPM, CPC, and CPD revenue based on the number of units + * served by the Google Ad Manager server, AdSense, Ad Exchange, and + * third-party Mediation networks. + * + * Generated from protobuf enum REVENUE = 36; + */ + const REVENUE = 36; + /** + * Total amount of revenue (excluding CPD) based on the number of units + * served by the Google Ad Manager server, AdSense, Ad Exchange, and + * third-party Mediation networks. + * + * Generated from protobuf enum REVENUE_WITHOUT_CPD = 4; + */ + const REVENUE_WITHOUT_CPD = 4; + /** + * Number of times a yield group buyer successfully returned a bid in + * response to a yield group callout. + * + * Generated from protobuf enum SUCCESSFUL_RESPONSES = 84; + */ + const SUCCESSFUL_RESPONSES = 84; + /** + * The total number of missed impressions due to the ad servers' inability + * to find ads to serve including dynamic allocation. + * + * Generated from protobuf enum UNFILLED_IMPRESSIONS = 45; + */ + const UNFILLED_IMPRESSIONS = 45; + /** + * The total number of times that an ad is not returned by the ad server. + * + * Generated from protobuf enum UNMATCHED_AD_REQUESTS = 43; + */ + const UNMATCHED_AD_REQUESTS = 43; + /** + * Number of times an Offerwall message was shown to users. + * + * Generated from protobuf enum USER_MESSAGES_OFFERWALL_MESSAGES_SHOWN = 121; + */ + const USER_MESSAGES_OFFERWALL_MESSAGES_SHOWN = 121; + /** + * The number of messages where the user gained an entitlement. + * + * Generated from protobuf enum USER_MESSAGES_OFFERWALL_SUCCESSFUL_ENGAGEMENTS = 122; + */ + const USER_MESSAGES_OFFERWALL_SUCCESSFUL_ENGAGEMENTS = 122; + /** + * The number of user interactions with a video, on average, such as pause, + * full screen, mute, etc. + * + * Generated from protobuf enum VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE = 92; + */ + const VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE = 92; + /** + * The number of times a user collapses a video, either to its original size + * or to a different size. + * + * Generated from protobuf enum VIDEO_INTERACTION_COLLAPSES = 93; + */ + const VIDEO_INTERACTION_COLLAPSES = 93; + /** + * The number of times a user expands a video. + * + * Generated from protobuf enum VIDEO_INTERACTION_EXPANDS = 95; + */ + const VIDEO_INTERACTION_EXPANDS = 95; + /** + * The number of times ad clip played in full screen mode. + * + * Generated from protobuf enum VIDEO_INTERACTION_FULL_SCREENS = 96; + */ + const VIDEO_INTERACTION_FULL_SCREENS = 96; + /** + * The number of times video player was in mute state during play of ad + * clip. + * + * Generated from protobuf enum VIDEO_INTERACTION_MUTES = 97; + */ + const VIDEO_INTERACTION_MUTES = 97; + /** + * The number of times user paused ad clip. + * + * Generated from protobuf enum VIDEO_INTERACTION_PAUSES = 98; + */ + const VIDEO_INTERACTION_PAUSES = 98; + /** + * The number of times the user unpaused the video. + * + * Generated from protobuf enum VIDEO_INTERACTION_RESUMES = 99; + */ + const VIDEO_INTERACTION_RESUMES = 99; + /** + * The number of times a user rewinds the video. + * + * Generated from protobuf enum VIDEO_INTERACTION_REWINDS = 100; + */ + const VIDEO_INTERACTION_REWINDS = 100; + /** + * The number of times a user unmutes the video. + * + * Generated from protobuf enum VIDEO_INTERACTION_UNMUTES = 101; + */ + const VIDEO_INTERACTION_UNMUTES = 101; + /** + * The number of times a skippable video is skipped. + * + * Generated from protobuf enum VIDEO_INTERACTION_VIDEO_SKIPS = 102; + */ + const VIDEO_INTERACTION_VIDEO_SKIPS = 102; + /** + * The number of total creative serves in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_CREATIVE_SERVES = 139; + */ + const VIDEO_REAL_TIME_CREATIVE_SERVES = 139; + /** + * The number of errors of type 100 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_100_COUNT = 143; + */ + const VIDEO_REAL_TIME_ERROR_100_COUNT = 143; + /** + * The number of errors of type 101 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_101_COUNT = 144; + */ + const VIDEO_REAL_TIME_ERROR_101_COUNT = 144; + /** + * The number of errors of type 102 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_102_COUNT = 145; + */ + const VIDEO_REAL_TIME_ERROR_102_COUNT = 145; + /** + * The number of errors of type 200 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_200_COUNT = 146; + */ + const VIDEO_REAL_TIME_ERROR_200_COUNT = 146; + /** + * The number of errors of type 201 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_201_COUNT = 147; + */ + const VIDEO_REAL_TIME_ERROR_201_COUNT = 147; + /** + * The number of errors of type 202 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_202_COUNT = 148; + */ + const VIDEO_REAL_TIME_ERROR_202_COUNT = 148; + /** + * The number of errors of type 203 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_203_COUNT = 149; + */ + const VIDEO_REAL_TIME_ERROR_203_COUNT = 149; + /** + * The number of errors of type 300 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_300_COUNT = 150; + */ + const VIDEO_REAL_TIME_ERROR_300_COUNT = 150; + /** + * The number of errors of type 301 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_301_COUNT = 151; + */ + const VIDEO_REAL_TIME_ERROR_301_COUNT = 151; + /** + * The number of errors of type 302 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_302_COUNT = 152; + */ + const VIDEO_REAL_TIME_ERROR_302_COUNT = 152; + /** + * The number of errors of type 303 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_303_COUNT = 153; + */ + const VIDEO_REAL_TIME_ERROR_303_COUNT = 153; + /** + * The number of errors of type 400 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_400_COUNT = 154; + */ + const VIDEO_REAL_TIME_ERROR_400_COUNT = 154; + /** + * The number of errors of type 401 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_401_COUNT = 155; + */ + const VIDEO_REAL_TIME_ERROR_401_COUNT = 155; + /** + * The number of errors of type 402 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_402_COUNT = 156; + */ + const VIDEO_REAL_TIME_ERROR_402_COUNT = 156; + /** + * The number of errors of type 403 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_403_COUNT = 157; + */ + const VIDEO_REAL_TIME_ERROR_403_COUNT = 157; + /** + * The number of errors of type 405 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_405_COUNT = 158; + */ + const VIDEO_REAL_TIME_ERROR_405_COUNT = 158; + /** + * The number of errors of type 406 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_406_COUNT = 159; + */ + const VIDEO_REAL_TIME_ERROR_406_COUNT = 159; + /** + * The number of errors of type 407 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_407_COUNT = 160; + */ + const VIDEO_REAL_TIME_ERROR_407_COUNT = 160; + /** + * The number of errors of type 408 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_408_COUNT = 161; + */ + const VIDEO_REAL_TIME_ERROR_408_COUNT = 161; + /** + * The number of errors of type 409 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_409_COUNT = 162; + */ + const VIDEO_REAL_TIME_ERROR_409_COUNT = 162; + /** + * The number of errors of type 410 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_410_COUNT = 163; + */ + const VIDEO_REAL_TIME_ERROR_410_COUNT = 163; + /** + * The number of errors of type 500 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_500_COUNT = 164; + */ + const VIDEO_REAL_TIME_ERROR_500_COUNT = 164; + /** + * The number of errors of type 501 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_501_COUNT = 165; + */ + const VIDEO_REAL_TIME_ERROR_501_COUNT = 165; + /** + * The number of errors of type 502 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_502_COUNT = 166; + */ + const VIDEO_REAL_TIME_ERROR_502_COUNT = 166; + /** + * The number of errors of type 503 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_503_COUNT = 167; + */ + const VIDEO_REAL_TIME_ERROR_503_COUNT = 167; + /** + * The number of errors of type 600 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_600_COUNT = 168; + */ + const VIDEO_REAL_TIME_ERROR_600_COUNT = 168; + /** + * The number of errors of type 601 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_601_COUNT = 169; + */ + const VIDEO_REAL_TIME_ERROR_601_COUNT = 169; + /** + * The number of errors of type 602 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_602_COUNT = 170; + */ + const VIDEO_REAL_TIME_ERROR_602_COUNT = 170; + /** + * The number of errors of type 603 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_603_COUNT = 171; + */ + const VIDEO_REAL_TIME_ERROR_603_COUNT = 171; + /** + * The number of errors of type 604 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_604_COUNT = 172; + */ + const VIDEO_REAL_TIME_ERROR_604_COUNT = 172; + /** + * The number of errors of type 900 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_900_COUNT = 173; + */ + const VIDEO_REAL_TIME_ERROR_900_COUNT = 173; + /** + * The number of errors of type 901 in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_ERROR_901_COUNT = 174; + */ + const VIDEO_REAL_TIME_ERROR_901_COUNT = 174; + /** + * The number of total impressions in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_IMPRESSIONS = 138; + */ + const VIDEO_REAL_TIME_IMPRESSIONS = 138; + /** + * The number of matched queries in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_MATCHED_QUERIES = 140; + */ + const VIDEO_REAL_TIME_MATCHED_QUERIES = 140; + /** + * The number of all errors in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_TOTAL_ERROR_COUNT = 175; + */ + const VIDEO_REAL_TIME_TOTAL_ERROR_COUNT = 175; + /** + * The number of total queries in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_TOTAL_QUERIES = 142; + */ + const VIDEO_REAL_TIME_TOTAL_QUERIES = 142; + /** + * The number of unmatched queries in video realtime reporting. + * + * Generated from protobuf enum VIDEO_REAL_TIME_UNMATCHED_QUERIES = 141; + */ + const VIDEO_REAL_TIME_UNMATCHED_QUERIES = 141; + /** + * Number of times that the publisher specified a video ad played + * automatically. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_AUTO_PLAYS = 103; + */ + const VIDEO_VIEWERSHIP_AUTO_PLAYS = 103; + /** + * Average percentage of the video watched by users. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE = 104; + */ + const VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE = 104; + /** + * Average time(seconds) users watched the video. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME = 105; + */ + const VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME = 105; + /** + * Number of times that the publisher specified a video ad was clicked to + * play. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_CLICK_TO_PLAYS = 106; + */ + const VIDEO_VIEWERSHIP_CLICK_TO_PLAYS = 106; + /** + * The number of times the video played to completion. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_COMPLETES = 107; + */ + const VIDEO_VIEWERSHIP_COMPLETES = 107; + /** + * Percentage of times the video played to the end. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_COMPLETION_RATE = 108; + */ + const VIDEO_VIEWERSHIP_COMPLETION_RATE = 108; + /** + * The number of engaged views: ad is viewed to completion or for 30s, + * whichever comes first. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_ENGAGED_VIEWS = 109; + */ + const VIDEO_VIEWERSHIP_ENGAGED_VIEWS = 109; + /** + * The number of times the video played to 25% of its length. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_FIRST_QUARTILES = 110; + */ + const VIDEO_VIEWERSHIP_FIRST_QUARTILES = 110; + /** + * The number of times the video reached its midpoint during play. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_MIDPOINTS = 111; + */ + const VIDEO_VIEWERSHIP_MIDPOINTS = 111; + /** + * The number of times a skip button is shown in video. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_SKIP_BUTTONS_SHOWN = 112; + */ + const VIDEO_VIEWERSHIP_SKIP_BUTTONS_SHOWN = 112; + /** + * The number of impressions where the video was played. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_STARTS = 113; + */ + const VIDEO_VIEWERSHIP_STARTS = 113; + /** + * The number of times the video played to 75% of its length. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_THIRD_QUARTILES = 114; + */ + const VIDEO_VIEWERSHIP_THIRD_QUARTILES = 114; + /** + * The number of times an error occurred, such as a VAST redirect error, a + * video playback error, or an invalid response error. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT = 115; + */ + const VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT = 115; + /** + * The percentage of video error count. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE = 94; + */ + const VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE = 94; + /** + * Duration of the video creative. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_VIDEO_LENGTH = 116; + */ + const VIDEO_VIEWERSHIP_VIDEO_LENGTH = 116; + /** + * View-through rate represented as a percentage. + * + * Generated from protobuf enum VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE = 117; + */ + const VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE = 117; + /** + * The estimated net rate for yield groups or individual + * yield group partners. + * + * Generated from protobuf enum YIELD_GROUP_ESTIMATED_CPM = 88; + */ + const YIELD_GROUP_ESTIMATED_CPM = 88; + /** + * Total net revenue earned by a yield group, based upon the yield group + * estimated CPM and yield group impressions recorded. + * + * Generated from protobuf enum YIELD_GROUP_ESTIMATED_REVENUE = 87; + */ + const YIELD_GROUP_ESTIMATED_REVENUE = 87; + /** + * Number of matched yield group requests where a yield partner delivered + * their ad to publisher inventory. + * + * Generated from protobuf enum YIELD_GROUP_IMPRESSIONS = 85; + */ + const YIELD_GROUP_IMPRESSIONS = 85; + /** + * Yield group Mediation fill rate indicating how often a network + * fills an ad request. + * + * Generated from protobuf enum YIELD_GROUP_MEDIATION_FILL_RATE = 89; + */ + const YIELD_GROUP_MEDIATION_FILL_RATE = 89; + /** + * Total requests where a Mediation chain was served. + * + * Generated from protobuf enum YIELD_GROUP_MEDIATION_MATCHED_QUERIES = 86; + */ + const YIELD_GROUP_MEDIATION_MATCHED_QUERIES = 86; + /** + * The number of mediation chain passback across all channels. + * + * Generated from protobuf enum YIELD_GROUP_MEDIATION_PASSBACKS = 118; + */ + const YIELD_GROUP_MEDIATION_PASSBACKS = 118; + /** + * Revenue per thousand impressions based on data collected by Ad Manager + * from third-party ad network reports. + * + * Generated from protobuf enum YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM = 90; + */ + const YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM = 90; + + private static $valueToName = [ + self::METRIC_UNSPECIFIED => 'METRIC_UNSPECIFIED', + self::ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME => 'ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', + self::ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS => 'ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', + self::ACTIVE_VIEW_MEASURABLE_IMPRESSIONS => 'ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', + self::ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE => 'ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', + self::ACTIVE_VIEW_VIEWABLE_IMPRESSIONS => 'ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', + self::ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE => 'ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', + self::ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME => 'ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', + self::ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS => 'ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', + self::ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS => 'ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', + self::ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE => 'ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', + self::ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS => 'ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', + self::ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE => 'ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', + self::ADSENSE_AVERAGE_ECPM => 'ADSENSE_AVERAGE_ECPM', + self::ADSENSE_CLICKS => 'ADSENSE_CLICKS', + self::ADSENSE_CTR => 'ADSENSE_CTR', + self::ADSENSE_IMPRESSIONS => 'ADSENSE_IMPRESSIONS', + self::ADSENSE_PERCENT_CLICKS => 'ADSENSE_PERCENT_CLICKS', + self::ADSENSE_PERCENT_IMPRESSIONS => 'ADSENSE_PERCENT_IMPRESSIONS', + self::ADSENSE_PERCENT_REVENUE => 'ADSENSE_PERCENT_REVENUE', + self::ADSENSE_PERCENT_REVENUE_WITHOUT_CPD => 'ADSENSE_PERCENT_REVENUE_WITHOUT_CPD', + self::ADSENSE_RESPONSES_SERVED => 'ADSENSE_RESPONSES_SERVED', + self::ADSENSE_REVENUE => 'ADSENSE_REVENUE', + self::AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME => 'AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', + self::AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS => 'AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', + self::AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS => 'AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', + self::AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE => 'AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', + self::AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS => 'AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', + self::AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE => 'AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', + self::AD_EXCHANGE_AVERAGE_ECPM => 'AD_EXCHANGE_AVERAGE_ECPM', + self::AD_EXCHANGE_CLICKS => 'AD_EXCHANGE_CLICKS', + self::AD_EXCHANGE_CTR => 'AD_EXCHANGE_CTR', + self::AD_EXCHANGE_IMPRESSIONS => 'AD_EXCHANGE_IMPRESSIONS', + self::AD_EXCHANGE_PERCENT_CLICKS => 'AD_EXCHANGE_PERCENT_CLICKS', + self::AD_EXCHANGE_PERCENT_IMPRESSIONS => 'AD_EXCHANGE_PERCENT_IMPRESSIONS', + self::AD_EXCHANGE_PERCENT_REVENUE => 'AD_EXCHANGE_PERCENT_REVENUE', + self::AD_EXCHANGE_PERCENT_REVENUE_WITHOUT_CPD => 'AD_EXCHANGE_PERCENT_REVENUE_WITHOUT_CPD', + self::AD_EXCHANGE_RESPONSES_SERVED => 'AD_EXCHANGE_RESPONSES_SERVED', + self::AD_EXCHANGE_REVENUE => 'AD_EXCHANGE_REVENUE', + self::AD_REQUESTS => 'AD_REQUESTS', + self::AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME => 'AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', + self::AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS => 'AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', + self::AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS => 'AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', + self::AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE => 'AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', + self::AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS => 'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', + self::AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE => 'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', + self::AD_SERVER_AVERAGE_ECPM => 'AD_SERVER_AVERAGE_ECPM', + self::AD_SERVER_AVERAGE_ECPM_WITHOUT_CPD => 'AD_SERVER_AVERAGE_ECPM_WITHOUT_CPD', + self::AD_SERVER_CLICKS => 'AD_SERVER_CLICKS', + self::AD_SERVER_CPD_REVENUE => 'AD_SERVER_CPD_REVENUE', + self::AD_SERVER_CTR => 'AD_SERVER_CTR', + self::AD_SERVER_IMPRESSIONS => 'AD_SERVER_IMPRESSIONS', + self::AD_SERVER_PERCENT_CLICKS => 'AD_SERVER_PERCENT_CLICKS', + self::AD_SERVER_PERCENT_IMPRESSIONS => 'AD_SERVER_PERCENT_IMPRESSIONS', + self::AD_SERVER_PERCENT_REVENUE => 'AD_SERVER_PERCENT_REVENUE', + self::AD_SERVER_PERCENT_REVENUE_WITHOUT_CPD => 'AD_SERVER_PERCENT_REVENUE_WITHOUT_CPD', + self::AD_SERVER_RESPONSES_SERVED => 'AD_SERVER_RESPONSES_SERVED', + self::AD_SERVER_REVENUE => 'AD_SERVER_REVENUE', + self::AD_SERVER_REVENUE_WITHOUT_CPD => 'AD_SERVER_REVENUE_WITHOUT_CPD', + self::AUCTIONS_WON => 'AUCTIONS_WON', + self::AVERAGE_ECPM => 'AVERAGE_ECPM', + self::AVERAGE_ECPM_WITHOUT_CPD => 'AVERAGE_ECPM_WITHOUT_CPD', + self::BIDS => 'BIDS', + self::BIDS_IN_AUCTION => 'BIDS_IN_AUCTION', + self::CALLOUTS => 'CALLOUTS', + self::CLICKS => 'CLICKS', + self::CODE_SERVED_COUNT => 'CODE_SERVED_COUNT', + self::CTR => 'CTR', + self::GOOGLE_SOLD_AUCTION_COVIEWED_IMPRESSIONS => 'GOOGLE_SOLD_AUCTION_COVIEWED_IMPRESSIONS', + self::GOOGLE_SOLD_AUCTION_IMPRESSIONS => 'GOOGLE_SOLD_AUCTION_IMPRESSIONS', + self::GOOGLE_SOLD_COVIEWED_IMPRESSIONS => 'GOOGLE_SOLD_COVIEWED_IMPRESSIONS', + self::GOOGLE_SOLD_IMPRESSIONS => 'GOOGLE_SOLD_IMPRESSIONS', + self::GOOGLE_SOLD_RESERVATION_COVIEWED_IMPRESSIONS => 'GOOGLE_SOLD_RESERVATION_COVIEWED_IMPRESSIONS', + self::GOOGLE_SOLD_RESERVATION_IMPRESSIONS => 'GOOGLE_SOLD_RESERVATION_IMPRESSIONS', + self::IMPRESSIONS => 'IMPRESSIONS', + self::PARTNER_SALES_FILLED_POD_REQUESTS => 'PARTNER_SALES_FILLED_POD_REQUESTS', + self::PARTNER_SALES_FILL_RATE => 'PARTNER_SALES_FILL_RATE', + self::PARTNER_SALES_PARTNER_MATCH_RATE => 'PARTNER_SALES_PARTNER_MATCH_RATE', + self::PARTNER_SALES_QUERIES => 'PARTNER_SALES_QUERIES', + self::PARTNER_SALES_UNFILLED_IMPRESSIONS => 'PARTNER_SALES_UNFILLED_IMPRESSIONS', + self::PARTNER_SALES_UNMATCHED_QUERIES => 'PARTNER_SALES_UNMATCHED_QUERIES', + self::PARTNER_SOLD_CODE_SERVED => 'PARTNER_SOLD_CODE_SERVED', + self::PARTNER_SOLD_COVIEWED_IMPRESSIONS => 'PARTNER_SOLD_COVIEWED_IMPRESSIONS', + self::PARTNER_SOLD_IMPRESSIONS => 'PARTNER_SOLD_IMPRESSIONS', + self::PROGRAMMATIC_ELIGIBLE_AD_REQUESTS => 'PROGRAMMATIC_ELIGIBLE_AD_REQUESTS', + self::PROGRAMMATIC_MATCH_RATE => 'PROGRAMMATIC_MATCH_RATE', + self::PROGRAMMATIC_RESPONSES_SERVED => 'PROGRAMMATIC_RESPONSES_SERVED', + self::RESPONSES_SERVED => 'RESPONSES_SERVED', + self::REVENUE => 'REVENUE', + self::REVENUE_WITHOUT_CPD => 'REVENUE_WITHOUT_CPD', + self::SUCCESSFUL_RESPONSES => 'SUCCESSFUL_RESPONSES', + self::UNFILLED_IMPRESSIONS => 'UNFILLED_IMPRESSIONS', + self::UNMATCHED_AD_REQUESTS => 'UNMATCHED_AD_REQUESTS', + self::USER_MESSAGES_OFFERWALL_MESSAGES_SHOWN => 'USER_MESSAGES_OFFERWALL_MESSAGES_SHOWN', + self::USER_MESSAGES_OFFERWALL_SUCCESSFUL_ENGAGEMENTS => 'USER_MESSAGES_OFFERWALL_SUCCESSFUL_ENGAGEMENTS', + self::VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE => 'VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE', + self::VIDEO_INTERACTION_COLLAPSES => 'VIDEO_INTERACTION_COLLAPSES', + self::VIDEO_INTERACTION_EXPANDS => 'VIDEO_INTERACTION_EXPANDS', + self::VIDEO_INTERACTION_FULL_SCREENS => 'VIDEO_INTERACTION_FULL_SCREENS', + self::VIDEO_INTERACTION_MUTES => 'VIDEO_INTERACTION_MUTES', + self::VIDEO_INTERACTION_PAUSES => 'VIDEO_INTERACTION_PAUSES', + self::VIDEO_INTERACTION_RESUMES => 'VIDEO_INTERACTION_RESUMES', + self::VIDEO_INTERACTION_REWINDS => 'VIDEO_INTERACTION_REWINDS', + self::VIDEO_INTERACTION_UNMUTES => 'VIDEO_INTERACTION_UNMUTES', + self::VIDEO_INTERACTION_VIDEO_SKIPS => 'VIDEO_INTERACTION_VIDEO_SKIPS', + self::VIDEO_REAL_TIME_CREATIVE_SERVES => 'VIDEO_REAL_TIME_CREATIVE_SERVES', + self::VIDEO_REAL_TIME_ERROR_100_COUNT => 'VIDEO_REAL_TIME_ERROR_100_COUNT', + self::VIDEO_REAL_TIME_ERROR_101_COUNT => 'VIDEO_REAL_TIME_ERROR_101_COUNT', + self::VIDEO_REAL_TIME_ERROR_102_COUNT => 'VIDEO_REAL_TIME_ERROR_102_COUNT', + self::VIDEO_REAL_TIME_ERROR_200_COUNT => 'VIDEO_REAL_TIME_ERROR_200_COUNT', + self::VIDEO_REAL_TIME_ERROR_201_COUNT => 'VIDEO_REAL_TIME_ERROR_201_COUNT', + self::VIDEO_REAL_TIME_ERROR_202_COUNT => 'VIDEO_REAL_TIME_ERROR_202_COUNT', + self::VIDEO_REAL_TIME_ERROR_203_COUNT => 'VIDEO_REAL_TIME_ERROR_203_COUNT', + self::VIDEO_REAL_TIME_ERROR_300_COUNT => 'VIDEO_REAL_TIME_ERROR_300_COUNT', + self::VIDEO_REAL_TIME_ERROR_301_COUNT => 'VIDEO_REAL_TIME_ERROR_301_COUNT', + self::VIDEO_REAL_TIME_ERROR_302_COUNT => 'VIDEO_REAL_TIME_ERROR_302_COUNT', + self::VIDEO_REAL_TIME_ERROR_303_COUNT => 'VIDEO_REAL_TIME_ERROR_303_COUNT', + self::VIDEO_REAL_TIME_ERROR_400_COUNT => 'VIDEO_REAL_TIME_ERROR_400_COUNT', + self::VIDEO_REAL_TIME_ERROR_401_COUNT => 'VIDEO_REAL_TIME_ERROR_401_COUNT', + self::VIDEO_REAL_TIME_ERROR_402_COUNT => 'VIDEO_REAL_TIME_ERROR_402_COUNT', + self::VIDEO_REAL_TIME_ERROR_403_COUNT => 'VIDEO_REAL_TIME_ERROR_403_COUNT', + self::VIDEO_REAL_TIME_ERROR_405_COUNT => 'VIDEO_REAL_TIME_ERROR_405_COUNT', + self::VIDEO_REAL_TIME_ERROR_406_COUNT => 'VIDEO_REAL_TIME_ERROR_406_COUNT', + self::VIDEO_REAL_TIME_ERROR_407_COUNT => 'VIDEO_REAL_TIME_ERROR_407_COUNT', + self::VIDEO_REAL_TIME_ERROR_408_COUNT => 'VIDEO_REAL_TIME_ERROR_408_COUNT', + self::VIDEO_REAL_TIME_ERROR_409_COUNT => 'VIDEO_REAL_TIME_ERROR_409_COUNT', + self::VIDEO_REAL_TIME_ERROR_410_COUNT => 'VIDEO_REAL_TIME_ERROR_410_COUNT', + self::VIDEO_REAL_TIME_ERROR_500_COUNT => 'VIDEO_REAL_TIME_ERROR_500_COUNT', + self::VIDEO_REAL_TIME_ERROR_501_COUNT => 'VIDEO_REAL_TIME_ERROR_501_COUNT', + self::VIDEO_REAL_TIME_ERROR_502_COUNT => 'VIDEO_REAL_TIME_ERROR_502_COUNT', + self::VIDEO_REAL_TIME_ERROR_503_COUNT => 'VIDEO_REAL_TIME_ERROR_503_COUNT', + self::VIDEO_REAL_TIME_ERROR_600_COUNT => 'VIDEO_REAL_TIME_ERROR_600_COUNT', + self::VIDEO_REAL_TIME_ERROR_601_COUNT => 'VIDEO_REAL_TIME_ERROR_601_COUNT', + self::VIDEO_REAL_TIME_ERROR_602_COUNT => 'VIDEO_REAL_TIME_ERROR_602_COUNT', + self::VIDEO_REAL_TIME_ERROR_603_COUNT => 'VIDEO_REAL_TIME_ERROR_603_COUNT', + self::VIDEO_REAL_TIME_ERROR_604_COUNT => 'VIDEO_REAL_TIME_ERROR_604_COUNT', + self::VIDEO_REAL_TIME_ERROR_900_COUNT => 'VIDEO_REAL_TIME_ERROR_900_COUNT', + self::VIDEO_REAL_TIME_ERROR_901_COUNT => 'VIDEO_REAL_TIME_ERROR_901_COUNT', + self::VIDEO_REAL_TIME_IMPRESSIONS => 'VIDEO_REAL_TIME_IMPRESSIONS', + self::VIDEO_REAL_TIME_MATCHED_QUERIES => 'VIDEO_REAL_TIME_MATCHED_QUERIES', + self::VIDEO_REAL_TIME_TOTAL_ERROR_COUNT => 'VIDEO_REAL_TIME_TOTAL_ERROR_COUNT', + self::VIDEO_REAL_TIME_TOTAL_QUERIES => 'VIDEO_REAL_TIME_TOTAL_QUERIES', + self::VIDEO_REAL_TIME_UNMATCHED_QUERIES => 'VIDEO_REAL_TIME_UNMATCHED_QUERIES', + self::VIDEO_VIEWERSHIP_AUTO_PLAYS => 'VIDEO_VIEWERSHIP_AUTO_PLAYS', + self::VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE => 'VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE', + self::VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME => 'VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME', + self::VIDEO_VIEWERSHIP_CLICK_TO_PLAYS => 'VIDEO_VIEWERSHIP_CLICK_TO_PLAYS', + self::VIDEO_VIEWERSHIP_COMPLETES => 'VIDEO_VIEWERSHIP_COMPLETES', + self::VIDEO_VIEWERSHIP_COMPLETION_RATE => 'VIDEO_VIEWERSHIP_COMPLETION_RATE', + self::VIDEO_VIEWERSHIP_ENGAGED_VIEWS => 'VIDEO_VIEWERSHIP_ENGAGED_VIEWS', + self::VIDEO_VIEWERSHIP_FIRST_QUARTILES => 'VIDEO_VIEWERSHIP_FIRST_QUARTILES', + self::VIDEO_VIEWERSHIP_MIDPOINTS => 'VIDEO_VIEWERSHIP_MIDPOINTS', + self::VIDEO_VIEWERSHIP_SKIP_BUTTONS_SHOWN => 'VIDEO_VIEWERSHIP_SKIP_BUTTONS_SHOWN', + self::VIDEO_VIEWERSHIP_STARTS => 'VIDEO_VIEWERSHIP_STARTS', + self::VIDEO_VIEWERSHIP_THIRD_QUARTILES => 'VIDEO_VIEWERSHIP_THIRD_QUARTILES', + self::VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT => 'VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT', + self::VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE => 'VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE', + self::VIDEO_VIEWERSHIP_VIDEO_LENGTH => 'VIDEO_VIEWERSHIP_VIDEO_LENGTH', + self::VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE => 'VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE', + self::YIELD_GROUP_ESTIMATED_CPM => 'YIELD_GROUP_ESTIMATED_CPM', + self::YIELD_GROUP_ESTIMATED_REVENUE => 'YIELD_GROUP_ESTIMATED_REVENUE', + self::YIELD_GROUP_IMPRESSIONS => 'YIELD_GROUP_IMPRESSIONS', + self::YIELD_GROUP_MEDIATION_FILL_RATE => 'YIELD_GROUP_MEDIATION_FILL_RATE', + self::YIELD_GROUP_MEDIATION_MATCHED_QUERIES => 'YIELD_GROUP_MEDIATION_MATCHED_QUERIES', + self::YIELD_GROUP_MEDIATION_PASSBACKS => 'YIELD_GROUP_MEDIATION_PASSBACKS', + self::YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM => 'YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Report/MetricValueType.php b/AdsAdManager/src/V1/Report/MetricValueType.php new file mode 100644 index 000000000000..3a8557eab111 --- /dev/null +++ b/AdsAdManager/src/V1/Report/MetricValueType.php @@ -0,0 +1,83 @@ +google.ads.admanager.v1.Report.MetricValueType + */ +class MetricValueType +{ + /** + * The values for the primary date_range. + * + * Generated from protobuf enum PRIMARY = 0; + */ + const PRIMARY = 0; + /** + * Each metrics' percent of the total for the primary date_range. + * + * Generated from protobuf enum PRIMARY_PERCENT_OF_TOTAL = 1; + */ + const PRIMARY_PERCENT_OF_TOTAL = 1; + /** + * The values for the comparison_date_range. + * + * Generated from protobuf enum COMPARISON = 2; + */ + const COMPARISON = 2; + /** + * Each metrics' percent of the total for the comparison_date_range. + * + * Generated from protobuf enum COMPARISON_PERCENT_OF_TOTAL = 3; + */ + const COMPARISON_PERCENT_OF_TOTAL = 3; + /** + * The absolute change between the primary and comparison date ranges. + * + * Generated from protobuf enum ABSOLUTE_CHANGE = 4; + */ + const ABSOLUTE_CHANGE = 4; + /** + * The relative change between the primary and comparison date ranges. + * + * Generated from protobuf enum RELATIVE_CHANGE = 5; + */ + const RELATIVE_CHANGE = 5; + + private static $valueToName = [ + self::PRIMARY => 'PRIMARY', + self::PRIMARY_PERCENT_OF_TOTAL => 'PRIMARY_PERCENT_OF_TOTAL', + self::COMPARISON => 'COMPARISON', + self::COMPARISON_PERCENT_OF_TOTAL => 'COMPARISON_PERCENT_OF_TOTAL', + self::ABSOLUTE_CHANGE => 'ABSOLUTE_CHANGE', + self::RELATIVE_CHANGE => 'RELATIVE_CHANGE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Report/ReportType.php b/AdsAdManager/src/V1/Report/ReportType.php new file mode 100644 index 000000000000..f00508132276 --- /dev/null +++ b/AdsAdManager/src/V1/Report/ReportType.php @@ -0,0 +1,55 @@ +google.ads.admanager.v1.Report.ReportType + */ +class ReportType +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum REPORT_TYPE_UNSPECIFIED = 0; + */ + const REPORT_TYPE_UNSPECIFIED = 0; + /** + * Historical. + * + * Generated from protobuf enum HISTORICAL = 1; + */ + const HISTORICAL = 1; + + private static $valueToName = [ + self::REPORT_TYPE_UNSPECIFIED => 'REPORT_TYPE_UNSPECIFIED', + self::HISTORICAL => 'HISTORICAL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Report/Slice.php b/AdsAdManager/src/V1/Report/Slice.php new file mode 100644 index 000000000000..b0af001ed513 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Slice.php @@ -0,0 +1,114 @@ +google.ads.admanager.v1.Report.Slice + */ +class Slice extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The dimension to slice on. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Dimension dimension = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $dimension = 0; + /** + * Required. The value of the dimension. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Value value = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $value = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $dimension + * Required. The dimension to slice on. + * @type \Google\Ads\AdManager\V1\Report\Value $value + * Required. The value of the dimension. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The dimension to slice on. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Dimension dimension = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getDimension() + { + return $this->dimension; + } + + /** + * Required. The dimension to slice on. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Dimension dimension = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setDimension($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\Dimension::class); + $this->dimension = $var; + + return $this; + } + + /** + * Required. The value of the dimension. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Value value = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\Report\Value|null + */ + public function getValue() + { + return $this->value; + } + + public function hasValue() + { + return isset($this->value); + } + + public function clearValue() + { + unset($this->value); + } + + /** + * Required. The value of the dimension. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Value value = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\Report\Value $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Value::class); + $this->value = $var; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Sort.php b/AdsAdManager/src/V1/Report/Sort.php new file mode 100644 index 000000000000..721e80f89774 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Sort.php @@ -0,0 +1,252 @@ +google.ads.admanager.v1.Report.Sort + */ +class Sort extends \Google\Protobuf\Internal\Message +{ + /** + * Required. A field (dimension or metric) to sort by. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $field = null; + /** + * Optional. The sort order. If true the sort will be descending. + * + * Generated from protobuf field bool descending = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $descending = false; + /** + * Optional. Use to sort on a specific slice of data. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $slice = null; + /** + * Optional. When using time period columns, use this to sort on a specific + * column. + * + * Generated from protobuf field optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $time_period_index = null; + /** + * Optional. Use to specify which metric value type to sort on. Defaults to + * PRIMARY. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $metric_value_type = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\Report\Field $field + * Required. A field (dimension or metric) to sort by. + * @type bool $descending + * Optional. The sort order. If true the sort will be descending. + * @type \Google\Ads\AdManager\V1\Report\Slice $slice + * Optional. Use to sort on a specific slice of data. + * @type int $time_period_index + * Optional. When using time period columns, use this to sort on a specific + * column. + * @type int $metric_value_type + * Optional. Use to specify which metric value type to sort on. Defaults to + * PRIMARY. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. A field (dimension or metric) to sort by. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\Report\Field|null + */ + public function getField() + { + return $this->field; + } + + public function hasField() + { + return isset($this->field); + } + + public function clearField() + { + unset($this->field); + } + + /** + * Required. A field (dimension or metric) to sort by. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\Report\Field $var + * @return $this + */ + public function setField($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Field::class); + $this->field = $var; + + return $this; + } + + /** + * Optional. The sort order. If true the sort will be descending. + * + * Generated from protobuf field bool descending = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getDescending() + { + return $this->descending; + } + + /** + * Optional. The sort order. If true the sort will be descending. + * + * Generated from protobuf field bool descending = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setDescending($var) + { + GPBUtil::checkBool($var); + $this->descending = $var; + + return $this; + } + + /** + * Optional. Use to sort on a specific slice of data. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Ads\AdManager\V1\Report\Slice|null + */ + public function getSlice() + { + return $this->slice; + } + + public function hasSlice() + { + return isset($this->slice); + } + + public function clearSlice() + { + unset($this->slice); + } + + /** + * Optional. Use to sort on a specific slice of data. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Ads\AdManager\V1\Report\Slice $var + * @return $this + */ + public function setSlice($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Slice::class); + $this->slice = $var; + + return $this; + } + + /** + * Optional. When using time period columns, use this to sort on a specific + * column. + * + * Generated from protobuf field optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getTimePeriodIndex() + { + return isset($this->time_period_index) ? $this->time_period_index : 0; + } + + public function hasTimePeriodIndex() + { + return isset($this->time_period_index); + } + + public function clearTimePeriodIndex() + { + unset($this->time_period_index); + } + + /** + * Optional. When using time period columns, use this to sort on a specific + * column. + * + * Generated from protobuf field optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setTimePeriodIndex($var) + { + GPBUtil::checkInt32($var); + $this->time_period_index = $var; + + return $this; + } + + /** + * Optional. Use to specify which metric value type to sort on. Defaults to + * PRIMARY. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getMetricValueType() + { + return isset($this->metric_value_type) ? $this->metric_value_type : 0; + } + + public function hasMetricValueType() + { + return isset($this->metric_value_type); + } + + public function clearMetricValueType() + { + unset($this->metric_value_type); + } + + /** + * Optional. Use to specify which metric value type to sort on. Defaults to + * PRIMARY. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setMetricValueType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\MetricValueType::class); + $this->metric_value_type = $var; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/TimePeriodColumn.php b/AdsAdManager/src/V1/Report/TimePeriodColumn.php new file mode 100644 index 000000000000..d882d06e6049 --- /dev/null +++ b/AdsAdManager/src/V1/Report/TimePeriodColumn.php @@ -0,0 +1,76 @@ +google.ads.admanager.v1.Report.TimePeriodColumn + */ +class TimePeriodColumn +{ + /** + * Default value. Report will have no time period column. + * + * Generated from protobuf enum TIME_PERIOD_COLUMN_UNSPECIFIED = 0; + */ + const TIME_PERIOD_COLUMN_UNSPECIFIED = 0; + /** + * A column for each date in the report. + * + * Generated from protobuf enum TIME_PERIOD_COLUMN_DATE = 1; + */ + const TIME_PERIOD_COLUMN_DATE = 1; + /** + * A column for each week in the report. + * + * Generated from protobuf enum TIME_PERIOD_COLUMN_WEEK = 2; + */ + const TIME_PERIOD_COLUMN_WEEK = 2; + /** + * A column for each month in the report. + * + * Generated from protobuf enum TIME_PERIOD_COLUMN_MONTH = 3; + */ + const TIME_PERIOD_COLUMN_MONTH = 3; + /** + * A column for each quarter in the report. + * + * Generated from protobuf enum TIME_PERIOD_COLUMN_QUARTER = 4; + */ + const TIME_PERIOD_COLUMN_QUARTER = 4; + + private static $valueToName = [ + self::TIME_PERIOD_COLUMN_UNSPECIFIED => 'TIME_PERIOD_COLUMN_UNSPECIFIED', + self::TIME_PERIOD_COLUMN_DATE => 'TIME_PERIOD_COLUMN_DATE', + self::TIME_PERIOD_COLUMN_WEEK => 'TIME_PERIOD_COLUMN_WEEK', + self::TIME_PERIOD_COLUMN_MONTH => 'TIME_PERIOD_COLUMN_MONTH', + self::TIME_PERIOD_COLUMN_QUARTER => 'TIME_PERIOD_COLUMN_QUARTER', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Report/Value.php b/AdsAdManager/src/V1/Report/Value.php new file mode 100644 index 000000000000..e0f3dfefc0d2 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Value.php @@ -0,0 +1,274 @@ +google.ads.admanager.v1.Report.Value + */ +class Value extends \Google\Protobuf\Internal\Message +{ + protected $value; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $int_value + * For integer values. + * @type float $double_value + * For double values. + * @type string $string_value + * For string values. + * @type bool $bool_value + * For boolean values. + * @type \Google\Ads\AdManager\V1\Report\Value\IntList $int_list_value + * For lists of integer values. + * @type \Google\Ads\AdManager\V1\Report\Value\StringList $string_list_value + * For lists of string values. + * @type string $bytes_value + * For bytes values. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * For integer values. + * + * Generated from protobuf field int64 int_value = 1; + * @return int|string + */ + public function getIntValue() + { + return $this->readOneof(1); + } + + public function hasIntValue() + { + return $this->hasOneof(1); + } + + /** + * For integer values. + * + * Generated from protobuf field int64 int_value = 1; + * @param int|string $var + * @return $this + */ + public function setIntValue($var) + { + GPBUtil::checkInt64($var); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * For double values. + * + * Generated from protobuf field double double_value = 2; + * @return float + */ + public function getDoubleValue() + { + return $this->readOneof(2); + } + + public function hasDoubleValue() + { + return $this->hasOneof(2); + } + + /** + * For double values. + * + * Generated from protobuf field double double_value = 2; + * @param float $var + * @return $this + */ + public function setDoubleValue($var) + { + GPBUtil::checkDouble($var); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * For string values. + * + * Generated from protobuf field string string_value = 3; + * @return string + */ + public function getStringValue() + { + return $this->readOneof(3); + } + + public function hasStringValue() + { + return $this->hasOneof(3); + } + + /** + * For string values. + * + * Generated from protobuf field string string_value = 3; + * @param string $var + * @return $this + */ + public function setStringValue($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * For boolean values. + * + * Generated from protobuf field bool bool_value = 4; + * @return bool + */ + public function getBoolValue() + { + return $this->readOneof(4); + } + + public function hasBoolValue() + { + return $this->hasOneof(4); + } + + /** + * For boolean values. + * + * Generated from protobuf field bool bool_value = 4; + * @param bool $var + * @return $this + */ + public function setBoolValue($var) + { + GPBUtil::checkBool($var); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * For lists of integer values. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Value.IntList int_list_value = 6; + * @return \Google\Ads\AdManager\V1\Report\Value\IntList|null + */ + public function getIntListValue() + { + return $this->readOneof(6); + } + + public function hasIntListValue() + { + return $this->hasOneof(6); + } + + /** + * For lists of integer values. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Value.IntList int_list_value = 6; + * @param \Google\Ads\AdManager\V1\Report\Value\IntList $var + * @return $this + */ + public function setIntListValue($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Value\IntList::class); + $this->writeOneof(6, $var); + + return $this; + } + + /** + * For lists of string values. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Value.StringList string_list_value = 7; + * @return \Google\Ads\AdManager\V1\Report\Value\StringList|null + */ + public function getStringListValue() + { + return $this->readOneof(7); + } + + public function hasStringListValue() + { + return $this->hasOneof(7); + } + + /** + * For lists of string values. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.Value.StringList string_list_value = 7; + * @param \Google\Ads\AdManager\V1\Report\Value\StringList $var + * @return $this + */ + public function setStringListValue($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\Value\StringList::class); + $this->writeOneof(7, $var); + + return $this; + } + + /** + * For bytes values. + * + * Generated from protobuf field bytes bytes_value = 8; + * @return string + */ + public function getBytesValue() + { + return $this->readOneof(8); + } + + public function hasBytesValue() + { + return $this->hasOneof(8); + } + + /** + * For bytes values. + * + * Generated from protobuf field bytes bytes_value = 8; + * @param string $var + * @return $this + */ + public function setBytesValue($var) + { + GPBUtil::checkString($var, False); + $this->writeOneof(8, $var); + + return $this; + } + + /** + * @return string + */ + public function getValue() + { + return $this->whichOneof("value"); + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Value/IntList.php b/AdsAdManager/src/V1/Report/Value/IntList.php new file mode 100644 index 000000000000..f8973692cc7e --- /dev/null +++ b/AdsAdManager/src/V1/Report/Value/IntList.php @@ -0,0 +1,68 @@ +google.ads.admanager.v1.Report.Value.IntList + */ +class IntList extends \Google\Protobuf\Internal\Message +{ + /** + * The values + * + * Generated from protobuf field repeated int64 values = 1; + */ + private $values; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|array|\Google\Protobuf\Internal\RepeatedField $values + * The values + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * The values + * + * Generated from protobuf field repeated int64 values = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getValues() + { + return $this->values; + } + + /** + * The values + * + * Generated from protobuf field repeated int64 values = 1; + * @param array|array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64); + $this->values = $arr; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Value/StringList.php b/AdsAdManager/src/V1/Report/Value/StringList.php new file mode 100644 index 000000000000..f8c9042f5214 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Value/StringList.php @@ -0,0 +1,68 @@ +google.ads.admanager.v1.Report.Value.StringList + */ +class StringList extends \Google\Protobuf\Internal\Message +{ + /** + * The values + * + * Generated from protobuf field repeated string values = 1; + */ + private $values; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $values + * The values + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * The values + * + * Generated from protobuf field repeated string values = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getValues() + { + return $this->values; + } + + /** + * The values + * + * Generated from protobuf field repeated string values = 1; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setValues($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->values = $arr; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Report/Visibility.php b/AdsAdManager/src/V1/Report/Visibility.php new file mode 100644 index 000000000000..990e89aa5e71 --- /dev/null +++ b/AdsAdManager/src/V1/Report/Visibility.php @@ -0,0 +1,65 @@ +google.ads.admanager.v1.Report.Visibility + */ +class Visibility +{ + /** + * Default value. Reports with hidden visibility will not appear in the Ad + * Manager UI. + * + * Generated from protobuf enum HIDDEN = 0; + */ + const HIDDEN = 0; + /** + * Reports with draft visibility will appear in the Ad Manager UI only if + * the user has configured the UI to show them. + * + * Generated from protobuf enum DRAFT = 1; + */ + const DRAFT = 1; + /** + * Reports with saved visibility will appear in the Ad Manager UI by + * default. + * + * Generated from protobuf enum SAVED = 2; + */ + const SAVED = 2; + + private static $valueToName = [ + self::HIDDEN => 'HIDDEN', + self::DRAFT => 'DRAFT', + self::SAVED => 'SAVED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/ReportDefinition.php b/AdsAdManager/src/V1/ReportDefinition.php new file mode 100644 index 000000000000..148e84f9f03e --- /dev/null +++ b/AdsAdManager/src/V1/ReportDefinition.php @@ -0,0 +1,667 @@ +google.ads.admanager.v1.ReportDefinition + */ +class ReportDefinition extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The list of dimensions to report on. If empty, the report will + * have no dimensions, and any metrics will be totals. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $dimensions; + /** + * Required. The list of metrics to report on. If empty, the report will have + * no metrics. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $metrics; + /** + * Optional. The filters for this report. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $filters; + /** + * Optional. The time zone the date range is defined in for this report. + * Defaults to publisher's time zone if not specified. Time zone in IANA + * format. Acceptable values depend on the report type. Publisher time zone is + * always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC" + * for UTC. + * + * Generated from protobuf field string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $time_zone = ''; + /** + * Optional. The ISO 4217 currency code for this report. Defaults to publisher + * currency code if not specified. + * + * Generated from protobuf field string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $currency_code = ''; + /** + * Required. The primary date range of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $date_range = null; + /** + * Optional. The comparison date range of this report. If unspecified, the + * report will not have any comparison metrics. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $comparison_date_range = null; + /** + * Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, custom_dimension_key_ids[0] describes + * CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE. + * + * Generated from protobuf field repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $custom_dimension_key_ids; + /** + * Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, line_item_custom_field_ids[0] describes + * LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $line_item_custom_field_ids; + /** + * Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, order_custom_field_ids[0] describes + * ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $order_custom_field_ids; + /** + * Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, creative_custom_field_ids[0] describes + * CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $creative_custom_field_ids; + /** + * Required. The type of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $report_type = 0; + /** + * Optional. Include a time period column to introduce comparison columns in + * the report for each generated period. For example, set to "QUARTERS" here + * to have a column for each quarter present in the primary date range. If + * "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter + * column will also include comparison values for its relative previous + * quarter. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $time_period_column = 0; + /** + * Optional. List of flags for this report. Used to flag rows in a result set + * based on a set of defined filters. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $flags; + /** + * Optional. Default sorts to apply to this report. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $sorts; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $dimensions + * Required. The list of dimensions to report on. If empty, the report will + * have no dimensions, and any metrics will be totals. + * @type array|\Google\Protobuf\Internal\RepeatedField $metrics + * Required. The list of metrics to report on. If empty, the report will have + * no metrics. + * @type array<\Google\Ads\AdManager\V1\Report\Filter>|\Google\Protobuf\Internal\RepeatedField $filters + * Optional. The filters for this report. + * @type string $time_zone + * Optional. The time zone the date range is defined in for this report. + * Defaults to publisher's time zone if not specified. Time zone in IANA + * format. Acceptable values depend on the report type. Publisher time zone is + * always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC" + * for UTC. + * @type string $currency_code + * Optional. The ISO 4217 currency code for this report. Defaults to publisher + * currency code if not specified. + * @type \Google\Ads\AdManager\V1\Report\DateRange $date_range + * Required. The primary date range of this report. + * @type \Google\Ads\AdManager\V1\Report\DateRange $comparison_date_range + * Optional. The comparison date range of this report. If unspecified, the + * report will not have any comparison metrics. + * @type array|array|\Google\Protobuf\Internal\RepeatedField $custom_dimension_key_ids + * Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, custom_dimension_key_ids[0] describes + * CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE. + * @type array|array|\Google\Protobuf\Internal\RepeatedField $line_item_custom_field_ids + * Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, line_item_custom_field_ids[0] describes + * LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE. + * @type array|array|\Google\Protobuf\Internal\RepeatedField $order_custom_field_ids + * Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, order_custom_field_ids[0] describes + * ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE. + * @type array|array|\Google\Protobuf\Internal\RepeatedField $creative_custom_field_ids + * Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, creative_custom_field_ids[0] describes + * CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE. + * @type int $report_type + * Required. The type of this report. + * @type int $time_period_column + * Optional. Include a time period column to introduce comparison columns in + * the report for each generated period. For example, set to "QUARTERS" here + * to have a column for each quarter present in the primary date range. If + * "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter + * column will also include comparison values for its relative previous + * quarter. + * @type array<\Google\Ads\AdManager\V1\Report\Flag>|\Google\Protobuf\Internal\RepeatedField $flags + * Optional. List of flags for this report. Used to flag rows in a result set + * based on a set of defined filters. + * @type array<\Google\Ads\AdManager\V1\Report\Sort>|\Google\Protobuf\Internal\RepeatedField $sorts + * Optional. Default sorts to apply to this report. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The list of dimensions to report on. If empty, the report will + * have no dimensions, and any metrics will be totals. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDimensions() + { + return $this->dimensions; + } + + /** + * Required. The list of dimensions to report on. If empty, the report will + * have no dimensions, and any metrics will be totals. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDimensions($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\AdManager\V1\Report\Dimension::class); + $this->dimensions = $arr; + + return $this; + } + + /** + * Required. The list of metrics to report on. If empty, the report will have + * no metrics. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMetrics() + { + return $this->metrics; + } + + /** + * Required. The list of metrics to report on. If empty, the report will have + * no metrics. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMetrics($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\AdManager\V1\Report\Metric::class); + $this->metrics = $arr; + + return $this; + } + + /** + * Optional. The filters for this report. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getFilters() + { + return $this->filters; + } + + /** + * Optional. The filters for this report. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\Report\Filter>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setFilters($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Filter::class); + $this->filters = $arr; + + return $this; + } + + /** + * Optional. The time zone the date range is defined in for this report. + * Defaults to publisher's time zone if not specified. Time zone in IANA + * format. Acceptable values depend on the report type. Publisher time zone is + * always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC" + * for UTC. + * + * Generated from protobuf field string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getTimeZone() + { + return $this->time_zone; + } + + /** + * Optional. The time zone the date range is defined in for this report. + * Defaults to publisher's time zone if not specified. Time zone in IANA + * format. Acceptable values depend on the report type. Publisher time zone is + * always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC" + * for UTC. + * + * Generated from protobuf field string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setTimeZone($var) + { + GPBUtil::checkString($var, True); + $this->time_zone = $var; + + return $this; + } + + /** + * Optional. The ISO 4217 currency code for this report. Defaults to publisher + * currency code if not specified. + * + * Generated from protobuf field string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getCurrencyCode() + { + return $this->currency_code; + } + + /** + * Optional. The ISO 4217 currency code for this report. Defaults to publisher + * currency code if not specified. + * + * Generated from protobuf field string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setCurrencyCode($var) + { + GPBUtil::checkString($var, True); + $this->currency_code = $var; + + return $this; + } + + /** + * Required. The primary date range of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\Report\DateRange|null + */ + public function getDateRange() + { + return $this->date_range; + } + + public function hasDateRange() + { + return isset($this->date_range); + } + + public function clearDateRange() + { + unset($this->date_range); + } + + /** + * Required. The primary date range of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\Report\DateRange $var + * @return $this + */ + public function setDateRange($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\DateRange::class); + $this->date_range = $var; + + return $this; + } + + /** + * Optional. The comparison date range of this report. If unspecified, the + * report will not have any comparison metrics. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Ads\AdManager\V1\Report\DateRange|null + */ + public function getComparisonDateRange() + { + return $this->comparison_date_range; + } + + public function hasComparisonDateRange() + { + return isset($this->comparison_date_range); + } + + public function clearComparisonDateRange() + { + unset($this->comparison_date_range); + } + + /** + * Optional. The comparison date range of this report. If unspecified, the + * report will not have any comparison metrics. + * + * Generated from protobuf field optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Ads\AdManager\V1\Report\DateRange $var + * @return $this + */ + public function setComparisonDateRange($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\DateRange::class); + $this->comparison_date_range = $var; + + return $this; + } + + /** + * Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, custom_dimension_key_ids[0] describes + * CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE. + * + * Generated from protobuf field repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCustomDimensionKeyIds() + { + return $this->custom_dimension_key_ids; + } + + /** + * Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, custom_dimension_key_ids[0] describes + * CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE. + * + * Generated from protobuf field repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCustomDimensionKeyIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64); + $this->custom_dimension_key_ids = $arr; + + return $this; + } + + /** + * Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, line_item_custom_field_ids[0] describes + * LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getLineItemCustomFieldIds() + { + return $this->line_item_custom_field_ids; + } + + /** + * Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, line_item_custom_field_ids[0] describes + * LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setLineItemCustomFieldIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64); + $this->line_item_custom_field_ids = $arr; + + return $this; + } + + /** + * Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, order_custom_field_ids[0] describes + * ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getOrderCustomFieldIds() + { + return $this->order_custom_field_ids; + } + + /** + * Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, order_custom_field_ids[0] describes + * ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setOrderCustomFieldIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64); + $this->order_custom_field_ids = $arr; + + return $this; + } + + /** + * Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, creative_custom_field_ids[0] describes + * CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCreativeCustomFieldIds() + { + return $this->creative_custom_field_ids; + } + + /** + * Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* + * dimensions. The index of this repeated field corresponds to the index on + * each dimension. For example, creative_custom_field_ids[0] describes + * CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE. + * + * Generated from protobuf field repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCreativeCustomFieldIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64); + $this->creative_custom_field_ids = $arr; + + return $this; + } + + /** + * Required. The type of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getReportType() + { + return $this->report_type; + } + + /** + * Required. The type of this report. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setReportType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\ReportType::class); + $this->report_type = $var; + + return $this; + } + + /** + * Optional. Include a time period column to introduce comparison columns in + * the report for each generated period. For example, set to "QUARTERS" here + * to have a column for each quarter present in the primary date range. If + * "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter + * column will also include comparison values for its relative previous + * quarter. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getTimePeriodColumn() + { + return $this->time_period_column; + } + + /** + * Optional. Include a time period column to introduce comparison columns in + * the report for each generated period. For example, set to "QUARTERS" here + * to have a column for each quarter present in the primary date range. If + * "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter + * column will also include comparison values for its relative previous + * quarter. + * + * Generated from protobuf field .google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setTimePeriodColumn($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\TimePeriodColumn::class); + $this->time_period_column = $var; + + return $this; + } + + /** + * Optional. List of flags for this report. Used to flag rows in a result set + * based on a set of defined filters. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getFlags() + { + return $this->flags; + } + + /** + * Optional. List of flags for this report. Used to flag rows in a result set + * based on a set of defined filters. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\Report\Flag>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setFlags($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Flag::class); + $this->flags = $arr; + + return $this; + } + + /** + * Optional. Default sorts to apply to this report. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSorts() + { + return $this->sorts; + } + + /** + * Optional. Default sorts to apply to this report. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\Report\Sort>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSorts($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Sort::class); + $this->sorts = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/Role.php b/AdsAdManager/src/V1/Role.php new file mode 100644 index 000000000000..dada96c1f725 --- /dev/null +++ b/AdsAdManager/src/V1/Role.php @@ -0,0 +1,241 @@ +google.ads.admanager.v1.Role + */ +class Role extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `Role`. + * Format: `networks/{network_code}/roles/{role_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. `Role` ID. + * + * Generated from protobuf field int64 role_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $role_id = 0; + /** + * Required. The display name of the `Role`. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $display_name = ''; + /** + * Optional. The description of the `Role`. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $description = ''; + /** + * Output only. Whether the `Role` is a built-in or custom user role. + * + * Generated from protobuf field bool built_in = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $built_in = false; + /** + * Output only. The status of the `Role`. + * + * Generated from protobuf field .google.ads.admanager.v1.RoleStatusEnum.RoleStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `Role`. + * Format: `networks/{network_code}/roles/{role_id}` + * @type int|string $role_id + * Output only. `Role` ID. + * @type string $display_name + * Required. The display name of the `Role`. + * @type string $description + * Optional. The description of the `Role`. + * @type bool $built_in + * Output only. Whether the `Role` is a built-in or custom user role. + * @type int $status + * Output only. The status of the `Role`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\RoleMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `Role`. + * Format: `networks/{network_code}/roles/{role_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `Role`. + * Format: `networks/{network_code}/roles/{role_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. `Role` ID. + * + * Generated from protobuf field int64 role_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getRoleId() + { + return $this->role_id; + } + + /** + * Output only. `Role` ID. + * + * Generated from protobuf field int64 role_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setRoleId($var) + { + GPBUtil::checkInt64($var); + $this->role_id = $var; + + return $this; + } + + /** + * Required. The display name of the `Role`. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Required. The display name of the `Role`. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Optional. The description of the `Role`. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDescription() + { + return $this->description; + } + + /** + * Optional. The description of the `Role`. + * + * Generated from protobuf field string description = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDescription($var) + { + GPBUtil::checkString($var, True); + $this->description = $var; + + return $this; + } + + /** + * Output only. Whether the `Role` is a built-in or custom user role. + * + * Generated from protobuf field bool built_in = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getBuiltIn() + { + return $this->built_in; + } + + /** + * Output only. Whether the `Role` is a built-in or custom user role. + * + * Generated from protobuf field bool built_in = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setBuiltIn($var) + { + GPBUtil::checkBool($var); + $this->built_in = $var; + + return $this; + } + + /** + * Output only. The status of the `Role`. + * + * Generated from protobuf field .google.ads.admanager.v1.RoleStatusEnum.RoleStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getStatus() + { + return $this->status; + } + + /** + * Output only. The status of the `Role`. + * + * Generated from protobuf field .google.ads.admanager.v1.RoleStatusEnum.RoleStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\RoleStatusEnum\RoleStatus::class); + $this->status = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/RoleStatusEnum.php b/AdsAdManager/src/V1/RoleStatusEnum.php new file mode 100644 index 000000000000..f503830b55c8 --- /dev/null +++ b/AdsAdManager/src/V1/RoleStatusEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.RoleStatusEnum + */ +class RoleStatusEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\RoleEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/RoleStatusEnum/RoleStatus.php b/AdsAdManager/src/V1/RoleStatusEnum/RoleStatus.php new file mode 100644 index 000000000000..d217869ae173 --- /dev/null +++ b/AdsAdManager/src/V1/RoleStatusEnum/RoleStatus.php @@ -0,0 +1,62 @@ +google.ads.admanager.v1.RoleStatusEnum.RoleStatus + */ +class RoleStatus +{ + /** + * No value specified. + * + * Generated from protobuf enum ROLE_STATUS_UNSPECIFIED = 0; + */ + const ROLE_STATUS_UNSPECIFIED = 0; + /** + * Role is active. + * + * Generated from protobuf enum ACTIVE = 1; + */ + const ACTIVE = 1; + /** + * Role is inactive. + * + * Generated from protobuf enum INACTIVE = 2; + */ + const INACTIVE = 2; + + private static $valueToName = [ + self::ROLE_STATUS_UNSPECIFIED => 'ROLE_STATUS_UNSPECIFIED', + self::ACTIVE => 'ACTIVE', + self::INACTIVE => 'INACTIVE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/RunReportMetadata.php b/AdsAdManager/src/V1/RunReportMetadata.php new file mode 100644 index 000000000000..8ef7b7307ec0 --- /dev/null +++ b/AdsAdManager/src/V1/RunReportMetadata.php @@ -0,0 +1,105 @@ +google.ads.admanager.v1.RunReportMetadata + */ +class RunReportMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * An estimate of how close this report is to being completed. Will always be + * 100 for failed and completed reports. + * + * Generated from protobuf field int32 percent_complete = 2; + */ + protected $percent_complete = 0; + /** + * The result's parent report. + * + * Generated from protobuf field string report = 4 [(.google.api.resource_reference) = { + */ + protected $report = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $percent_complete + * An estimate of how close this report is to being completed. Will always be + * 100 for failed and completed reports. + * @type string $report + * The result's parent report. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * An estimate of how close this report is to being completed. Will always be + * 100 for failed and completed reports. + * + * Generated from protobuf field int32 percent_complete = 2; + * @return int + */ + public function getPercentComplete() + { + return $this->percent_complete; + } + + /** + * An estimate of how close this report is to being completed. Will always be + * 100 for failed and completed reports. + * + * Generated from protobuf field int32 percent_complete = 2; + * @param int $var + * @return $this + */ + public function setPercentComplete($var) + { + GPBUtil::checkInt32($var); + $this->percent_complete = $var; + + return $this; + } + + /** + * The result's parent report. + * + * Generated from protobuf field string report = 4 [(.google.api.resource_reference) = { + * @return string + */ + public function getReport() + { + return $this->report; + } + + /** + * The result's parent report. + * + * Generated from protobuf field string report = 4 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setReport($var) + { + GPBUtil::checkString($var, True); + $this->report = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/RunReportRequest.php b/AdsAdManager/src/V1/RunReportRequest.php new file mode 100644 index 000000000000..45effb973cb7 --- /dev/null +++ b/AdsAdManager/src/V1/RunReportRequest.php @@ -0,0 +1,86 @@ +google.ads.admanager.v1.RunReportRequest + */ +class RunReportRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The report to run. + * Format: `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The report to run. + * Format: `networks/{network_code}/reports/{report_id}` + * Please see {@see ReportServiceClient::reportName()} for help formatting this field. + * + * @return \Google\Ads\AdManager\V1\RunReportRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The report to run. + * Format: `networks/{network_code}/reports/{report_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The report to run. + * Format: `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The report to run. + * Format: `networks/{network_code}/reports/{report_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/RunReportResponse.php b/AdsAdManager/src/V1/RunReportResponse.php new file mode 100644 index 000000000000..c19b155b00c9 --- /dev/null +++ b/AdsAdManager/src/V1/RunReportResponse.php @@ -0,0 +1,71 @@ +google.ads.admanager.v1.RunReportResponse + */ +class RunReportResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The unique name of the generated result. Use with `FetchReportResultRows` + * to retrieve data. + * + * Generated from protobuf field string report_result = 1; + */ + protected $report_result = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $report_result + * The unique name of the generated result. Use with `FetchReportResultRows` + * to retrieve data. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * The unique name of the generated result. Use with `FetchReportResultRows` + * to retrieve data. + * + * Generated from protobuf field string report_result = 1; + * @return string + */ + public function getReportResult() + { + return $this->report_result; + } + + /** + * The unique name of the generated result. Use with `FetchReportResultRows` + * to retrieve data. + * + * Generated from protobuf field string report_result = 1; + * @param string $var + * @return $this + */ + public function setReportResult($var) + { + GPBUtil::checkString($var, True); + $this->report_result = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/Schedule.php b/AdsAdManager/src/V1/Schedule.php new file mode 100644 index 000000000000..cb71b1409633 --- /dev/null +++ b/AdsAdManager/src/V1/Schedule.php @@ -0,0 +1,306 @@ +google.ads.admanager.v1.Schedule + */ +class Schedule extends \Google\Protobuf\Internal\Message +{ + /** + * Date for the first run of the report. + * + * Generated from protobuf field .google.type.Date start_date = 1; + */ + protected $start_date = null; + /** + * Date for the final run of the report. + * + * Generated from protobuf field .google.type.Date end_date = 2; + */ + protected $end_date = null; + /** + * Frequency to run report. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule.Frequency frequency = 3; + */ + protected $frequency = 0; + /** + * Indicates start time for schedule to run + * Will use the time_zone from `ReportDefinition`. Defaults + * to the publisher's time zone if not specified. + * For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this + * will be the time of day that the first report will run on the first day. + * For example, if the start time is 2:00 PM, and the frequency is + * THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, + * 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, + * 2:00 PM, 10:00 PM. + * + * Generated from protobuf field .google.type.TimeOfDay start_time = 4; + */ + protected $start_time = null; + protected $frequency_schedule; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\Schedule\WeeklySchedule $weekly_schedule + * Days of week to schedule report run. + * @type \Google\Ads\AdManager\V1\Schedule\MonthlySchedule $monthly_schedule + * Days of month to schedule report run. + * @type \Google\Type\Date $start_date + * Date for the first run of the report. + * @type \Google\Type\Date $end_date + * Date for the final run of the report. + * @type int $frequency + * Frequency to run report. + * @type \Google\Type\TimeOfDay $start_time + * Indicates start time for schedule to run + * Will use the time_zone from `ReportDefinition`. Defaults + * to the publisher's time zone if not specified. + * For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this + * will be the time of day that the first report will run on the first day. + * For example, if the start time is 2:00 PM, and the frequency is + * THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, + * 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, + * 2:00 PM, 10:00 PM. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Days of week to schedule report run. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6; + * @return \Google\Ads\AdManager\V1\Schedule\WeeklySchedule|null + */ + public function getWeeklySchedule() + { + return $this->readOneof(6); + } + + public function hasWeeklySchedule() + { + return $this->hasOneof(6); + } + + /** + * Days of week to schedule report run. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6; + * @param \Google\Ads\AdManager\V1\Schedule\WeeklySchedule $var + * @return $this + */ + public function setWeeklySchedule($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Schedule\WeeklySchedule::class); + $this->writeOneof(6, $var); + + return $this; + } + + /** + * Days of month to schedule report run. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7; + * @return \Google\Ads\AdManager\V1\Schedule\MonthlySchedule|null + */ + public function getMonthlySchedule() + { + return $this->readOneof(7); + } + + public function hasMonthlySchedule() + { + return $this->hasOneof(7); + } + + /** + * Days of month to schedule report run. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7; + * @param \Google\Ads\AdManager\V1\Schedule\MonthlySchedule $var + * @return $this + */ + public function setMonthlySchedule($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Schedule\MonthlySchedule::class); + $this->writeOneof(7, $var); + + return $this; + } + + /** + * Date for the first run of the report. + * + * Generated from protobuf field .google.type.Date start_date = 1; + * @return \Google\Type\Date|null + */ + public function getStartDate() + { + return $this->start_date; + } + + public function hasStartDate() + { + return isset($this->start_date); + } + + public function clearStartDate() + { + unset($this->start_date); + } + + /** + * Date for the first run of the report. + * + * Generated from protobuf field .google.type.Date start_date = 1; + * @param \Google\Type\Date $var + * @return $this + */ + public function setStartDate($var) + { + GPBUtil::checkMessage($var, \Google\Type\Date::class); + $this->start_date = $var; + + return $this; + } + + /** + * Date for the final run of the report. + * + * Generated from protobuf field .google.type.Date end_date = 2; + * @return \Google\Type\Date|null + */ + public function getEndDate() + { + return $this->end_date; + } + + public function hasEndDate() + { + return isset($this->end_date); + } + + public function clearEndDate() + { + unset($this->end_date); + } + + /** + * Date for the final run of the report. + * + * Generated from protobuf field .google.type.Date end_date = 2; + * @param \Google\Type\Date $var + * @return $this + */ + public function setEndDate($var) + { + GPBUtil::checkMessage($var, \Google\Type\Date::class); + $this->end_date = $var; + + return $this; + } + + /** + * Frequency to run report. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule.Frequency frequency = 3; + * @return int + */ + public function getFrequency() + { + return $this->frequency; + } + + /** + * Frequency to run report. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule.Frequency frequency = 3; + * @param int $var + * @return $this + */ + public function setFrequency($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Schedule\Frequency::class); + $this->frequency = $var; + + return $this; + } + + /** + * Indicates start time for schedule to run + * Will use the time_zone from `ReportDefinition`. Defaults + * to the publisher's time zone if not specified. + * For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this + * will be the time of day that the first report will run on the first day. + * For example, if the start time is 2:00 PM, and the frequency is + * THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, + * 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, + * 2:00 PM, 10:00 PM. + * + * Generated from protobuf field .google.type.TimeOfDay start_time = 4; + * @return \Google\Type\TimeOfDay|null + */ + public function getStartTime() + { + return $this->start_time; + } + + public function hasStartTime() + { + return isset($this->start_time); + } + + public function clearStartTime() + { + unset($this->start_time); + } + + /** + * Indicates start time for schedule to run + * Will use the time_zone from `ReportDefinition`. Defaults + * to the publisher's time zone if not specified. + * For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this + * will be the time of day that the first report will run on the first day. + * For example, if the start time is 2:00 PM, and the frequency is + * THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, + * 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, + * 2:00 PM, 10:00 PM. + * + * Generated from protobuf field .google.type.TimeOfDay start_time = 4; + * @param \Google\Type\TimeOfDay $var + * @return $this + */ + public function setStartTime($var) + { + GPBUtil::checkMessage($var, \Google\Type\TimeOfDay::class); + $this->start_time = $var; + + return $this; + } + + /** + * @return string + */ + public function getFrequencySchedule() + { + return $this->whichOneof("frequency_schedule"); + } + +} + diff --git a/AdsAdManager/src/V1/Schedule/Frequency.php b/AdsAdManager/src/V1/Schedule/Frequency.php new file mode 100644 index 000000000000..079f0f2f6944 --- /dev/null +++ b/AdsAdManager/src/V1/Schedule/Frequency.php @@ -0,0 +1,97 @@ +google.ads.admanager.v1.Schedule.Frequency + */ +class Frequency +{ + /** + * No Frequency specified. + * + * Generated from protobuf enum FREQUENCY_UNSPECIFIED = 0; + */ + const FREQUENCY_UNSPECIFIED = 0; + /** + * Schedule report to run every hour. + * + * Generated from protobuf enum HOURLY = 1; + */ + const HOURLY = 1; + /** + * Schedule report to run twice a day (every 12 hours). + * + * Generated from protobuf enum TWO_TIMES_DAILY = 2; + */ + const TWO_TIMES_DAILY = 2; + /** + * Schedule report to run three times a day (every 8 hours). + * + * Generated from protobuf enum THREE_TIMES_DAILY = 3; + */ + const THREE_TIMES_DAILY = 3; + /** + * Schedule report to run four times a day (every 6 hours). + * + * Generated from protobuf enum FOUR_TIMES_DAILY = 4; + */ + const FOUR_TIMES_DAILY = 4; + /** + * Schedule report to run on a daily basis. + * + * Generated from protobuf enum DAILY = 5; + */ + const DAILY = 5; + /** + * Schedule report to run on a weekly basis. + * + * Generated from protobuf enum WEEKLY = 6; + */ + const WEEKLY = 6; + /** + * Schedule report to run on a monthly basis. + * + * Generated from protobuf enum MONTHLY = 7; + */ + const MONTHLY = 7; + + private static $valueToName = [ + self::FREQUENCY_UNSPECIFIED => 'FREQUENCY_UNSPECIFIED', + self::HOURLY => 'HOURLY', + self::TWO_TIMES_DAILY => 'TWO_TIMES_DAILY', + self::THREE_TIMES_DAILY => 'THREE_TIMES_DAILY', + self::FOUR_TIMES_DAILY => 'FOUR_TIMES_DAILY', + self::DAILY => 'DAILY', + self::WEEKLY => 'WEEKLY', + self::MONTHLY => 'MONTHLY', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Schedule/MonthlySchedule.php b/AdsAdManager/src/V1/Schedule/MonthlySchedule.php new file mode 100644 index 000000000000..9997e91c800e --- /dev/null +++ b/AdsAdManager/src/V1/Schedule/MonthlySchedule.php @@ -0,0 +1,72 @@ +google.ads.admanager.v1.Schedule.MonthlySchedule + */ +class MonthlySchedule extends \Google\Protobuf\Internal\Message +{ + /** + * Specifies days of the month to run report. Range is from 1-31. + * Will ignore days that are not valid for the given month. + * + * Generated from protobuf field repeated int32 monthly_scheduled_days = 1; + */ + private $monthly_scheduled_days; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $monthly_scheduled_days + * Specifies days of the month to run report. Range is from 1-31. + * Will ignore days that are not valid for the given month. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Specifies days of the month to run report. Range is from 1-31. + * Will ignore days that are not valid for the given month. + * + * Generated from protobuf field repeated int32 monthly_scheduled_days = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMonthlyScheduledDays() + { + return $this->monthly_scheduled_days; + } + + /** + * Specifies days of the month to run report. Range is from 1-31. + * Will ignore days that are not valid for the given month. + * + * Generated from protobuf field repeated int32 monthly_scheduled_days = 1; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMonthlyScheduledDays($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32); + $this->monthly_scheduled_days = $arr; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/Schedule/WeeklySchedule.php b/AdsAdManager/src/V1/Schedule/WeeklySchedule.php new file mode 100644 index 000000000000..c1b3d359a6f3 --- /dev/null +++ b/AdsAdManager/src/V1/Schedule/WeeklySchedule.php @@ -0,0 +1,68 @@ +google.ads.admanager.v1.Schedule.WeeklySchedule + */ +class WeeklySchedule extends \Google\Protobuf\Internal\Message +{ + /** + * Specifies days of the week on which to run report. + * + * Generated from protobuf field repeated .google.type.DayOfWeek weekly_scheduled_days = 1; + */ + private $weekly_scheduled_days; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $weekly_scheduled_days + * Specifies days of the week on which to run report. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Specifies days of the week on which to run report. + * + * Generated from protobuf field repeated .google.type.DayOfWeek weekly_scheduled_days = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getWeeklyScheduledDays() + { + return $this->weekly_scheduled_days; + } + + /** + * Specifies days of the week on which to run report. + * + * Generated from protobuf field repeated .google.type.DayOfWeek weekly_scheduled_days = 1; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setWeeklyScheduledDays($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Type\DayOfWeek::class); + $this->weekly_scheduled_days = $arr; + + return $this; + } + +} + + diff --git a/AdsAdManager/src/V1/ScheduleOptions.php b/AdsAdManager/src/V1/ScheduleOptions.php new file mode 100644 index 000000000000..fce3aa5c0d3c --- /dev/null +++ b/AdsAdManager/src/V1/ScheduleOptions.php @@ -0,0 +1,149 @@ +google.ads.admanager.v1.ScheduleOptions + */ +class ScheduleOptions extends \Google\Protobuf\Internal\Message +{ + /** + * Information pertaining to schedule itself. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule schedule = 1; + */ + protected $schedule = null; + /** + * Option for when to deliver the scheduled report. + * + * Generated from protobuf field .google.ads.admanager.v1.ScheduleOptions.DeliveryCondition delivery_condition = 2; + */ + protected $delivery_condition = 0; + /** + * Optional. The flags evaluated when ReportDeliveryOption.WHEN_FLAG_PRESENT + * is specified. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Flag flags = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $flags; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\Schedule $schedule + * Information pertaining to schedule itself. + * @type int $delivery_condition + * Option for when to deliver the scheduled report. + * @type array<\Google\Ads\AdManager\V1\Report\Flag>|\Google\Protobuf\Internal\RepeatedField $flags + * Optional. The flags evaluated when ReportDeliveryOption.WHEN_FLAG_PRESENT + * is specified. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Information pertaining to schedule itself. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule schedule = 1; + * @return \Google\Ads\AdManager\V1\Schedule|null + */ + public function getSchedule() + { + return $this->schedule; + } + + public function hasSchedule() + { + return isset($this->schedule); + } + + public function clearSchedule() + { + unset($this->schedule); + } + + /** + * Information pertaining to schedule itself. + * + * Generated from protobuf field .google.ads.admanager.v1.Schedule schedule = 1; + * @param \Google\Ads\AdManager\V1\Schedule $var + * @return $this + */ + public function setSchedule($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Schedule::class); + $this->schedule = $var; + + return $this; + } + + /** + * Option for when to deliver the scheduled report. + * + * Generated from protobuf field .google.ads.admanager.v1.ScheduleOptions.DeliveryCondition delivery_condition = 2; + * @return int + */ + public function getDeliveryCondition() + { + return $this->delivery_condition; + } + + /** + * Option for when to deliver the scheduled report. + * + * Generated from protobuf field .google.ads.admanager.v1.ScheduleOptions.DeliveryCondition delivery_condition = 2; + * @param int $var + * @return $this + */ + public function setDeliveryCondition($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\ScheduleOptions\DeliveryCondition::class); + $this->delivery_condition = $var; + + return $this; + } + + /** + * Optional. The flags evaluated when ReportDeliveryOption.WHEN_FLAG_PRESENT + * is specified. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Flag flags = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getFlags() + { + return $this->flags; + } + + /** + * Optional. The flags evaluated when ReportDeliveryOption.WHEN_FLAG_PRESENT + * is specified. + * + * Generated from protobuf field repeated .google.ads.admanager.v1.Report.Flag flags = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Ads\AdManager\V1\Report\Flag>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setFlags($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Flag::class); + $this->flags = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/ScheduleOptions/DeliveryCondition.php b/AdsAdManager/src/V1/ScheduleOptions/DeliveryCondition.php new file mode 100644 index 000000000000..f6c9f5b1b827 --- /dev/null +++ b/AdsAdManager/src/V1/ScheduleOptions/DeliveryCondition.php @@ -0,0 +1,62 @@ +google.ads.admanager.v1.ScheduleOptions.DeliveryCondition + */ +class DeliveryCondition +{ + /** + * Never deliver report. + * + * Generated from protobuf enum NEVER = 0; + */ + const NEVER = 0; + /** + * Always deliver report. + * + * Generated from protobuf enum ALWAYS = 1; + */ + const ALWAYS = 1; + /** + * Deliver report when flag's conditions are met. + * + * Generated from protobuf enum WHEN_FLAG_CONDITIONS_MET = 2; + */ + const WHEN_FLAG_CONDITIONS_MET = 2; + + private static $valueToName = [ + self::NEVER => 'NEVER', + self::ALWAYS => 'ALWAYS', + self::WHEN_FLAG_CONDITIONS_MET => 'WHEN_FLAG_CONDITIONS_MET', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Size.php b/AdsAdManager/src/V1/Size.php new file mode 100644 index 000000000000..927a409b1f5a --- /dev/null +++ b/AdsAdManager/src/V1/Size.php @@ -0,0 +1,163 @@ +google.ads.admanager.v1.Size + */ +class Size extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The width of the [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field int32 width = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $width = 0; + /** + * Required. The height of the [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field int32 height = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $height = 0; + /** + * Required. The SizeType of the + * [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field .google.ads.admanager.v1.SizeTypeEnum.SizeType size_type = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $size_type = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $width + * Required. The width of the [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * @type int $height + * Required. The height of the [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * @type int $size_type + * Required. The SizeType of the + * [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\Size::initOnce(); + parent::__construct($data); + } + + /** + * Required. The width of the [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field int32 width = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getWidth() + { + return $this->width; + } + + /** + * Required. The width of the [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field int32 width = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setWidth($var) + { + GPBUtil::checkInt32($var); + $this->width = $var; + + return $this; + } + + /** + * Required. The height of the [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field int32 height = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getHeight() + { + return $this->height; + } + + /** + * Required. The height of the [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field int32 height = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setHeight($var) + { + GPBUtil::checkInt32($var); + $this->height = $var; + + return $this; + } + + /** + * Required. The SizeType of the + * [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field .google.ads.admanager.v1.SizeTypeEnum.SizeType size_type = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getSizeType() + { + return $this->size_type; + } + + /** + * Required. The SizeType of the + * [Creative](google.ads.admanager.v1.Creative), + * [AdUnit](google.ads.admanager.v1.AdUnit), or + * [LineItem](google.ads.admanager.v1.LineItem). + * + * Generated from protobuf field .google.ads.admanager.v1.SizeTypeEnum.SizeType size_type = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setSizeType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\SizeTypeEnum\SizeType::class); + $this->size_type = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/SizeTypeEnum.php b/AdsAdManager/src/V1/SizeTypeEnum.php new file mode 100644 index 000000000000..245c82dc7304 --- /dev/null +++ b/AdsAdManager/src/V1/SizeTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.SizeTypeEnum + */ +class SizeTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\SizeTypeEnum::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/SizeTypeEnum/SizeType.php b/AdsAdManager/src/V1/SizeTypeEnum/SizeType.php new file mode 100644 index 000000000000..4b3cbd0385b9 --- /dev/null +++ b/AdsAdManager/src/V1/SizeTypeEnum/SizeType.php @@ -0,0 +1,103 @@ +google.ads.admanager.v1.SizeTypeEnum.SizeType + */ +class SizeType +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum SIZE_TYPE_UNSPECIFIED = 0; + */ + const SIZE_TYPE_UNSPECIFIED = 0; + /** + * Dimension based size, an actual height and width in pixels. + * + * Generated from protobuf enum PIXEL = 1; + */ + const PIXEL = 1; + /** + * Size is expressed as a ratio. For example, 4:1 could be + * met by a 100 x 25 sized image. + * + * Generated from protobuf enum ASPECT_RATIO = 2; + */ + const ASPECT_RATIO = 2; + /** + * Out-of-page (Interstitial) size that is not related to the slot it is + * served. This must be used with 1x1 size. + * + * Generated from protobuf enum INTERSTITIAL = 3; + */ + const INTERSTITIAL = 3; + /** + * Size is ignored. This must be used with 1x1 + * size. + * + * Generated from protobuf enum IGNORED = 4; + */ + const IGNORED = 4; + /** + * Native size, which is a function of the how the client renders the + * creative. This must be used with 1x1 size. + * + * Generated from protobuf enum NATIVE = 5; + */ + const NATIVE = 5; + /** + * Fluid size. Automatically sizes the ad by filling the width of the + * enclosing column and adjusting the height as appropriate. This must be + * used with 1x1 size. + * + * Generated from protobuf enum FLUID = 6; + */ + const FLUID = 6; + /** + * Audio size. Used with audio ads. This must be used with 1x1 size. + * + * Generated from protobuf enum AUDIO = 7; + */ + const AUDIO = 7; + + private static $valueToName = [ + self::SIZE_TYPE_UNSPECIFIED => 'SIZE_TYPE_UNSPECIFIED', + self::PIXEL => 'PIXEL', + self::ASPECT_RATIO => 'ASPECT_RATIO', + self::INTERSTITIAL => 'INTERSTITIAL', + self::IGNORED => 'IGNORED', + self::NATIVE => 'NATIVE', + self::FLUID => 'FLUID', + self::AUDIO => 'AUDIO', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/SmartSizeModeEnum.php b/AdsAdManager/src/V1/SmartSizeModeEnum.php new file mode 100644 index 000000000000..40e9ca0edd29 --- /dev/null +++ b/AdsAdManager/src/V1/SmartSizeModeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.SmartSizeModeEnum + */ +class SmartSizeModeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/SmartSizeModeEnum/SmartSizeMode.php b/AdsAdManager/src/V1/SmartSizeModeEnum/SmartSizeMode.php new file mode 100644 index 000000000000..3b682e0be320 --- /dev/null +++ b/AdsAdManager/src/V1/SmartSizeModeEnum/SmartSizeMode.php @@ -0,0 +1,70 @@ +google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode + */ +class SmartSizeMode +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum SMART_SIZE_MODE_UNSPECIFIED = 0; + */ + const SMART_SIZE_MODE_UNSPECIFIED = 0; + /** + * Fixed size mode (default). + * + * Generated from protobuf enum NONE = 1; + */ + const NONE = 1; + /** + * The height is fixed for the request, the width is a range. + * + * Generated from protobuf enum SMART_BANNER = 2; + */ + const SMART_BANNER = 2; + /** + * Height and width are ranges. + * + * Generated from protobuf enum DYNAMIC_SIZE = 3; + */ + const DYNAMIC_SIZE = 3; + + private static $valueToName = [ + self::SMART_SIZE_MODE_UNSPECIFIED => 'SMART_SIZE_MODE_UNSPECIFIED', + self::NONE => 'NONE', + self::SMART_BANNER => 'SMART_BANNER', + self::DYNAMIC_SIZE => 'DYNAMIC_SIZE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/TargetWindowEnum.php b/AdsAdManager/src/V1/TargetWindowEnum.php new file mode 100644 index 000000000000..a8637484ab5b --- /dev/null +++ b/AdsAdManager/src/V1/TargetWindowEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.TargetWindowEnum + */ +class TargetWindowEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\AdUnitEnums::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/TargetWindowEnum/TargetWindow.php b/AdsAdManager/src/V1/TargetWindowEnum/TargetWindow.php new file mode 100644 index 000000000000..8a8b36b99cf0 --- /dev/null +++ b/AdsAdManager/src/V1/TargetWindowEnum/TargetWindow.php @@ -0,0 +1,63 @@ +google.ads.admanager.v1.TargetWindowEnum.TargetWindow + */ +class TargetWindow +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum TARGET_WINDOW_UNSPECIFIED = 0; + */ + const TARGET_WINDOW_UNSPECIFIED = 0; + /** + * Specifies that the link should open in the full body of the page. + * + * Generated from protobuf enum TOP = 1; + */ + const TOP = 1; + /** + * Specifies that the link should open in a new window. + * + * Generated from protobuf enum BLANK = 2; + */ + const BLANK = 2; + + private static $valueToName = [ + self::TARGET_WINDOW_UNSPECIFIED => 'TARGET_WINDOW_UNSPECIFIED', + self::TOP => 'TOP', + self::BLANK => 'BLANK', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/TaxonomyCategory.php b/AdsAdManager/src/V1/TaxonomyCategory.php new file mode 100644 index 000000000000..53d713a41b4d --- /dev/null +++ b/AdsAdManager/src/V1/TaxonomyCategory.php @@ -0,0 +1,317 @@ +google.ads.admanager.v1.TaxonomyCategory + */ +class TaxonomyCategory extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `TaxonomyCategory`. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. `TaxonomyCategory` ID. + * + * Generated from protobuf field int64 taxonomy_category_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $taxonomy_category_id = 0; + /** + * Output only. Display name of the `TaxonomyCategory`. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $display_name = ''; + /** + * Output only. Whether this `TaxonomyCategory` only serves to group its + * children. + * + * Generated from protobuf field bool grouping_only = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $grouping_only = false; + /** + * Output only. The ID of the parent category this `TaxonomyCategory` descends + * from. + * + * Generated from protobuf field int64 parent_taxonomy_category_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $parent_taxonomy_category_id = 0; + /** + * Output only. The taxonomy that this `TaxonomyCategory` belongs to. + * + * Generated from protobuf field .google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType taxonomy_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $taxonomy_type = 0; + /** + * Output only. The list of names of the ancestors of this `TaxonomyCategory`. + * + * Generated from protobuf field repeated string ancestor_names = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $ancestor_names; + /** + * Output only. The list of IDs of the ancestors of this `TaxonomyCategory`. + * + * Generated from protobuf field repeated int64 ancestor_taxonomy_category_ids = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $ancestor_taxonomy_category_ids; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `TaxonomyCategory`. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * @type int|string $taxonomy_category_id + * Output only. `TaxonomyCategory` ID. + * @type string $display_name + * Output only. Display name of the `TaxonomyCategory`. + * @type bool $grouping_only + * Output only. Whether this `TaxonomyCategory` only serves to group its + * children. + * @type int|string $parent_taxonomy_category_id + * Output only. The ID of the parent category this `TaxonomyCategory` descends + * from. + * @type int $taxonomy_type + * Output only. The taxonomy that this `TaxonomyCategory` belongs to. + * @type array|\Google\Protobuf\Internal\RepeatedField $ancestor_names + * Output only. The list of names of the ancestors of this `TaxonomyCategory`. + * @type array|array|\Google\Protobuf\Internal\RepeatedField $ancestor_taxonomy_category_ids + * Output only. The list of IDs of the ancestors of this `TaxonomyCategory`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\TaxonomyCategoryMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `TaxonomyCategory`. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `TaxonomyCategory`. + * Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. `TaxonomyCategory` ID. + * + * Generated from protobuf field int64 taxonomy_category_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getTaxonomyCategoryId() + { + return $this->taxonomy_category_id; + } + + /** + * Output only. `TaxonomyCategory` ID. + * + * Generated from protobuf field int64 taxonomy_category_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setTaxonomyCategoryId($var) + { + GPBUtil::checkInt64($var); + $this->taxonomy_category_id = $var; + + return $this; + } + + /** + * Output only. Display name of the `TaxonomyCategory`. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Output only. Display name of the `TaxonomyCategory`. + * + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Output only. Whether this `TaxonomyCategory` only serves to group its + * children. + * + * Generated from protobuf field bool grouping_only = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getGroupingOnly() + { + return $this->grouping_only; + } + + /** + * Output only. Whether this `TaxonomyCategory` only serves to group its + * children. + * + * Generated from protobuf field bool grouping_only = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setGroupingOnly($var) + { + GPBUtil::checkBool($var); + $this->grouping_only = $var; + + return $this; + } + + /** + * Output only. The ID of the parent category this `TaxonomyCategory` descends + * from. + * + * Generated from protobuf field int64 parent_taxonomy_category_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getParentTaxonomyCategoryId() + { + return $this->parent_taxonomy_category_id; + } + + /** + * Output only. The ID of the parent category this `TaxonomyCategory` descends + * from. + * + * Generated from protobuf field int64 parent_taxonomy_category_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setParentTaxonomyCategoryId($var) + { + GPBUtil::checkInt64($var); + $this->parent_taxonomy_category_id = $var; + + return $this; + } + + /** + * Output only. The taxonomy that this `TaxonomyCategory` belongs to. + * + * Generated from protobuf field .google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType taxonomy_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getTaxonomyType() + { + return $this->taxonomy_type; + } + + /** + * Output only. The taxonomy that this `TaxonomyCategory` belongs to. + * + * Generated from protobuf field .google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType taxonomy_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setTaxonomyType($var) + { + GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\TaxonomyTypeEnum\TaxonomyType::class); + $this->taxonomy_type = $var; + + return $this; + } + + /** + * Output only. The list of names of the ancestors of this `TaxonomyCategory`. + * + * Generated from protobuf field repeated string ancestor_names = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAncestorNames() + { + return $this->ancestor_names; + } + + /** + * Output only. The list of names of the ancestors of this `TaxonomyCategory`. + * + * Generated from protobuf field repeated string ancestor_names = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAncestorNames($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->ancestor_names = $arr; + + return $this; + } + + /** + * Output only. The list of IDs of the ancestors of this `TaxonomyCategory`. + * + * Generated from protobuf field repeated int64 ancestor_taxonomy_category_ids = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAncestorTaxonomyCategoryIds() + { + return $this->ancestor_taxonomy_category_ids; + } + + /** + * Output only. The list of IDs of the ancestors of this `TaxonomyCategory`. + * + * Generated from protobuf field repeated int64 ancestor_taxonomy_category_ids = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param array|array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAncestorTaxonomyCategoryIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64); + $this->ancestor_taxonomy_category_ids = $arr; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/TaxonomyTypeEnum.php b/AdsAdManager/src/V1/TaxonomyTypeEnum.php new file mode 100644 index 000000000000..0eb538bca072 --- /dev/null +++ b/AdsAdManager/src/V1/TaxonomyTypeEnum.php @@ -0,0 +1,34 @@ +google.ads.admanager.v1.TaxonomyTypeEnum + */ +class TaxonomyTypeEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\TaxonomyTypeEnum::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/TaxonomyTypeEnum/TaxonomyType.php b/AdsAdManager/src/V1/TaxonomyTypeEnum/TaxonomyType.php new file mode 100644 index 000000000000..e3dcd4043d54 --- /dev/null +++ b/AdsAdManager/src/V1/TaxonomyTypeEnum/TaxonomyType.php @@ -0,0 +1,84 @@ +google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType + */ +class TaxonomyType +{ + /** + * Unspecified/not present + * + * Generated from protobuf enum TAXONOMY_TYPE_UNSPECIFIED = 0; + */ + const TAXONOMY_TYPE_UNSPECIFIED = 0; + /** + * The IAB Audience Taxonomy v1.1. + * + * Generated from protobuf enum TAXONOMY_IAB_AUDIENCE_1_1 = 3; + */ + const TAXONOMY_IAB_AUDIENCE_1_1 = 3; + /** + * The IAB Content Taxonomy v2.1. + * + * Generated from protobuf enum TAXONOMY_IAB_CONTENT_2_1 = 4; + */ + const TAXONOMY_IAB_CONTENT_2_1 = 4; + /** + * The IAB Content Taxonomy v2.2. + * + * Generated from protobuf enum TAXONOMY_IAB_CONTENT_2_2 = 6; + */ + const TAXONOMY_IAB_CONTENT_2_2 = 6; + /** + * The IAB Content Taxonomy v3.0. + * + * Generated from protobuf enum TAXONOMY_IAB_CONTENT_3_0 = 5; + */ + const TAXONOMY_IAB_CONTENT_3_0 = 5; + /** + * The PPS structured video signals taxonomy. + * + * Generated from protobuf enum TAXONOMY_GOOGLE_STRUCTURED_VIDEO_1_0 = 7; + */ + const TAXONOMY_GOOGLE_STRUCTURED_VIDEO_1_0 = 7; + + private static $valueToName = [ + self::TAXONOMY_TYPE_UNSPECIFIED => 'TAXONOMY_TYPE_UNSPECIFIED', + self::TAXONOMY_IAB_AUDIENCE_1_1 => 'TAXONOMY_IAB_AUDIENCE_1_1', + self::TAXONOMY_IAB_CONTENT_2_1 => 'TAXONOMY_IAB_CONTENT_2_1', + self::TAXONOMY_IAB_CONTENT_2_2 => 'TAXONOMY_IAB_CONTENT_2_2', + self::TAXONOMY_IAB_CONTENT_3_0 => 'TAXONOMY_IAB_CONTENT_3_0', + self::TAXONOMY_GOOGLE_STRUCTURED_VIDEO_1_0 => 'TAXONOMY_GOOGLE_STRUCTURED_VIDEO_1_0', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/Team.php b/AdsAdManager/src/V1/Team.php new file mode 100644 index 000000000000..d48d2bf8bc0a --- /dev/null +++ b/AdsAdManager/src/V1/Team.php @@ -0,0 +1,109 @@ +google.ads.admanager.v1.Team + */ +class Team extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the `Team`. + * Format: `networks/{network_code}/teams/{team_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. The unique ID of the Team. This value is assigned by Google. + * Teams that are created by Google will have negative IDs. + * + * Generated from protobuf field int64 team_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $team_id = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the `Team`. + * Format: `networks/{network_code}/teams/{team_id}` + * @type int|string $team_id + * Output only. The unique ID of the Team. This value is assigned by Google. + * Teams that are created by Google will have negative IDs. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\TeamMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the `Team`. + * Format: `networks/{network_code}/teams/{team_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the `Team`. + * Format: `networks/{network_code}/teams/{team_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. The unique ID of the Team. This value is assigned by Google. + * Teams that are created by Google will have negative IDs. + * + * Generated from protobuf field int64 team_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getTeamId() + { + return $this->team_id; + } + + /** + * Output only. The unique ID of the Team. This value is assigned by Google. + * Teams that are created by Google will have negative IDs. + * + * Generated from protobuf field int64 team_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setTeamId($var) + { + GPBUtil::checkInt64($var); + $this->team_id = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/TimeUnitEnum.php b/AdsAdManager/src/V1/TimeUnitEnum.php new file mode 100644 index 000000000000..22d5fc47f884 --- /dev/null +++ b/AdsAdManager/src/V1/TimeUnitEnum.php @@ -0,0 +1,33 @@ +google.ads.admanager.v1.TimeUnitEnum + */ +class TimeUnitEnum extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\TimeUnitEnum::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AdsAdManager/src/V1/TimeUnitEnum/TimeUnit.php b/AdsAdManager/src/V1/TimeUnitEnum/TimeUnit.php new file mode 100644 index 000000000000..52a1e81c3c1b --- /dev/null +++ b/AdsAdManager/src/V1/TimeUnitEnum/TimeUnit.php @@ -0,0 +1,105 @@ +google.ads.admanager.v1.TimeUnitEnum.TimeUnit + */ +class TimeUnit +{ + /** + * Default value. This value is unused. + * + * Generated from protobuf enum TIME_UNIT_UNSPECIFIED = 0; + */ + const TIME_UNIT_UNSPECIFIED = 0; + /** + * Minute + * + * Generated from protobuf enum MINUTE = 1; + */ + const MINUTE = 1; + /** + * Hour + * + * Generated from protobuf enum HOUR = 2; + */ + const HOUR = 2; + /** + * Day + * + * Generated from protobuf enum DAY = 3; + */ + const DAY = 3; + /** + * Week + * + * Generated from protobuf enum WEEK = 4; + */ + const WEEK = 4; + /** + * Month + * + * Generated from protobuf enum MONTH = 5; + */ + const MONTH = 5; + /** + * Lifetime + * + * Generated from protobuf enum LIFETIME = 6; + */ + const LIFETIME = 6; + /** + * Per pod of ads in a video stream. Only valid for entities in a + * VIDEO_PLAYER environment. + * + * Generated from protobuf enum POD = 7; + */ + const POD = 7; + /** + * Per video stream. Only valid for entities in a VIDEO_PLAYER environment. + * + * Generated from protobuf enum STREAM = 8; + */ + const STREAM = 8; + + private static $valueToName = [ + self::TIME_UNIT_UNSPECIFIED => 'TIME_UNIT_UNSPECIFIED', + self::MINUTE => 'MINUTE', + self::HOUR => 'HOUR', + self::DAY => 'DAY', + self::WEEK => 'WEEK', + self::MONTH => 'MONTH', + self::LIFETIME => 'LIFETIME', + self::POD => 'POD', + self::STREAM => 'STREAM', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AdsAdManager/src/V1/UpdateEntitySignalsMappingRequest.php b/AdsAdManager/src/V1/UpdateEntitySignalsMappingRequest.php new file mode 100644 index 000000000000..0a9d17a8a645 --- /dev/null +++ b/AdsAdManager/src/V1/UpdateEntitySignalsMappingRequest.php @@ -0,0 +1,157 @@ +google.ads.admanager.v1.UpdateEntitySignalsMappingRequest + */ +class UpdateEntitySignalsMappingRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The `EntitySignalsMapping` to update. + * The EntitySignalsMapping's name is used to identify the + * EntitySignalsMapping to update. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}` + * + * Generated from protobuf field .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mapping = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $entity_signals_mapping = null; + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + + /** + * @param \Google\Ads\AdManager\V1\EntitySignalsMapping $entitySignalsMapping Required. The `EntitySignalsMapping` to update. + * + * The EntitySignalsMapping's name is used to identify the + * EntitySignalsMapping to update. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}` + * @param \Google\Protobuf\FieldMask $updateMask Required. The list of fields to update. + * + * @return \Google\Ads\AdManager\V1\UpdateEntitySignalsMappingRequest + * + * @experimental + */ + public static function build(\Google\Ads\AdManager\V1\EntitySignalsMapping $entitySignalsMapping, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setEntitySignalsMapping($entitySignalsMapping) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\EntitySignalsMapping $entity_signals_mapping + * Required. The `EntitySignalsMapping` to update. + * The EntitySignalsMapping's name is used to identify the + * EntitySignalsMapping to update. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}` + * @type \Google\Protobuf\FieldMask $update_mask + * Required. The list of fields to update. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\EntitySignalsMappingService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The `EntitySignalsMapping` to update. + * The EntitySignalsMapping's name is used to identify the + * EntitySignalsMapping to update. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}` + * + * Generated from protobuf field .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mapping = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\EntitySignalsMapping|null + */ + public function getEntitySignalsMapping() + { + return $this->entity_signals_mapping; + } + + public function hasEntitySignalsMapping() + { + return isset($this->entity_signals_mapping); + } + + public function clearEntitySignalsMapping() + { + unset($this->entity_signals_mapping); + } + + /** + * Required. The `EntitySignalsMapping` to update. + * The EntitySignalsMapping's name is used to identify the + * EntitySignalsMapping to update. + * Format: + * `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}` + * + * Generated from protobuf field .google.ads.admanager.v1.EntitySignalsMapping entity_signals_mapping = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\EntitySignalsMapping $var + * @return $this + */ + public function setEntitySignalsMapping($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\EntitySignalsMapping::class); + $this->entity_signals_mapping = $var; + + return $this; + } + + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/UpdateReportRequest.php b/AdsAdManager/src/V1/UpdateReportRequest.php new file mode 100644 index 000000000000..e34757d484ce --- /dev/null +++ b/AdsAdManager/src/V1/UpdateReportRequest.php @@ -0,0 +1,136 @@ +google.ads.admanager.v1.UpdateReportRequest + */ +class UpdateReportRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The `Report` to update. + * + * Generated from protobuf field .google.ads.admanager.v1.Report report = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $report = null; + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + + /** + * @param \Google\Ads\AdManager\V1\Report $report Required. The `Report` to update. + * @param \Google\Protobuf\FieldMask $updateMask Required. The list of fields to update. + * + * @return \Google\Ads\AdManager\V1\UpdateReportRequest + * + * @experimental + */ + public static function build(\Google\Ads\AdManager\V1\Report $report, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setReport($report) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Ads\AdManager\V1\Report $report + * Required. The `Report` to update. + * @type \Google\Protobuf\FieldMask $update_mask + * Required. The list of fields to update. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\ReportService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The `Report` to update. + * + * Generated from protobuf field .google.ads.admanager.v1.Report report = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Ads\AdManager\V1\Report|null + */ + public function getReport() + { + return $this->report; + } + + public function hasReport() + { + return isset($this->report); + } + + public function clearReport() + { + unset($this->report); + } + + /** + * Required. The `Report` to update. + * + * Generated from protobuf field .google.ads.admanager.v1.Report report = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Ads\AdManager\V1\Report $var + * @return $this + */ + public function setReport($var) + { + GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report::class); + $this->report = $var; + + return $this; + } + + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. The list of fields to update. + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/User.php b/AdsAdManager/src/V1/User.php new file mode 100644 index 000000000000..a09c0c1997a9 --- /dev/null +++ b/AdsAdManager/src/V1/User.php @@ -0,0 +1,379 @@ +google.ads.admanager.v1.User + */ +class User extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. `User` ID. + * + * Generated from protobuf field int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $user_id = 0; + /** + * Required. The name of the User. It has a maximum length of 128 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $display_name = ''; + /** + * Required. The email or login of the User. In order to create a new user, + * you must already have a Google Account. + * + * Generated from protobuf field string email = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $email = ''; + /** + * Required. The unique Role ID of the User. Roles that are created by Google + * will have negative IDs. + * + * Generated from protobuf field string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $role = ''; + /** + * Output only. Specifies whether or not the User is active. An inactive user + * cannot log in to the system or perform any operations. + * + * Generated from protobuf field bool active = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $active = false; + /** + * Optional. An identifier for the User that is meaningful to the publisher. + * This attribute has a maximum length of 255 characters. + * + * Generated from protobuf field string external_id = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $external_id = ''; + /** + * Output only. Whether the user is an OAuth2 service account user. + * Service account users can only be added through the UI. + * + * Generated from protobuf field bool service_account = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $service_account = false; + /** + * Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", + * used in the orders and line items UI for this User. If not provided, the UI + * then defaults to using the Network's timezone. This setting only affects + * the UI for this user and does not affect the timezone of any dates and + * times returned in API responses. + * + * Generated from protobuf field string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $orders_ui_local_time_zone = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * @type int|string $user_id + * Output only. `User` ID. + * @type string $display_name + * Required. The name of the User. It has a maximum length of 128 characters. + * @type string $email + * Required. The email or login of the User. In order to create a new user, + * you must already have a Google Account. + * @type string $role + * Required. The unique Role ID of the User. Roles that are created by Google + * will have negative IDs. + * @type bool $active + * Output only. Specifies whether or not the User is active. An inactive user + * cannot log in to the system or perform any operations. + * @type string $external_id + * Optional. An identifier for the User that is meaningful to the publisher. + * This attribute has a maximum length of 255 characters. + * @type bool $service_account + * Output only. Whether the user is an OAuth2 service account user. + * Service account users can only be added through the UI. + * @type string $orders_ui_local_time_zone + * Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", + * used in the orders and line items UI for this User. If not provided, the UI + * then defaults to using the Network's timezone. This setting only affects + * the UI for this user and does not affect the timezone of any dates and + * times returned in API responses. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Ads\Admanager\V1\UserMessages::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the User. + * Format: `networks/{network_code}/users/{user_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. `User` ID. + * + * Generated from protobuf field int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getUserId() + { + return $this->user_id; + } + + /** + * Output only. `User` ID. + * + * Generated from protobuf field int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setUserId($var) + { + GPBUtil::checkInt64($var); + $this->user_id = $var; + + return $this; + } + + /** + * Required. The name of the User. It has a maximum length of 128 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Required. The name of the User. It has a maximum length of 128 characters. + * + * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Required. The email or login of the User. In order to create a new user, + * you must already have a Google Account. + * + * Generated from protobuf field string email = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getEmail() + { + return $this->email; + } + + /** + * Required. The email or login of the User. In order to create a new user, + * you must already have a Google Account. + * + * Generated from protobuf field string email = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setEmail($var) + { + GPBUtil::checkString($var, True); + $this->email = $var; + + return $this; + } + + /** + * Required. The unique Role ID of the User. Roles that are created by Google + * will have negative IDs. + * + * Generated from protobuf field string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getRole() + { + return $this->role; + } + + /** + * Required. The unique Role ID of the User. Roles that are created by Google + * will have negative IDs. + * + * Generated from protobuf field string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setRole($var) + { + GPBUtil::checkString($var, True); + $this->role = $var; + + return $this; + } + + /** + * Output only. Specifies whether or not the User is active. An inactive user + * cannot log in to the system or perform any operations. + * + * Generated from protobuf field bool active = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getActive() + { + return $this->active; + } + + /** + * Output only. Specifies whether or not the User is active. An inactive user + * cannot log in to the system or perform any operations. + * + * Generated from protobuf field bool active = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setActive($var) + { + GPBUtil::checkBool($var); + $this->active = $var; + + return $this; + } + + /** + * Optional. An identifier for the User that is meaningful to the publisher. + * This attribute has a maximum length of 255 characters. + * + * Generated from protobuf field string external_id = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getExternalId() + { + return $this->external_id; + } + + /** + * Optional. An identifier for the User that is meaningful to the publisher. + * This attribute has a maximum length of 255 characters. + * + * Generated from protobuf field string external_id = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setExternalId($var) + { + GPBUtil::checkString($var, True); + $this->external_id = $var; + + return $this; + } + + /** + * Output only. Whether the user is an OAuth2 service account user. + * Service account users can only be added through the UI. + * + * Generated from protobuf field bool service_account = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getServiceAccount() + { + return $this->service_account; + } + + /** + * Output only. Whether the user is an OAuth2 service account user. + * Service account users can only be added through the UI. + * + * Generated from protobuf field bool service_account = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setServiceAccount($var) + { + GPBUtil::checkBool($var); + $this->service_account = $var; + + return $this; + } + + /** + * Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", + * used in the orders and line items UI for this User. If not provided, the UI + * then defaults to using the Network's timezone. This setting only affects + * the UI for this user and does not affect the timezone of any dates and + * times returned in API responses. + * + * Generated from protobuf field string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrdersUiLocalTimeZone() + { + return $this->orders_ui_local_time_zone; + } + + /** + * Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", + * used in the orders and line items UI for this User. If not provided, the UI + * then defaults to using the Network's timezone. This setting only affects + * the UI for this user and does not affect the timezone of any dates and + * times returned in API responses. + * + * Generated from protobuf field string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrdersUiLocalTimeZone($var) + { + GPBUtil::checkString($var, True); + $this->orders_ui_local_time_zone = $var; + + return $this; + } + +} + diff --git a/AdsAdManager/src/V1/gapic_metadata.json b/AdsAdManager/src/V1/gapic_metadata.json new file mode 100644 index 000000000000..b61b94818b7a --- /dev/null +++ b/AdsAdManager/src/V1/gapic_metadata.json @@ -0,0 +1,296 @@ +{ + "schema": "1.0", + "comment": "This file maps proto services\/RPCs to the corresponding library clients\/methods", + "language": "php", + "protoPackage": "google.ads.admanager.v1", + "libraryPackage": "Google\\Ads\\AdManager\\V1", + "services": { + "AdUnitService": { + "clients": { + "grpc": { + "libraryClient": "AdUnitServiceGapicClient", + "rpcs": { + "GetAdUnit": { + "methods": [ + "getAdUnit" + ] + }, + "ListAdUnitSizes": { + "methods": [ + "listAdUnitSizes" + ] + }, + "ListAdUnits": { + "methods": [ + "listAdUnits" + ] + } + } + } + } + }, + "CompanyService": { + "clients": { + "grpc": { + "libraryClient": "CompanyServiceGapicClient", + "rpcs": { + "GetCompany": { + "methods": [ + "getCompany" + ] + }, + "ListCompanies": { + "methods": [ + "listCompanies" + ] + } + } + } + } + }, + "CustomFieldService": { + "clients": { + "grpc": { + "libraryClient": "CustomFieldServiceGapicClient", + "rpcs": { + "GetCustomField": { + "methods": [ + "getCustomField" + ] + }, + "ListCustomFields": { + "methods": [ + "listCustomFields" + ] + } + } + } + } + }, + "CustomTargetingKeyService": { + "clients": { + "grpc": { + "libraryClient": "CustomTargetingKeyServiceGapicClient", + "rpcs": { + "GetCustomTargetingKey": { + "methods": [ + "getCustomTargetingKey" + ] + }, + "ListCustomTargetingKeys": { + "methods": [ + "listCustomTargetingKeys" + ] + } + } + } + } + }, + "CustomTargetingValueService": { + "clients": { + "grpc": { + "libraryClient": "CustomTargetingValueServiceGapicClient", + "rpcs": { + "GetCustomTargetingValue": { + "methods": [ + "getCustomTargetingValue" + ] + }, + "ListCustomTargetingValues": { + "methods": [ + "listCustomTargetingValues" + ] + } + } + } + } + }, + "EntitySignalsMappingService": { + "clients": { + "grpc": { + "libraryClient": "EntitySignalsMappingServiceGapicClient", + "rpcs": { + "BatchCreateEntitySignalsMappings": { + "methods": [ + "batchCreateEntitySignalsMappings" + ] + }, + "BatchUpdateEntitySignalsMappings": { + "methods": [ + "batchUpdateEntitySignalsMappings" + ] + }, + "CreateEntitySignalsMapping": { + "methods": [ + "createEntitySignalsMapping" + ] + }, + "GetEntitySignalsMapping": { + "methods": [ + "getEntitySignalsMapping" + ] + }, + "ListEntitySignalsMappings": { + "methods": [ + "listEntitySignalsMappings" + ] + }, + "UpdateEntitySignalsMapping": { + "methods": [ + "updateEntitySignalsMapping" + ] + } + } + } + } + }, + "NetworkService": { + "clients": { + "grpc": { + "libraryClient": "NetworkServiceGapicClient", + "rpcs": { + "GetNetwork": { + "methods": [ + "getNetwork" + ] + }, + "ListNetworks": { + "methods": [ + "listNetworks" + ] + } + } + } + } + }, + "OrderService": { + "clients": { + "grpc": { + "libraryClient": "OrderServiceGapicClient", + "rpcs": { + "GetOrder": { + "methods": [ + "getOrder" + ] + }, + "ListOrders": { + "methods": [ + "listOrders" + ] + } + } + } + } + }, + "PlacementService": { + "clients": { + "grpc": { + "libraryClient": "PlacementServiceGapicClient", + "rpcs": { + "GetPlacement": { + "methods": [ + "getPlacement" + ] + }, + "ListPlacements": { + "methods": [ + "listPlacements" + ] + } + } + } + } + }, + "ReportService": { + "clients": { + "grpc": { + "libraryClient": "ReportServiceGapicClient", + "rpcs": { + "CreateReport": { + "methods": [ + "createReport" + ] + }, + "FetchReportResultRows": { + "methods": [ + "fetchReportResultRows" + ] + }, + "GetReport": { + "methods": [ + "getReport" + ] + }, + "ListReports": { + "methods": [ + "listReports" + ] + }, + "RunReport": { + "methods": [ + "runReport" + ] + }, + "UpdateReport": { + "methods": [ + "updateReport" + ] + } + } + } + } + }, + "RoleService": { + "clients": { + "grpc": { + "libraryClient": "RoleServiceGapicClient", + "rpcs": { + "GetRole": { + "methods": [ + "getRole" + ] + }, + "ListRoles": { + "methods": [ + "listRoles" + ] + } + } + } + } + }, + "TaxonomyCategoryService": { + "clients": { + "grpc": { + "libraryClient": "TaxonomyCategoryServiceGapicClient", + "rpcs": { + "GetTaxonomyCategory": { + "methods": [ + "getTaxonomyCategory" + ] + }, + "ListTaxonomyCategories": { + "methods": [ + "listTaxonomyCategories" + ] + } + } + } + } + }, + "UserService": { + "clients": { + "grpc": { + "libraryClient": "UserServiceGapicClient", + "rpcs": { + "GetUser": { + "methods": [ + "getUser" + ] + } + } + } + } + } + } +} \ No newline at end of file diff --git a/AdsAdManager/src/V1/resources/ad_unit_service_client_config.json b/AdsAdManager/src/V1/resources/ad_unit_service_client_config.json new file mode 100644 index 000000000000..5fdf2cea857b --- /dev/null +++ b/AdsAdManager/src/V1/resources/ad_unit_service_client_config.json @@ -0,0 +1,37 @@ +{ + "interfaces": { + "google.ads.admanager.v1.AdUnitService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetAdUnit": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListAdUnitSizes": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListAdUnits": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/ad_unit_service_descriptor_config.php b/AdsAdManager/src/V1/resources/ad_unit_service_descriptor_config.php new file mode 100644 index 000000000000..50f3f17baaff --- /dev/null +++ b/AdsAdManager/src/V1/resources/ad_unit_service_descriptor_config.php @@ -0,0 +1,84 @@ + [ + 'google.ads.admanager.v1.AdUnitService' => [ + 'GetAdUnit' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\AdUnit', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListAdUnitSizes' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getAdUnitSizes', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListAdUnitSizesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListAdUnits' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getAdUnits', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListAdUnitsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'adUnit' => 'networks/{network_code}/adUnits/{ad_unit}', + 'network' => 'networks/{network_code}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/ad_unit_service_rest_client_config.php b/AdsAdManager/src/V1/resources/ad_unit_service_rest_client_config.php new file mode 100644 index 000000000000..2357e7bb5118 --- /dev/null +++ b/AdsAdManager/src/V1/resources/ad_unit_service_rest_client_config.php @@ -0,0 +1,81 @@ + [ + 'google.ads.admanager.v1.AdUnitService' => [ + 'GetAdUnit' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/adUnits/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListAdUnitSizes' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/adUnitSizes', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListAdUnits' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/adUnits', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/company_service_client_config.json b/AdsAdManager/src/V1/resources/company_service_client_config.json new file mode 100644 index 000000000000..00bdee6fd628 --- /dev/null +++ b/AdsAdManager/src/V1/resources/company_service_client_config.json @@ -0,0 +1,32 @@ +{ + "interfaces": { + "google.ads.admanager.v1.CompanyService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetCompany": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListCompanies": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/company_service_descriptor_config.php b/AdsAdManager/src/V1/resources/company_service_descriptor_config.php new file mode 100644 index 000000000000..702b48d1cefb --- /dev/null +++ b/AdsAdManager/src/V1/resources/company_service_descriptor_config.php @@ -0,0 +1,64 @@ + [ + 'google.ads.admanager.v1.CompanyService' => [ + 'GetCompany' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\Company', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListCompanies' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getCompanies', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListCompaniesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'company' => 'networks/{network_code}/companies/{company}', + 'network' => 'networks/{network_code}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/company_service_rest_client_config.php b/AdsAdManager/src/V1/resources/company_service_rest_client_config.php new file mode 100644 index 000000000000..337fb3ce0db9 --- /dev/null +++ b/AdsAdManager/src/V1/resources/company_service_rest_client_config.php @@ -0,0 +1,70 @@ + [ + 'google.ads.admanager.v1.CompanyService' => [ + 'GetCompany' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/companies/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListCompanies' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/companies', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/custom_field_service_client_config.json b/AdsAdManager/src/V1/resources/custom_field_service_client_config.json new file mode 100644 index 000000000000..8f8a5a8fc36e --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_field_service_client_config.json @@ -0,0 +1,32 @@ +{ + "interfaces": { + "google.ads.admanager.v1.CustomFieldService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetCustomField": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListCustomFields": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/custom_field_service_descriptor_config.php b/AdsAdManager/src/V1/resources/custom_field_service_descriptor_config.php new file mode 100644 index 000000000000..a7ce127626b8 --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_field_service_descriptor_config.php @@ -0,0 +1,64 @@ + [ + 'google.ads.admanager.v1.CustomFieldService' => [ + 'GetCustomField' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\CustomField', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListCustomFields' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getCustomFields', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListCustomFieldsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'customField' => 'networks/{network_code}/customFields/{custom_field}', + 'network' => 'networks/{network_code}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/custom_field_service_rest_client_config.php b/AdsAdManager/src/V1/resources/custom_field_service_rest_client_config.php new file mode 100644 index 000000000000..73fa8d1c16df --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_field_service_rest_client_config.php @@ -0,0 +1,70 @@ + [ + 'google.ads.admanager.v1.CustomFieldService' => [ + 'GetCustomField' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/customFields/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListCustomFields' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/customFields', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/custom_targeting_key_service_client_config.json b/AdsAdManager/src/V1/resources/custom_targeting_key_service_client_config.json new file mode 100644 index 000000000000..031df8f440ba --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_targeting_key_service_client_config.json @@ -0,0 +1,32 @@ +{ + "interfaces": { + "google.ads.admanager.v1.CustomTargetingKeyService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetCustomTargetingKey": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListCustomTargetingKeys": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/custom_targeting_key_service_descriptor_config.php b/AdsAdManager/src/V1/resources/custom_targeting_key_service_descriptor_config.php new file mode 100644 index 000000000000..107f89f40f0e --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_targeting_key_service_descriptor_config.php @@ -0,0 +1,64 @@ + [ + 'google.ads.admanager.v1.CustomTargetingKeyService' => [ + 'GetCustomTargetingKey' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\CustomTargetingKey', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListCustomTargetingKeys' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getCustomTargetingKeys', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListCustomTargetingKeysResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'customTargetingKey' => 'networks/{network_code}/customTargetingKeys/{custom_targeting_key}', + 'network' => 'networks/{network_code}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/custom_targeting_key_service_rest_client_config.php b/AdsAdManager/src/V1/resources/custom_targeting_key_service_rest_client_config.php new file mode 100644 index 000000000000..1a35718aa455 --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_targeting_key_service_rest_client_config.php @@ -0,0 +1,70 @@ + [ + 'google.ads.admanager.v1.CustomTargetingKeyService' => [ + 'GetCustomTargetingKey' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/customTargetingKeys/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListCustomTargetingKeys' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/customTargetingKeys', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/custom_targeting_value_service_client_config.json b/AdsAdManager/src/V1/resources/custom_targeting_value_service_client_config.json new file mode 100644 index 000000000000..e2444ae9ce7b --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_targeting_value_service_client_config.json @@ -0,0 +1,32 @@ +{ + "interfaces": { + "google.ads.admanager.v1.CustomTargetingValueService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetCustomTargetingValue": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListCustomTargetingValues": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/custom_targeting_value_service_descriptor_config.php b/AdsAdManager/src/V1/resources/custom_targeting_value_service_descriptor_config.php new file mode 100644 index 000000000000..2d1752e01380 --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_targeting_value_service_descriptor_config.php @@ -0,0 +1,64 @@ + [ + 'google.ads.admanager.v1.CustomTargetingValueService' => [ + 'GetCustomTargetingValue' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\CustomTargetingValue', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListCustomTargetingValues' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getCustomTargetingValues', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListCustomTargetingValuesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'customTargetingKey' => 'networks/{network_code}/customTargetingKeys/{custom_targeting_key}', + 'customTargetingValue' => 'networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/custom_targeting_value_service_rest_client_config.php b/AdsAdManager/src/V1/resources/custom_targeting_value_service_rest_client_config.php new file mode 100644 index 000000000000..b6c9c7456c27 --- /dev/null +++ b/AdsAdManager/src/V1/resources/custom_targeting_value_service_rest_client_config.php @@ -0,0 +1,70 @@ + [ + 'google.ads.admanager.v1.CustomTargetingValueService' => [ + 'GetCustomTargetingValue' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/customTargetingKeys/*/customTargetingValues/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListCustomTargetingValues' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*/customTargetingKeys/*}/customTargetingValues', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/entity_signals_mapping_service_client_config.json b/AdsAdManager/src/V1/resources/entity_signals_mapping_service_client_config.json new file mode 100644 index 000000000000..22fd1b90d729 --- /dev/null +++ b/AdsAdManager/src/V1/resources/entity_signals_mapping_service_client_config.json @@ -0,0 +1,52 @@ +{ + "interfaces": { + "google.ads.admanager.v1.EntitySignalsMappingService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "BatchCreateEntitySignalsMappings": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "BatchUpdateEntitySignalsMappings": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "CreateEntitySignalsMapping": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "GetEntitySignalsMapping": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListEntitySignalsMappings": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "UpdateEntitySignalsMapping": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/entity_signals_mapping_service_descriptor_config.php b/AdsAdManager/src/V1/resources/entity_signals_mapping_service_descriptor_config.php new file mode 100644 index 000000000000..ee92c845811d --- /dev/null +++ b/AdsAdManager/src/V1/resources/entity_signals_mapping_service_descriptor_config.php @@ -0,0 +1,113 @@ + [ + 'google.ads.admanager.v1.EntitySignalsMappingService' => [ + 'BatchCreateEntitySignalsMappings' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\BatchCreateEntitySignalsMappingsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'BatchUpdateEntitySignalsMappings' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\BatchUpdateEntitySignalsMappingsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'CreateEntitySignalsMapping' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\EntitySignalsMapping', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'GetEntitySignalsMapping' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\EntitySignalsMapping', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListEntitySignalsMappings' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getEntitySignalsMappings', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListEntitySignalsMappingsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'UpdateEntitySignalsMapping' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\EntitySignalsMapping', + 'headerParams' => [ + [ + 'keyName' => 'entity_signals_mapping.name', + 'fieldAccessors' => [ + 'getEntitySignalsMapping', + 'getName', + ], + ], + ], + ], + 'templateMap' => [ + 'entitySignalsMapping' => 'networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}', + 'network' => 'networks/{network_code}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/entity_signals_mapping_service_rest_client_config.php b/AdsAdManager/src/V1/resources/entity_signals_mapping_service_rest_client_config.php new file mode 100644 index 000000000000..9f9aae3f48ea --- /dev/null +++ b/AdsAdManager/src/V1/resources/entity_signals_mapping_service_rest_client_config.php @@ -0,0 +1,122 @@ + [ + 'google.ads.admanager.v1.EntitySignalsMappingService' => [ + 'BatchCreateEntitySignalsMappings' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=networks/*}/entitySignalsMappings:batchCreate', + 'body' => '*', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'BatchUpdateEntitySignalsMappings' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=networks/*}/entitySignalsMappings:batchUpdate', + 'body' => '*', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'CreateEntitySignalsMapping' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=networks/*}/entitySignalsMappings', + 'body' => 'entity_signals_mapping', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'GetEntitySignalsMapping' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/entitySignalsMappings/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListEntitySignalsMappings' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/entitySignalsMappings', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'UpdateEntitySignalsMapping' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{entity_signals_mapping.name=networks/*/entitySignalsMappings/*}', + 'body' => 'entity_signals_mapping', + 'placeholders' => [ + 'entity_signals_mapping.name' => [ + 'getters' => [ + 'getEntitySignalsMapping', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/network_service_client_config.json b/AdsAdManager/src/V1/resources/network_service_client_config.json new file mode 100644 index 000000000000..aec7ab1f074c --- /dev/null +++ b/AdsAdManager/src/V1/resources/network_service_client_config.json @@ -0,0 +1,32 @@ +{ + "interfaces": { + "google.ads.admanager.v1.NetworkService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetNetwork": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListNetworks": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/network_service_descriptor_config.php b/AdsAdManager/src/V1/resources/network_service_descriptor_config.php new file mode 100644 index 000000000000..9c9e431d99fa --- /dev/null +++ b/AdsAdManager/src/V1/resources/network_service_descriptor_config.php @@ -0,0 +1,47 @@ + [ + 'google.ads.admanager.v1.NetworkService' => [ + 'GetNetwork' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\Network', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListNetworks' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListNetworksResponse', + ], + 'templateMap' => [ + 'network' => 'networks/{network_code}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/network_service_rest_client_config.php b/AdsAdManager/src/V1/resources/network_service_rest_client_config.php new file mode 100644 index 000000000000..8a718fdee222 --- /dev/null +++ b/AdsAdManager/src/V1/resources/network_service_rest_client_config.php @@ -0,0 +1,63 @@ + [ + 'google.ads.admanager.v1.NetworkService' => [ + 'GetNetwork' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListNetworks' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/networks', + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/order_service_client_config.json b/AdsAdManager/src/V1/resources/order_service_client_config.json new file mode 100644 index 000000000000..de7c27588915 --- /dev/null +++ b/AdsAdManager/src/V1/resources/order_service_client_config.json @@ -0,0 +1,44 @@ +{ + "interfaces": { + "google.ads.admanager.v1.OrderService": { + "retry_codes": { + "no_retry_codes": [], + "retry_policy_1_codes": [ + "UNAVAILABLE" + ] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + }, + "retry_policy_1_params": { + "initial_retry_delay_millis": 1000, + "retry_delay_multiplier": 1.3, + "max_retry_delay_millis": 10000, + "initial_rpc_timeout_millis": 60000, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 60000, + "total_timeout_millis": 60000 + } + }, + "methods": { + "GetOrder": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "ListOrders": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/order_service_descriptor_config.php b/AdsAdManager/src/V1/resources/order_service_descriptor_config.php new file mode 100644 index 000000000000..9cf7e3962ede --- /dev/null +++ b/AdsAdManager/src/V1/resources/order_service_descriptor_config.php @@ -0,0 +1,64 @@ + [ + 'google.ads.admanager.v1.OrderService' => [ + 'GetOrder' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\Order', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListOrders' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getOrders', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListOrdersResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'network' => 'networks/{network_code}', + 'order' => 'networks/{network_code}/orders/{order}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/order_service_rest_client_config.php b/AdsAdManager/src/V1/resources/order_service_rest_client_config.php new file mode 100644 index 000000000000..67c80d2ce1ed --- /dev/null +++ b/AdsAdManager/src/V1/resources/order_service_rest_client_config.php @@ -0,0 +1,70 @@ + [ + 'google.ads.admanager.v1.OrderService' => [ + 'GetOrder' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/orders/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListOrders' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/orders', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/placement_service_client_config.json b/AdsAdManager/src/V1/resources/placement_service_client_config.json new file mode 100644 index 000000000000..8d039baaad41 --- /dev/null +++ b/AdsAdManager/src/V1/resources/placement_service_client_config.json @@ -0,0 +1,32 @@ +{ + "interfaces": { + "google.ads.admanager.v1.PlacementService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetPlacement": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListPlacements": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/placement_service_descriptor_config.php b/AdsAdManager/src/V1/resources/placement_service_descriptor_config.php new file mode 100644 index 000000000000..f7949ce84422 --- /dev/null +++ b/AdsAdManager/src/V1/resources/placement_service_descriptor_config.php @@ -0,0 +1,64 @@ + [ + 'google.ads.admanager.v1.PlacementService' => [ + 'GetPlacement' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\Placement', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListPlacements' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getPlacements', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListPlacementsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'network' => 'networks/{network_code}', + 'placement' => 'networks/{network_code}/placements/{placement}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/placement_service_rest_client_config.php b/AdsAdManager/src/V1/resources/placement_service_rest_client_config.php new file mode 100644 index 000000000000..385d27a9a508 --- /dev/null +++ b/AdsAdManager/src/V1/resources/placement_service_rest_client_config.php @@ -0,0 +1,70 @@ + [ + 'google.ads.admanager.v1.PlacementService' => [ + 'GetPlacement' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/placements/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListPlacements' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/placements', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/report_service_client_config.json b/AdsAdManager/src/V1/resources/report_service_client_config.json new file mode 100644 index 000000000000..30eac575d3c6 --- /dev/null +++ b/AdsAdManager/src/V1/resources/report_service_client_config.json @@ -0,0 +1,52 @@ +{ + "interfaces": { + "google.ads.admanager.v1.ReportService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "CreateReport": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "FetchReportResultRows": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "GetReport": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListReports": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "RunReport": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "UpdateReport": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/report_service_descriptor_config.php b/AdsAdManager/src/V1/resources/report_service_descriptor_config.php new file mode 100644 index 000000000000..6d3268234ca5 --- /dev/null +++ b/AdsAdManager/src/V1/resources/report_service_descriptor_config.php @@ -0,0 +1,120 @@ + [ + 'google.ads.admanager.v1.ReportService' => [ + 'RunReport' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Ads\AdManager\V1\RunReportResponse', + 'metadataReturnType' => '\Google\Ads\AdManager\V1\RunReportMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'CreateReport' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\Report', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'FetchReportResultRows' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\FetchReportResultRowsResponse', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'GetReport' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\Report', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListReports' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getReports', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListReportsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'UpdateReport' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\Report', + 'headerParams' => [ + [ + 'keyName' => 'report.name', + 'fieldAccessors' => [ + 'getReport', + 'getName', + ], + ], + ], + ], + 'templateMap' => [ + 'network' => 'networks/{network_code}', + 'report' => 'networks/{network_code}/reports/{report}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/report_service_rest_client_config.php b/AdsAdManager/src/V1/resources/report_service_rest_client_config.php new file mode 100644 index 000000000000..3a942eabf667 --- /dev/null +++ b/AdsAdManager/src/V1/resources/report_service_rest_client_config.php @@ -0,0 +1,121 @@ + [ + 'google.ads.admanager.v1.ReportService' => [ + 'CreateReport' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=networks/*}/reports', + 'body' => 'report', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'FetchReportResultRows' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/reports/*/results/*}:fetchRows', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetReport' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/reports/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListReports' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/reports', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'RunReport' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=networks/*/reports/*}:run', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'UpdateReport' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{report.name=networks/*/reports/*}', + 'body' => 'report', + 'placeholders' => [ + 'report.name' => [ + 'getters' => [ + 'getReport', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/role_service_client_config.json b/AdsAdManager/src/V1/resources/role_service_client_config.json new file mode 100644 index 000000000000..ac76997d5641 --- /dev/null +++ b/AdsAdManager/src/V1/resources/role_service_client_config.json @@ -0,0 +1,32 @@ +{ + "interfaces": { + "google.ads.admanager.v1.RoleService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetRole": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListRoles": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/role_service_descriptor_config.php b/AdsAdManager/src/V1/resources/role_service_descriptor_config.php new file mode 100644 index 000000000000..03c6d0883075 --- /dev/null +++ b/AdsAdManager/src/V1/resources/role_service_descriptor_config.php @@ -0,0 +1,64 @@ + [ + 'google.ads.admanager.v1.RoleService' => [ + 'GetRole' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\Role', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListRoles' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getRoles', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListRolesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'network' => 'networks/{network_code}', + 'role' => 'networks/{network_code}/roles/{role}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/role_service_rest_client_config.php b/AdsAdManager/src/V1/resources/role_service_rest_client_config.php new file mode 100644 index 000000000000..5d49f4fe70cb --- /dev/null +++ b/AdsAdManager/src/V1/resources/role_service_rest_client_config.php @@ -0,0 +1,70 @@ + [ + 'google.ads.admanager.v1.RoleService' => [ + 'GetRole' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/roles/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListRoles' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/roles', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/taxonomy_category_service_client_config.json b/AdsAdManager/src/V1/resources/taxonomy_category_service_client_config.json new file mode 100644 index 000000000000..2de30370c2f5 --- /dev/null +++ b/AdsAdManager/src/V1/resources/taxonomy_category_service_client_config.json @@ -0,0 +1,32 @@ +{ + "interfaces": { + "google.ads.admanager.v1.TaxonomyCategoryService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetTaxonomyCategory": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, + "ListTaxonomyCategories": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/taxonomy_category_service_descriptor_config.php b/AdsAdManager/src/V1/resources/taxonomy_category_service_descriptor_config.php new file mode 100644 index 000000000000..6be3b9000cc7 --- /dev/null +++ b/AdsAdManager/src/V1/resources/taxonomy_category_service_descriptor_config.php @@ -0,0 +1,64 @@ + [ + 'google.ads.admanager.v1.TaxonomyCategoryService' => [ + 'GetTaxonomyCategory' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\TaxonomyCategory', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'ListTaxonomyCategories' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getTaxonomyCategories', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\ListTaxonomyCategoriesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'templateMap' => [ + 'network' => 'networks/{network_code}', + 'taxonomyCategory' => 'networks/{network_code}/taxonomyCategories/{taxonomy_category}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/taxonomy_category_service_rest_client_config.php b/AdsAdManager/src/V1/resources/taxonomy_category_service_rest_client_config.php new file mode 100644 index 000000000000..5fc884225e03 --- /dev/null +++ b/AdsAdManager/src/V1/resources/taxonomy_category_service_rest_client_config.php @@ -0,0 +1,70 @@ + [ + 'google.ads.admanager.v1.TaxonomyCategoryService' => [ + 'GetTaxonomyCategory' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/taxonomyCategories/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'ListTaxonomyCategories' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=networks/*}/taxonomyCategories', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/src/V1/resources/user_service_client_config.json b/AdsAdManager/src/V1/resources/user_service_client_config.json new file mode 100644 index 000000000000..34a4b4903db2 --- /dev/null +++ b/AdsAdManager/src/V1/resources/user_service_client_config.json @@ -0,0 +1,27 @@ +{ + "interfaces": { + "google.ads.admanager.v1.UserService": { + "retry_codes": { + "no_retry_codes": [] + }, + "retry_params": { + "no_retry_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 0, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 0, + "total_timeout_millis": 0 + } + }, + "methods": { + "GetUser": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + } + } + } + } +} diff --git a/AdsAdManager/src/V1/resources/user_service_descriptor_config.php b/AdsAdManager/src/V1/resources/user_service_descriptor_config.php new file mode 100644 index 000000000000..405ff289c084 --- /dev/null +++ b/AdsAdManager/src/V1/resources/user_service_descriptor_config.php @@ -0,0 +1,43 @@ + [ + 'google.ads.admanager.v1.UserService' => [ + 'GetUser' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Ads\AdManager\V1\User', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'templateMap' => [ + 'user' => 'networks/{network_code}/users/{user}', + ], + ], + ], +]; diff --git a/AdsAdManager/src/V1/resources/user_service_rest_client_config.php b/AdsAdManager/src/V1/resources/user_service_rest_client_config.php new file mode 100644 index 000000000000..91979f52361a --- /dev/null +++ b/AdsAdManager/src/V1/resources/user_service_rest_client_config.php @@ -0,0 +1,59 @@ + [ + 'google.ads.admanager.v1.UserService' => [ + 'GetUser' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/users/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + 'google.longrunning.Operations' => [ + 'GetOperation' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/runs/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=networks/*/operations/reports/exports/*}', + ], + ], + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + ], + ], + 'numericEnums' => true, +]; diff --git a/AdsAdManager/tests/Unit/V1/Client/AdUnitServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/AdUnitServiceClientTest.php new file mode 100644 index 000000000000..1783a121f27f --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/AdUnitServiceClientTest.php @@ -0,0 +1,348 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return AdUnitServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new AdUnitServiceClient($options); + } + + /** @test */ + public function getAdUnitTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $adUnitId = 167061094; + $parentAdUnit = 'parentAdUnit-898168437'; + $displayName = 'displayName1615086568'; + $adUnitCode = 'adUnitCode-1632086356'; + $description = 'description-1724546052'; + $explicitlyTargeted = true; + $hasChildren = true; + $externalSetTopBoxChannelId = 'externalSetTopBoxChannelId-1727346970'; + $appliedAdsenseEnabled = false; + $effectiveAdsenseEnabled = false; + $expectedResponse = new AdUnit(); + $expectedResponse->setName($name2); + $expectedResponse->setAdUnitId($adUnitId); + $expectedResponse->setParentAdUnit($parentAdUnit); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setAdUnitCode($adUnitCode); + $expectedResponse->setDescription($description); + $expectedResponse->setExplicitlyTargeted($explicitlyTargeted); + $expectedResponse->setHasChildren($hasChildren); + $expectedResponse->setExternalSetTopBoxChannelId($externalSetTopBoxChannelId); + $expectedResponse->setAppliedAdsenseEnabled($appliedAdsenseEnabled); + $expectedResponse->setEffectiveAdsenseEnabled($effectiveAdsenseEnabled); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->adUnitName('[NETWORK_CODE]', '[AD_UNIT]'); + $request = (new GetAdUnitRequest())->setName($formattedName); + $response = $gapicClient->getAdUnit($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.AdUnitService/GetAdUnit', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getAdUnitExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->adUnitName('[NETWORK_CODE]', '[AD_UNIT]'); + $request = (new GetAdUnitRequest())->setName($formattedName); + try { + $gapicClient->getAdUnit($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listAdUnitSizesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $adUnitSizesElement = new AdUnitSize(); + $adUnitSizes = [$adUnitSizesElement]; + $expectedResponse = new ListAdUnitSizesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setAdUnitSizes($adUnitSizes); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListAdUnitSizesRequest())->setParent($formattedParent); + $response = $gapicClient->listAdUnitSizes($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getAdUnitSizes()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.AdUnitService/ListAdUnitSizes', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listAdUnitSizesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListAdUnitSizesRequest())->setParent($formattedParent); + try { + $gapicClient->listAdUnitSizes($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listAdUnitsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $adUnitsElement = new AdUnit(); + $adUnits = [$adUnitsElement]; + $expectedResponse = new ListAdUnitsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setAdUnits($adUnits); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListAdUnitsRequest())->setParent($formattedParent); + $response = $gapicClient->listAdUnits($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getAdUnits()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.AdUnitService/ListAdUnits', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listAdUnitsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListAdUnitsRequest())->setParent($formattedParent); + try { + $gapicClient->listAdUnits($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getAdUnitAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $adUnitId = 167061094; + $parentAdUnit = 'parentAdUnit-898168437'; + $displayName = 'displayName1615086568'; + $adUnitCode = 'adUnitCode-1632086356'; + $description = 'description-1724546052'; + $explicitlyTargeted = true; + $hasChildren = true; + $externalSetTopBoxChannelId = 'externalSetTopBoxChannelId-1727346970'; + $appliedAdsenseEnabled = false; + $effectiveAdsenseEnabled = false; + $expectedResponse = new AdUnit(); + $expectedResponse->setName($name2); + $expectedResponse->setAdUnitId($adUnitId); + $expectedResponse->setParentAdUnit($parentAdUnit); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setAdUnitCode($adUnitCode); + $expectedResponse->setDescription($description); + $expectedResponse->setExplicitlyTargeted($explicitlyTargeted); + $expectedResponse->setHasChildren($hasChildren); + $expectedResponse->setExternalSetTopBoxChannelId($externalSetTopBoxChannelId); + $expectedResponse->setAppliedAdsenseEnabled($appliedAdsenseEnabled); + $expectedResponse->setEffectiveAdsenseEnabled($effectiveAdsenseEnabled); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->adUnitName('[NETWORK_CODE]', '[AD_UNIT]'); + $request = (new GetAdUnitRequest())->setName($formattedName); + $response = $gapicClient->getAdUnitAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.AdUnitService/GetAdUnit', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/CompanyServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/CompanyServiceClientTest.php new file mode 100644 index 000000000000..4e512619f2c3 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/CompanyServiceClientTest.php @@ -0,0 +1,272 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return CompanyServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new CompanyServiceClient($options); + } + + /** @test */ + public function getCompanyTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $companyId = 847673315; + $displayName = 'displayName1615086568'; + $address = 'address-1147692044'; + $email = 'email96619420'; + $fax = 'fax101149'; + $phone = 'phone106642798'; + $externalId = 'externalId-1153075697'; + $comment = 'comment950398559'; + $primaryContact = 'primaryContact203339491'; + $thirdPartyCompanyId = 2003341038; + $expectedResponse = new Company(); + $expectedResponse->setName($name2); + $expectedResponse->setCompanyId($companyId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setAddress($address); + $expectedResponse->setEmail($email); + $expectedResponse->setFax($fax); + $expectedResponse->setPhone($phone); + $expectedResponse->setExternalId($externalId); + $expectedResponse->setComment($comment); + $expectedResponse->setPrimaryContact($primaryContact); + $expectedResponse->setThirdPartyCompanyId($thirdPartyCompanyId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->companyName('[NETWORK_CODE]', '[COMPANY]'); + $request = (new GetCompanyRequest())->setName($formattedName); + $response = $gapicClient->getCompany($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.CompanyService/GetCompany', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getCompanyExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->companyName('[NETWORK_CODE]', '[COMPANY]'); + $request = (new GetCompanyRequest())->setName($formattedName); + try { + $gapicClient->getCompany($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listCompaniesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $companiesElement = new Company(); + $companies = [$companiesElement]; + $expectedResponse = new ListCompaniesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setCompanies($companies); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListCompaniesRequest())->setParent($formattedParent); + $response = $gapicClient->listCompanies($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getCompanies()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.CompanyService/ListCompanies', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listCompaniesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListCompaniesRequest())->setParent($formattedParent); + try { + $gapicClient->listCompanies($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getCompanyAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $companyId = 847673315; + $displayName = 'displayName1615086568'; + $address = 'address-1147692044'; + $email = 'email96619420'; + $fax = 'fax101149'; + $phone = 'phone106642798'; + $externalId = 'externalId-1153075697'; + $comment = 'comment950398559'; + $primaryContact = 'primaryContact203339491'; + $thirdPartyCompanyId = 2003341038; + $expectedResponse = new Company(); + $expectedResponse->setName($name2); + $expectedResponse->setCompanyId($companyId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setAddress($address); + $expectedResponse->setEmail($email); + $expectedResponse->setFax($fax); + $expectedResponse->setPhone($phone); + $expectedResponse->setExternalId($externalId); + $expectedResponse->setComment($comment); + $expectedResponse->setPrimaryContact($primaryContact); + $expectedResponse->setThirdPartyCompanyId($thirdPartyCompanyId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->companyName('[NETWORK_CODE]', '[COMPANY]'); + $request = (new GetCompanyRequest())->setName($formattedName); + $response = $gapicClient->getCompanyAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.CompanyService/GetCompany', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/CustomFieldServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/CustomFieldServiceClientTest.php new file mode 100644 index 000000000000..b5cf6fa12850 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/CustomFieldServiceClientTest.php @@ -0,0 +1,244 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return CustomFieldServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new CustomFieldServiceClient($options); + } + + /** @test */ + public function getCustomFieldTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $customFieldId = 66688114; + $displayName = 'displayName1615086568'; + $description = 'description-1724546052'; + $expectedResponse = new CustomField(); + $expectedResponse->setName($name2); + $expectedResponse->setCustomFieldId($customFieldId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDescription($description); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->customFieldName('[NETWORK_CODE]', '[CUSTOM_FIELD]'); + $request = (new GetCustomFieldRequest())->setName($formattedName); + $response = $gapicClient->getCustomField($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.CustomFieldService/GetCustomField', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getCustomFieldExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->customFieldName('[NETWORK_CODE]', '[CUSTOM_FIELD]'); + $request = (new GetCustomFieldRequest())->setName($formattedName); + try { + $gapicClient->getCustomField($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listCustomFieldsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $customFieldsElement = new CustomField(); + $customFields = [$customFieldsElement]; + $expectedResponse = new ListCustomFieldsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setCustomFields($customFields); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListCustomFieldsRequest())->setParent($formattedParent); + $response = $gapicClient->listCustomFields($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getCustomFields()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.CustomFieldService/ListCustomFields', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listCustomFieldsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListCustomFieldsRequest())->setParent($formattedParent); + try { + $gapicClient->listCustomFields($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getCustomFieldAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $customFieldId = 66688114; + $displayName = 'displayName1615086568'; + $description = 'description-1724546052'; + $expectedResponse = new CustomField(); + $expectedResponse->setName($name2); + $expectedResponse->setCustomFieldId($customFieldId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDescription($description); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->customFieldName('[NETWORK_CODE]', '[CUSTOM_FIELD]'); + $request = (new GetCustomFieldRequest())->setName($formattedName); + $response = $gapicClient->getCustomFieldAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.CustomFieldService/GetCustomField', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/CustomTargetingKeyServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/CustomTargetingKeyServiceClientTest.php new file mode 100644 index 000000000000..819dd2351187 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/CustomTargetingKeyServiceClientTest.php @@ -0,0 +1,247 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return CustomTargetingKeyServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new CustomTargetingKeyServiceClient($options); + } + + /** @test */ + public function getCustomTargetingKeyTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $customTargetingKeyId = 138683049; + $adTagName = 'adTagName-1355595604'; + $displayName = 'displayName1615086568'; + $expectedResponse = new CustomTargetingKey(); + $expectedResponse->setName($name2); + $expectedResponse->setCustomTargetingKeyId($customTargetingKeyId); + $expectedResponse->setAdTagName($adTagName); + $expectedResponse->setDisplayName($displayName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->customTargetingKeyName('[NETWORK_CODE]', '[CUSTOM_TARGETING_KEY]'); + $request = (new GetCustomTargetingKeyRequest())->setName($formattedName); + $response = $gapicClient->getCustomTargetingKey($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.CustomTargetingKeyService/GetCustomTargetingKey', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getCustomTargetingKeyExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->customTargetingKeyName('[NETWORK_CODE]', '[CUSTOM_TARGETING_KEY]'); + $request = (new GetCustomTargetingKeyRequest())->setName($formattedName); + try { + $gapicClient->getCustomTargetingKey($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listCustomTargetingKeysTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $customTargetingKeysElement = new CustomTargetingKey(); + $customTargetingKeys = [$customTargetingKeysElement]; + $expectedResponse = new ListCustomTargetingKeysResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setCustomTargetingKeys($customTargetingKeys); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListCustomTargetingKeysRequest())->setParent($formattedParent); + $response = $gapicClient->listCustomTargetingKeys($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getCustomTargetingKeys()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.CustomTargetingKeyService/ListCustomTargetingKeys', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listCustomTargetingKeysExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListCustomTargetingKeysRequest())->setParent($formattedParent); + try { + $gapicClient->listCustomTargetingKeys($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getCustomTargetingKeyAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $customTargetingKeyId = 138683049; + $adTagName = 'adTagName-1355595604'; + $displayName = 'displayName1615086568'; + $expectedResponse = new CustomTargetingKey(); + $expectedResponse->setName($name2); + $expectedResponse->setCustomTargetingKeyId($customTargetingKeyId); + $expectedResponse->setAdTagName($adTagName); + $expectedResponse->setDisplayName($displayName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->customTargetingKeyName('[NETWORK_CODE]', '[CUSTOM_TARGETING_KEY]'); + $request = (new GetCustomTargetingKeyRequest())->setName($formattedName); + $response = $gapicClient->getCustomTargetingKeyAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.CustomTargetingKeyService/GetCustomTargetingKey', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/CustomTargetingValueServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/CustomTargetingValueServiceClientTest.php new file mode 100644 index 000000000000..7ca476c1512b --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/CustomTargetingValueServiceClientTest.php @@ -0,0 +1,261 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return CustomTargetingValueServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new CustomTargetingValueServiceClient($options); + } + + /** @test */ + public function getCustomTargetingValueTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $adTagName = 'adTagName-1355595604'; + $displayName = 'displayName1615086568'; + $expectedResponse = new CustomTargetingValue(); + $expectedResponse->setName($name2); + $expectedResponse->setAdTagName($adTagName); + $expectedResponse->setDisplayName($displayName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->customTargetingValueName( + '[NETWORK_CODE]', + '[CUSTOM_TARGETING_KEY]', + '[CUSTOM_TARGETING_VALUE]' + ); + $request = (new GetCustomTargetingValueRequest())->setName($formattedName); + $response = $gapicClient->getCustomTargetingValue($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.CustomTargetingValueService/GetCustomTargetingValue', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getCustomTargetingValueExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->customTargetingValueName( + '[NETWORK_CODE]', + '[CUSTOM_TARGETING_KEY]', + '[CUSTOM_TARGETING_VALUE]' + ); + $request = (new GetCustomTargetingValueRequest())->setName($formattedName); + try { + $gapicClient->getCustomTargetingValue($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listCustomTargetingValuesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $customTargetingValuesElement = new CustomTargetingValue(); + $customTargetingValues = [$customTargetingValuesElement]; + $expectedResponse = new ListCustomTargetingValuesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setCustomTargetingValues($customTargetingValues); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->customTargetingKeyName('[NETWORK_CODE]', '[CUSTOM_TARGETING_KEY]'); + $request = (new ListCustomTargetingValuesRequest())->setParent($formattedParent); + $response = $gapicClient->listCustomTargetingValues($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getCustomTargetingValues()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.CustomTargetingValueService/ListCustomTargetingValues', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listCustomTargetingValuesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->customTargetingKeyName('[NETWORK_CODE]', '[CUSTOM_TARGETING_KEY]'); + $request = (new ListCustomTargetingValuesRequest())->setParent($formattedParent); + try { + $gapicClient->listCustomTargetingValues($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getCustomTargetingValueAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $adTagName = 'adTagName-1355595604'; + $displayName = 'displayName1615086568'; + $expectedResponse = new CustomTargetingValue(); + $expectedResponse->setName($name2); + $expectedResponse->setAdTagName($adTagName); + $expectedResponse->setDisplayName($displayName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->customTargetingValueName( + '[NETWORK_CODE]', + '[CUSTOM_TARGETING_KEY]', + '[CUSTOM_TARGETING_VALUE]' + ); + $request = (new GetCustomTargetingValueRequest())->setName($formattedName); + $response = $gapicClient->getCustomTargetingValueAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.CustomTargetingValueService/GetCustomTargetingValue', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/EntitySignalsMappingServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/EntitySignalsMappingServiceClientTest.php new file mode 100644 index 000000000000..0323897f6558 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/EntitySignalsMappingServiceClientTest.php @@ -0,0 +1,561 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return EntitySignalsMappingServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new EntitySignalsMappingServiceClient($options); + } + + /** @test */ + public function batchCreateEntitySignalsMappingsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new BatchCreateEntitySignalsMappingsResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $requests = []; + $request = (new BatchCreateEntitySignalsMappingsRequest())->setParent($formattedParent)->setRequests($requests); + $response = $gapicClient->batchCreateEntitySignalsMappings($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.EntitySignalsMappingService/BatchCreateEntitySignalsMappings', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualRequestObject->getRequests(); + $this->assertProtobufEquals($requests, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function batchCreateEntitySignalsMappingsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $requests = []; + $request = (new BatchCreateEntitySignalsMappingsRequest())->setParent($formattedParent)->setRequests($requests); + try { + $gapicClient->batchCreateEntitySignalsMappings($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function batchUpdateEntitySignalsMappingsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new BatchUpdateEntitySignalsMappingsResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $requests = []; + $request = (new BatchUpdateEntitySignalsMappingsRequest())->setParent($formattedParent)->setRequests($requests); + $response = $gapicClient->batchUpdateEntitySignalsMappings($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.EntitySignalsMappingService/BatchUpdateEntitySignalsMappings', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualRequestObject->getRequests(); + $this->assertProtobufEquals($requests, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function batchUpdateEntitySignalsMappingsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $requests = []; + $request = (new BatchUpdateEntitySignalsMappingsRequest())->setParent($formattedParent)->setRequests($requests); + try { + $gapicClient->batchUpdateEntitySignalsMappings($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function createEntitySignalsMappingTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $audienceSegmentId = 321086146; + $name = 'name3373707'; + $entitySignalsMappingId = 350688772; + $expectedResponse = new EntitySignalsMapping(); + $expectedResponse->setAudienceSegmentId($audienceSegmentId); + $expectedResponse->setName($name); + $expectedResponse->setEntitySignalsMappingId($entitySignalsMappingId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $entitySignalsMapping = new EntitySignalsMapping(); + $entitySignalsMappingTaxonomyCategoryIds = []; + $entitySignalsMapping->setTaxonomyCategoryIds($entitySignalsMappingTaxonomyCategoryIds); + $request = (new CreateEntitySignalsMappingRequest()) + ->setParent($formattedParent) + ->setEntitySignalsMapping($entitySignalsMapping); + $response = $gapicClient->createEntitySignalsMapping($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.EntitySignalsMappingService/CreateEntitySignalsMapping', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualRequestObject->getEntitySignalsMapping(); + $this->assertProtobufEquals($entitySignalsMapping, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function createEntitySignalsMappingExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $entitySignalsMapping = new EntitySignalsMapping(); + $entitySignalsMappingTaxonomyCategoryIds = []; + $entitySignalsMapping->setTaxonomyCategoryIds($entitySignalsMappingTaxonomyCategoryIds); + $request = (new CreateEntitySignalsMappingRequest()) + ->setParent($formattedParent) + ->setEntitySignalsMapping($entitySignalsMapping); + try { + $gapicClient->createEntitySignalsMapping($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getEntitySignalsMappingTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $audienceSegmentId = 321086146; + $name2 = 'name2-1052831874'; + $entitySignalsMappingId = 350688772; + $expectedResponse = new EntitySignalsMapping(); + $expectedResponse->setAudienceSegmentId($audienceSegmentId); + $expectedResponse->setName($name2); + $expectedResponse->setEntitySignalsMappingId($entitySignalsMappingId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->entitySignalsMappingName('[NETWORK_CODE]', '[ENTITY_SIGNALS_MAPPING]'); + $request = (new GetEntitySignalsMappingRequest())->setName($formattedName); + $response = $gapicClient->getEntitySignalsMapping($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.EntitySignalsMappingService/GetEntitySignalsMapping', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getEntitySignalsMappingExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->entitySignalsMappingName('[NETWORK_CODE]', '[ENTITY_SIGNALS_MAPPING]'); + $request = (new GetEntitySignalsMappingRequest())->setName($formattedName); + try { + $gapicClient->getEntitySignalsMapping($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listEntitySignalsMappingsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $entitySignalsMappingsElement = new EntitySignalsMapping(); + $entitySignalsMappings = [$entitySignalsMappingsElement]; + $expectedResponse = new ListEntitySignalsMappingsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setEntitySignalsMappings($entitySignalsMappings); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListEntitySignalsMappingsRequest())->setParent($formattedParent); + $response = $gapicClient->listEntitySignalsMappings($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getEntitySignalsMappings()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.EntitySignalsMappingService/ListEntitySignalsMappings', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listEntitySignalsMappingsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListEntitySignalsMappingsRequest())->setParent($formattedParent); + try { + $gapicClient->listEntitySignalsMappings($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateEntitySignalsMappingTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $audienceSegmentId = 321086146; + $name = 'name3373707'; + $entitySignalsMappingId = 350688772; + $expectedResponse = new EntitySignalsMapping(); + $expectedResponse->setAudienceSegmentId($audienceSegmentId); + $expectedResponse->setName($name); + $expectedResponse->setEntitySignalsMappingId($entitySignalsMappingId); + $transport->addResponse($expectedResponse); + // Mock request + $entitySignalsMapping = new EntitySignalsMapping(); + $entitySignalsMappingTaxonomyCategoryIds = []; + $entitySignalsMapping->setTaxonomyCategoryIds($entitySignalsMappingTaxonomyCategoryIds); + $updateMask = new FieldMask(); + $request = (new UpdateEntitySignalsMappingRequest()) + ->setEntitySignalsMapping($entitySignalsMapping) + ->setUpdateMask($updateMask); + $response = $gapicClient->updateEntitySignalsMapping($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.EntitySignalsMappingService/UpdateEntitySignalsMapping', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getEntitySignalsMapping(); + $this->assertProtobufEquals($entitySignalsMapping, $actualValue); + $actualValue = $actualRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateEntitySignalsMappingExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $entitySignalsMapping = new EntitySignalsMapping(); + $entitySignalsMappingTaxonomyCategoryIds = []; + $entitySignalsMapping->setTaxonomyCategoryIds($entitySignalsMappingTaxonomyCategoryIds); + $updateMask = new FieldMask(); + $request = (new UpdateEntitySignalsMappingRequest()) + ->setEntitySignalsMapping($entitySignalsMapping) + ->setUpdateMask($updateMask); + try { + $gapicClient->updateEntitySignalsMapping($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function batchCreateEntitySignalsMappingsAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new BatchCreateEntitySignalsMappingsResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $requests = []; + $request = (new BatchCreateEntitySignalsMappingsRequest())->setParent($formattedParent)->setRequests($requests); + $response = $gapicClient->batchCreateEntitySignalsMappingsAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame( + '/google.ads.admanager.v1.EntitySignalsMappingService/BatchCreateEntitySignalsMappings', + $actualFuncCall + ); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualRequestObject->getRequests(); + $this->assertProtobufEquals($requests, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/NetworkServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/NetworkServiceClientTest.php new file mode 100644 index 000000000000..011962ae5c7a --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/NetworkServiceClientTest.php @@ -0,0 +1,248 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return NetworkServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new NetworkServiceClient($options); + } + + /** @test */ + public function getNetworkTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $displayName = 'displayName1615086568'; + $networkCode = 'networkCode-19973794'; + $propertyCode = 'propertyCode-1019877865'; + $timeZone = 'timeZone36848094'; + $currencyCode = 'currencyCode1108728155'; + $effectiveRootAdUnit = 'effectiveRootAdUnit98840923'; + $testNetwork = false; + $networkId = 478232372; + $expectedResponse = new Network(); + $expectedResponse->setName($name2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setNetworkCode($networkCode); + $expectedResponse->setPropertyCode($propertyCode); + $expectedResponse->setTimeZone($timeZone); + $expectedResponse->setCurrencyCode($currencyCode); + $expectedResponse->setEffectiveRootAdUnit($effectiveRootAdUnit); + $expectedResponse->setTestNetwork($testNetwork); + $expectedResponse->setNetworkId($networkId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new GetNetworkRequest())->setName($formattedName); + $response = $gapicClient->getNetwork($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.NetworkService/GetNetwork', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getNetworkExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new GetNetworkRequest())->setName($formattedName); + try { + $gapicClient->getNetwork($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listNetworksTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new ListNetworksResponse(); + $transport->addResponse($expectedResponse); + $request = new ListNetworksRequest(); + $response = $gapicClient->listNetworks($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.NetworkService/ListNetworks', $actualFuncCall); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listNetworksExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + $request = new ListNetworksRequest(); + try { + $gapicClient->listNetworks($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getNetworkAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $displayName = 'displayName1615086568'; + $networkCode = 'networkCode-19973794'; + $propertyCode = 'propertyCode-1019877865'; + $timeZone = 'timeZone36848094'; + $currencyCode = 'currencyCode1108728155'; + $effectiveRootAdUnit = 'effectiveRootAdUnit98840923'; + $testNetwork = false; + $networkId = 478232372; + $expectedResponse = new Network(); + $expectedResponse->setName($name2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setNetworkCode($networkCode); + $expectedResponse->setPropertyCode($propertyCode); + $expectedResponse->setTimeZone($timeZone); + $expectedResponse->setCurrencyCode($currencyCode); + $expectedResponse->setEffectiveRootAdUnit($effectiveRootAdUnit); + $expectedResponse->setTestNetwork($testNetwork); + $expectedResponse->setNetworkId($networkId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new GetNetworkRequest())->setName($formattedName); + $response = $gapicClient->getNetworkAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.NetworkService/GetNetwork', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/OrderServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/OrderServiceClientTest.php new file mode 100644 index 000000000000..e79b907632a0 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/OrderServiceClientTest.php @@ -0,0 +1,292 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return OrderServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new OrderServiceClient($options); + } + + /** @test */ + public function getOrderTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $orderId = 1234304940; + $displayName = 'displayName1615086568'; + $programmatic = true; + $trafficker = 'trafficker-606937285'; + $advertiser = 'advertiser72080683'; + $agency = 'agency-1419699195'; + $creator = 'creator1028554796'; + $currencyCode = 'currencyCode1108728155'; + $unlimitedEndTime = false; + $externalOrderId = 1332092512; + $archived = true; + $lastModifiedByApp = 'lastModifiedByApp-1580292922'; + $notes = 'notes105008833'; + $poNumber = 'poNumber1281088905'; + $salesperson = 'salesperson-2087326879'; + $expectedResponse = new Order(); + $expectedResponse->setName($name2); + $expectedResponse->setOrderId($orderId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setProgrammatic($programmatic); + $expectedResponse->setTrafficker($trafficker); + $expectedResponse->setAdvertiser($advertiser); + $expectedResponse->setAgency($agency); + $expectedResponse->setCreator($creator); + $expectedResponse->setCurrencyCode($currencyCode); + $expectedResponse->setUnlimitedEndTime($unlimitedEndTime); + $expectedResponse->setExternalOrderId($externalOrderId); + $expectedResponse->setArchived($archived); + $expectedResponse->setLastModifiedByApp($lastModifiedByApp); + $expectedResponse->setNotes($notes); + $expectedResponse->setPoNumber($poNumber); + $expectedResponse->setSalesperson($salesperson); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->orderName('[NETWORK_CODE]', '[ORDER]'); + $request = (new GetOrderRequest())->setName($formattedName); + $response = $gapicClient->getOrder($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.OrderService/GetOrder', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getOrderExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->orderName('[NETWORK_CODE]', '[ORDER]'); + $request = (new GetOrderRequest())->setName($formattedName); + try { + $gapicClient->getOrder($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listOrdersTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $ordersElement = new Order(); + $orders = [$ordersElement]; + $expectedResponse = new ListOrdersResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setOrders($orders); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListOrdersRequest())->setParent($formattedParent); + $response = $gapicClient->listOrders($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getOrders()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.OrderService/ListOrders', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listOrdersExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListOrdersRequest())->setParent($formattedParent); + try { + $gapicClient->listOrders($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getOrderAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $orderId = 1234304940; + $displayName = 'displayName1615086568'; + $programmatic = true; + $trafficker = 'trafficker-606937285'; + $advertiser = 'advertiser72080683'; + $agency = 'agency-1419699195'; + $creator = 'creator1028554796'; + $currencyCode = 'currencyCode1108728155'; + $unlimitedEndTime = false; + $externalOrderId = 1332092512; + $archived = true; + $lastModifiedByApp = 'lastModifiedByApp-1580292922'; + $notes = 'notes105008833'; + $poNumber = 'poNumber1281088905'; + $salesperson = 'salesperson-2087326879'; + $expectedResponse = new Order(); + $expectedResponse->setName($name2); + $expectedResponse->setOrderId($orderId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setProgrammatic($programmatic); + $expectedResponse->setTrafficker($trafficker); + $expectedResponse->setAdvertiser($advertiser); + $expectedResponse->setAgency($agency); + $expectedResponse->setCreator($creator); + $expectedResponse->setCurrencyCode($currencyCode); + $expectedResponse->setUnlimitedEndTime($unlimitedEndTime); + $expectedResponse->setExternalOrderId($externalOrderId); + $expectedResponse->setArchived($archived); + $expectedResponse->setLastModifiedByApp($lastModifiedByApp); + $expectedResponse->setNotes($notes); + $expectedResponse->setPoNumber($poNumber); + $expectedResponse->setSalesperson($salesperson); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->orderName('[NETWORK_CODE]', '[ORDER]'); + $request = (new GetOrderRequest())->setName($formattedName); + $response = $gapicClient->getOrderAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.OrderService/GetOrder', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/PlacementServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/PlacementServiceClientTest.php new file mode 100644 index 000000000000..71dbca739c66 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/PlacementServiceClientTest.php @@ -0,0 +1,248 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return PlacementServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new PlacementServiceClient($options); + } + + /** @test */ + public function getPlacementTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $placementId = 1224358069; + $displayName = 'displayName1615086568'; + $description = 'description-1724546052'; + $placementCode = 'placementCode-213099769'; + $expectedResponse = new Placement(); + $expectedResponse->setName($name2); + $expectedResponse->setPlacementId($placementId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDescription($description); + $expectedResponse->setPlacementCode($placementCode); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->placementName('[NETWORK_CODE]', '[PLACEMENT]'); + $request = (new GetPlacementRequest())->setName($formattedName); + $response = $gapicClient->getPlacement($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.PlacementService/GetPlacement', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getPlacementExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->placementName('[NETWORK_CODE]', '[PLACEMENT]'); + $request = (new GetPlacementRequest())->setName($formattedName); + try { + $gapicClient->getPlacement($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listPlacementsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $placementsElement = new Placement(); + $placements = [$placementsElement]; + $expectedResponse = new ListPlacementsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setPlacements($placements); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListPlacementsRequest())->setParent($formattedParent); + $response = $gapicClient->listPlacements($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getPlacements()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.PlacementService/ListPlacements', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listPlacementsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListPlacementsRequest())->setParent($formattedParent); + try { + $gapicClient->listPlacements($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getPlacementAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $placementId = 1224358069; + $displayName = 'displayName1615086568'; + $description = 'description-1724546052'; + $placementCode = 'placementCode-213099769'; + $expectedResponse = new Placement(); + $expectedResponse->setName($name2); + $expectedResponse->setPlacementId($placementId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDescription($description); + $expectedResponse->setPlacementCode($placementCode); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->placementName('[NETWORK_CODE]', '[PLACEMENT]'); + $request = (new GetPlacementRequest())->setName($formattedName); + $response = $gapicClient->getPlacementAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.PlacementService/GetPlacement', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/ReportServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/ReportServiceClientTest.php new file mode 100644 index 000000000000..f9078d83360d --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/ReportServiceClientTest.php @@ -0,0 +1,646 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return ReportServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new ReportServiceClient($options); + } + + /** @test */ + public function createReportTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $reportId = 353329146; + $displayName = 'displayName1615086568'; + $locale = 'locale-1097462182'; + $expectedResponse = new Report(); + $expectedResponse->setName($name); + $expectedResponse->setReportId($reportId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setLocale($locale); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $report = new Report(); + $reportReportDefinition = new ReportDefinition(); + $reportDefinitionDimensions = []; + $reportReportDefinition->setDimensions($reportDefinitionDimensions); + $reportDefinitionMetrics = []; + $reportReportDefinition->setMetrics($reportDefinitionMetrics); + $reportDefinitionDateRange = new DateRange(); + $reportReportDefinition->setDateRange($reportDefinitionDateRange); + $reportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED; + $reportReportDefinition->setReportType($reportDefinitionReportType); + $report->setReportDefinition($reportReportDefinition); + $request = (new CreateReportRequest())->setParent($formattedParent)->setReport($report); + $response = $gapicClient->createReport($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.ReportService/CreateReport', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualRequestObject->getReport(); + $this->assertProtobufEquals($report, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function createReportExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $report = new Report(); + $reportReportDefinition = new ReportDefinition(); + $reportDefinitionDimensions = []; + $reportReportDefinition->setDimensions($reportDefinitionDimensions); + $reportDefinitionMetrics = []; + $reportReportDefinition->setMetrics($reportDefinitionMetrics); + $reportDefinitionDateRange = new DateRange(); + $reportReportDefinition->setDateRange($reportDefinitionDateRange); + $reportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED; + $reportReportDefinition->setReportType($reportDefinitionReportType); + $report->setReportDefinition($reportReportDefinition); + $request = (new CreateReportRequest())->setParent($formattedParent)->setReport($report); + try { + $gapicClient->createReport($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function fetchReportResultRowsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $totalRowCount = 1810281263; + $nextPageToken = 'nextPageToken-1530815211'; + $expectedResponse = new FetchReportResultRowsResponse(); + $expectedResponse->setTotalRowCount($totalRowCount); + $expectedResponse->setNextPageToken($nextPageToken); + $transport->addResponse($expectedResponse); + $request = new FetchReportResultRowsRequest(); + $response = $gapicClient->fetchReportResultRows($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.ReportService/FetchReportResultRows', $actualFuncCall); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function fetchReportResultRowsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + $request = new FetchReportResultRowsRequest(); + try { + $gapicClient->fetchReportResultRows($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getReportTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $reportId = 353329146; + $displayName = 'displayName1615086568'; + $locale = 'locale-1097462182'; + $expectedResponse = new Report(); + $expectedResponse->setName($name2); + $expectedResponse->setReportId($reportId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setLocale($locale); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->reportName('[NETWORK_CODE]', '[REPORT]'); + $request = (new GetReportRequest())->setName($formattedName); + $response = $gapicClient->getReport($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.ReportService/GetReport', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getReportExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->reportName('[NETWORK_CODE]', '[REPORT]'); + $request = (new GetReportRequest())->setName($formattedName); + try { + $gapicClient->getReport($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listReportsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $reportsElement = new Report(); + $reports = [$reportsElement]; + $expectedResponse = new ListReportsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setReports($reports); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListReportsRequest())->setParent($formattedParent); + $response = $gapicClient->listReports($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getReports()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.ReportService/ListReports', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listReportsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListReportsRequest())->setParent($formattedParent); + try { + $gapicClient->listReports($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function runReportTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/runReportTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $reportResult = 'reportResult-778769016'; + $expectedResponse = new RunReportResponse(); + $expectedResponse->setReportResult($reportResult); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/runReportTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->reportName('[NETWORK_CODE]', '[REPORT]'); + $request = (new RunReportRequest())->setName($formattedName); + $response = $gapicClient->runReport($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.ReportService/RunReport', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/runReportTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function runReportExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/runReportTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->reportName('[NETWORK_CODE]', '[REPORT]'); + $request = (new RunReportRequest())->setName($formattedName); + $response = $gapicClient->runReport($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/runReportTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function updateReportTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $reportId = 353329146; + $displayName = 'displayName1615086568'; + $locale = 'locale-1097462182'; + $expectedResponse = new Report(); + $expectedResponse->setName($name); + $expectedResponse->setReportId($reportId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setLocale($locale); + $transport->addResponse($expectedResponse); + // Mock request + $report = new Report(); + $reportReportDefinition = new ReportDefinition(); + $reportDefinitionDimensions = []; + $reportReportDefinition->setDimensions($reportDefinitionDimensions); + $reportDefinitionMetrics = []; + $reportReportDefinition->setMetrics($reportDefinitionMetrics); + $reportDefinitionDateRange = new DateRange(); + $reportReportDefinition->setDateRange($reportDefinitionDateRange); + $reportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED; + $reportReportDefinition->setReportType($reportDefinitionReportType); + $report->setReportDefinition($reportReportDefinition); + $updateMask = new FieldMask(); + $request = (new UpdateReportRequest())->setReport($report)->setUpdateMask($updateMask); + $response = $gapicClient->updateReport($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.ReportService/UpdateReport', $actualFuncCall); + $actualValue = $actualRequestObject->getReport(); + $this->assertProtobufEquals($report, $actualValue); + $actualValue = $actualRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateReportExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $report = new Report(); + $reportReportDefinition = new ReportDefinition(); + $reportDefinitionDimensions = []; + $reportReportDefinition->setDimensions($reportDefinitionDimensions); + $reportDefinitionMetrics = []; + $reportReportDefinition->setMetrics($reportDefinitionMetrics); + $reportDefinitionDateRange = new DateRange(); + $reportReportDefinition->setDateRange($reportDefinitionDateRange); + $reportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED; + $reportReportDefinition->setReportType($reportDefinitionReportType); + $report->setReportDefinition($reportReportDefinition); + $updateMask = new FieldMask(); + $request = (new UpdateReportRequest())->setReport($report)->setUpdateMask($updateMask); + try { + $gapicClient->updateReport($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function createReportAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $reportId = 353329146; + $displayName = 'displayName1615086568'; + $locale = 'locale-1097462182'; + $expectedResponse = new Report(); + $expectedResponse->setName($name); + $expectedResponse->setReportId($reportId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setLocale($locale); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $report = new Report(); + $reportReportDefinition = new ReportDefinition(); + $reportDefinitionDimensions = []; + $reportReportDefinition->setDimensions($reportDefinitionDimensions); + $reportDefinitionMetrics = []; + $reportReportDefinition->setMetrics($reportDefinitionMetrics); + $reportDefinitionDateRange = new DateRange(); + $reportReportDefinition->setDateRange($reportDefinitionDateRange); + $reportDefinitionReportType = ReportType::REPORT_TYPE_UNSPECIFIED; + $reportReportDefinition->setReportType($reportDefinitionReportType); + $report->setReportDefinition($reportReportDefinition); + $request = (new CreateReportRequest())->setParent($formattedParent)->setReport($report); + $response = $gapicClient->createReportAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.ReportService/CreateReport', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualRequestObject->getReport(); + $this->assertProtobufEquals($report, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/RoleServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/RoleServiceClientTest.php new file mode 100644 index 000000000000..d29d5ff785d0 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/RoleServiceClientTest.php @@ -0,0 +1,248 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return RoleServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new RoleServiceClient($options); + } + + /** @test */ + public function getRoleTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $roleId = 1376884100; + $displayName = 'displayName1615086568'; + $description = 'description-1724546052'; + $builtIn = true; + $expectedResponse = new Role(); + $expectedResponse->setName($name2); + $expectedResponse->setRoleId($roleId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDescription($description); + $expectedResponse->setBuiltIn($builtIn); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->roleName('[NETWORK_CODE]', '[ROLE]'); + $request = (new GetRoleRequest())->setName($formattedName); + $response = $gapicClient->getRole($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.RoleService/GetRole', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getRoleExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->roleName('[NETWORK_CODE]', '[ROLE]'); + $request = (new GetRoleRequest())->setName($formattedName); + try { + $gapicClient->getRole($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listRolesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $rolesElement = new Role(); + $roles = [$rolesElement]; + $expectedResponse = new ListRolesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setRoles($roles); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListRolesRequest())->setParent($formattedParent); + $response = $gapicClient->listRoles($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getRoles()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.RoleService/ListRoles', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listRolesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListRolesRequest())->setParent($formattedParent); + try { + $gapicClient->listRoles($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getRoleAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $roleId = 1376884100; + $displayName = 'displayName1615086568'; + $description = 'description-1724546052'; + $builtIn = true; + $expectedResponse = new Role(); + $expectedResponse->setName($name2); + $expectedResponse->setRoleId($roleId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDescription($description); + $expectedResponse->setBuiltIn($builtIn); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->roleName('[NETWORK_CODE]', '[ROLE]'); + $request = (new GetRoleRequest())->setName($formattedName); + $response = $gapicClient->getRoleAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.RoleService/GetRole', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/TaxonomyCategoryServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/TaxonomyCategoryServiceClientTest.php new file mode 100644 index 000000000000..2ca5022cd603 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/TaxonomyCategoryServiceClientTest.php @@ -0,0 +1,248 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return TaxonomyCategoryServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new TaxonomyCategoryServiceClient($options); + } + + /** @test */ + public function getTaxonomyCategoryTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $taxonomyCategoryId = 28298254; + $displayName = 'displayName1615086568'; + $groupingOnly = true; + $parentTaxonomyCategoryId = 1790260093; + $expectedResponse = new TaxonomyCategory(); + $expectedResponse->setName($name2); + $expectedResponse->setTaxonomyCategoryId($taxonomyCategoryId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setGroupingOnly($groupingOnly); + $expectedResponse->setParentTaxonomyCategoryId($parentTaxonomyCategoryId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->taxonomyCategoryName('[NETWORK_CODE]', '[TAXONOMY_CATEGORY]'); + $request = (new GetTaxonomyCategoryRequest())->setName($formattedName); + $response = $gapicClient->getTaxonomyCategory($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.TaxonomyCategoryService/GetTaxonomyCategory', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getTaxonomyCategoryExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->taxonomyCategoryName('[NETWORK_CODE]', '[TAXONOMY_CATEGORY]'); + $request = (new GetTaxonomyCategoryRequest())->setName($formattedName); + try { + $gapicClient->getTaxonomyCategory($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listTaxonomyCategoriesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $totalSize = 705419236; + $taxonomyCategoriesElement = new TaxonomyCategory(); + $taxonomyCategories = [$taxonomyCategoriesElement]; + $expectedResponse = new ListTaxonomyCategoriesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setTaxonomyCategories($taxonomyCategories); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListTaxonomyCategoriesRequest())->setParent($formattedParent); + $response = $gapicClient->listTaxonomyCategories($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getTaxonomyCategories()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.TaxonomyCategoryService/ListTaxonomyCategories', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listTaxonomyCategoriesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->networkName('[NETWORK_CODE]'); + $request = (new ListTaxonomyCategoriesRequest())->setParent($formattedParent); + try { + $gapicClient->listTaxonomyCategories($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getTaxonomyCategoryAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $taxonomyCategoryId = 28298254; + $displayName = 'displayName1615086568'; + $groupingOnly = true; + $parentTaxonomyCategoryId = 1790260093; + $expectedResponse = new TaxonomyCategory(); + $expectedResponse->setName($name2); + $expectedResponse->setTaxonomyCategoryId($taxonomyCategoryId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setGroupingOnly($groupingOnly); + $expectedResponse->setParentTaxonomyCategoryId($parentTaxonomyCategoryId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->taxonomyCategoryName('[NETWORK_CODE]', '[TAXONOMY_CATEGORY]'); + $request = (new GetTaxonomyCategoryRequest())->setName($formattedName); + $response = $gapicClient->getTaxonomyCategoryAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.TaxonomyCategoryService/GetTaxonomyCategory', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/AdsAdManager/tests/Unit/V1/Client/UserServiceClientTest.php b/AdsAdManager/tests/Unit/V1/Client/UserServiceClientTest.php new file mode 100644 index 000000000000..2410a72d21a7 --- /dev/null +++ b/AdsAdManager/tests/Unit/V1/Client/UserServiceClientTest.php @@ -0,0 +1,189 @@ +getMockBuilder(CredentialsWrapper::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** @return UserServiceClient */ + private function createClient(array $options = []) + { + $options += [ + 'credentials' => $this->createCredentials(), + ]; + return new UserServiceClient($options); + } + + /** @test */ + public function getUserTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $userId = 147132913; + $displayName = 'displayName1615086568'; + $email = 'email96619420'; + $role = 'role3506294'; + $active = true; + $externalId = 'externalId-1153075697'; + $serviceAccount = false; + $ordersUiLocalTimeZone = 'ordersUiLocalTimeZone-1376832007'; + $expectedResponse = new User(); + $expectedResponse->setName($name2); + $expectedResponse->setUserId($userId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setEmail($email); + $expectedResponse->setRole($role); + $expectedResponse->setActive($active); + $expectedResponse->setExternalId($externalId); + $expectedResponse->setServiceAccount($serviceAccount); + $expectedResponse->setOrdersUiLocalTimeZone($ordersUiLocalTimeZone); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->userName('[NETWORK_CODE]', '[USER]'); + $request = (new GetUserRequest())->setName($formattedName); + $response = $gapicClient->getUser($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.UserService/GetUser', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getUserExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->userName('[NETWORK_CODE]', '[USER]'); + $request = (new GetUserRequest())->setName($formattedName); + try { + $gapicClient->getUser($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getUserAsyncTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $userId = 147132913; + $displayName = 'displayName1615086568'; + $email = 'email96619420'; + $role = 'role3506294'; + $active = true; + $externalId = 'externalId-1153075697'; + $serviceAccount = false; + $ordersUiLocalTimeZone = 'ordersUiLocalTimeZone-1376832007'; + $expectedResponse = new User(); + $expectedResponse->setName($name2); + $expectedResponse->setUserId($userId); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setEmail($email); + $expectedResponse->setRole($role); + $expectedResponse->setActive($active); + $expectedResponse->setExternalId($externalId); + $expectedResponse->setServiceAccount($serviceAccount); + $expectedResponse->setOrdersUiLocalTimeZone($ordersUiLocalTimeZone); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->userName('[NETWORK_CODE]', '[USER]'); + $request = (new GetUserRequest())->setName($formattedName); + $response = $gapicClient->getUserAsync($request)->wait(); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.ads.admanager.v1.UserService/GetUser', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } +} diff --git a/composer.json b/composer.json index 86d464ebec10..53681abbd817 100644 --- a/composer.json +++ b/composer.json @@ -261,7 +261,8 @@ "google/shopping-merchant-products": "0.1.0", "google/shopping-merchant-promotions": "0.1.0", "google/shopping-merchant-quota": "0.1.3", - "google/shopping-merchant-reports": "0.8.1" + "google/shopping-merchant-reports": "0.8.1", + "googleads/ad-manager": "0.0.0" }, "suggest": { "opis/closure": "May be used to serialize closures to process jobs in the batch daemon. Please require version ^3.", @@ -269,6 +270,7 @@ }, "autoload": { "psr-4": { + "GPBMetadata\\Google\\Ads\\Admanager\\": "AdsAdManager/metadata", "GPBMetadata\\Google\\Analytics\\Admin\\": "AnalyticsAdmin/metadata", "GPBMetadata\\Google\\Analytics\\Data\\": "AnalyticsData/metadata", "GPBMetadata\\Google\\Api\\": "CommonProtos/metadata/Api", @@ -482,6 +484,7 @@ "GPBMetadata\\Google\\Storagetransfer\\": "StorageTransfer/metadata", "GPBMetadata\\Google\\Type\\": "CommonProtos/metadata/Type", "GPBMetadata\\Grafeas\\": "Grafeas/metadata", + "Google\\Ads\\AdManager\\": "AdsAdManager/src", "Google\\Ads\\MarketingPlatform\\Admin\\": "AdsMarketingPlatformAdmin/src", "Google\\Analytics\\Admin\\": "AnalyticsAdmin/src", "Google\\Analytics\\Data\\": "AnalyticsData/src", From 9abf2ba3917cdc6d933a68670b8a9762a4f3eb4d Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Mon, 28 Oct 2024 17:54:42 -0400 Subject: [PATCH 045/157] chore(main): release 0.265.0 (#7756) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- AdsAdManager/VERSION | 2 +- AiPlatform/VERSION | 2 +- AlloyDb/VERSION | 2 +- CHANGELOG.md | 118 ++++++++++++++++++++++++++++++++++ DocumentAi/VERSION | 2 +- Parallelstore/VERSION | 2 +- SecureSourceManager/VERSION | 2 +- ShoppingCss/VERSION | 2 +- Spanner/VERSION | 2 +- Spanner/src/SpannerClient.php | 2 +- TextToSpeech/VERSION | 2 +- composer.json | 18 +++--- 12 files changed, 137 insertions(+), 19 deletions(-) diff --git a/AdsAdManager/VERSION b/AdsAdManager/VERSION index 77d6f4ca2371..6e8bf73aa550 100644 --- a/AdsAdManager/VERSION +++ b/AdsAdManager/VERSION @@ -1 +1 @@ -0.0.0 +0.1.0 diff --git a/AiPlatform/VERSION b/AiPlatform/VERSION index 27f9cd322bb9..f8e233b27332 100644 --- a/AiPlatform/VERSION +++ b/AiPlatform/VERSION @@ -1 +1 @@ -1.8.0 +1.9.0 diff --git a/AlloyDb/VERSION b/AlloyDb/VERSION index 3eefcb9dd5b3..9084fa2f716a 100644 --- a/AlloyDb/VERSION +++ b/AlloyDb/VERSION @@ -1 +1 @@ -1.0.0 +1.1.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index d2abfc83f13d..d5a24c3cf7e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,123 @@ # Changelog +## 0.265.0 + +

googleads/ad-manager 0.1.0 + + + +### Features + +* Introduce AdManager component ([#7767](https://github.com/googleapis/google-cloud-php/issues/7767)) ([9b4de94](https://github.com/googleapis/google-cloud-php/commit/9b4de9431c6774156ac0a58271fd0355f7d3004f)) + +
+ +
google/cloud-ai-platform 1.9.0 + + + +### Features + +* Add `text` field for Grounding metadata support chunk output ([#7758](https://github.com/googleapis/google-cloud-php/issues/7758)) ([385c1e7](https://github.com/googleapis/google-cloud-php/commit/385c1e763613e3c5683757447a36f133c9787530)) + +
+ +
google/cloud-alloydb 1.1.0 + + + +### Features + +* Add more observability options on the Instance level ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Add new API to execute SQL statements ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Add new API to list the databases in a project and location ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Add new API to perform a promotion or switchover on secondary instances ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Add new PSC instance configuration setting and output the PSC DNS name ([#7760](https://github.com/googleapis/google-cloud-php/issues/7760)) ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Add optional field to keep extra roles on a user if it already exists ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Add support for Free Trials ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Add support to schedule maintenance ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Additional field to set tags on a backup or cluster ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) +* Support for obtaining the public ip addresses of an instance and enabling either inbound or outbound public ip ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) + + +### Documentation + +* Various typo fixes, correcting the formatting, and clarifications on the request_id and validate_only fields in API requests and on the page_size when listing the database ([22357f5](https://github.com/googleapis/google-cloud-php/commit/22357f5392c482243dd47d17383d0af6367d3911)) + +
+ +
google/cloud-document-ai 2.1.0 + + + +### Features + +* Add RESOURCE_EXHAUSTED to retryable status codes for ProcessDocument method ([4d427bf](https://github.com/googleapis/google-cloud-php/commit/4d427bf3f9b23c2d790e0d23ad0b9e842ceed691)) +* Added an url for issue reporting and api short name ([4d427bf](https://github.com/googleapis/google-cloud-php/commit/4d427bf3f9b23c2d790e0d23ad0b9e842ceed691)) +* Updated the exponential backoff settings for the Document AI ProcessDocument and BatchProcessDocuments methods ([#7757](https://github.com/googleapis/google-cloud-php/issues/7757)) ([4d427bf](https://github.com/googleapis/google-cloud-php/commit/4d427bf3f9b23c2d790e0d23ad0b9e842ceed691)) + +
+ +
google/cloud-parallelstore 0.7.0 + + + +### Features + +* Add Parallelstore V1 ([#7764](https://github.com/googleapis/google-cloud-php/issues/7764)) ([c8289d5](https://github.com/googleapis/google-cloud-php/commit/c8289d51320fc3367fa1ab837c777288352f4bf3)) + +
+ +
google/cloud-securesourcemanager 1.3.0 + + + +### Features + +* Add branch rule APIs ([#7754](https://github.com/googleapis/google-cloud-php/issues/7754)) ([be3a11c](https://github.com/googleapis/google-cloud-php/commit/be3a11c9f4b18c20264399206e6aa2c7716adb6a)) +* Add field `psc_allowed_projects` to message `.google.cloud.securesourcemanager.v1.Instance` ([be3a11c](https://github.com/googleapis/google-cloud-php/commit/be3a11c9f4b18c20264399206e6aa2c7716adb6a)) + + +### Documentation + +* A comment for field `instance` in message `.google.cloud.securesourcemanager.v1.Repository` is changed ([be3a11c](https://github.com/googleapis/google-cloud-php/commit/be3a11c9f4b18c20264399206e6aa2c7716adb6a)) + +
+ +
google/shopping-css 0.3.0 + + + +### Features + +* A new enum `SubscriptionPeriod` is added ([8afaa8c](https://github.com/googleapis/google-cloud-php/commit/8afaa8c19587006d276ded057c684b9a59836c66)) +* A new field `headline_offer_installment` is added to message `.google.shopping.css.v1.Attributes` ([#7761](https://github.com/googleapis/google-cloud-php/issues/7761)) ([8afaa8c](https://github.com/googleapis/google-cloud-php/commit/8afaa8c19587006d276ded057c684b9a59836c66)) +* A new field `headline_offer_subscription_cost` is added to message `.google.shopping.css.v1.Attributes` ([8afaa8c](https://github.com/googleapis/google-cloud-php/commit/8afaa8c19587006d276ded057c684b9a59836c66)) +* A new message `HeadlineOfferInstallment` is added ([8afaa8c](https://github.com/googleapis/google-cloud-php/commit/8afaa8c19587006d276ded057c684b9a59836c66)) +* A new message `HeadlineOfferSubscriptionCost` is added ([8afaa8c](https://github.com/googleapis/google-cloud-php/commit/8afaa8c19587006d276ded057c684b9a59836c66)) + +
+ +
google/cloud-spanner 1.88.0 + + + +### Features + +* **spanner:** Add support for Cloud Spanner Default Backup Schedules ([#7762](https://github.com/googleapis/google-cloud-php/issues/7762)) ([c134d3d](https://github.com/googleapis/google-cloud-php/commit/c134d3debb4e4afa724c2e769c4adaff113a3477)) + +
+ +
google/cloud-text-to-speech 1.11.0 + + + +### Features + +* Add brand voice lite, which lets you clone a voice with just 10 seconds of audio ([#7759](https://github.com/googleapis/google-cloud-php/issues/7759)) ([3b5afb3](https://github.com/googleapis/google-cloud-php/commit/3b5afb394afe814d2fa2de028e214b528c80a234)) + +
+ ## 0.264.0
google/analytics-data 0.20.0 diff --git a/DocumentAi/VERSION b/DocumentAi/VERSION index 227cea215648..7ec1d6db4087 100644 --- a/DocumentAi/VERSION +++ b/DocumentAi/VERSION @@ -1 +1 @@ -2.0.0 +2.1.0 diff --git a/Parallelstore/VERSION b/Parallelstore/VERSION index ee6cdce3c290..faef31a4357c 100644 --- a/Parallelstore/VERSION +++ b/Parallelstore/VERSION @@ -1 +1 @@ -0.6.1 +0.7.0 diff --git a/SecureSourceManager/VERSION b/SecureSourceManager/VERSION index 26aaba0e8663..f0bb29e76388 100644 --- a/SecureSourceManager/VERSION +++ b/SecureSourceManager/VERSION @@ -1 +1 @@ -1.2.0 +1.3.0 diff --git a/ShoppingCss/VERSION b/ShoppingCss/VERSION index 1866a362b7be..0d91a54c7d43 100644 --- a/ShoppingCss/VERSION +++ b/ShoppingCss/VERSION @@ -1 +1 @@ -0.2.9 +0.3.0 diff --git a/Spanner/VERSION b/Spanner/VERSION index f6342716723f..59be592144c2 100644 --- a/Spanner/VERSION +++ b/Spanner/VERSION @@ -1 +1 @@ -1.87.0 +1.88.0 diff --git a/Spanner/src/SpannerClient.php b/Spanner/src/SpannerClient.php index 7c379c418cfa..a4ef1ddafe28 100644 --- a/Spanner/src/SpannerClient.php +++ b/Spanner/src/SpannerClient.php @@ -120,7 +120,7 @@ class SpannerClient use LROTrait; use ValidateTrait; - const VERSION = '1.87.0'; + const VERSION = '1.88.0'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/spanner.data'; const ADMIN_SCOPE = 'https://www.googleapis.com/auth/spanner.admin'; diff --git a/TextToSpeech/VERSION b/TextToSpeech/VERSION index 81c871de46b3..1cac385c6cb8 100644 --- a/TextToSpeech/VERSION +++ b/TextToSpeech/VERSION @@ -1 +1 @@ -1.10.0 +1.11.0 diff --git a/composer.json b/composer.json index 53681abbd817..5f1433d8b8a9 100644 --- a/composer.json +++ b/composer.json @@ -76,8 +76,8 @@ "google/apps-meet": "0.2.3", "google/cloud-access-approval": "2.0.1", "google/cloud-advisorynotifications": "1.0.0", - "google/cloud-ai-platform": "1.8.0", - "google/cloud-alloydb": "1.0.0", + "google/cloud-ai-platform": "1.9.0", + "google/cloud-alloydb": "1.1.0", "google/cloud-api-gateway": "2.0.0", "google/cloud-api-keys": "1.0.0", "google/cloud-apigee-connect": "2.0.1", @@ -143,7 +143,7 @@ "google/cloud-discoveryengine": "1.2.0", "google/cloud-dlp": "2.2.0", "google/cloud-dms": "2.0.1", - "google/cloud-document-ai": "2.0.0", + "google/cloud-document-ai": "2.1.0", "google/cloud-domains": "1.0.0", "google/cloud-edgenetwork": "1.1.1", "google/cloud-error-reporting": "0.22.7", @@ -185,7 +185,7 @@ "google/cloud-org-policy": "1.1.0", "google/cloud-osconfig": "2.0.0", "google/cloud-oslogin": "2.0.1", - "google/cloud-parallelstore": "0.6.1", + "google/cloud-parallelstore": "0.7.0", "google/cloud-policy-troubleshooter": "2.0.1", "google/cloud-policysimulator": "1.0.0", "google/cloud-policytroubleshooter-iam": "0.2.6", @@ -206,7 +206,7 @@ "google/cloud-run": "1.2.0", "google/cloud-scheduler": "2.0.0", "google/cloud-secret-manager": "1.15.2", - "google/cloud-securesourcemanager": "1.2.0", + "google/cloud-securesourcemanager": "1.3.0", "google/cloud-security-center": "2.0.1", "google/cloud-security-private-ca": "2.0.0", "google/cloud-security-public-ca": "1.0.0", @@ -217,7 +217,7 @@ "google/cloud-service-usage": "2.0.0", "google/cloud-servicehealth": "0.1.6", "google/cloud-shell": "2.0.1", - "google/cloud-spanner": "1.87.0", + "google/cloud-spanner": "1.88.0", "google/cloud-speech": "1.19.0", "google/cloud-sql-admin": "1.2.0", "google/cloud-storage": "1.43.1", @@ -228,7 +228,7 @@ "google/cloud-talent": "2.0.0", "google/cloud-tasks": "1.15.0", "google/cloud-telcoautomation": "1.0.0", - "google/cloud-text-to-speech": "1.10.0", + "google/cloud-text-to-speech": "1.11.0", "google/cloud-tpu": "1.4.5", "google/cloud-trace": "1.8.6", "google/cloud-translate": "1.19.0", @@ -251,7 +251,7 @@ "google/maps-fleetengine-delivery": "0.1.5", "google/maps-routeoptimization": "0.3.0", "google/shopping-common-protos": "0.4.0", - "google/shopping-css": "0.2.9", + "google/shopping-css": "0.3.0", "google/shopping-merchant-accounts": "0.3.0", "google/shopping-merchant-conversions": "0.1.2", "google/shopping-merchant-datasources": "0.2.1", @@ -262,7 +262,7 @@ "google/shopping-merchant-promotions": "0.1.0", "google/shopping-merchant-quota": "0.1.3", "google/shopping-merchant-reports": "0.8.1", - "googleads/ad-manager": "0.0.0" + "googleads/ad-manager": "0.1.0" }, "suggest": { "opis/closure": "May be used to serialize closures to process jobs in the batch daemon. Please require version ^3.", From ebac0c878cf9207ea64b8747e5234e629d3ff4c1 Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Mon, 28 Oct 2024 16:49:50 -0700 Subject: [PATCH 046/157] fix(dev): allow for packagist components in googleads/ as well (#7771) --- dev/src/Component.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev/src/Component.php b/dev/src/Component.php index c8d8afb8c801..bc9e7514a8ee 100644 --- a/dev/src/Component.php +++ b/dev/src/Component.php @@ -68,7 +68,7 @@ public static function getComponents(array $componentNames = []): array public function getId(): string { - return str_replace('google/', '', $this->getPackageName()); + return str_replace(['google/', 'googleads/'], '', $this->getPackageName()); } public function getName(): string From 3c82c64143c00027bd172a32670cbb9f75202823 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Mendoza?= Date: Wed, 30 Oct 2024 14:56:07 -0400 Subject: [PATCH 047/157] feat: support external links for Guzzle Promise Interface (#7778) --- dev/src/DocFx/Node/XrefTrait.php | 38 +++++++++++++------ dev/tests/Unit/DocFx/NodeTest.php | 36 ++++++++++++++++++ .../V1.Client.SecretManagerServiceClient.yml | 30 +++++++-------- .../Vision/V1.Client.ImageAnnotatorClient.yml | 8 ++-- .../Vision/V1.Client.ProductSearchClient.yml | 38 +++++++++---------- 5 files changed, 100 insertions(+), 50 deletions(-) diff --git a/dev/src/DocFx/Node/XrefTrait.php b/dev/src/DocFx/Node/XrefTrait.php index 30f2ddd90ffe..6b691a398b49 100644 --- a/dev/src/DocFx/Node/XrefTrait.php +++ b/dev/src/DocFx/Node/XrefTrait.php @@ -159,34 +159,48 @@ private function replaceUidWithLink(string $uid, string $name = null): string // Remove preceeding "\" from namespace $name = $name ?: ltrim($uid, '\\'); + // Case for generic types + if (preg_match('/(.*)<(.*)>/', $uid, $matches)) { + return sprintf( + '%s<%s>', + $this->replaceUidWithLink($matches[1]), + $this->replaceUidWithLink($matches[2]) + ); + } + // Check for external package namespaces switch (true) { - case 0 === strpos($uid, '\Google\ApiCore\\'): + case str_starts_with($uid, '\Google\ApiCore\\'): $extLinkRoot = 'https://googleapis.github.io/gax-php#'; break; - case 0 === strpos($uid, '\Google\Auth\\'): + case str_starts_with($uid, '\Google\Auth\\'): $extLinkRoot = 'https://googleapis.github.io/google-auth-library-php/main/'; break; - case 0 === strpos($uid, '\Google\Protobuf\\'): + case str_starts_with($uid, '\Google\Protobuf\\'): $extLinkRoot = 'https://protobuf.dev/reference/php/api-docs/'; break; - case 0 === strpos($uid, '\Google\Api\\'): - case 0 === strpos($uid, '\Google\Cloud\Iam\V1\\'): - case 0 === strpos($uid, '\Google\Cloud\Location\\'): - case 0 === strpos($uid, '\Google\Cloud\Logging\Type\\'): - case 0 === strpos($uid, '\Google\Iam\\'): - case 0 === strpos($uid, '\Google\Rpc\\'): - case 0 === strpos($uid, '\Google\Type\\'): + case str_starts_with($uid, '\Google\Api\\'): + case str_starts_with($uid, '\Google\Cloud\Iam\V1\\'): + case str_starts_with($uid, '\Google\Cloud\Location\\'): + case str_starts_with($uid, '\Google\Cloud\Logging\Type\\'): + case str_starts_with($uid, '\Google\Iam\\'): + case str_starts_with($uid, '\Google\Rpc\\'): + case str_starts_with($uid, '\Google\Type\\'): $extLinkRoot = 'https://googleapis.github.io/common-protos-php#'; break; + case 0 === strpos($uid, '\GuzzleHttp\Promise\PromiseInterface'): + $extLinkRoot = 'https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html'; + break; default: $extLinkRoot = ''; } // Create external link if ($extLinkRoot) { - $path = str_replace(['::', '\\', '()'], ['#method_', '/'], $name); - return sprintf('%s', $extLinkRoot . $path, $name); + if (str_starts_with($uid, '\Google')) { + $extLinkRoot .= str_replace(['::', '\\', '()'], ['#method_', '/'], $name); + } + return sprintf('%s', $extLinkRoot, $name); } return sprintf('%s', $uid, $name); diff --git a/dev/tests/Unit/DocFx/NodeTest.php b/dev/tests/Unit/DocFx/NodeTest.php index 67633fdf418a..310fe7fea7b1 100644 --- a/dev/tests/Unit/DocFx/NodeTest.php +++ b/dev/tests/Unit/DocFx/NodeTest.php @@ -138,6 +138,42 @@ public function testSeeTagsInMethodDescription() ); } + public function testReplaceGuzzleExternalLink() + { + $guzzlePromiseClassName = '\GuzzleHttp\Promise\PromiseInterface'; + $expected = 'GuzzleHttp\Promise\PromiseInterface'; + $xref = new class { + use XrefTrait; + + public function replace(string $uid) { + return $this->replaceUidWithLink($uid); + } + }; + + $result = $xref->replace($guzzlePromiseClassName); + $this->assertEquals($expected, $result); + } + + public function testReplaceGenericPromiseClass() + { + $guzzlePromiseClassName = '\GuzzleHttp\Promise\PromiseInterface'; + $googleReference = '\Google\Cloud\AdvisoryNotifications\V1\Notification'; + $uid = $guzzlePromiseClassName . '<' . $googleReference . '>'; + + $expected = 'GuzzleHttp\Promise\PromiseInterface'; + $expected .= '<Google\Cloud\AdvisoryNotifications\V1\Notification>'; + $xref = new class { + use XrefTrait; + + public function replace(string $uid) { + return $this->replaceUidWithLink($uid); + } + }; + + $result = $xref->replace($uid); + $this->assertEquals($expected, $result); + } + /** * @dataProvider provideReplaceProtoRefWithXref */ diff --git a/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml b/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml index 192e38fe3899..2d1c121e642c 100644 --- a/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml +++ b/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml @@ -604,7 +604,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::addSecretVersionAsync()' name: addSecretVersionAsync @@ -625,7 +625,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::createSecretAsync()' name: createSecretAsync @@ -646,7 +646,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::deleteSecretAsync()' name: deleteSecretAsync @@ -667,7 +667,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::destroySecretVersionAsync()' name: destroySecretVersionAsync @@ -688,7 +688,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::disableSecretVersionAsync()' name: disableSecretVersionAsync @@ -709,7 +709,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::enableSecretVersionAsync()' name: enableSecretVersionAsync @@ -730,7 +730,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getIamPolicyAsync()' name: getIamPolicyAsync @@ -751,7 +751,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretAsync()' name: getSecretAsync @@ -772,7 +772,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretVersionAsync()' name: getSecretVersionAsync @@ -793,7 +793,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretVersionsAsync()' name: listSecretVersionsAsync @@ -814,7 +814,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretsAsync()' name: listSecretsAsync @@ -835,7 +835,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::setIamPolicyAsync()' name: setIamPolicyAsync @@ -856,7 +856,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::testIamPermissionsAsync()' name: testIamPermissionsAsync @@ -877,7 +877,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::updateSecretAsync()' name: updateSecretAsync @@ -898,7 +898,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::projectName()' name: 'static::projectName' diff --git a/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml b/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml index 08aafe34a931..194ad2a2e434 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml @@ -244,7 +244,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImagesAsync()' name: asyncBatchAnnotateImagesAsync @@ -265,7 +265,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFilesAsync()' name: batchAnnotateFilesAsync @@ -286,7 +286,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImagesAsync()' name: batchAnnotateImagesAsync @@ -307,7 +307,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::getOperationsClient()' name: getOperationsClient diff --git a/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml b/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml index 60651c60739a..4c6a63cd900b 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml @@ -826,7 +826,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductAsync()' name: createProductAsync @@ -847,7 +847,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSetAsync()' name: createProductSetAsync @@ -868,7 +868,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImageAsync()' name: createReferenceImageAsync @@ -889,7 +889,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductAsync()' name: deleteProductAsync @@ -910,7 +910,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSetAsync()' name: deleteProductSetAsync @@ -931,7 +931,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImageAsync()' name: deleteReferenceImageAsync @@ -952,7 +952,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductAsync()' name: getProductAsync @@ -973,7 +973,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSetAsync()' name: getProductSetAsync @@ -994,7 +994,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImageAsync()' name: getReferenceImageAsync @@ -1015,7 +1015,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSetsAsync()' name: importProductSetsAsync @@ -1036,7 +1036,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSetsAsync()' name: listProductSetsAsync @@ -1057,7 +1057,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsAsync()' name: listProductsAsync @@ -1078,7 +1078,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSetAsync()' name: listProductsInProductSetAsync @@ -1099,7 +1099,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImagesAsync()' name: listReferenceImagesAsync @@ -1120,7 +1120,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProductsAsync()' name: purgeProductsAsync @@ -1141,7 +1141,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSetAsync()' name: removeProductFromProductSetAsync @@ -1162,7 +1162,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductAsync()' name: updateProductAsync @@ -1183,7 +1183,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSetAsync()' name: updateProductSetAsync @@ -1204,7 +1204,7 @@ items: description: '' returns: - - var_type: 'GuzzleHttp\Promise\PromiseInterface' + var_type: 'GuzzleHttp\Promise\PromiseInterface' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getOperationsClient()' name: getOperationsClient From 31098df0b6df048189c4ab1c863b2c1b755610c4 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 30 Oct 2024 17:17:14 -0400 Subject: [PATCH 048/157] feat: Add Artifact Registry attachment API (#7768) feat: Add Artifact Registry custom remote support feat: Add Artifact Registry generic repository support feat: Add Artifact Registry server side resource filtering and sorting feat: Add Artifact Registry rule APIs feat: Add Artifact Registry UpdateFile and DeleteFile APIs docs: Include max page size for all Artifact Registry APIs PiperOrigin-RevId: 689929618 Source-Link: https://github.com/googleapis/googleapis/commit/5dc10a42f836b42b091088408ab3e17172ce7359 Source-Link: https://github.com/googleapis/googleapis-gen/commit/158367d972e2447b77fa9bf1b94628f05b3cf864 Copy-Tag: eyJwIjoiQXJ0aWZhY3RSZWdpc3RyeS8uT3dsQm90LnlhbWwiLCJoIjoiMTU4MzY3ZDk3MmUyNDQ3Yjc3ZmE5YmYxYjk0NjI4ZjA1YjNjZjg2NCJ9 --- ArtifactRegistry/metadata/V1/Attachment.php | 66 + ArtifactRegistry/metadata/V1/File.php | Bin 2026 -> 2477 bytes ArtifactRegistry/metadata/V1/Generic.php | 36 + ArtifactRegistry/metadata/V1/Package.php | 22 +- ArtifactRegistry/metadata/V1/Repository.php | Bin 8060 -> 10174 bytes ArtifactRegistry/metadata/V1/Rule.php | Bin 0 -> 2338 bytes ArtifactRegistry/metadata/V1/Service.php | 38 +- ArtifactRegistry/metadata/V1/Settings.php | Bin 1819 -> 1939 bytes ArtifactRegistry/metadata/V1/Version.php | Bin 2503 -> 2901 bytes .../create_attachment.php | 120 ++ .../V1/ArtifactRegistryClient/create_rule.php | 75 ++ .../delete_attachment.php | 87 ++ .../V1/ArtifactRegistryClient/delete_file.php | 87 ++ .../V1/ArtifactRegistryClient/delete_rule.php | 74 ++ .../ArtifactRegistryClient/get_attachment.php | 76 ++ .../V1/ArtifactRegistryClient/get_rule.php | 76 ++ .../list_attachments.php | 80 ++ .../V1/ArtifactRegistryClient/list_rules.php | 82 ++ .../V1/ArtifactRegistryClient/update_file.php | 62 + .../ArtifactRegistryClient/update_package.php | 57 + .../V1/ArtifactRegistryClient/update_rule.php | 57 + .../ArtifactRegistryClient/update_version.php | 59 + ArtifactRegistry/src/V1/Attachment.php | 412 ++++++ .../src/V1/Client/ArtifactRegistryClient.php | 417 ++++++ .../src/V1/CreateAttachmentRequest.php | 168 +++ ArtifactRegistry/src/V1/CreateRuleRequest.php | 163 +++ .../src/V1/DeleteAttachmentRequest.php | 81 ++ ArtifactRegistry/src/V1/DeleteFileRequest.php | 81 ++ ArtifactRegistry/src/V1/DeleteRuleRequest.php | 81 ++ ArtifactRegistry/src/V1/File.php | 42 +- ArtifactRegistry/src/V1/GenericArtifact.php | 205 +++ .../src/V1/GetAttachmentRequest.php | 81 ++ ArtifactRegistry/src/V1/GetRuleRequest.php | 81 ++ .../src/V1/ListAttachmentsRequest.php | 199 +++ .../src/V1/ListAttachmentsResponse.php | 105 ++ .../src/V1/ListDockerImagesRequest.php | 8 +- ArtifactRegistry/src/V1/ListFilesRequest.php | 148 ++- .../src/V1/ListMavenArtifactsRequest.php | 8 +- .../src/V1/ListNpmPackagesRequest.php | 8 +- .../src/V1/ListPackagesRequest.php | 188 +++ .../src/V1/ListPythonPackagesRequest.php | 8 +- .../src/V1/ListRepositoriesRequest.php | 116 ++ ArtifactRegistry/src/V1/ListRulesRequest.php | 159 +++ ArtifactRegistry/src/V1/ListRulesResponse.php | 105 ++ ArtifactRegistry/src/V1/ListTagsRequest.php | 84 +- .../src/V1/ListVersionsRequest.php | 154 +++ ArtifactRegistry/src/V1/Package.php | 34 + ArtifactRegistry/src/V1/ProjectSettings.php | 38 + .../V1/ProjectSettings/RedirectionState.php | 14 + .../src/V1/RemoteRepositoryConfig.php | 74 ++ .../RemoteRepositoryConfig/AptRepository.php | 33 + .../AptRepository/CustomRepository.php | 72 + .../PublicRepository/RepositoryBase.php | 7 + .../CommonRemoteRepository.php | 68 + .../DockerRepository.php | 33 + .../DockerRepository/CustomRepository.php | 72 + .../MavenRepository.php | 33 + .../MavenRepository/CustomRepository.php | 72 + .../RemoteRepositoryConfig/NpmRepository.php | 33 + .../NpmRepository/CustomRepository.php | 72 + .../PythonRepository.php | 33 + .../PythonRepository/CustomRepository.php | 72 + .../RemoteRepositoryConfig/YumRepository.php | 33 + .../YumRepository/CustomRepository.php | 72 + ArtifactRegistry/src/V1/Repository.php | 132 +- ArtifactRegistry/src/V1/Repository/Format.php | 7 + .../VulnerabilityScanningConfig.php | 189 +++ .../EnablementConfig.php | 63 + .../EnablementState.php | 70 + ArtifactRegistry/src/V1/Rule.php | 220 +++ ArtifactRegistry/src/V1/Rule/Action.php | 62 + ArtifactRegistry/src/V1/Rule/Operation.php | 55 + ArtifactRegistry/src/V1/Tag.php | 8 +- ArtifactRegistry/src/V1/UpdateFileRequest.php | 146 ++ .../src/V1/UpdatePackageRequest.php | 146 ++ ArtifactRegistry/src/V1/UpdateRuleRequest.php | 146 ++ .../src/V1/UpdateVersionRequest.php | 146 ++ ArtifactRegistry/src/V1/Version.php | 42 +- ArtifactRegistry/src/V1/gapic_metadata.json | 65 + .../artifact_registry_client_config.json | 65 + .../artifact_registry_descriptor_config.php | 199 +++ .../artifact_registry_rest_client_config.php | 159 +++ .../V1/Client/ArtifactRegistryClientTest.php | 1181 ++++++++++++++++- 83 files changed, 8099 insertions(+), 123 deletions(-) create mode 100644 ArtifactRegistry/metadata/V1/Attachment.php create mode 100644 ArtifactRegistry/metadata/V1/Generic.php create mode 100644 ArtifactRegistry/metadata/V1/Rule.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/create_attachment.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/create_rule.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_attachment.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_file.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_rule.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/get_attachment.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/get_rule.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/list_attachments.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/list_rules.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_file.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_package.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_rule.php create mode 100644 ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_version.php create mode 100644 ArtifactRegistry/src/V1/Attachment.php create mode 100644 ArtifactRegistry/src/V1/CreateAttachmentRequest.php create mode 100644 ArtifactRegistry/src/V1/CreateRuleRequest.php create mode 100644 ArtifactRegistry/src/V1/DeleteAttachmentRequest.php create mode 100644 ArtifactRegistry/src/V1/DeleteFileRequest.php create mode 100644 ArtifactRegistry/src/V1/DeleteRuleRequest.php create mode 100644 ArtifactRegistry/src/V1/GenericArtifact.php create mode 100644 ArtifactRegistry/src/V1/GetAttachmentRequest.php create mode 100644 ArtifactRegistry/src/V1/GetRuleRequest.php create mode 100644 ArtifactRegistry/src/V1/ListAttachmentsRequest.php create mode 100644 ArtifactRegistry/src/V1/ListAttachmentsResponse.php create mode 100644 ArtifactRegistry/src/V1/ListRulesRequest.php create mode 100644 ArtifactRegistry/src/V1/ListRulesResponse.php create mode 100644 ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository/CustomRepository.php create mode 100644 ArtifactRegistry/src/V1/RemoteRepositoryConfig/CommonRemoteRepository.php create mode 100644 ArtifactRegistry/src/V1/RemoteRepositoryConfig/DockerRepository/CustomRepository.php create mode 100644 ArtifactRegistry/src/V1/RemoteRepositoryConfig/MavenRepository/CustomRepository.php create mode 100644 ArtifactRegistry/src/V1/RemoteRepositoryConfig/NpmRepository/CustomRepository.php create mode 100644 ArtifactRegistry/src/V1/RemoteRepositoryConfig/PythonRepository/CustomRepository.php create mode 100644 ArtifactRegistry/src/V1/RemoteRepositoryConfig/YumRepository/CustomRepository.php create mode 100644 ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig.php create mode 100644 ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig/EnablementConfig.php create mode 100644 ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig/EnablementState.php create mode 100644 ArtifactRegistry/src/V1/Rule.php create mode 100644 ArtifactRegistry/src/V1/Rule/Action.php create mode 100644 ArtifactRegistry/src/V1/Rule/Operation.php create mode 100644 ArtifactRegistry/src/V1/UpdateFileRequest.php create mode 100644 ArtifactRegistry/src/V1/UpdatePackageRequest.php create mode 100644 ArtifactRegistry/src/V1/UpdateRuleRequest.php create mode 100644 ArtifactRegistry/src/V1/UpdateVersionRequest.php diff --git a/ArtifactRegistry/metadata/V1/Attachment.php b/ArtifactRegistry/metadata/V1/Attachment.php new file mode 100644 index 000000000000..394ad21ccd46 --- /dev/null +++ b/ArtifactRegistry/metadata/V1/Attachment.php @@ -0,0 +1,66 @@ +internalAddGeneratedFile( + ' +ó +4google/devtools/artifactregistry/v1/attachment.proto#google.devtools.artifactregistry.v1google/api/resource.protogoogle/protobuf/timestamp.proto" + +Attachment +name (  +target ( BàA +type (  +attachment_namespace ( Z + annotations ( 2@.google.devtools.artifactregistry.v1.Attachment.AnnotationsEntryBàA4 + create_time ( 2.google.protobuf.TimestampBàA4 + update_time ( 2.google.protobuf.TimestampBàA; +files ( B,àAúA& +$artifactregistry.googleapis.com/File +oci_version_name ( BàA2 +AnnotationsEntry +key (  +value ( :8:ŒêAˆ +*artifactregistry.googleapis.com/AttachmentZprojects/{project}/locations/{location}/repositories/{repository}/attachments/{attachment}"˜ +ListAttachmentsRequestB +parent ( B2àAúA,*artifactregistry.googleapis.com/Attachment +filter ( BàA + page_size ( + +page_token ( "x +ListAttachmentsResponseD + attachments ( 2/.google.devtools.artifactregistry.v1.Attachment +next_page_token ( "X +GetAttachmentRequest@ +name ( B2àAúA, +*artifactregistry.googleapis.com/Attachment"à +CreateAttachmentRequestB +parent ( B2àAúA,*artifactregistry.googleapis.com/Attachment + attachment_id ( BàAH + +attachment ( 2/.google.devtools.artifactregistry.v1.AttachmentBàA"[ +DeleteAttachmentRequest@ +name ( B2àAúA, +*artifactregistry.googleapis.com/AttachmentBú +\'com.google.devtools.artifactregistry.v1BAttachmentProtoPZPcloud.google.com/go/artifactregistry/apiv1/artifactregistrypb;artifactregistrypbª Google.Cloud.ArtifactRegistry.V1Ê Google\\Cloud\\ArtifactRegistry\\V1ê#Google::Cloud::ArtifactRegistry::V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/ArtifactRegistry/metadata/V1/File.php b/ArtifactRegistry/metadata/V1/File.php index 381fb05293ac3a6710163243759d8fd5f9c1c982..2cbadf3e73155e801e36a6ac54afb16c8908db7f 100644 GIT binary patch delta 313 zcmaFGzgBpI2NS1TW@=7~Z(?!wxyQXZcRQqRP^k7)+W=0nWFjN(EeT-=FydHE%YC7Jno#S)wf%o^NAR+IlQ ztA@B`=A`O5A|ze&N{T9-m>)PYN*Qqppi2mGb1`S9R!T4`FlulL@p7@2CFYc-N-%-A zR!kO*R+Xp3JNZfOD>ZH13{B#1GfT>1G69m69Kcm1internalAddGeneratedFile( + ' +Ô +1google/devtools/artifactregistry/v1/generic.proto#google.devtools.artifactregistry.v1google/api/resource.protogoogle/protobuf/timestamp.proto"» +GenericArtifact +name (  +version ( 4 + create_time ( 2.google.protobuf.TimestampBàA4 + update_time ( 2.google.protobuf.TimestampBàA:œêA˜ +/artifactregistry.googleapis.com/GenericArtifacteprojects/{project}/locations/{location}/repositories/{repository}/genericArtifacts/{generic_artifact}B÷ +\'com.google.devtools.artifactregistry.v1B GenericProtoPZPcloud.google.com/go/artifactregistry/apiv1/artifactregistrypb;artifactregistrypbª Google.Cloud.ArtifactRegistry.V1Ê Google\\Cloud\\ArtifactRegistry\\V1ê#Google::Cloud::ArtifactRegistry::V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/ArtifactRegistry/metadata/V1/Package.php b/ArtifactRegistry/metadata/V1/Package.php index c0351d017912..1970c0d56337 100644 --- a/ArtifactRegistry/metadata/V1/Package.php +++ b/ArtifactRegistry/metadata/V1/Package.php @@ -16,22 +16,29 @@ public static function initOnce() { } \GPBMetadata\Google\Api\FieldBehavior::initOnce(); \GPBMetadata\Google\Api\Resource::initOnce(); + \GPBMetadata\Google\Protobuf\FieldMask::initOnce(); \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -È -1google/devtools/artifactregistry/v1/package.proto#google.devtools.artifactregistry.v1google/api/resource.protogoogle/protobuf/timestamp.proto"” +­ +1google/devtools/artifactregistry/v1/package.proto#google.devtools.artifactregistry.v1google/api/resource.proto google/protobuf/field_mask.protogoogle/protobuf/timestamp.proto"¡ Package name (  display_name ( / create_time ( 2.google.protobuf.Timestamp/ - update_time ( 2.google.protobuf.Timestamp:‚êA -\'artifactregistry.googleapis.com/PackageTprojects/{project}/locations/{location}/repositories/{repository}/packages/{package}"} + update_time ( 2.google.protobuf.TimestampW + annotations ( 2=.google.devtools.artifactregistry.v1.Package.AnnotationsEntryBàA2 +AnnotationsEntry +key (  +value ( :8:‚êA +\'artifactregistry.googleapis.com/PackageTprojects/{project}/locations/{location}/repositories/{repository}/packages/{package}"© ListPackagesRequest? parent ( B/àAúA)\'artifactregistry.googleapis.com/Package page_size ( -page_token ( "o +page_token (  +filter ( BàA +order_by ( BàA"o ListPackagesResponse> packages ( 2,.google.devtools.artifactregistry.v1.Package next_page_token ( "R @@ -40,7 +47,10 @@ public static function initOnce() { \'artifactregistry.googleapis.com/Package"U DeletePackageRequest= name ( B/àAúA) -\'artifactregistry.googleapis.com/PackageB÷ +\'artifactregistry.googleapis.com/Package"† +UpdatePackageRequest= +package ( 2,.google.devtools.artifactregistry.v1.Package/ + update_mask ( 2.google.protobuf.FieldMaskB÷ \'com.google.devtools.artifactregistry.v1B PackageProtoPZPcloud.google.com/go/artifactregistry/apiv1/artifactregistrypb;artifactregistrypbª Google.Cloud.ArtifactRegistry.V1Ê Google\\Cloud\\ArtifactRegistry\\V1ê#Google::Cloud::ArtifactRegistry::V1bproto3' , true); diff --git a/ArtifactRegistry/metadata/V1/Repository.php b/ArtifactRegistry/metadata/V1/Repository.php index d6f9d5f4689794ca5c3d700335719879fe17fffb..f36277f4dfdecf71d697adce716209516561d9d9 100644 GIT binary patch delta 1704 zcmbW2O>7%Q6vw-}E_Ehedp(KWwH=c-6cVb|t_rCHs)E*=ZMpd5(hw4M;wrl;K-qeNJbn0QE@9AWxgmin!3_yiG2_^YWzi<|wma|r z-|x-LdvE?(_^z^(;n<(c-5huEC^rq#_+%>GZACqH$^*%|=Qy5g_^9OtR_OU1F@A!X z8$Vyg_xOu3xo52+#|sgD06snq=RmGu1?HNKjCLysePlYuhG|<3GqgNcj1h6P#Qh>g zy3KK!VIQ&hZtSBx+$5xS5PHrqiR+QBQ4;wr)F*R9;f%kT!Z;$reu=IuKZ z^Z2vmqzWfMVo@onl4j_dw4#?QHGw`<~ z`U!Ry;ALj}|Ito^^l*vqR~{6GYK+!1TS@@l?=^xEcx}IqW+cfH)yKXhb3H)dDEWVW*Yg`@n)BA36&x>*y_yWk# zjAdA|Y#+YCZuH>MF<4#HACgP%<&a+^RHLIt52 zB9Tsm`1v=Z|Adq$ui}$odc-*S1Ya+ck_TK=OF*9O8Y364U%})?QPs&M0`W{r4sh9}g5pfK z87J=(1e#y=#1txQfYchIH zelOz5@5IH$QCd)3Qk0sQD|MN9a;<2`<~lKZMg?RECw?y8qSV~{lGOO({L-T2RHatF z%~}%InK$o~(PW%#q%fN?fATqn{K;O5zZqL5yD7D9{;t%+#PNcOD@HvzKX>v60hP_` MRh<|o7pnUL07V*Jng9R* diff --git a/ArtifactRegistry/metadata/V1/Rule.php b/ArtifactRegistry/metadata/V1/Rule.php new file mode 100644 index 0000000000000000000000000000000000000000..88272adadee9d24fd1ffcc31f5674bc5546d582a GIT binary patch literal 2338 zcmbtW!EW0|5Upg{jmAbI5oqf8w3Uro22!$eTC|{(wv;6s0u)hD9S1E42o$xFx28#! zT&ht6{X&1Bf6)KvrC*VA&OPlmwyAeaCmnARdiqNF4tnU@i?+LK-INm?xy!Xq|k9u8|*y4%Nxn_s1^PhIGPx z-;Fdof ztsMY3t{p|BhiLE`2!4Wi;4+6q+~)YT!=gU(7-zQ2e#e@gk&*326df0BN3rK{=6ggq zn4UwcdnCaWwmSjVg8o@vT|o;{VzoR@L(g_G)5r-~!2Pg`rn)|+d`_k~sqUp=1sofZ zYLcU_FC_Vl@Gz!VqZ1NR9*5q6%v%7==1-5Z?FhA7w%c?FxZgTC> zw3kbJ&FPR)pWD&-@)1v_0kxX1f*X>Q%zyD6OL;bi!#S--D8%ZV2tms({ILP*-4v*7 zC-!QlSoOMM)k$sZQ3`4YObb(f5(RH%ikEsuO=u%Qeg6VkNG%?w&KyhCD3+R>SN>js zf)KB=0R=Gzn>muJ7L^}h4d(^5xS7ZI`}<#}72TSlDu7f&`YA_H^aC--0%S#kJXs#Z z%v_Z{C_273#0f&20^+Rimopquj4Jw8UwLEX6a@f>_}m`TJ{xYXib5)1!&;iqLr{#v zla|@(zv%qfZ63CcTFpl3Bc%wdM!RjkEajAYP-rweKb7*8ub_CD!Xx;^>^6JGdz?4m zUc-FZX`4o)l+&kgjS1{5^e&+u+ZL&KcWILD4z}tS>hMT=oj%Pp*LNgcc$PiRu+xDb zF`Q{e@qGR^#b1zZafDy9%5P9=yO_U`Tva1mE|%l zLopCkMtE;Y6|5!%;}Q4IY0}hUWd!9bfuq3pBC31~t1>$byn+qe%Nll@zNLDUPvL<_ zU-7;Sox~9eELPfZ|Cq}9vhwt+ip`2!j{eG@IVc~76xWPkEJOS-!XCiKqG+K#nX>W? z6vTm4|6NF^%%J=tz#a5Xav7Q!(7T{18mz|>P2LAGxApz4tR>l%q0aBkiV5Wgb?Lj| zKY;D}zd5jWQTkcT+hkBLijH)}a_i=P?mDg?4>Lb8J!5}yo#SZXM!!CH!Qf!==&w9E zmU~@2l*mT9)O+b)1NF4_PiA6S(#D!^{>;e2)&DlXodD^&w9@tKP`Z9v8>~rwpX|internalAddGeneratedFile( ' -øH -1google/devtools/artifactregistry/v1/service.proto#google.devtools.artifactregistry.v1google/api/client.proto6google/devtools/artifactregistry/v1/apt_artifact.proto2google/devtools/artifactregistry/v1/artifact.proto.google/devtools/artifactregistry/v1/file.proto1google/devtools/artifactregistry/v1/package.proto4google/devtools/artifactregistry/v1/repository.proto2google/devtools/artifactregistry/v1/settings.proto-google/devtools/artifactregistry/v1/tag.proto1google/devtools/artifactregistry/v1/version.proto6google/devtools/artifactregistry/v1/vpcsc_config.proto6google/devtools/artifactregistry/v1/yum_artifact.protogoogle/iam/v1/iam_policy.protogoogle/iam/v1/policy.proto#google/longrunning/operations.protogoogle/protobuf/empty.proto" -OperationMetadata2ä@ +ä` +1google/devtools/artifactregistry/v1/service.proto#google.devtools.artifactregistry.v1google/api/client.proto6google/devtools/artifactregistry/v1/apt_artifact.proto2google/devtools/artifactregistry/v1/artifact.proto4google/devtools/artifactregistry/v1/attachment.proto.google/devtools/artifactregistry/v1/file.proto1google/devtools/artifactregistry/v1/package.proto4google/devtools/artifactregistry/v1/repository.proto.google/devtools/artifactregistry/v1/rule.proto2google/devtools/artifactregistry/v1/settings.proto-google/devtools/artifactregistry/v1/tag.proto1google/devtools/artifactregistry/v1/version.proto6google/devtools/artifactregistry/v1/vpcsc_config.proto6google/devtools/artifactregistry/v1/yum_artifact.protogoogle/iam/v1/iam_policy.protogoogle/iam/v1/policy.proto#google/longrunning/operations.protogoogle/protobuf/empty.proto" +OperationMetadata2êW ArtifactRegistryá ListDockerImages<.google.devtools.artifactregistry.v1.ListDockerImagesRequest=.google.devtools.artifactregistry.v1.ListDockerImagesResponse"PÚAparent‚Óä“A?/v1/{parent=projects/*/locations/*/repositories/*}/dockerImagesÎ GetDockerImage:.google.devtools.artifactregistry.v1.GetDockerImageRequest0.google.devtools.artifactregistry.v1.DockerImage"NÚAname‚Óä“A?/v1/{name=projects/*/locations/*/repositories/*/dockerImages/*}é @@ -68,21 +70,43 @@ public static function initOnce() { DeleteVersion9.google.devtools.artifactregistry.v1.DeleteVersionRequest.google.longrunning.Operation"¦ÊAN google.protobuf.Empty5google.devtools.artifactregistry.v1.OperationMetadataÚAname‚Óä“H*F/v1/{name=projects/*/locations/*/repositories/*/packages/*/versions/*}¿ BatchDeleteVersions?.google.devtools.artifactregistry.v1.BatchDeleteVersionsRequest.google.longrunning.Operation"ÇÊAX -google.protobuf.Empty?google.devtools.artifactregistry.v1.BatchDeleteVersionsMetadataÚA parent,names‚Óä“W"R/v1/{parent=projects/*/locations/*/repositories/*/packages/*}/versions:batchDelete:*Å +google.protobuf.Empty?google.devtools.artifactregistry.v1.BatchDeleteVersionsMetadataÚA parent,names‚Óä“W"R/v1/{parent=projects/*/locations/*/repositories/*/packages/*}/versions:batchDelete:*ï + UpdateVersion9.google.devtools.artifactregistry.v1.UpdateVersionRequest,.google.devtools.artifactregistry.v1.Version"uÚAversion,update_mask‚Óä“Y2N/v1/{version.name=projects/*/locations/*/repositories/*/packages/*/versions/*}:versionÅ ListFiles5.google.devtools.artifactregistry.v1.ListFilesRequest6.google.devtools.artifactregistry.v1.ListFilesResponse"IÚAparent‚Óä“:8/v1/{parent=projects/*/locations/*/repositories/*}/files³ -GetFile3.google.devtools.artifactregistry.v1.GetFileRequest).google.devtools.artifactregistry.v1.File"HÚAname‚Óä“;9/v1/{name=projects/*/locations/*/repositories/*/files/**}Ì +GetFile3.google.devtools.artifactregistry.v1.GetFileRequest).google.devtools.artifactregistry.v1.File"HÚAname‚Óä“;9/v1/{name=projects/*/locations/*/repositories/*/files/**}þ + +DeleteFile6.google.devtools.artifactregistry.v1.DeleteFileRequest.google.longrunning.Operation"˜ÊAN +google.protobuf.Empty5google.devtools.artifactregistry.v1.OperationMetadataÚAname‚Óä“:*8/v1/{name=projects/*/locations/*/repositories/*/files/*}Ï + +UpdateFile6.google.devtools.artifactregistry.v1.UpdateFileRequest).google.devtools.artifactregistry.v1.File"^ÚAfile,update_mask‚Óä“E2=/v1/{file.name=projects/*/locations/*/repositories/*/files/*}:fileÌ ListTags4.google.devtools.artifactregistry.v1.ListTagsRequest5.google.devtools.artifactregistry.v1.ListTagsResponse"SÚAparent‚Óä“DB/v1/{parent=projects/*/locations/*/repositories/*/packages/*}/tags¹ GetTag2.google.devtools.artifactregistry.v1.GetTagRequest(.google.devtools.artifactregistry.v1.Tag"QÚAname‚Óä“DB/v1/{name=projects/*/locations/*/repositories/*/packages/*/tags/*}Ñ CreateTag5.google.devtools.artifactregistry.v1.CreateTagRequest(.google.devtools.artifactregistry.v1.Tag"cÚAparent,tag,tag_id‚Óä“I"B/v1/{parent=projects/*/locations/*/repositories/*/packages/*}/tags:tagÓ UpdateTag5.google.devtools.artifactregistry.v1.UpdateTagRequest(.google.devtools.artifactregistry.v1.Tag"eÚAtag,update_mask‚Óä“M2F/v1/{tag.name=projects/*/locations/*/repositories/*/packages/*/tags/*}:tag­ - DeleteTag5.google.devtools.artifactregistry.v1.DeleteTagRequest.google.protobuf.Empty"QÚAname‚Óä“D*B/v1/{name=projects/*/locations/*/repositories/*/packages/*/tags/*}— + DeleteTag5.google.devtools.artifactregistry.v1.DeleteTagRequest.google.protobuf.Empty"QÚAname‚Óä“D*B/v1/{name=projects/*/locations/*/repositories/*/packages/*/tags/*}Í + +CreateRule6.google.devtools.artifactregistry.v1.CreateRuleRequest).google.devtools.artifactregistry.v1.Rule"\\ÚAparent,rule,rule_id‚Óä“@"8/v1/{parent=projects/*/locations/*/repositories/*}/rules:ruleÅ + ListRules5.google.devtools.artifactregistry.v1.ListRulesRequest6.google.devtools.artifactregistry.v1.ListRulesResponse"IÚAparent‚Óä“:8/v1/{parent=projects/*/locations/*/repositories/*}/rules² +GetRule3.google.devtools.artifactregistry.v1.GetRuleRequest).google.devtools.artifactregistry.v1.Rule"GÚAname‚Óä“:8/v1/{name=projects/*/locations/*/repositories/*/rules/*}Ï + +UpdateRule6.google.devtools.artifactregistry.v1.UpdateRuleRequest).google.devtools.artifactregistry.v1.Rule"^ÚArule,update_mask‚Óä“E2=/v1/{rule.name=projects/*/locations/*/repositories/*/rules/*}:rule¥ + +DeleteRule6.google.devtools.artifactregistry.v1.DeleteRuleRequest.google.protobuf.Empty"GÚAname‚Óä“:*8/v1/{name=projects/*/locations/*/repositories/*/rules/*}— SetIamPolicy".google.iam.v1.SetIamPolicyRequest.google.iam.v1.Policy"L‚Óä“F"A/v1/{resource=projects/*/locations/*/repositories/*}:setIamPolicy:*” GetIamPolicy".google.iam.v1.GetIamPolicyRequest.google.iam.v1.Policy"I‚Óä“CA/v1/{resource=projects/*/locations/*/repositories/*}:getIamPolicy½ TestIamPermissions(.google.iam.v1.TestIamPermissionsRequest).google.iam.v1.TestIamPermissionsResponse"R‚Óä“L"G/v1/{resource=projects/*/locations/*/repositories/*}:testIamPermissions:*À GetProjectSettings>.google.devtools.artifactregistry.v1.GetProjectSettingsRequest4.google.devtools.artifactregistry.v1.ProjectSettings"4ÚAname‚Óä“\'%/v1/{name=projects/*/projectSettings} UpdateProjectSettingsA.google.devtools.artifactregistry.v1.UpdateProjectSettingsRequest4.google.devtools.artifactregistry.v1.ProjectSettings"oÚAproject_settings,update_mask‚Óä“J26/v1/{project_settings.name=projects/*/projectSettings}:project_settings¼ GetVPCSCConfig:.google.devtools.artifactregistry.v1.GetVPCSCConfigRequest0.google.devtools.artifactregistry.v1.VPCSCConfig"<ÚAname‚Óä“/-/v1/{name=projects/*/locations/*/vpcscConfig}ñ -UpdateVPCSCConfig=.google.devtools.artifactregistry.v1.UpdateVPCSCConfigRequest0.google.devtools.artifactregistry.v1.VPCSCConfig"kÚAvpcsc_config,update_mask‚Óä“J2:/v1/{vpcsc_config.name=projects/*/locations/*/vpcscConfig}: vpcsc_configŒÊAartifactregistry.googleapis.comÒAghttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/cloud-platform.read-onlyB÷ +UpdateVPCSCConfig=.google.devtools.artifactregistry.v1.UpdateVPCSCConfigRequest0.google.devtools.artifactregistry.v1.VPCSCConfig"kÚAvpcsc_config,update_mask‚Óä“J2:/v1/{vpcsc_config.name=projects/*/locations/*/vpcscConfig}: vpcsc_configä + UpdatePackage9.google.devtools.artifactregistry.v1.UpdatePackageRequest,.google.devtools.artifactregistry.v1.Package"jÚApackage,update_mask‚Óä“N2C/v1/{package.name=projects/*/locations/*/repositories/*/packages/*}:packageÝ +ListAttachments;.google.devtools.artifactregistry.v1.ListAttachmentsRequest<.google.devtools.artifactregistry.v1.ListAttachmentsResponse"OÚAparent‚Óä“@>/v1/{parent=projects/*/locations/*/repositories/*}/attachmentsÊ + GetAttachment9.google.devtools.artifactregistry.v1.GetAttachmentRequest/.google.devtools.artifactregistry.v1.Attachment"MÚAname‚Óä“@>/v1/{name=projects/*/locations/*/repositories/*/attachments/*}Ð +CreateAttachment<.google.devtools.artifactregistry.v1.CreateAttachmentRequest.google.longrunning.Operation"ÞÊAg +.google.devtools.artifactregistry.v1.Attachment5google.devtools.artifactregistry.v1.OperationMetadataÚAparent,attachment,attachment_id‚Óä“L">/v1/{parent=projects/*/locations/*/repositories/*}/attachments: +attachment +DeleteAttachment<.google.devtools.artifactregistry.v1.DeleteAttachmentRequest.google.longrunning.Operation"žÊAN +google.protobuf.Empty5google.devtools.artifactregistry.v1.OperationMetadataÚAname‚Óä“@*>/v1/{name=projects/*/locations/*/repositories/*/attachments/*}ŒÊAartifactregistry.googleapis.comÒAghttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/cloud-platform.read-onlyB÷ \'com.google.devtools.artifactregistry.v1B ServiceProtoPZPcloud.google.com/go/artifactregistry/apiv1/artifactregistrypb;artifactregistrypbª Google.Cloud.ArtifactRegistry.V1Ê Google\\Cloud\\ArtifactRegistry\\V1ê#Google::Cloud::ArtifactRegistry::V1bproto3' , true); diff --git a/ArtifactRegistry/metadata/V1/Settings.php b/ArtifactRegistry/metadata/V1/Settings.php index 5823e6f990ac8da70e0ac3c42247332669be004c..49d4de20ff0f25fa38c8ba88f939789269fa6786 100644 GIT binary patch delta 117 zcmbQuH<^FKJSL`9oRb$YO=s$0nQY12At@xn#Zyq4lM`Q%T9llcS0cfzz^K8h)XOya z2=i(dA$>0G$$yz8BwhU+oqSwf;vM~5;+_2iB0c@w1z2ISq5+OUA)bytD6(vu^I6s~ F0RY+ZAwmEE delta 34 scmV+-0NwwS51S6Ko&o~02$P@!mjaLjlQ{#310t&dliCBTv*!e?0?y+MNB{r; diff --git a/ArtifactRegistry/metadata/V1/Version.php b/ArtifactRegistry/metadata/V1/Version.php index 3bc4fca9498cc60c4b3b2ed5c72393be20428a21..81d53cf2a243935847aa296a439e7839a77ad3ca 100644 GIT binary patch delta 317 zcmX>ud{u123?@#u%+#C|-^AkV$@7?uC(mGNXIjHQS&@0Mv_g7*etJ%-enC-wNq$mk zntmEcWqdA3>0V|xrX?(sSy}#x3x#uWC+6klmn4>C=I0ela4Ilsa2wf9&S%pJ)N@2g zxaO4AoU|Vd(#-yRt&B!GZT9A@hk{Xs;R19=b zP-6Bm0KL8KLVEnlVb$_lkNqZ0i%`. Please see + * {@see ArtifactRegistryClient::fileName()} for help formatting this field. + */ +function create_attachment_sample( + string $formattedParent, + string $attachmentId, + string $attachmentTarget, + string $formattedAttachmentFilesElement +): void { + // Create a client. + $artifactRegistryClient = new ArtifactRegistryClient(); + + // Prepare the request message. + $formattedAttachmentFiles = [$formattedAttachmentFilesElement,]; + $attachment = (new Attachment()) + ->setTarget($attachmentTarget) + ->setFiles($formattedAttachmentFiles); + $request = (new CreateAttachmentRequest()) + ->setParent($formattedParent) + ->setAttachmentId($attachmentId) + ->setAttachment($attachment); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $artifactRegistryClient->createAttachment($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Attachment $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 +{ + $formattedParent = ArtifactRegistryClient::repositoryName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]' + ); + $attachmentId = '[ATTACHMENT_ID]'; + $attachmentTarget = '[TARGET]'; + $formattedAttachmentFilesElement = ArtifactRegistryClient::fileName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]', + '[FILE]' + ); + + create_attachment_sample( + $formattedParent, + $attachmentId, + $attachmentTarget, + $formattedAttachmentFilesElement + ); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_CreateAttachment_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/create_rule.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/create_rule.php new file mode 100644 index 000000000000..c3849cd60f21 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/create_rule.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var Rule $response */ + $response = $artifactRegistryClient->createRule($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedParent = ArtifactRegistryClient::repositoryName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]' + ); + + create_rule_sample($formattedParent); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_CreateRule_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_attachment.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_attachment.php new file mode 100644 index 000000000000..54728b57aece --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_attachment.php @@ -0,0 +1,87 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $artifactRegistryClient->deleteAttachment($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } 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 +{ + $formattedName = ArtifactRegistryClient::attachmentName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]', + '[ATTACHMENT]' + ); + + delete_attachment_sample($formattedName); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_DeleteAttachment_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_file.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_file.php new file mode 100644 index 000000000000..3e466d22af2e --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_file.php @@ -0,0 +1,87 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $artifactRegistryClient->deleteFile($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } 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 +{ + $formattedName = ArtifactRegistryClient::fileName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]', + '[FILE]' + ); + + delete_file_sample($formattedName); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_DeleteFile_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_rule.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_rule.php new file mode 100644 index 000000000000..e51c4979d7f2 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/delete_rule.php @@ -0,0 +1,74 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + $artifactRegistryClient->deleteRule($request); + printf('Call completed successfully.' . PHP_EOL); + } 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 +{ + $formattedName = ArtifactRegistryClient::ruleName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]', + '[RULE]' + ); + + delete_rule_sample($formattedName); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_DeleteRule_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/get_attachment.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/get_attachment.php new file mode 100644 index 000000000000..7db7fe48e5e0 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/get_attachment.php @@ -0,0 +1,76 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Attachment $response */ + $response = $artifactRegistryClient->getAttachment($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = ArtifactRegistryClient::attachmentName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]', + '[ATTACHMENT]' + ); + + get_attachment_sample($formattedName); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_GetAttachment_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/get_rule.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/get_rule.php new file mode 100644 index 000000000000..998656c310af --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/get_rule.php @@ -0,0 +1,76 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Rule $response */ + $response = $artifactRegistryClient->getRule($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = ArtifactRegistryClient::ruleName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]', + '[RULE]' + ); + + get_rule_sample($formattedName); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_GetRule_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/list_attachments.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/list_attachments.php new file mode 100644 index 000000000000..c624ce8e8132 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/list_attachments.php @@ -0,0 +1,80 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $artifactRegistryClient->listAttachments($request); + + /** @var Attachment $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = ArtifactRegistryClient::repositoryName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]' + ); + + list_attachments_sample($formattedParent); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_ListAttachments_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/list_rules.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/list_rules.php new file mode 100644 index 000000000000..ac4df58ccfc0 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/list_rules.php @@ -0,0 +1,82 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $artifactRegistryClient->listRules($request); + + /** @var Rule $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = ArtifactRegistryClient::repositoryName( + '[PROJECT]', + '[LOCATION]', + '[REPOSITORY]' + ); + + list_rules_sample($formattedParent); +} +// [END artifactregistry_v1_generated_ArtifactRegistry_ListRules_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_file.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_file.php new file mode 100644 index 000000000000..d7848dba8bc5 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_file.php @@ -0,0 +1,62 @@ +setFile($file) + ->setUpdateMask($updateMask); + + // Call the API and handle any network failures. + try { + /** @var File $response */ + $response = $artifactRegistryClient->updateFile($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END artifactregistry_v1_generated_ArtifactRegistry_UpdateFile_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_package.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_package.php new file mode 100644 index 000000000000..ceb5ee521284 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_package.php @@ -0,0 +1,57 @@ +updatePackage($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END artifactregistry_v1_generated_ArtifactRegistry_UpdatePackage_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_rule.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_rule.php new file mode 100644 index 000000000000..d52bb220c640 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_rule.php @@ -0,0 +1,57 @@ +updateRule($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END artifactregistry_v1_generated_ArtifactRegistry_UpdateRule_sync] diff --git a/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_version.php b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_version.php new file mode 100644 index 000000000000..2a3684f43630 --- /dev/null +++ b/ArtifactRegistry/samples/V1/ArtifactRegistryClient/update_version.php @@ -0,0 +1,59 @@ +setVersion($version); + + // Call the API and handle any network failures. + try { + /** @var Version $response */ + $response = $artifactRegistryClient->updateVersion($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} +// [END artifactregistry_v1_generated_ArtifactRegistry_UpdateVersion_sync] diff --git a/ArtifactRegistry/src/V1/Attachment.php b/ArtifactRegistry/src/V1/Attachment.php new file mode 100644 index 000000000000..c0fbabaade4b --- /dev/null +++ b/ArtifactRegistry/src/V1/Attachment.php @@ -0,0 +1,412 @@ +google.devtools.artifactregistry.v1.Attachment + */ +class Attachment extends \Google\Protobuf\Internal\Message +{ + /** + * The name of the attachment. E.g. + * `projects/p1/locations/us/repositories/repo/attachments/sbom`. + * + * Generated from protobuf field string name = 1; + */ + protected $name = ''; + /** + * Required. The target the attachment is for, can be a Version, Package or + * Repository. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + * + * Generated from protobuf field string target = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $target = ''; + /** + * Type of attachment. + * E.g. `application/vnd.spdx+json` + * + * Generated from protobuf field string type = 3; + */ + protected $type = ''; + /** + * The namespace this attachment belongs to. + * E.g. If an attachment is created by artifact analysis, namespace is set + * to `artifactanalysis.googleapis.com`. + * + * Generated from protobuf field string attachment_namespace = 4; + */ + protected $attachment_namespace = ''; + /** + * Optional. User annotations. These attributes can only be set and used by + * the user, and not by Artifact Registry. See + * https://google.aip.dev/128#annotations for more details such as format and + * size limitations. + * + * Generated from protobuf field map annotations = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; + /** + * Output only. The time when the attachment was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time when the attachment was last updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Required. The files that belong to this attachment. + * If the file ID part contains slashes, they are escaped. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/files/sha:`. + * + * Generated from protobuf field repeated string files = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + private $files; + /** + * Output only. The name of the OCI version that this attachment created. Only + * populated for Docker attachments. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + * + * Generated from protobuf field string oci_version_name = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $oci_version_name = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * The name of the attachment. E.g. + * `projects/p1/locations/us/repositories/repo/attachments/sbom`. + * @type string $target + * Required. The target the attachment is for, can be a Version, Package or + * Repository. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + * @type string $type + * Type of attachment. + * E.g. `application/vnd.spdx+json` + * @type string $attachment_namespace + * The namespace this attachment belongs to. + * E.g. If an attachment is created by artifact analysis, namespace is set + * to `artifactanalysis.googleapis.com`. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. User annotations. These attributes can only be set and used by + * the user, and not by Artifact Registry. See + * https://google.aip.dev/128#annotations for more details such as format and + * size limitations. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the attachment was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the attachment was last updated. + * @type array|\Google\Protobuf\Internal\RepeatedField $files + * Required. The files that belong to this attachment. + * If the file ID part contains slashes, they are escaped. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/files/sha:`. + * @type string $oci_version_name + * Output only. The name of the OCI version that this attachment created. Only + * populated for Docker attachments. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Attachment::initOnce(); + parent::__construct($data); + } + + /** + * The name of the attachment. E.g. + * `projects/p1/locations/us/repositories/repo/attachments/sbom`. + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * The name of the attachment. E.g. + * `projects/p1/locations/us/repositories/repo/attachments/sbom`. + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Required. The target the attachment is for, can be a Version, Package or + * Repository. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + * + * Generated from protobuf field string target = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getTarget() + { + return $this->target; + } + + /** + * Required. The target the attachment is for, can be a Version, Package or + * Repository. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + * + * Generated from protobuf field string target = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setTarget($var) + { + GPBUtil::checkString($var, True); + $this->target = $var; + + return $this; + } + + /** + * Type of attachment. + * E.g. `application/vnd.spdx+json` + * + * Generated from protobuf field string type = 3; + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * Type of attachment. + * E.g. `application/vnd.spdx+json` + * + * Generated from protobuf field string type = 3; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + + /** + * The namespace this attachment belongs to. + * E.g. If an attachment is created by artifact analysis, namespace is set + * to `artifactanalysis.googleapis.com`. + * + * Generated from protobuf field string attachment_namespace = 4; + * @return string + */ + public function getAttachmentNamespace() + { + return $this->attachment_namespace; + } + + /** + * The namespace this attachment belongs to. + * E.g. If an attachment is created by artifact analysis, namespace is set + * to `artifactanalysis.googleapis.com`. + * + * Generated from protobuf field string attachment_namespace = 4; + * @param string $var + * @return $this + */ + public function setAttachmentNamespace($var) + { + GPBUtil::checkString($var, True); + $this->attachment_namespace = $var; + + return $this; + } + + /** + * Optional. User annotations. These attributes can only be set and used by + * the user, and not by Artifact Registry. See + * https://google.aip.dev/128#annotations for more details such as format and + * size limitations. + * + * Generated from protobuf field map annotations = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. User annotations. These attributes can only be set and used by + * the user, and not by Artifact Registry. See + * https://google.aip.dev/128#annotations for more details such as format and + * size limitations. + * + * Generated from protobuf field map annotations = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + + /** + * Output only. The time when the attachment was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the attachment was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time when the attachment was last updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the attachment was last updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Required. The files that belong to this attachment. + * If the file ID part contains slashes, they are escaped. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/files/sha:`. + * + * Generated from protobuf field repeated string files = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getFiles() + { + return $this->files; + } + + /** + * Required. The files that belong to this attachment. + * If the file ID part contains slashes, they are escaped. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/files/sha:`. + * + * Generated from protobuf field repeated string files = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setFiles($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->files = $arr; + + return $this; + } + + /** + * Output only. The name of the OCI version that this attachment created. Only + * populated for Docker attachments. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + * + * Generated from protobuf field string oci_version_name = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getOciVersionName() + { + return $this->oci_version_name; + } + + /** + * Output only. The name of the OCI version that this attachment created. Only + * populated for Docker attachments. E.g. + * `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + * + * Generated from protobuf field string oci_version_name = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setOciVersionName($var) + { + GPBUtil::checkString($var, True); + $this->oci_version_name = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/Client/ArtifactRegistryClient.php b/ArtifactRegistry/src/V1/Client/ArtifactRegistryClient.php index 8ef0e0bde17b..b47093978340 100644 --- a/ArtifactRegistry/src/V1/Client/ArtifactRegistryClient.php +++ b/ArtifactRegistry/src/V1/Client/ArtifactRegistryClient.php @@ -34,15 +34,22 @@ use Google\ApiCore\Transport\TransportInterface; use Google\ApiCore\ValidationException; use Google\Auth\FetchAuthTokenInterface; +use Google\Cloud\ArtifactRegistry\V1\Attachment; use Google\Cloud\ArtifactRegistry\V1\BatchDeleteVersionsRequest; +use Google\Cloud\ArtifactRegistry\V1\CreateAttachmentRequest; use Google\Cloud\ArtifactRegistry\V1\CreateRepositoryRequest; +use Google\Cloud\ArtifactRegistry\V1\CreateRuleRequest; use Google\Cloud\ArtifactRegistry\V1\CreateTagRequest; +use Google\Cloud\ArtifactRegistry\V1\DeleteAttachmentRequest; +use Google\Cloud\ArtifactRegistry\V1\DeleteFileRequest; use Google\Cloud\ArtifactRegistry\V1\DeletePackageRequest; use Google\Cloud\ArtifactRegistry\V1\DeleteRepositoryRequest; +use Google\Cloud\ArtifactRegistry\V1\DeleteRuleRequest; use Google\Cloud\ArtifactRegistry\V1\DeleteTagRequest; use Google\Cloud\ArtifactRegistry\V1\DeleteVersionRequest; use Google\Cloud\ArtifactRegistry\V1\DockerImage; use Google\Cloud\ArtifactRegistry\V1\File; +use Google\Cloud\ArtifactRegistry\V1\GetAttachmentRequest; use Google\Cloud\ArtifactRegistry\V1\GetDockerImageRequest; use Google\Cloud\ArtifactRegistry\V1\GetFileRequest; use Google\Cloud\ArtifactRegistry\V1\GetMavenArtifactRequest; @@ -51,11 +58,13 @@ use Google\Cloud\ArtifactRegistry\V1\GetProjectSettingsRequest; use Google\Cloud\ArtifactRegistry\V1\GetPythonPackageRequest; use Google\Cloud\ArtifactRegistry\V1\GetRepositoryRequest; +use Google\Cloud\ArtifactRegistry\V1\GetRuleRequest; use Google\Cloud\ArtifactRegistry\V1\GetTagRequest; use Google\Cloud\ArtifactRegistry\V1\GetVPCSCConfigRequest; use Google\Cloud\ArtifactRegistry\V1\GetVersionRequest; use Google\Cloud\ArtifactRegistry\V1\ImportAptArtifactsRequest; use Google\Cloud\ArtifactRegistry\V1\ImportYumArtifactsRequest; +use Google\Cloud\ArtifactRegistry\V1\ListAttachmentsRequest; use Google\Cloud\ArtifactRegistry\V1\ListDockerImagesRequest; use Google\Cloud\ArtifactRegistry\V1\ListFilesRequest; use Google\Cloud\ArtifactRegistry\V1\ListMavenArtifactsRequest; @@ -63,6 +72,7 @@ use Google\Cloud\ArtifactRegistry\V1\ListPackagesRequest; use Google\Cloud\ArtifactRegistry\V1\ListPythonPackagesRequest; use Google\Cloud\ArtifactRegistry\V1\ListRepositoriesRequest; +use Google\Cloud\ArtifactRegistry\V1\ListRulesRequest; use Google\Cloud\ArtifactRegistry\V1\ListTagsRequest; use Google\Cloud\ArtifactRegistry\V1\ListVersionsRequest; use Google\Cloud\ArtifactRegistry\V1\MavenArtifact; @@ -71,11 +81,16 @@ use Google\Cloud\ArtifactRegistry\V1\ProjectSettings; use Google\Cloud\ArtifactRegistry\V1\PythonPackage; use Google\Cloud\ArtifactRegistry\V1\Repository; +use Google\Cloud\ArtifactRegistry\V1\Rule; use Google\Cloud\ArtifactRegistry\V1\Tag; +use Google\Cloud\ArtifactRegistry\V1\UpdateFileRequest; +use Google\Cloud\ArtifactRegistry\V1\UpdatePackageRequest; use Google\Cloud\ArtifactRegistry\V1\UpdateProjectSettingsRequest; use Google\Cloud\ArtifactRegistry\V1\UpdateRepositoryRequest; +use Google\Cloud\ArtifactRegistry\V1\UpdateRuleRequest; use Google\Cloud\ArtifactRegistry\V1\UpdateTagRequest; use Google\Cloud\ArtifactRegistry\V1\UpdateVPCSCConfigRequest; +use Google\Cloud\ArtifactRegistry\V1\UpdateVersionRequest; use Google\Cloud\ArtifactRegistry\V1\VPCSCConfig; use Google\Cloud\ArtifactRegistry\V1\Version; use Google\Cloud\Iam\V1\GetIamPolicyRequest; @@ -114,12 +129,18 @@ * contained within formatted names that are returned by the API. * * @method PromiseInterface batchDeleteVersionsAsync(BatchDeleteVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAttachmentAsync(CreateAttachmentRequest $request, array $optionalArgs = []) * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRuleAsync(CreateRuleRequest $request, array $optionalArgs = []) * @method PromiseInterface createTagAsync(CreateTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAttachmentAsync(DeleteAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFileAsync(DeleteFileRequest $request, array $optionalArgs = []) * @method PromiseInterface deletePackageAsync(DeletePackageRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRuleAsync(DeleteRuleRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteTagAsync(DeleteTagRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttachmentAsync(GetAttachmentRequest $request, array $optionalArgs = []) * @method PromiseInterface getDockerImageAsync(GetDockerImageRequest $request, array $optionalArgs = []) * @method PromiseInterface getFileAsync(GetFileRequest $request, array $optionalArgs = []) * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) @@ -129,11 +150,13 @@ * @method PromiseInterface getProjectSettingsAsync(GetProjectSettingsRequest $request, array $optionalArgs = []) * @method PromiseInterface getPythonPackageAsync(GetPythonPackageRequest $request, array $optionalArgs = []) * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuleAsync(GetRuleRequest $request, array $optionalArgs = []) * @method PromiseInterface getTagAsync(GetTagRequest $request, array $optionalArgs = []) * @method PromiseInterface getVPCSCConfigAsync(GetVPCSCConfigRequest $request, array $optionalArgs = []) * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) * @method PromiseInterface importAptArtifactsAsync(ImportAptArtifactsRequest $request, array $optionalArgs = []) * @method PromiseInterface importYumArtifactsAsync(ImportYumArtifactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAttachmentsAsync(ListAttachmentsRequest $request, array $optionalArgs = []) * @method PromiseInterface listDockerImagesAsync(ListDockerImagesRequest $request, array $optionalArgs = []) * @method PromiseInterface listFilesAsync(ListFilesRequest $request, array $optionalArgs = []) * @method PromiseInterface listMavenArtifactsAsync(ListMavenArtifactsRequest $request, array $optionalArgs = []) @@ -141,14 +164,19 @@ * @method PromiseInterface listPackagesAsync(ListPackagesRequest $request, array $optionalArgs = []) * @method PromiseInterface listPythonPackagesAsync(ListPythonPackagesRequest $request, array $optionalArgs = []) * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRulesAsync(ListRulesRequest $request, array $optionalArgs = []) * @method PromiseInterface listTagsAsync(ListTagsRequest $request, array $optionalArgs = []) * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFileAsync(UpdateFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePackageAsync(UpdatePackageRequest $request, array $optionalArgs = []) * @method PromiseInterface updateProjectSettingsAsync(UpdateProjectSettingsRequest $request, array $optionalArgs = []) * @method PromiseInterface updateRepositoryAsync(UpdateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRuleAsync(UpdateRuleRequest $request, array $optionalArgs = []) * @method PromiseInterface updateTagAsync(UpdateTagRequest $request, array $optionalArgs = []) * @method PromiseInterface updateVPCSCConfigAsync(UpdateVPCSCConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ @@ -253,6 +281,31 @@ private function createOperationsClient(array $options) return new OperationsClient($options); } + /** + * Formats a string containing the fully-qualified path to represent a attachment + * resource. + * + * @param string $project + * @param string $location + * @param string $repository + * @param string $attachment + * + * @return string The formatted attachment resource. + */ + public static function attachmentName( + string $project, + string $location, + string $repository, + string $attachment + ): string { + return self::getPathTemplate('attachment')->render([ + 'project' => $project, + 'location' => $location, + 'repository' => $repository, + 'attachment' => $attachment, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a docker_image * resource. @@ -446,6 +499,27 @@ public static function repositoryName(string $project, string $location, string ]); } + /** + * Formats a string containing the fully-qualified path to represent a rule + * resource. + * + * @param string $project + * @param string $location + * @param string $repository + * @param string $rule + * + * @return string The formatted rule resource. + */ + public static function ruleName(string $project, string $location, string $repository, string $rule): string + { + return self::getPathTemplate('rule')->render([ + 'project' => $project, + 'location' => $location, + 'repository' => $repository, + 'rule' => $rule, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a * secret_version resource. @@ -542,6 +616,7 @@ public static function vpcscConfigName(string $project, string $location): strin * Parses a formatted name string and returns an associative array of the components in the name. * The following name formats are supported: * Template: Pattern + * - attachment: projects/{project}/locations/{location}/repositories/{repository}/attachments/{attachment} * - dockerImage: projects/{project}/locations/{location}/repositories/{repository}/dockerImages/{docker_image} * - file: projects/{project}/locations/{location}/repositories/{repository}/files/{file} * - location: projects/{project}/locations/{location} @@ -551,6 +626,7 @@ public static function vpcscConfigName(string $project, string $location): strin * - projectSettings: projects/{project}/projectSettings * - pythonPackage: projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_package} * - repository: projects/{project}/locations/{location}/repositories/{repository} + * - rule: projects/{project}/locations/{location}/repositories/{repository}/rules/{rule} * - secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version} * - tag: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag} * - version: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version} @@ -673,6 +749,33 @@ public function batchDeleteVersions(BatchDeleteVersionsRequest $request, array $ return $this->startApiCall('BatchDeleteVersions', $request, $callOptions)->wait(); } + /** + * Creates an attachment. The returned Operation will finish once the + * attachment has been created. Its response will be the created attachment. + * + * The async variant is {@see ArtifactRegistryClient::createAttachmentAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/create_attachment.php + * + * @param CreateAttachmentRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createAttachment(CreateAttachmentRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreateAttachment', $request, $callOptions)->wait(); + } + /** * Creates a repository. The returned Operation will finish once the * repository has been created. Its response will be the created Repository. @@ -700,6 +803,32 @@ public function createRepository(CreateRepositoryRequest $request, array $callOp return $this->startApiCall('CreateRepository', $request, $callOptions)->wait(); } + /** + * Creates a rule. + * + * The async variant is {@see ArtifactRegistryClient::createRuleAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/create_rule.php + * + * @param CreateRuleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Rule + * + * @throws ApiException Thrown if the API call fails. + */ + public function createRule(CreateRuleRequest $request, array $callOptions = []): Rule + { + return $this->startApiCall('CreateRule', $request, $callOptions)->wait(); + } + /** * Creates a tag. * @@ -726,6 +855,62 @@ public function createTag(CreateTagRequest $request, array $callOptions = []): T return $this->startApiCall('CreateTag', $request, $callOptions)->wait(); } + /** + * Deletes an attachment. The returned Operation will + * finish once the attachments has been deleted. It will not have any + * Operation metadata and will return a `google.protobuf.Empty` response. + * + * The async variant is {@see ArtifactRegistryClient::deleteAttachmentAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/delete_attachment.php + * + * @param DeleteAttachmentRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteAttachment(DeleteAttachmentRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteAttachment', $request, $callOptions)->wait(); + } + + /** + * Deletes a file and all of its content. It is only allowed on generic + * repositories. The returned operation will complete once the file has been + * deleted. + * + * The async variant is {@see ArtifactRegistryClient::deleteFileAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/delete_file.php + * + * @param DeleteFileRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteFile(DeleteFileRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteFile', $request, $callOptions)->wait(); + } + /** * Deletes a package and all of its versions and tags. The returned operation * will complete once the package has been deleted. @@ -781,6 +966,30 @@ public function deleteRepository(DeleteRepositoryRequest $request, array $callOp return $this->startApiCall('DeleteRepository', $request, $callOptions)->wait(); } + /** + * Deletes a rule. + * + * The async variant is {@see ArtifactRegistryClient::deleteRuleAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/delete_rule.php + * + * @param DeleteRuleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteRule(DeleteRuleRequest $request, array $callOptions = []): void + { + $this->startApiCall('DeleteRule', $request, $callOptions)->wait(); + } + /** * Deletes a tag. * @@ -832,6 +1041,32 @@ public function deleteVersion(DeleteVersionRequest $request, array $callOptions return $this->startApiCall('DeleteVersion', $request, $callOptions)->wait(); } + /** + * Gets an attachment. + * + * The async variant is {@see ArtifactRegistryClient::getAttachmentAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/get_attachment.php + * + * @param GetAttachmentRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Attachment + * + * @throws ApiException Thrown if the API call fails. + */ + public function getAttachment(GetAttachmentRequest $request, array $callOptions = []): Attachment + { + return $this->startApiCall('GetAttachment', $request, $callOptions)->wait(); + } + /** * Gets a docker image. * @@ -1066,6 +1301,32 @@ public function getRepository(GetRepositoryRequest $request, array $callOptions return $this->startApiCall('GetRepository', $request, $callOptions)->wait(); } + /** + * Gets a rule. + * + * The async variant is {@see ArtifactRegistryClient::getRuleAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/get_rule.php + * + * @param GetRuleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Rule + * + * @throws ApiException Thrown if the API call fails. + */ + public function getRule(GetRuleRequest $request, array $callOptions = []): Rule + { + return $this->startApiCall('GetRule', $request, $callOptions)->wait(); + } + /** * Gets a tag. * @@ -1202,6 +1463,32 @@ public function importYumArtifacts(ImportYumArtifactsRequest $request, array $ca return $this->startApiCall('ImportYumArtifacts', $request, $callOptions)->wait(); } + /** + * Lists attachments. + * + * The async variant is {@see ArtifactRegistryClient::listAttachmentsAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/list_attachments.php + * + * @param ListAttachmentsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listAttachments(ListAttachmentsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListAttachments', $request, $callOptions); + } + /** * Lists docker images. * @@ -1384,6 +1671,32 @@ public function listRepositories(ListRepositoriesRequest $request, array $callOp return $this->startApiCall('ListRepositories', $request, $callOptions); } + /** + * Lists rules. + * + * The async variant is {@see ArtifactRegistryClient::listRulesAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/list_rules.php + * + * @param ListRulesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listRules(ListRulesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListRules', $request, $callOptions); + } + /** * Lists tags. * @@ -1490,6 +1803,58 @@ public function testIamPermissions( return $this->startApiCall('TestIamPermissions', $request, $callOptions)->wait(); } + /** + * Updates a file. + * + * The async variant is {@see ArtifactRegistryClient::updateFileAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/update_file.php + * + * @param UpdateFileRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return File + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateFile(UpdateFileRequest $request, array $callOptions = []): File + { + return $this->startApiCall('UpdateFile', $request, $callOptions)->wait(); + } + + /** + * Updates a package. + * + * The async variant is {@see ArtifactRegistryClient::updatePackageAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/update_package.php + * + * @param UpdatePackageRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Package + * + * @throws ApiException Thrown if the API call fails. + */ + public function updatePackage(UpdatePackageRequest $request, array $callOptions = []): Package + { + return $this->startApiCall('UpdatePackage', $request, $callOptions)->wait(); + } + /** * Updates the Settings for the Project. * @@ -1545,6 +1910,32 @@ public function updateRepository(UpdateRepositoryRequest $request, array $callOp return $this->startApiCall('UpdateRepository', $request, $callOptions)->wait(); } + /** + * Updates a rule. + * + * The async variant is {@see ArtifactRegistryClient::updateRuleAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/update_rule.php + * + * @param UpdateRuleRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Rule + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateRule(UpdateRuleRequest $request, array $callOptions = []): Rule + { + return $this->startApiCall('UpdateRule', $request, $callOptions)->wait(); + } + /** * Updates a tag. * @@ -1597,6 +1988,32 @@ public function updateVPCSCConfig(UpdateVPCSCConfigRequest $request, array $call return $this->startApiCall('UpdateVPCSCConfig', $request, $callOptions)->wait(); } + /** + * Updates a version. + * + * The async variant is {@see ArtifactRegistryClient::updateVersionAsync()} . + * + * @example samples/V1/ArtifactRegistryClient/update_version.php + * + * @param UpdateVersionRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Version + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateVersion(UpdateVersionRequest $request, array $callOptions = []): Version + { + return $this->startApiCall('UpdateVersion', $request, $callOptions)->wait(); + } + /** * Gets information about a location. * diff --git a/ArtifactRegistry/src/V1/CreateAttachmentRequest.php b/ArtifactRegistry/src/V1/CreateAttachmentRequest.php new file mode 100644 index 000000000000..595ccb3ed8a3 --- /dev/null +++ b/ArtifactRegistry/src/V1/CreateAttachmentRequest.php @@ -0,0 +1,168 @@ +google.devtools.artifactregistry.v1.CreateAttachmentRequest + */ +class CreateAttachmentRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the parent resource where the attachment will be + * created. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The attachment id to use for this attachment. + * + * Generated from protobuf field string attachment_id = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $attachment_id = ''; + /** + * Required. The attachment to be created. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Attachment attachment = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $attachment = null; + + /** + * @param string $parent Required. The name of the parent resource where the attachment will be + * created. Please see + * {@see ArtifactRegistryClient::repositoryName()} for help formatting this field. + * @param \Google\Cloud\ArtifactRegistry\V1\Attachment $attachment Required. The attachment to be created. + * @param string $attachmentId Required. The attachment id to use for this attachment. + * + * @return \Google\Cloud\ArtifactRegistry\V1\CreateAttachmentRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\ArtifactRegistry\V1\Attachment $attachment, string $attachmentId): self + { + return (new self()) + ->setParent($parent) + ->setAttachment($attachment) + ->setAttachmentId($attachmentId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The name of the parent resource where the attachment will be + * created. + * @type string $attachment_id + * Required. The attachment id to use for this attachment. + * @type \Google\Cloud\ArtifactRegistry\V1\Attachment $attachment + * Required. The attachment to be created. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Attachment::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the parent resource where the attachment will be + * created. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The name of the parent resource where the attachment will be + * created. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The attachment id to use for this attachment. + * + * Generated from protobuf field string attachment_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getAttachmentId() + { + return $this->attachment_id; + } + + /** + * Required. The attachment id to use for this attachment. + * + * Generated from protobuf field string attachment_id = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setAttachmentId($var) + { + GPBUtil::checkString($var, True); + $this->attachment_id = $var; + + return $this; + } + + /** + * Required. The attachment to be created. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Attachment attachment = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\ArtifactRegistry\V1\Attachment|null + */ + public function getAttachment() + { + return $this->attachment; + } + + public function hasAttachment() + { + return isset($this->attachment); + } + + public function clearAttachment() + { + unset($this->attachment); + } + + /** + * Required. The attachment to be created. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Attachment attachment = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\ArtifactRegistry\V1\Attachment $var + * @return $this + */ + public function setAttachment($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\Attachment::class); + $this->attachment = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/CreateRuleRequest.php b/ArtifactRegistry/src/V1/CreateRuleRequest.php new file mode 100644 index 000000000000..a088d5919b2e --- /dev/null +++ b/ArtifactRegistry/src/V1/CreateRuleRequest.php @@ -0,0 +1,163 @@ +google.devtools.artifactregistry.v1.CreateRuleRequest + */ +class CreateRuleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the parent resource where the rule will be created. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * The rule id to use for this repository. + * + * Generated from protobuf field string rule_id = 2; + */ + protected $rule_id = ''; + /** + * The rule to be created. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule rule = 3; + */ + protected $rule = null; + + /** + * @param string $parent Required. The name of the parent resource where the rule will be created. Please see + * {@see ArtifactRegistryClient::repositoryName()} for help formatting this field. + * @param \Google\Cloud\ArtifactRegistry\V1\Rule $rule The rule to be created. + * @param string $ruleId The rule id to use for this repository. + * + * @return \Google\Cloud\ArtifactRegistry\V1\CreateRuleRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\ArtifactRegistry\V1\Rule $rule, string $ruleId): self + { + return (new self()) + ->setParent($parent) + ->setRule($rule) + ->setRuleId($ruleId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The name of the parent resource where the rule will be created. + * @type string $rule_id + * The rule id to use for this repository. + * @type \Google\Cloud\ArtifactRegistry\V1\Rule $rule + * The rule to be created. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Rule::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the parent resource where the rule will be created. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The name of the parent resource where the rule will be created. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * The rule id to use for this repository. + * + * Generated from protobuf field string rule_id = 2; + * @return string + */ + public function getRuleId() + { + return $this->rule_id; + } + + /** + * The rule id to use for this repository. + * + * Generated from protobuf field string rule_id = 2; + * @param string $var + * @return $this + */ + public function setRuleId($var) + { + GPBUtil::checkString($var, True); + $this->rule_id = $var; + + return $this; + } + + /** + * The rule to be created. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule rule = 3; + * @return \Google\Cloud\ArtifactRegistry\V1\Rule|null + */ + public function getRule() + { + return $this->rule; + } + + public function hasRule() + { + return isset($this->rule); + } + + public function clearRule() + { + unset($this->rule); + } + + /** + * The rule to be created. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule rule = 3; + * @param \Google\Cloud\ArtifactRegistry\V1\Rule $var + * @return $this + */ + public function setRule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\Rule::class); + $this->rule = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/DeleteAttachmentRequest.php b/ArtifactRegistry/src/V1/DeleteAttachmentRequest.php new file mode 100644 index 000000000000..5b9bf5f09725 --- /dev/null +++ b/ArtifactRegistry/src/V1/DeleteAttachmentRequest.php @@ -0,0 +1,81 @@ +google.devtools.artifactregistry.v1.DeleteAttachmentRequest + */ +class DeleteAttachmentRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the attachment to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the attachment to delete. Please see + * {@see ArtifactRegistryClient::attachmentName()} for help formatting this field. + * + * @return \Google\Cloud\ArtifactRegistry\V1\DeleteAttachmentRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the attachment to delete. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Attachment::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the attachment to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the attachment to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/DeleteFileRequest.php b/ArtifactRegistry/src/V1/DeleteFileRequest.php new file mode 100644 index 000000000000..0a1b6041a92d --- /dev/null +++ b/ArtifactRegistry/src/V1/DeleteFileRequest.php @@ -0,0 +1,81 @@ +google.devtools.artifactregistry.v1.DeleteFileRequest + */ +class DeleteFileRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the file to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the file to delete. Please see + * {@see ArtifactRegistryClient::fileName()} for help formatting this field. + * + * @return \Google\Cloud\ArtifactRegistry\V1\DeleteFileRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the file to delete. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\File::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the file to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the file to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/DeleteRuleRequest.php b/ArtifactRegistry/src/V1/DeleteRuleRequest.php new file mode 100644 index 000000000000..1f09d0e1cb48 --- /dev/null +++ b/ArtifactRegistry/src/V1/DeleteRuleRequest.php @@ -0,0 +1,81 @@ +google.devtools.artifactregistry.v1.DeleteRuleRequest + */ +class DeleteRuleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the rule to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the rule to delete. Please see + * {@see ArtifactRegistryClient::ruleName()} for help formatting this field. + * + * @return \Google\Cloud\ArtifactRegistry\V1\DeleteRuleRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the rule to delete. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Rule::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the rule to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the rule to delete. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/File.php b/ArtifactRegistry/src/V1/File.php index a9aa22d95500..78f5157fbf56 100644 --- a/ArtifactRegistry/src/V1/File.php +++ b/ArtifactRegistry/src/V1/File.php @@ -17,7 +17,7 @@ class File extends \Google\Protobuf\Internal\Message { /** * The name of the file, for example: - * "projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt". + * `projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt`. * If the file ID part contains slashes, they are escaped. * * Generated from protobuf field string name = 1; @@ -60,6 +60,12 @@ class File extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Timestamp fetch_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $fetch_time = null; + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; /** * Constructor. @@ -69,7 +75,7 @@ class File extends \Google\Protobuf\Internal\Message * * @type string $name * The name of the file, for example: - * "projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt". + * `projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt`. * If the file ID part contains slashes, they are escaped. * @type int|string $size_bytes * The size of the File in bytes. @@ -84,6 +90,8 @@ class File extends \Google\Protobuf\Internal\Message * @type \Google\Protobuf\Timestamp $fetch_time * Output only. The time when the last attempt to refresh the file's data was * made. Only set when the repository is remote. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. Client specified annotations. * } */ public function __construct($data = NULL) { @@ -93,7 +101,7 @@ public function __construct($data = NULL) { /** * The name of the file, for example: - * "projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt". + * `projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt`. * If the file ID part contains slashes, they are escaped. * * Generated from protobuf field string name = 1; @@ -106,7 +114,7 @@ public function getName() /** * The name of the file, for example: - * "projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt". + * `projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt`. * If the file ID part contains slashes, they are escaped. * * Generated from protobuf field string name = 1; @@ -309,5 +317,31 @@ public function setFetchTime($var) return $this; } + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + } diff --git a/ArtifactRegistry/src/V1/GenericArtifact.php b/ArtifactRegistry/src/V1/GenericArtifact.php new file mode 100644 index 000000000000..4a6efd0137ef --- /dev/null +++ b/ArtifactRegistry/src/V1/GenericArtifact.php @@ -0,0 +1,205 @@ +google.devtools.artifactregistry.v1.GenericArtifact + */ +class GenericArtifact extends \Google\Protobuf\Internal\Message +{ + /** + * Resource name of the generic artifact. + * project, location, repository, package_id and version_id + * create a unique generic artifact. + * i.e. "projects/test-project/locations/us-west4/repositories/test-repo/ + * genericArtifacts/package_id:version_id" + * + * Generated from protobuf field string name = 1; + */ + protected $name = ''; + /** + * The version of the generic artifact. + * + * Generated from protobuf field string version = 2; + */ + protected $version = ''; + /** + * Output only. The time when the Generic module is created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time when the Generic module is updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Resource name of the generic artifact. + * project, location, repository, package_id and version_id + * create a unique generic artifact. + * i.e. "projects/test-project/locations/us-west4/repositories/test-repo/ + * genericArtifacts/package_id:version_id" + * @type string $version + * The version of the generic artifact. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the Generic module is created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the Generic module is updated. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Generic::initOnce(); + parent::__construct($data); + } + + /** + * Resource name of the generic artifact. + * project, location, repository, package_id and version_id + * create a unique generic artifact. + * i.e. "projects/test-project/locations/us-west4/repositories/test-repo/ + * genericArtifacts/package_id:version_id" + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Resource name of the generic artifact. + * project, location, repository, package_id and version_id + * create a unique generic artifact. + * i.e. "projects/test-project/locations/us-west4/repositories/test-repo/ + * genericArtifacts/package_id:version_id" + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * The version of the generic artifact. + * + * Generated from protobuf field string version = 2; + * @return string + */ + public function getVersion() + { + return $this->version; + } + + /** + * The version of the generic artifact. + * + * Generated from protobuf field string version = 2; + * @param string $var + * @return $this + */ + public function setVersion($var) + { + GPBUtil::checkString($var, True); + $this->version = $var; + + return $this; + } + + /** + * Output only. The time when the Generic module is created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the Generic module is created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time when the Generic module is updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the Generic module is updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/GetAttachmentRequest.php b/ArtifactRegistry/src/V1/GetAttachmentRequest.php new file mode 100644 index 000000000000..b06cb6b7177b --- /dev/null +++ b/ArtifactRegistry/src/V1/GetAttachmentRequest.php @@ -0,0 +1,81 @@ +google.devtools.artifactregistry.v1.GetAttachmentRequest + */ +class GetAttachmentRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the attachment to retrieve. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the attachment to retrieve. Please see + * {@see ArtifactRegistryClient::attachmentName()} for help formatting this field. + * + * @return \Google\Cloud\ArtifactRegistry\V1\GetAttachmentRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the attachment to retrieve. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Attachment::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the attachment to retrieve. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the attachment to retrieve. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/GetRuleRequest.php b/ArtifactRegistry/src/V1/GetRuleRequest.php new file mode 100644 index 000000000000..1e23880ca5ca --- /dev/null +++ b/ArtifactRegistry/src/V1/GetRuleRequest.php @@ -0,0 +1,81 @@ +google.devtools.artifactregistry.v1.GetRuleRequest + */ +class GetRuleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the rule to retrieve. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the rule to retrieve. Please see + * {@see ArtifactRegistryClient::ruleName()} for help formatting this field. + * + * @return \Google\Cloud\ArtifactRegistry\V1\GetRuleRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the rule to retrieve. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Rule::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the rule to retrieve. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the rule to retrieve. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/ListAttachmentsRequest.php b/ArtifactRegistry/src/V1/ListAttachmentsRequest.php new file mode 100644 index 000000000000..9717a3807920 --- /dev/null +++ b/ArtifactRegistry/src/V1/ListAttachmentsRequest.php @@ -0,0 +1,199 @@ +google.devtools.artifactregistry.v1.ListAttachmentsRequest + */ +class ListAttachmentsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the parent resource whose attachments will be listed. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `target` + * * `type` + * * `attachment_namespace` + * + * Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * The maximum number of attachments to return. Maximum page size is 1,000. + * + * Generated from protobuf field int32 page_size = 3; + */ + protected $page_size = 0; + /** + * The next_page_token value returned from a previous list request, if any. + * + * Generated from protobuf field string page_token = 4; + */ + protected $page_token = ''; + + /** + * @param string $parent Required. The name of the parent resource whose attachments will be listed. Please see + * {@see ArtifactRegistryClient::repositoryName()} for help formatting this field. + * + * @return \Google\Cloud\ArtifactRegistry\V1\ListAttachmentsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The name of the parent resource whose attachments will be listed. + * @type string $filter + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `target` + * * `type` + * * `attachment_namespace` + * @type int $page_size + * The maximum number of attachments to return. Maximum page size is 1,000. + * @type string $page_token + * The next_page_token value returned from a previous list request, if any. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Attachment::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the parent resource whose attachments will be listed. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The name of the parent resource whose attachments will be listed. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `target` + * * `type` + * * `attachment_namespace` + * + * Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `target` + * * `type` + * * `attachment_namespace` + * + * Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * The maximum number of attachments to return. Maximum page size is 1,000. + * + * Generated from protobuf field int32 page_size = 3; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * The maximum number of attachments to return. Maximum page size is 1,000. + * + * Generated from protobuf field int32 page_size = 3; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * The next_page_token value returned from a previous list request, if any. + * + * Generated from protobuf field string page_token = 4; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * The next_page_token value returned from a previous list request, if any. + * + * Generated from protobuf field string page_token = 4; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/ListAttachmentsResponse.php b/ArtifactRegistry/src/V1/ListAttachmentsResponse.php new file mode 100644 index 000000000000..81c1780e2d0b --- /dev/null +++ b/ArtifactRegistry/src/V1/ListAttachmentsResponse.php @@ -0,0 +1,105 @@ +google.devtools.artifactregistry.v1.ListAttachmentsResponse + */ +class ListAttachmentsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The attachments returned. + * + * Generated from protobuf field repeated .google.devtools.artifactregistry.v1.Attachment attachments = 1; + */ + private $attachments; + /** + * The token to retrieve the next page of attachments, or empty if there are + * no more attachments to return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\ArtifactRegistry\V1\Attachment>|\Google\Protobuf\Internal\RepeatedField $attachments + * The attachments returned. + * @type string $next_page_token + * The token to retrieve the next page of attachments, or empty if there are + * no more attachments to return. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Attachment::initOnce(); + parent::__construct($data); + } + + /** + * The attachments returned. + * + * Generated from protobuf field repeated .google.devtools.artifactregistry.v1.Attachment attachments = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAttachments() + { + return $this->attachments; + } + + /** + * The attachments returned. + * + * Generated from protobuf field repeated .google.devtools.artifactregistry.v1.Attachment attachments = 1; + * @param array<\Google\Cloud\ArtifactRegistry\V1\Attachment>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAttachments($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\ArtifactRegistry\V1\Attachment::class); + $this->attachments = $arr; + + return $this; + } + + /** + * The token to retrieve the next page of attachments, or empty if there are + * no more attachments to return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * The token to retrieve the next page of attachments, or empty if there are + * no more attachments to return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/ListDockerImagesRequest.php b/ArtifactRegistry/src/V1/ListDockerImagesRequest.php index 6b0dff272eab..fc3d59be882a 100644 --- a/ArtifactRegistry/src/V1/ListDockerImagesRequest.php +++ b/ArtifactRegistry/src/V1/ListDockerImagesRequest.php @@ -23,7 +23,7 @@ class ListDockerImagesRequest extends \Google\Protobuf\Internal\Message */ protected $parent = ''; /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; */ @@ -65,7 +65,7 @@ public static function build(string $parent): self * Required. The name of the parent resource whose docker images will be * listed. * @type int $page_size - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * @type string $page_token * The next_page_token value returned from a previous list request, if any. * @type string $order_by @@ -106,7 +106,7 @@ public function setParent($var) } /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @return int @@ -117,7 +117,7 @@ public function getPageSize() } /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @param int $var diff --git a/ArtifactRegistry/src/V1/ListFilesRequest.php b/ArtifactRegistry/src/V1/ListFilesRequest.php index f8cf0a6173ca..9e06eec43575 100644 --- a/ArtifactRegistry/src/V1/ListFilesRequest.php +++ b/ArtifactRegistry/src/V1/ListFilesRequest.php @@ -27,17 +27,42 @@ class ListFilesRequest extends \Google\Protobuf\Internal\Message * case insensitive. The fields eligible for filtering are: * * `name` * * `owner` - * An example of using a filter: - * * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an - * ID starting with "a/b/". - * * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> - * Files owned by the version `1.0` in package `pkg1`. + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to files with the name `my_file.txt` + * in project `my-project` in the `us-central` region, in repository + * `my-repo`, append the following filter expression to your request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"` + * To filter the results of your request to files owned by the version `1.0` + * in package `pkg1`, append the following filter expression to your request: + * * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` + * To filter the results of your request to files with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request: + * * `"annotations.external_link:external_link_value"` + * To filter just for a specific annotation key `external_link`, append the + * following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to files with the annotation key-value pair + * [`external.link`:`https://example.com/my-file`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-file`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` * * Generated from protobuf field string filter = 4; */ protected $filter = ''; /** - * The maximum number of files to return. + * The maximum number of files to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; */ @@ -84,13 +109,38 @@ public static function build(string $parent): self * case insensitive. The fields eligible for filtering are: * * `name` * * `owner` - * An example of using a filter: - * * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an - * ID starting with "a/b/". - * * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> - * Files owned by the version `1.0` in package `pkg1`. + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to files with the name `my_file.txt` + * in project `my-project` in the `us-central` region, in repository + * `my-repo`, append the following filter expression to your request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"` + * To filter the results of your request to files owned by the version `1.0` + * in package `pkg1`, append the following filter expression to your request: + * * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` + * To filter the results of your request to files with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request: + * * `"annotations.external_link:external_link_value"` + * To filter just for a specific annotation key `external_link`, append the + * following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to files with the annotation key-value pair + * [`external.link`:`https://example.com/my-file`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-file`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` * @type int $page_size - * The maximum number of files to return. + * The maximum number of files to return. Maximum page size is 1,000. * @type string $page_token * The next_page_token value returned from a previous list request, if any. * @type string $order_by @@ -135,11 +185,36 @@ public function setParent($var) * case insensitive. The fields eligible for filtering are: * * `name` * * `owner` - * An example of using a filter: - * * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an - * ID starting with "a/b/". - * * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> - * Files owned by the version `1.0` in package `pkg1`. + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to files with the name `my_file.txt` + * in project `my-project` in the `us-central` region, in repository + * `my-repo`, append the following filter expression to your request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"` + * To filter the results of your request to files owned by the version `1.0` + * in package `pkg1`, append the following filter expression to your request: + * * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` + * To filter the results of your request to files with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request: + * * `"annotations.external_link:external_link_value"` + * To filter just for a specific annotation key `external_link`, append the + * following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to files with the annotation key-value pair + * [`external.link`:`https://example.com/my-file`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-file`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` * * Generated from protobuf field string filter = 4; * @return string @@ -154,11 +229,36 @@ public function getFilter() * case insensitive. The fields eligible for filtering are: * * `name` * * `owner` - * An example of using a filter: - * * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an - * ID starting with "a/b/". - * * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> - * Files owned by the version `1.0` in package `pkg1`. + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to files with the name `my_file.txt` + * in project `my-project` in the `us-central` region, in repository + * `my-repo`, append the following filter expression to your request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"` + * To filter the results of your request to files owned by the version `1.0` + * in package `pkg1`, append the following filter expression to your request: + * * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` + * To filter the results of your request to files with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request: + * * `"annotations.external_link:external_link_value"` + * To filter just for a specific annotation key `external_link`, append the + * following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to files with the annotation key-value pair + * [`external.link`:`https://example.com/my-file`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-file`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` * * Generated from protobuf field string filter = 4; * @param string $var @@ -173,7 +273,7 @@ public function setFilter($var) } /** - * The maximum number of files to return. + * The maximum number of files to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @return int @@ -184,7 +284,7 @@ public function getPageSize() } /** - * The maximum number of files to return. + * The maximum number of files to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @param int $var diff --git a/ArtifactRegistry/src/V1/ListMavenArtifactsRequest.php b/ArtifactRegistry/src/V1/ListMavenArtifactsRequest.php index 4db5ada82688..5f9eca2db026 100644 --- a/ArtifactRegistry/src/V1/ListMavenArtifactsRequest.php +++ b/ArtifactRegistry/src/V1/ListMavenArtifactsRequest.php @@ -23,7 +23,7 @@ class ListMavenArtifactsRequest extends \Google\Protobuf\Internal\Message */ protected $parent = ''; /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; */ @@ -60,7 +60,7 @@ public static function build(string $parent): self * Required. The name of the parent resource whose maven artifacts will be * listed. * @type int $page_size - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * @type string $page_token * The next_page_token value returned from a previous list request, if any. * } @@ -99,7 +99,7 @@ public function setParent($var) } /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @return int @@ -110,7 +110,7 @@ public function getPageSize() } /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @param int $var diff --git a/ArtifactRegistry/src/V1/ListNpmPackagesRequest.php b/ArtifactRegistry/src/V1/ListNpmPackagesRequest.php index 66ab4c44a7c4..4c33928e1271 100644 --- a/ArtifactRegistry/src/V1/ListNpmPackagesRequest.php +++ b/ArtifactRegistry/src/V1/ListNpmPackagesRequest.php @@ -23,7 +23,7 @@ class ListNpmPackagesRequest extends \Google\Protobuf\Internal\Message */ protected $parent = ''; /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; */ @@ -60,7 +60,7 @@ public static function build(string $parent): self * Required. The name of the parent resource whose npm packages will be * listed. * @type int $page_size - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * @type string $page_token * The next_page_token value returned from a previous list request, if any. * } @@ -99,7 +99,7 @@ public function setParent($var) } /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @return int @@ -110,7 +110,7 @@ public function getPageSize() } /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @param int $var diff --git a/ArtifactRegistry/src/V1/ListPackagesRequest.php b/ArtifactRegistry/src/V1/ListPackagesRequest.php index cf8929daaf9d..d4d32aa996fc 100644 --- a/ArtifactRegistry/src/V1/ListPackagesRequest.php +++ b/ArtifactRegistry/src/V1/ListPackagesRequest.php @@ -33,6 +33,48 @@ class ListPackagesRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field string page_token = 3; */ protected $page_token = ''; + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to packages with the name + * `my-package` in project `my-project` in the `us-central` region, in + * repository `my-repo`, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"` + * To filter the results of your request to packages with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request": + * * `"annotations.external_link:external_link_value"` + * To filter the results just for a specific annotation key `external_link`, + * append the following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to packages with the annotation key-value pair + * [`external.link`:`https://example.com/my-package`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-package`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. The field to order the results by. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; /** * @param string $parent Required. The name of the parent resource whose packages will be listed. Please see @@ -60,6 +102,40 @@ public static function build(string $parent): self * The maximum number of packages to return. Maximum page size is 1,000. * @type string $page_token * The next_page_token value returned from a previous list request, if any. + * @type string $filter + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to packages with the name + * `my-package` in project `my-project` in the `us-central` region, in + * repository `my-repo`, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"` + * To filter the results of your request to packages with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request": + * * `"annotations.external_link:external_link_value"` + * To filter the results just for a specific annotation key `external_link`, + * append the following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to packages with the annotation key-value pair + * [`external.link`:`https://example.com/my-package`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-package`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` + * @type string $order_by + * Optional. The field to order the results by. * } */ public function __construct($data = NULL) { @@ -145,5 +221,117 @@ public function setPageToken($var) return $this; } + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to packages with the name + * `my-package` in project `my-project` in the `us-central` region, in + * repository `my-repo`, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"` + * To filter the results of your request to packages with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request": + * * `"annotations.external_link:external_link_value"` + * To filter the results just for a specific annotation key `external_link`, + * append the following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to packages with the annotation key-value pair + * [`external.link`:`https://example.com/my-package`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-package`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to packages with the name + * `my-package` in project `my-project` in the `us-central` region, in + * repository `my-repo`, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"` + * To filter the results of your request to packages with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request": + * * `"annotations.external_link:external_link_value"` + * To filter the results just for a specific annotation key `external_link`, + * append the following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to packages with the annotation key-value pair + * [`external.link`:`https://example.com/my-package`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-package`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. The field to order the results by. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The field to order the results by. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + } diff --git a/ArtifactRegistry/src/V1/ListPythonPackagesRequest.php b/ArtifactRegistry/src/V1/ListPythonPackagesRequest.php index a49653837a14..0435c92ec3b7 100644 --- a/ArtifactRegistry/src/V1/ListPythonPackagesRequest.php +++ b/ArtifactRegistry/src/V1/ListPythonPackagesRequest.php @@ -23,7 +23,7 @@ class ListPythonPackagesRequest extends \Google\Protobuf\Internal\Message */ protected $parent = ''; /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; */ @@ -60,7 +60,7 @@ public static function build(string $parent): self * Required. The name of the parent resource whose python packages will be * listed. * @type int $page_size - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * @type string $page_token * The next_page_token value returned from a previous list request, if any. * } @@ -99,7 +99,7 @@ public function setParent($var) } /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @return int @@ -110,7 +110,7 @@ public function getPageSize() } /** - * The maximum number of artifacts to return. + * The maximum number of artifacts to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @param int $var diff --git a/ArtifactRegistry/src/V1/ListRepositoriesRequest.php b/ArtifactRegistry/src/V1/ListRepositoriesRequest.php index 6c4d1e49225d..968b3ea9eb1d 100644 --- a/ArtifactRegistry/src/V1/ListRepositoriesRequest.php +++ b/ArtifactRegistry/src/V1/ListRepositoriesRequest.php @@ -34,6 +34,30 @@ class ListRepositoriesRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field string page_token = 3; */ protected $page_token = ''; + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * Examples of using a filter: + * To filter the results of your request to repositories with the name + * `my-repo` in project `my-project` in the `us-central` region, append the + * following filter expression to your request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/*repo"` + * * `name="projects/my-project/locations/us-central1/repositories/*repo*"` + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. The field to order the results by. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; /** * @param string $parent Required. The name of the parent resource whose repositories will be @@ -63,6 +87,22 @@ public static function build(string $parent): self * The maximum number of repositories to return. Maximum page size is 1,000. * @type string $page_token * The next_page_token value returned from a previous list request, if any. + * @type string $filter + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * Examples of using a filter: + * To filter the results of your request to repositories with the name + * `my-repo` in project `my-project` in the `us-central` region, append the + * following filter expression to your request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/*repo"` + * * `name="projects/my-project/locations/us-central1/repositories/*repo*"` + * @type string $order_by + * Optional. The field to order the results by. * } */ public function __construct($data = NULL) { @@ -150,5 +190,81 @@ public function setPageToken($var) return $this; } + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * Examples of using a filter: + * To filter the results of your request to repositories with the name + * `my-repo` in project `my-project` in the `us-central` region, append the + * following filter expression to your request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/*repo"` + * * `name="projects/my-project/locations/us-central1/repositories/*repo*"` + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * Examples of using a filter: + * To filter the results of your request to repositories with the name + * `my-repo` in project `my-project` in the `us-central` region, append the + * following filter expression to your request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-*"` + * * `name="projects/my-project/locations/us-central1/repositories/*repo"` + * * `name="projects/my-project/locations/us-central1/repositories/*repo*"` + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. The field to order the results by. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The field to order the results by. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + } diff --git a/ArtifactRegistry/src/V1/ListRulesRequest.php b/ArtifactRegistry/src/V1/ListRulesRequest.php new file mode 100644 index 000000000000..0e1d3f2a3e30 --- /dev/null +++ b/ArtifactRegistry/src/V1/ListRulesRequest.php @@ -0,0 +1,159 @@ +google.devtools.artifactregistry.v1.ListRulesRequest + */ +class ListRulesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the parent repository whose rules will be listed. + * For example: + * `projects/p1/locations/us-central1/repositories/repo1`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * The maximum number of rules to return. Maximum page size is 1,000. + * + * Generated from protobuf field int32 page_size = 2; + */ + protected $page_size = 0; + /** + * The next_page_token value returned from a previous list request, if any. + * + * Generated from protobuf field string page_token = 3; + */ + protected $page_token = ''; + + /** + * @param string $parent Required. The name of the parent repository whose rules will be listed. + * For example: + * `projects/p1/locations/us-central1/repositories/repo1`. Please see + * {@see ArtifactRegistryClient::repositoryName()} for help formatting this field. + * + * @return \Google\Cloud\ArtifactRegistry\V1\ListRulesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The name of the parent repository whose rules will be listed. + * For example: + * `projects/p1/locations/us-central1/repositories/repo1`. + * @type int $page_size + * The maximum number of rules to return. Maximum page size is 1,000. + * @type string $page_token + * The next_page_token value returned from a previous list request, if any. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Rule::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the parent repository whose rules will be listed. + * For example: + * `projects/p1/locations/us-central1/repositories/repo1`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The name of the parent repository whose rules will be listed. + * For example: + * `projects/p1/locations/us-central1/repositories/repo1`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * The maximum number of rules to return. Maximum page size is 1,000. + * + * Generated from protobuf field int32 page_size = 2; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * The maximum number of rules to return. Maximum page size is 1,000. + * + * Generated from protobuf field int32 page_size = 2; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * The next_page_token value returned from a previous list request, if any. + * + * Generated from protobuf field string page_token = 3; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * The next_page_token value returned from a previous list request, if any. + * + * Generated from protobuf field string page_token = 3; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/ListRulesResponse.php b/ArtifactRegistry/src/V1/ListRulesResponse.php new file mode 100644 index 000000000000..bc9bcda95a7b --- /dev/null +++ b/ArtifactRegistry/src/V1/ListRulesResponse.php @@ -0,0 +1,105 @@ +google.devtools.artifactregistry.v1.ListRulesResponse + */ +class ListRulesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The rules returned. + * + * Generated from protobuf field repeated .google.devtools.artifactregistry.v1.Rule rules = 1; + */ + private $rules; + /** + * The token to retrieve the next page of rules, or empty if there are no + * more rules to return. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\ArtifactRegistry\V1\Rule>|\Google\Protobuf\Internal\RepeatedField $rules + * The rules returned. + * @type string $next_page_token + * The token to retrieve the next page of rules, or empty if there are no + * more rules to return. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Rule::initOnce(); + parent::__construct($data); + } + + /** + * The rules returned. + * + * Generated from protobuf field repeated .google.devtools.artifactregistry.v1.Rule rules = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRules() + { + return $this->rules; + } + + /** + * The rules returned. + * + * Generated from protobuf field repeated .google.devtools.artifactregistry.v1.Rule rules = 1; + * @param array<\Google\Cloud\ArtifactRegistry\V1\Rule>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRules($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\ArtifactRegistry\V1\Rule::class); + $this->rules = $arr; + + return $this; + } + + /** + * The token to retrieve the next page of rules, or empty if there are no + * more rules to return. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * The token to retrieve the next page of rules, or empty if there are no + * more rules to return. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/ListTagsRequest.php b/ArtifactRegistry/src/V1/ListTagsRequest.php index 3f5b8a81b0c6..91c35567cfe5 100644 --- a/ArtifactRegistry/src/V1/ListTagsRequest.php +++ b/ArtifactRegistry/src/V1/ListTagsRequest.php @@ -26,16 +26,29 @@ class ListTagsRequest extends \Google\Protobuf\Internal\Message /** * An expression for filtering the results of the request. Filter rules are * case insensitive. The fields eligible for filtering are: + * * `name` * * `version` - * An example of using a filter: - * * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` - * --> Tags that are applied to the version `1.0` in package `pkg1`. + * Examples of using a filter: + * To filter the results of your request to tags with the name `my-tag` in + * package `my-package` in repository `my-repo` in project "`y-project` in + * the us-central region, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` + * To filter the results of your request to tags applied to the version + * `1.0` in package `my-package`, append the following filter expression to + * your request: + * * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` * * Generated from protobuf field string filter = 4; */ protected $filter = ''; /** - * The maximum number of tags to return. Maximum page size is 10,000. + * The maximum number of tags to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; */ @@ -75,12 +88,25 @@ public static function build(string $parent): self * @type string $filter * An expression for filtering the results of the request. Filter rules are * case insensitive. The fields eligible for filtering are: + * * `name` * * `version` - * An example of using a filter: - * * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` - * --> Tags that are applied to the version `1.0` in package `pkg1`. + * Examples of using a filter: + * To filter the results of your request to tags with the name `my-tag` in + * package `my-package` in repository `my-repo` in project "`y-project` in + * the us-central region, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` + * To filter the results of your request to tags applied to the version + * `1.0` in package `my-package`, append the following filter expression to + * your request: + * * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` * @type int $page_size - * The maximum number of tags to return. Maximum page size is 10,000. + * The maximum number of tags to return. Maximum page size is 1,000. * @type string $page_token * The next_page_token value returned from a previous list request, if any. * } @@ -123,10 +149,23 @@ public function setParent($var) /** * An expression for filtering the results of the request. Filter rules are * case insensitive. The fields eligible for filtering are: + * * `name` * * `version` - * An example of using a filter: - * * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` - * --> Tags that are applied to the version `1.0` in package `pkg1`. + * Examples of using a filter: + * To filter the results of your request to tags with the name `my-tag` in + * package `my-package` in repository `my-repo` in project "`y-project` in + * the us-central region, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` + * To filter the results of your request to tags applied to the version + * `1.0` in package `my-package`, append the following filter expression to + * your request: + * * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` * * Generated from protobuf field string filter = 4; * @return string @@ -139,10 +178,23 @@ public function getFilter() /** * An expression for filtering the results of the request. Filter rules are * case insensitive. The fields eligible for filtering are: + * * `name` * * `version` - * An example of using a filter: - * * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` - * --> Tags that are applied to the version `1.0` in package `pkg1`. + * Examples of using a filter: + * To filter the results of your request to tags with the name `my-tag` in + * package `my-package` in repository `my-repo` in project "`y-project` in + * the us-central region, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` + * To filter the results of your request to tags applied to the version + * `1.0` in package `my-package`, append the following filter expression to + * your request: + * * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` * * Generated from protobuf field string filter = 4; * @param string $var @@ -157,7 +209,7 @@ public function setFilter($var) } /** - * The maximum number of tags to return. Maximum page size is 10,000. + * The maximum number of tags to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @return int @@ -168,7 +220,7 @@ public function getPageSize() } /** - * The maximum number of tags to return. Maximum page size is 10,000. + * The maximum number of tags to return. Maximum page size is 1,000. * * Generated from protobuf field int32 page_size = 2; * @param int $var diff --git a/ArtifactRegistry/src/V1/ListVersionsRequest.php b/ArtifactRegistry/src/V1/ListVersionsRequest.php index b10835ebe609..e7e73d781b2d 100644 --- a/ArtifactRegistry/src/V1/ListVersionsRequest.php +++ b/ArtifactRegistry/src/V1/ListVersionsRequest.php @@ -45,6 +45,42 @@ class ListVersionsRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $order_by = ''; + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to versions with the name + * `my-version` in project `my-project` in the `us-central` region, in + * repository `my-repo`, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*"` + * To filter the results of your request to versions with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request: + * * `"annotations.external_link:external_link_value"` + * To filter just for a specific annotation key `external_link`, append the + * following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to versions with the annotation key-value pair + * [`external.link`:`https://example.com/my-version`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-version`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` + * + * Generated from protobuf field string filter = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; /** * @param string $parent The name of the parent resource whose versions will be listed. @@ -75,6 +111,38 @@ public static function build(string $parent): self * The view that should be returned in the response. * @type string $order_by * Optional. The field to order the results by. + * @type string $filter + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to versions with the name + * `my-version` in project `my-project` in the `us-central` region, in + * repository `my-repo`, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*"` + * To filter the results of your request to versions with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request: + * * `"annotations.external_link:external_link_value"` + * To filter just for a specific annotation key `external_link`, append the + * following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to versions with the annotation key-value pair + * [`external.link`:`https://example.com/my-version`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-version`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` * } */ public function __construct($data = NULL) { @@ -212,5 +280,91 @@ public function setOrderBy($var) return $this; } + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to versions with the name + * `my-version` in project `my-project` in the `us-central` region, in + * repository `my-repo`, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*"` + * To filter the results of your request to versions with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request: + * * `"annotations.external_link:external_link_value"` + * To filter just for a specific annotation key `external_link`, append the + * following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to versions with the annotation key-value pair + * [`external.link`:`https://example.com/my-version`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-version`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` + * + * Generated from protobuf field string filter = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. An expression for filtering the results of the request. Filter + * rules are case insensitive. The fields eligible for filtering are: + * * `name` + * * `annotations` + * Examples of using a filter: + * To filter the results of your request to versions with the name + * `my-version` in project `my-project` in the `us-central` region, in + * repository `my-repo`, append the following filter expression to your + * request: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version"` + * You can also use wildcards to match any number of characters before or + * after the value: + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*"` + * * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*"` + * To filter the results of your request to versions with the annotation + * key-value pair [`external_link`: `external_link_value`], append the + * following filter expression to your request: + * * `"annotations.external_link:external_link_value"` + * To filter just for a specific annotation key `external_link`, append the + * following filter expression to your request: + * * `"annotations.external_link"` + * If the annotation key or value contains special characters, you can escape + * them by surrounding the value with backticks. For example, to filter the + * results of your request to versions with the annotation key-value pair + * [`external.link`:`https://example.com/my-version`], append the following + * filter expression to your request: + * * `` "annotations.`external.link`:`https://example.com/my-version`" `` + * You can also filter with annotations with a wildcard to + * match any number of characters before or after the value: + * * `` "annotations.*_link:`*example.com*`" `` + * + * Generated from protobuf field string filter = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + } diff --git a/ArtifactRegistry/src/V1/Package.php b/ArtifactRegistry/src/V1/Package.php index a61c4fe1b73a..fb2ef7cd265c 100644 --- a/ArtifactRegistry/src/V1/Package.php +++ b/ArtifactRegistry/src/V1/Package.php @@ -42,6 +42,12 @@ class Package extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Timestamp update_time = 6; */ protected $update_time = null; + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; /** * Constructor. @@ -60,6 +66,8 @@ class Package extends \Google\Protobuf\Internal\Message * @type \Google\Protobuf\Timestamp $update_time * The time when the package was last updated. This includes publishing a new * version of the package. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. Client specified annotations. * } */ public function __construct($data = NULL) { @@ -197,5 +205,31 @@ public function setUpdateTime($var) return $this; } + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + } diff --git a/ArtifactRegistry/src/V1/ProjectSettings.php b/ArtifactRegistry/src/V1/ProjectSettings.php index d9ff5a79afbf..499f6a847b9c 100644 --- a/ArtifactRegistry/src/V1/ProjectSettings.php +++ b/ArtifactRegistry/src/V1/ProjectSettings.php @@ -31,6 +31,13 @@ class ProjectSettings extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.devtools.artifactregistry.v1.ProjectSettings.RedirectionState legacy_redirection_state = 2; */ protected $legacy_redirection_state = 0; + /** + * The percentage of pull traffic to redirect from GCR to AR when using + * partial redirection. + * + * Generated from protobuf field int32 pull_percent = 3; + */ + protected $pull_percent = 0; /** * Constructor. @@ -46,6 +53,9 @@ class ProjectSettings extends \Google\Protobuf\Internal\Message * In response: always set * @type int $legacy_redirection_state * The redirection state of the legacy repositories in this project. + * @type int $pull_percent + * The percentage of pull traffic to redirect from GCR to AR when using + * partial redirection. * } */ public function __construct($data = NULL) { @@ -113,5 +123,33 @@ public function setLegacyRedirectionState($var) return $this; } + /** + * The percentage of pull traffic to redirect from GCR to AR when using + * partial redirection. + * + * Generated from protobuf field int32 pull_percent = 3; + * @return int + */ + public function getPullPercent() + { + return $this->pull_percent; + } + + /** + * The percentage of pull traffic to redirect from GCR to AR when using + * partial redirection. + * + * Generated from protobuf field int32 pull_percent = 3; + * @param int $var + * @return $this + */ + public function setPullPercent($var) + { + GPBUtil::checkInt32($var); + $this->pull_percent = $var; + + return $this; + } + } diff --git a/ArtifactRegistry/src/V1/ProjectSettings/RedirectionState.php b/ArtifactRegistry/src/V1/ProjectSettings/RedirectionState.php index e07820abc46e..49dabdd2afe2 100644 --- a/ArtifactRegistry/src/V1/ProjectSettings/RedirectionState.php +++ b/ArtifactRegistry/src/V1/ProjectSettings/RedirectionState.php @@ -37,12 +37,26 @@ class RedirectionState * Generated from protobuf enum REDIRECTION_FROM_GCR_IO_FINALIZED = 3 [deprecated = true]; */ const REDIRECTION_FROM_GCR_IO_FINALIZED = 3; + /** + * Redirection is enabled and missing images are copied from GCR + * + * Generated from protobuf enum REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING = 5; + */ + const REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING = 5; + /** + * Redirection is partially enabled and missing images are copied from GCR + * + * Generated from protobuf enum REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING = 6; + */ + const REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING = 6; private static $valueToName = [ self::REDIRECTION_STATE_UNSPECIFIED => 'REDIRECTION_STATE_UNSPECIFIED', self::REDIRECTION_FROM_GCR_IO_DISABLED => 'REDIRECTION_FROM_GCR_IO_DISABLED', self::REDIRECTION_FROM_GCR_IO_ENABLED => 'REDIRECTION_FROM_GCR_IO_ENABLED', self::REDIRECTION_FROM_GCR_IO_FINALIZED => 'REDIRECTION_FROM_GCR_IO_FINALIZED', + self::REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING => 'REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING', + self::REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING => 'REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING', ]; public static function name($value) diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig.php index cb55a85f5d2b..35567249d52c 100644 --- a/ArtifactRegistry/src/V1/RemoteRepositoryConfig.php +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig.php @@ -27,6 +27,13 @@ class RemoteRepositoryConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.UpstreamCredentials upstream_credentials = 9 [(.google.api.field_behavior) = OPTIONAL]; */ protected $upstream_credentials = null; + /** + * Input only. A create/update remote repo option to avoid making a HEAD/GET + * request to validate a remote repo and any supplied upstream credentials. + * + * Generated from protobuf field bool disable_upstream_validation = 12 [(.google.api.field_behavior) = INPUT_ONLY]; + */ + protected $disable_upstream_validation = false; protected $remote_source; /** @@ -47,10 +54,16 @@ class RemoteRepositoryConfig extends \Google\Protobuf\Internal\Message * Specific settings for an Apt remote repository. * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\YumRepository $yum_repository * Specific settings for a Yum remote repository. + * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\CommonRemoteRepository $common_repository + * Common remote repository settings. + * Used as the remote repository upstream URL. * @type string $description * The description of the remote source. * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\UpstreamCredentials $upstream_credentials * Optional. The credentials used to access the remote repository. + * @type bool $disable_upstream_validation + * Input only. A create/update remote repo option to avoid making a HEAD/GET + * request to validate a remote repo and any supplied upstream credentials. * } */ public function __construct($data = NULL) { @@ -244,6 +257,39 @@ public function setYumRepository($var) return $this; } + /** + * Common remote repository settings. + * Used as the remote repository upstream URL. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.CommonRemoteRepository common_repository = 14; + * @return \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\CommonRemoteRepository|null + */ + public function getCommonRepository() + { + return $this->readOneof(14); + } + + public function hasCommonRepository() + { + return $this->hasOneof(14); + } + + /** + * Common remote repository settings. + * Used as the remote repository upstream URL. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.CommonRemoteRepository common_repository = 14; + * @param \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\CommonRemoteRepository $var + * @return $this + */ + public function setCommonRepository($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\CommonRemoteRepository::class); + $this->writeOneof(14, $var); + + return $this; + } + /** * The description of the remote source. * @@ -306,6 +352,34 @@ public function setUpstreamCredentials($var) return $this; } + /** + * Input only. A create/update remote repo option to avoid making a HEAD/GET + * request to validate a remote repo and any supplied upstream credentials. + * + * Generated from protobuf field bool disable_upstream_validation = 12 [(.google.api.field_behavior) = INPUT_ONLY]; + * @return bool + */ + public function getDisableUpstreamValidation() + { + return $this->disable_upstream_validation; + } + + /** + * Input only. A create/update remote repo option to avoid making a HEAD/GET + * request to validate a remote repo and any supplied upstream credentials. + * + * Generated from protobuf field bool disable_upstream_validation = 12 [(.google.api.field_behavior) = INPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setDisableUpstreamValidation($var) + { + GPBUtil::checkBool($var); + $this->disable_upstream_validation = $var; + + return $this; + } + /** * @return string */ diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository.php index 18e276a813fc..751a6b19c24d 100644 --- a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository.php +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository.php @@ -26,6 +26,8 @@ class AptRepository extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\AptRepository\PublicRepository $public_repository * One of the publicly available Apt repositories supported by Artifact * Registry. + * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\AptRepository\CustomRepository $custom_repository + * Customer-specified remote repository. * } */ public function __construct($data = NULL) { @@ -66,6 +68,37 @@ public function setPublicRepository($var) return $this; } + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.AptRepository.CustomRepository custom_repository = 3; + * @return \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\AptRepository\CustomRepository|null + */ + public function getCustomRepository() + { + return $this->readOneof(3); + } + + public function hasCustomRepository() + { + return $this->hasOneof(3); + } + + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.AptRepository.CustomRepository custom_repository = 3; + * @param \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\AptRepository\CustomRepository $var + * @return $this + */ + public function setCustomRepository($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\AptRepository\CustomRepository::class); + $this->writeOneof(3, $var); + + return $this; + } + /** * @return string */ diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository/CustomRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository/CustomRepository.php new file mode 100644 index 000000000000..9eda4eafde5b --- /dev/null +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository/CustomRepository.php @@ -0,0 +1,72 @@ +google.devtools.artifactregistry.v1.RemoteRepositoryConfig.AptRepository.CustomRepository + */ +class CustomRepository extends \Google\Protobuf\Internal\Message +{ + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.apt.registry/". + * + * Generated from protobuf field string uri = 1; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.apt.registry/". + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Repository::initOnce(); + parent::__construct($data); + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.apt.registry/". + * + * Generated from protobuf field string uri = 1; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.apt.registry/". + * + * Generated from protobuf field string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + + diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository/PublicRepository/RepositoryBase.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository/PublicRepository/RepositoryBase.php index 54db0e457c47..f15cd6a96f53 100644 --- a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository/PublicRepository/RepositoryBase.php +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/AptRepository/PublicRepository/RepositoryBase.php @@ -31,11 +31,18 @@ class RepositoryBase * Generated from protobuf enum UBUNTU = 2; */ const UBUNTU = 2; + /** + * Archived Debian. + * + * Generated from protobuf enum DEBIAN_SNAPSHOT = 3; + */ + const DEBIAN_SNAPSHOT = 3; private static $valueToName = [ self::REPOSITORY_BASE_UNSPECIFIED => 'REPOSITORY_BASE_UNSPECIFIED', self::DEBIAN => 'DEBIAN', self::UBUNTU => 'UBUNTU', + self::DEBIAN_SNAPSHOT => 'DEBIAN_SNAPSHOT', ]; public static function name($value) diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/CommonRemoteRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/CommonRemoteRepository.php new file mode 100644 index 000000000000..5545f93e6c24 --- /dev/null +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/CommonRemoteRepository.php @@ -0,0 +1,68 @@ +google.devtools.artifactregistry.v1.RemoteRepositoryConfig.CommonRemoteRepository + */ +class CommonRemoteRepository extends \Google\Protobuf\Internal\Message +{ + /** + * Required. A common public repository base for remote repository. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * Required. A common public repository base for remote repository. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Repository::initOnce(); + parent::__construct($data); + } + + /** + * Required. A common public repository base for remote repository. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * Required. A common public repository base for remote repository. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + + diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/DockerRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/DockerRepository.php index 07f77336e9c7..f8f21b6dfa7a 100644 --- a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/DockerRepository.php +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/DockerRepository.php @@ -26,6 +26,8 @@ class DockerRepository extends \Google\Protobuf\Internal\Message * @type int $public_repository * One of the publicly available Docker repositories supported by Artifact * Registry. + * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\DockerRepository\CustomRepository $custom_repository + * Customer-specified remote repository. * } */ public function __construct($data = NULL) { @@ -66,6 +68,37 @@ public function setPublicRepository($var) return $this; } + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.DockerRepository.CustomRepository custom_repository = 3; + * @return \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\DockerRepository\CustomRepository|null + */ + public function getCustomRepository() + { + return $this->readOneof(3); + } + + public function hasCustomRepository() + { + return $this->hasOneof(3); + } + + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.DockerRepository.CustomRepository custom_repository = 3; + * @param \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\DockerRepository\CustomRepository $var + * @return $this + */ + public function setCustomRepository($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\DockerRepository\CustomRepository::class); + $this->writeOneof(3, $var); + + return $this; + } + /** * @return string */ diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/DockerRepository/CustomRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/DockerRepository/CustomRepository.php new file mode 100644 index 000000000000..a11bf9886f6c --- /dev/null +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/DockerRepository/CustomRepository.php @@ -0,0 +1,72 @@ +google.devtools.artifactregistry.v1.RemoteRepositoryConfig.DockerRepository.CustomRepository + */ +class CustomRepository extends \Google\Protobuf\Internal\Message +{ + /** + * An http/https uri reference to the custom remote repository, for ex: + * "https://registry-1.docker.io". + * + * Generated from protobuf field string uri = 1; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * An http/https uri reference to the custom remote repository, for ex: + * "https://registry-1.docker.io". + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Repository::initOnce(); + parent::__construct($data); + } + + /** + * An http/https uri reference to the custom remote repository, for ex: + * "https://registry-1.docker.io". + * + * Generated from protobuf field string uri = 1; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * An http/https uri reference to the custom remote repository, for ex: + * "https://registry-1.docker.io". + * + * Generated from protobuf field string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + + diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/MavenRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/MavenRepository.php index 85653c2ba49d..8559180dc496 100644 --- a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/MavenRepository.php +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/MavenRepository.php @@ -26,6 +26,8 @@ class MavenRepository extends \Google\Protobuf\Internal\Message * @type int $public_repository * One of the publicly available Maven repositories supported by Artifact * Registry. + * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\MavenRepository\CustomRepository $custom_repository + * Customer-specified remote repository. * } */ public function __construct($data = NULL) { @@ -66,6 +68,37 @@ public function setPublicRepository($var) return $this; } + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.MavenRepository.CustomRepository custom_repository = 3; + * @return \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\MavenRepository\CustomRepository|null + */ + public function getCustomRepository() + { + return $this->readOneof(3); + } + + public function hasCustomRepository() + { + return $this->hasOneof(3); + } + + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.MavenRepository.CustomRepository custom_repository = 3; + * @param \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\MavenRepository\CustomRepository $var + * @return $this + */ + public function setCustomRepository($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\MavenRepository\CustomRepository::class); + $this->writeOneof(3, $var); + + return $this; + } + /** * @return string */ diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/MavenRepository/CustomRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/MavenRepository/CustomRepository.php new file mode 100644 index 000000000000..15d4e0b015f6 --- /dev/null +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/MavenRepository/CustomRepository.php @@ -0,0 +1,72 @@ +google.devtools.artifactregistry.v1.RemoteRepositoryConfig.MavenRepository.CustomRepository + */ +class CustomRepository extends \Google\Protobuf\Internal\Message +{ + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.maven.registry/". + * + * Generated from protobuf field string uri = 1; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.maven.registry/". + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Repository::initOnce(); + parent::__construct($data); + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.maven.registry/". + * + * Generated from protobuf field string uri = 1; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.maven.registry/". + * + * Generated from protobuf field string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + + diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/NpmRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/NpmRepository.php index 9dabce6bd8f3..e6a7e0d51970 100644 --- a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/NpmRepository.php +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/NpmRepository.php @@ -26,6 +26,8 @@ class NpmRepository extends \Google\Protobuf\Internal\Message * @type int $public_repository * One of the publicly available Npm repositories supported by Artifact * Registry. + * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\NpmRepository\CustomRepository $custom_repository + * Customer-specified remote repository. * } */ public function __construct($data = NULL) { @@ -66,6 +68,37 @@ public function setPublicRepository($var) return $this; } + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.NpmRepository.CustomRepository custom_repository = 3; + * @return \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\NpmRepository\CustomRepository|null + */ + public function getCustomRepository() + { + return $this->readOneof(3); + } + + public function hasCustomRepository() + { + return $this->hasOneof(3); + } + + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.NpmRepository.CustomRepository custom_repository = 3; + * @param \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\NpmRepository\CustomRepository $var + * @return $this + */ + public function setCustomRepository($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\NpmRepository\CustomRepository::class); + $this->writeOneof(3, $var); + + return $this; + } + /** * @return string */ diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/NpmRepository/CustomRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/NpmRepository/CustomRepository.php new file mode 100644 index 000000000000..fdf6c7619632 --- /dev/null +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/NpmRepository/CustomRepository.php @@ -0,0 +1,72 @@ +google.devtools.artifactregistry.v1.RemoteRepositoryConfig.NpmRepository.CustomRepository + */ +class CustomRepository extends \Google\Protobuf\Internal\Message +{ + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.npm.registry/". + * + * Generated from protobuf field string uri = 1; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.npm.registry/". + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Repository::initOnce(); + parent::__construct($data); + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.npm.registry/". + * + * Generated from protobuf field string uri = 1; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.npm.registry/". + * + * Generated from protobuf field string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + + diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/PythonRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/PythonRepository.php index 8dd53a3ffb4d..4d9ea86e145a 100644 --- a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/PythonRepository.php +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/PythonRepository.php @@ -26,6 +26,8 @@ class PythonRepository extends \Google\Protobuf\Internal\Message * @type int $public_repository * One of the publicly available Python repositories supported by Artifact * Registry. + * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\PythonRepository\CustomRepository $custom_repository + * Customer-specified remote repository. * } */ public function __construct($data = NULL) { @@ -66,6 +68,37 @@ public function setPublicRepository($var) return $this; } + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.PythonRepository.CustomRepository custom_repository = 3; + * @return \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\PythonRepository\CustomRepository|null + */ + public function getCustomRepository() + { + return $this->readOneof(3); + } + + public function hasCustomRepository() + { + return $this->hasOneof(3); + } + + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.PythonRepository.CustomRepository custom_repository = 3; + * @param \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\PythonRepository\CustomRepository $var + * @return $this + */ + public function setCustomRepository($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\PythonRepository\CustomRepository::class); + $this->writeOneof(3, $var); + + return $this; + } + /** * @return string */ diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/PythonRepository/CustomRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/PythonRepository/CustomRepository.php new file mode 100644 index 000000000000..63559216f0e9 --- /dev/null +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/PythonRepository/CustomRepository.php @@ -0,0 +1,72 @@ +google.devtools.artifactregistry.v1.RemoteRepositoryConfig.PythonRepository.CustomRepository + */ +class CustomRepository extends \Google\Protobuf\Internal\Message +{ + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.python.registry/". + * + * Generated from protobuf field string uri = 1; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.python.registry/". + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Repository::initOnce(); + parent::__construct($data); + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.python.registry/". + * + * Generated from protobuf field string uri = 1; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.python.registry/". + * + * Generated from protobuf field string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + + diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/YumRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/YumRepository.php index a9792a1236b4..5e721e529381 100644 --- a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/YumRepository.php +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/YumRepository.php @@ -26,6 +26,8 @@ class YumRepository extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\YumRepository\PublicRepository $public_repository * One of the publicly available Yum repositories supported by Artifact * Registry. + * @type \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\YumRepository\CustomRepository $custom_repository + * Customer-specified remote repository. * } */ public function __construct($data = NULL) { @@ -66,6 +68,37 @@ public function setPublicRepository($var) return $this; } + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.YumRepository.CustomRepository custom_repository = 3; + * @return \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\YumRepository\CustomRepository|null + */ + public function getCustomRepository() + { + return $this->readOneof(3); + } + + public function hasCustomRepository() + { + return $this->hasOneof(3); + } + + /** + * Customer-specified remote repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.RemoteRepositoryConfig.YumRepository.CustomRepository custom_repository = 3; + * @param \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\YumRepository\CustomRepository $var + * @return $this + */ + public function setCustomRepository($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\RemoteRepositoryConfig\YumRepository\CustomRepository::class); + $this->writeOneof(3, $var); + + return $this; + } + /** * @return string */ diff --git a/ArtifactRegistry/src/V1/RemoteRepositoryConfig/YumRepository/CustomRepository.php b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/YumRepository/CustomRepository.php new file mode 100644 index 000000000000..70e161c48890 --- /dev/null +++ b/ArtifactRegistry/src/V1/RemoteRepositoryConfig/YumRepository/CustomRepository.php @@ -0,0 +1,72 @@ +google.devtools.artifactregistry.v1.RemoteRepositoryConfig.YumRepository.CustomRepository + */ +class CustomRepository extends \Google\Protobuf\Internal\Message +{ + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.yum.registry/". + * + * Generated from protobuf field string uri = 1; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.yum.registry/". + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Repository::initOnce(); + parent::__construct($data); + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.yum.registry/". + * + * Generated from protobuf field string uri = 1; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * An http/https uri reference to the upstream remote repository, for ex: + * "https://my.yum.registry/". + * + * Generated from protobuf field string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + + diff --git a/ArtifactRegistry/src/V1/Repository.php b/ArtifactRegistry/src/V1/Repository.php index b162598ad0f5..89434412b4ea 100644 --- a/ArtifactRegistry/src/V1/Repository.php +++ b/ArtifactRegistry/src/V1/Repository.php @@ -17,7 +17,8 @@ class Repository extends \Google\Protobuf\Internal\Message { /** * The name of the repository, for example: - * `projects/p1/locations/us-central1/repositories/repo1`. + * `projects/p1/locations/us-central1/repositories/repo1`. For each location + * in a project, repository names must be unique. * * Generated from protobuf field string name = 1; */ @@ -101,6 +102,26 @@ class Repository extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool cleanup_policy_dry_run = 18 [(.google.api.field_behavior) = OPTIONAL]; */ protected $cleanup_policy_dry_run = false; + /** + * Optional. Config and state for vulnerability scanning of resources within + * this Repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig vulnerability_scanning_config = 19 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $vulnerability_scanning_config = null; + /** + * Optional. If this is true, an unspecified repo type will be treated as + * error rather than defaulting to standard. + * + * Generated from protobuf field bool disallow_unspecified_mode = 21 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disallow_unspecified_mode = false; + /** + * Output only. If set, the repository satisfies physical zone isolation. + * + * Generated from protobuf field bool satisfies_pzi = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $satisfies_pzi = false; protected $format_config; protected $mode_config; @@ -122,7 +143,8 @@ class Repository extends \Google\Protobuf\Internal\Message * Configuration specific for a Remote Repository. * @type string $name * The name of the repository, for example: - * `projects/p1/locations/us-central1/repositories/repo1`. + * `projects/p1/locations/us-central1/repositories/repo1`. For each location + * in a project, repository names must be unique. * @type int $format * Optional. The format of packages that are stored in the repository. * @type string $description @@ -158,6 +180,14 @@ class Repository extends \Google\Protobuf\Internal\Message * @type bool $cleanup_policy_dry_run * Optional. If true, the cleanup pipeline is prevented from deleting versions * in this repository. + * @type \Google\Cloud\ArtifactRegistry\V1\Repository\VulnerabilityScanningConfig $vulnerability_scanning_config + * Optional. Config and state for vulnerability scanning of resources within + * this Repository. + * @type bool $disallow_unspecified_mode + * Optional. If this is true, an unspecified repo type will be treated as + * error rather than defaulting to standard. + * @type bool $satisfies_pzi + * Output only. If set, the repository satisfies physical zone isolation. * } */ public function __construct($data = NULL) { @@ -295,7 +325,8 @@ public function setRemoteRepositoryConfig($var) /** * The name of the repository, for example: - * `projects/p1/locations/us-central1/repositories/repo1`. + * `projects/p1/locations/us-central1/repositories/repo1`. For each location + * in a project, repository names must be unique. * * Generated from protobuf field string name = 1; * @return string @@ -307,7 +338,8 @@ public function getName() /** * The name of the repository, for example: - * `projects/p1/locations/us-central1/repositories/repo1`. + * `projects/p1/locations/us-central1/repositories/repo1`. For each location + * in a project, repository names must be unique. * * Generated from protobuf field string name = 1; * @param string $var @@ -653,6 +685,98 @@ public function setCleanupPolicyDryRun($var) return $this; } + /** + * Optional. Config and state for vulnerability scanning of resources within + * this Repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig vulnerability_scanning_config = 19 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\ArtifactRegistry\V1\Repository\VulnerabilityScanningConfig|null + */ + public function getVulnerabilityScanningConfig() + { + return $this->vulnerability_scanning_config; + } + + public function hasVulnerabilityScanningConfig() + { + return isset($this->vulnerability_scanning_config); + } + + public function clearVulnerabilityScanningConfig() + { + unset($this->vulnerability_scanning_config); + } + + /** + * Optional. Config and state for vulnerability scanning of resources within + * this Repository. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig vulnerability_scanning_config = 19 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\ArtifactRegistry\V1\Repository\VulnerabilityScanningConfig $var + * @return $this + */ + public function setVulnerabilityScanningConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\Repository\VulnerabilityScanningConfig::class); + $this->vulnerability_scanning_config = $var; + + return $this; + } + + /** + * Optional. If this is true, an unspecified repo type will be treated as + * error rather than defaulting to standard. + * + * Generated from protobuf field bool disallow_unspecified_mode = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getDisallowUnspecifiedMode() + { + return $this->disallow_unspecified_mode; + } + + /** + * Optional. If this is true, an unspecified repo type will be treated as + * error rather than defaulting to standard. + * + * Generated from protobuf field bool disallow_unspecified_mode = 21 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setDisallowUnspecifiedMode($var) + { + GPBUtil::checkBool($var); + $this->disallow_unspecified_mode = $var; + + return $this; + } + + /** + * Output only. If set, the repository satisfies physical zone isolation. + * + * Generated from protobuf field bool satisfies_pzi = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzi() + { + return $this->satisfies_pzi; + } + + /** + * Output only. If set, the repository satisfies physical zone isolation. + * + * Generated from protobuf field bool satisfies_pzi = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzi($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzi = $var; + + return $this; + } + /** * @return string */ diff --git a/ArtifactRegistry/src/V1/Repository/Format.php b/ArtifactRegistry/src/V1/Repository/Format.php index 6fc8c1369014..ec1cbc331259 100644 --- a/ArtifactRegistry/src/V1/Repository/Format.php +++ b/ArtifactRegistry/src/V1/Repository/Format.php @@ -67,6 +67,12 @@ class Format * Generated from protobuf enum GO = 10; */ const GO = 10; + /** + * Generic package format. + * + * Generated from protobuf enum GENERIC = 11; + */ + const GENERIC = 11; private static $valueToName = [ self::FORMAT_UNSPECIFIED => 'FORMAT_UNSPECIFIED', @@ -78,6 +84,7 @@ class Format self::PYTHON => 'PYTHON', self::KFP => 'KFP', self::GO => 'GO', + self::GENERIC => 'GENERIC', ]; public static function name($value) diff --git a/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig.php b/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig.php new file mode 100644 index 000000000000..1b53439ccf85 --- /dev/null +++ b/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig.php @@ -0,0 +1,189 @@ +google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig + */ +class VulnerabilityScanningConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Config for whether this repository has vulnerability scanning + * disabled. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig.EnablementConfig enablement_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $enablement_config = 0; + /** + * Output only. The last time this repository config was enabled. + * + * Generated from protobuf field .google.protobuf.Timestamp last_enable_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $last_enable_time = null; + /** + * Output only. State of feature enablement, combining repository enablement + * config and API enablement state. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $enablement_state = 0; + /** + * Output only. Reason for the repository state. + * + * Generated from protobuf field string enablement_state_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $enablement_state_reason = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $enablement_config + * Optional. Config for whether this repository has vulnerability scanning + * disabled. + * @type \Google\Protobuf\Timestamp $last_enable_time + * Output only. The last time this repository config was enabled. + * @type int $enablement_state + * Output only. State of feature enablement, combining repository enablement + * config and API enablement state. + * @type string $enablement_state_reason + * Output only. Reason for the repository state. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Repository::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Config for whether this repository has vulnerability scanning + * disabled. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig.EnablementConfig enablement_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getEnablementConfig() + { + return $this->enablement_config; + } + + /** + * Optional. Config for whether this repository has vulnerability scanning + * disabled. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig.EnablementConfig enablement_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setEnablementConfig($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\ArtifactRegistry\V1\Repository\VulnerabilityScanningConfig\EnablementConfig::class); + $this->enablement_config = $var; + + return $this; + } + + /** + * Output only. The last time this repository config was enabled. + * + * Generated from protobuf field .google.protobuf.Timestamp last_enable_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getLastEnableTime() + { + return $this->last_enable_time; + } + + public function hasLastEnableTime() + { + return isset($this->last_enable_time); + } + + public function clearLastEnableTime() + { + unset($this->last_enable_time); + } + + /** + * Output only. The last time this repository config was enabled. + * + * Generated from protobuf field .google.protobuf.Timestamp last_enable_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setLastEnableTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->last_enable_time = $var; + + return $this; + } + + /** + * Output only. State of feature enablement, combining repository enablement + * config and API enablement state. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getEnablementState() + { + return $this->enablement_state; + } + + /** + * Output only. State of feature enablement, combining repository enablement + * config and API enablement state. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setEnablementState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\ArtifactRegistry\V1\Repository\VulnerabilityScanningConfig\EnablementState::class); + $this->enablement_state = $var; + + return $this; + } + + /** + * Output only. Reason for the repository state. + * + * Generated from protobuf field string enablement_state_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getEnablementStateReason() + { + return $this->enablement_state_reason; + } + + /** + * Output only. Reason for the repository state. + * + * Generated from protobuf field string enablement_state_reason = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setEnablementStateReason($var) + { + GPBUtil::checkString($var, True); + $this->enablement_state_reason = $var; + + return $this; + } + +} + + diff --git a/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig/EnablementConfig.php b/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig/EnablementConfig.php new file mode 100644 index 000000000000..c46312733816 --- /dev/null +++ b/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig/EnablementConfig.php @@ -0,0 +1,63 @@ +google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig.EnablementConfig + */ +class EnablementConfig +{ + /** + * Not set. This will be treated as INHERITED. + * + * Generated from protobuf enum ENABLEMENT_CONFIG_UNSPECIFIED = 0; + */ + const ENABLEMENT_CONFIG_UNSPECIFIED = 0; + /** + * Scanning is Enabled, but dependent on API enablement. + * + * Generated from protobuf enum INHERITED = 1; + */ + const INHERITED = 1; + /** + * No automatic vulnerability scanning will be performed for this + * repository. + * + * Generated from protobuf enum DISABLED = 2; + */ + const DISABLED = 2; + + private static $valueToName = [ + self::ENABLEMENT_CONFIG_UNSPECIFIED => 'ENABLEMENT_CONFIG_UNSPECIFIED', + self::INHERITED => 'INHERITED', + self::DISABLED => 'DISABLED', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig/EnablementState.php b/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig/EnablementState.php new file mode 100644 index 000000000000..4418c2f815d1 --- /dev/null +++ b/ArtifactRegistry/src/V1/Repository/VulnerabilityScanningConfig/EnablementState.php @@ -0,0 +1,70 @@ +google.devtools.artifactregistry.v1.Repository.VulnerabilityScanningConfig.EnablementState + */ +class EnablementState +{ + /** + * Enablement state is unclear. + * + * Generated from protobuf enum ENABLEMENT_STATE_UNSPECIFIED = 0; + */ + const ENABLEMENT_STATE_UNSPECIFIED = 0; + /** + * Repository does not support vulnerability scanning. + * + * Generated from protobuf enum SCANNING_UNSUPPORTED = 1; + */ + const SCANNING_UNSUPPORTED = 1; + /** + * Vulnerability scanning is disabled for this repository. + * + * Generated from protobuf enum SCANNING_DISABLED = 2; + */ + const SCANNING_DISABLED = 2; + /** + * Vulnerability scanning is active for this repository. + * + * Generated from protobuf enum SCANNING_ACTIVE = 3; + */ + const SCANNING_ACTIVE = 3; + + private static $valueToName = [ + self::ENABLEMENT_STATE_UNSPECIFIED => 'ENABLEMENT_STATE_UNSPECIFIED', + self::SCANNING_UNSUPPORTED => 'SCANNING_UNSUPPORTED', + self::SCANNING_DISABLED => 'SCANNING_DISABLED', + self::SCANNING_ACTIVE => 'SCANNING_ACTIVE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/ArtifactRegistry/src/V1/Rule.php b/ArtifactRegistry/src/V1/Rule.php new file mode 100644 index 000000000000..6268ad14e9a5 --- /dev/null +++ b/ArtifactRegistry/src/V1/Rule.php @@ -0,0 +1,220 @@ +google.devtools.artifactregistry.v1.Rule + */ +class Rule extends \Google\Protobuf\Internal\Message +{ + /** + * The name of the rule, for example: + * `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. + * + * Generated from protobuf field string name = 1; + */ + protected $name = ''; + /** + * The action this rule takes. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule.Action action = 2; + */ + protected $action = 0; + /** + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule.Operation operation = 3; + */ + protected $operation = 0; + /** + * Optional. A CEL expression for conditions that must be met in order for the + * rule to apply. If not provided, the rule matches all objects. + * + * Generated from protobuf field .google.type.Expr condition = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $condition = null; + /** + * The package ID the rule applies to. + * If empty, this rule applies to all packages inside the repository. + * + * Generated from protobuf field string package_id = 5; + */ + protected $package_id = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * The name of the rule, for example: + * `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. + * @type int $action + * The action this rule takes. + * @type int $operation + * @type \Google\Type\Expr $condition + * Optional. A CEL expression for conditions that must be met in order for the + * rule to apply. If not provided, the rule matches all objects. + * @type string $package_id + * The package ID the rule applies to. + * If empty, this rule applies to all packages inside the repository. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Rule::initOnce(); + parent::__construct($data); + } + + /** + * The name of the rule, for example: + * `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. + * + * Generated from protobuf field string name = 1; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * The name of the rule, for example: + * `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. + * + * Generated from protobuf field string name = 1; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * The action this rule takes. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule.Action action = 2; + * @return int + */ + public function getAction() + { + return $this->action; + } + + /** + * The action this rule takes. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule.Action action = 2; + * @param int $var + * @return $this + */ + public function setAction($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\ArtifactRegistry\V1\Rule\Action::class); + $this->action = $var; + + return $this; + } + + /** + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule.Operation operation = 3; + * @return int + */ + public function getOperation() + { + return $this->operation; + } + + /** + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule.Operation operation = 3; + * @param int $var + * @return $this + */ + public function setOperation($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\ArtifactRegistry\V1\Rule\Operation::class); + $this->operation = $var; + + return $this; + } + + /** + * Optional. A CEL expression for conditions that must be met in order for the + * rule to apply. If not provided, the rule matches all objects. + * + * Generated from protobuf field .google.type.Expr condition = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Type\Expr|null + */ + public function getCondition() + { + return $this->condition; + } + + public function hasCondition() + { + return isset($this->condition); + } + + public function clearCondition() + { + unset($this->condition); + } + + /** + * Optional. A CEL expression for conditions that must be met in order for the + * rule to apply. If not provided, the rule matches all objects. + * + * Generated from protobuf field .google.type.Expr condition = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Type\Expr $var + * @return $this + */ + public function setCondition($var) + { + GPBUtil::checkMessage($var, \Google\Type\Expr::class); + $this->condition = $var; + + return $this; + } + + /** + * The package ID the rule applies to. + * If empty, this rule applies to all packages inside the repository. + * + * Generated from protobuf field string package_id = 5; + * @return string + */ + public function getPackageId() + { + return $this->package_id; + } + + /** + * The package ID the rule applies to. + * If empty, this rule applies to all packages inside the repository. + * + * Generated from protobuf field string package_id = 5; + * @param string $var + * @return $this + */ + public function setPackageId($var) + { + GPBUtil::checkString($var, True); + $this->package_id = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/Rule/Action.php b/ArtifactRegistry/src/V1/Rule/Action.php new file mode 100644 index 000000000000..f9e6589f25c5 --- /dev/null +++ b/ArtifactRegistry/src/V1/Rule/Action.php @@ -0,0 +1,62 @@ +google.devtools.artifactregistry.v1.Rule.Action + */ +class Action +{ + /** + * Action not specified. + * + * Generated from protobuf enum ACTION_UNSPECIFIED = 0; + */ + const ACTION_UNSPECIFIED = 0; + /** + * Allow the operation. + * + * Generated from protobuf enum ALLOW = 1; + */ + const ALLOW = 1; + /** + * Deny the operation. + * + * Generated from protobuf enum DENY = 2; + */ + const DENY = 2; + + private static $valueToName = [ + self::ACTION_UNSPECIFIED => 'ACTION_UNSPECIFIED', + self::ALLOW => 'ALLOW', + self::DENY => 'DENY', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/ArtifactRegistry/src/V1/Rule/Operation.php b/ArtifactRegistry/src/V1/Rule/Operation.php new file mode 100644 index 000000000000..11f4b57d58ce --- /dev/null +++ b/ArtifactRegistry/src/V1/Rule/Operation.php @@ -0,0 +1,55 @@ +google.devtools.artifactregistry.v1.Rule.Operation + */ +class Operation +{ + /** + * Operation not specified. + * + * Generated from protobuf enum OPERATION_UNSPECIFIED = 0; + */ + const OPERATION_UNSPECIFIED = 0; + /** + * Download operation. + * + * Generated from protobuf enum DOWNLOAD = 1; + */ + const DOWNLOAD = 1; + + private static $valueToName = [ + self::OPERATION_UNSPECIFIED => 'OPERATION_UNSPECIFIED', + self::DOWNLOAD => 'DOWNLOAD', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/ArtifactRegistry/src/V1/Tag.php b/ArtifactRegistry/src/V1/Tag.php index 01d7525b1fee..88d671f343ff 100644 --- a/ArtifactRegistry/src/V1/Tag.php +++ b/ArtifactRegistry/src/V1/Tag.php @@ -28,7 +28,7 @@ class Tag extends \Google\Protobuf\Internal\Message protected $name = ''; /** * The name of the version the tag refers to, for example: - * "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811" + * `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811` * If the package or version ID parts contain slashes, the slashes are * escaped. * @@ -50,7 +50,7 @@ class Tag extends \Google\Protobuf\Internal\Message * must be URL encoded. * @type string $version * The name of the version the tag refers to, for example: - * "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811" + * `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811` * If the package or version ID parts contain slashes, the slashes are * escaped. * } @@ -96,7 +96,7 @@ public function setName($var) /** * The name of the version the tag refers to, for example: - * "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811" + * `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811` * If the package or version ID parts contain slashes, the slashes are * escaped. * @@ -110,7 +110,7 @@ public function getVersion() /** * The name of the version the tag refers to, for example: - * "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811" + * `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811` * If the package or version ID parts contain slashes, the slashes are * escaped. * diff --git a/ArtifactRegistry/src/V1/UpdateFileRequest.php b/ArtifactRegistry/src/V1/UpdateFileRequest.php new file mode 100644 index 000000000000..8158ac1dd758 --- /dev/null +++ b/ArtifactRegistry/src/V1/UpdateFileRequest.php @@ -0,0 +1,146 @@ +google.devtools.artifactregistry.v1.UpdateFileRequest + */ +class UpdateFileRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The File that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.File file = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $file = null; + /** + * Required. The update mask applies to the resource. For the `FieldMask` + * definition, see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $update_mask = null; + + /** + * @param \Google\Cloud\ArtifactRegistry\V1\File $file Required. The File that replaces the resource on the server. + * @param \Google\Protobuf\FieldMask $updateMask Required. The update mask applies to the resource. For the `FieldMask` + * definition, see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * @return \Google\Cloud\ArtifactRegistry\V1\UpdateFileRequest + * + * @experimental + */ + public static function build(\Google\Cloud\ArtifactRegistry\V1\File $file, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setFile($file) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\ArtifactRegistry\V1\File $file + * Required. The File that replaces the resource on the server. + * @type \Google\Protobuf\FieldMask $update_mask + * Required. The update mask applies to the resource. For the `FieldMask` + * definition, see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\File::initOnce(); + parent::__construct($data); + } + + /** + * Required. The File that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.File file = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\ArtifactRegistry\V1\File|null + */ + public function getFile() + { + return $this->file; + } + + public function hasFile() + { + return isset($this->file); + } + + public function clearFile() + { + unset($this->file); + } + + /** + * Required. The File that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.File file = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\ArtifactRegistry\V1\File $var + * @return $this + */ + public function setFile($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\File::class); + $this->file = $var; + + return $this; + } + + /** + * Required. The update mask applies to the resource. For the `FieldMask` + * definition, see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Required. The update mask applies to the resource. For the `FieldMask` + * definition, see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/UpdatePackageRequest.php b/ArtifactRegistry/src/V1/UpdatePackageRequest.php new file mode 100644 index 000000000000..253ac00c595b --- /dev/null +++ b/ArtifactRegistry/src/V1/UpdatePackageRequest.php @@ -0,0 +1,146 @@ +google.devtools.artifactregistry.v1.UpdatePackageRequest + */ +class UpdatePackageRequest extends \Google\Protobuf\Internal\Message +{ + /** + * The package that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Package package = 1; + */ + protected $package = null; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + */ + protected $update_mask = null; + + /** + * @param \Google\Cloud\ArtifactRegistry\V1\Package $package The package that replaces the resource on the server. + * @param \Google\Protobuf\FieldMask $updateMask The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * @return \Google\Cloud\ArtifactRegistry\V1\UpdatePackageRequest + * + * @experimental + */ + public static function build(\Google\Cloud\ArtifactRegistry\V1\Package $package, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setPackage($package) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\ArtifactRegistry\V1\Package $package + * The package that replaces the resource on the server. + * @type \Google\Protobuf\FieldMask $update_mask + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Package::initOnce(); + parent::__construct($data); + } + + /** + * The package that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Package package = 1; + * @return \Google\Cloud\ArtifactRegistry\V1\Package|null + */ + public function getPackage() + { + return $this->package; + } + + public function hasPackage() + { + return isset($this->package); + } + + public function clearPackage() + { + unset($this->package); + } + + /** + * The package that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Package package = 1; + * @param \Google\Cloud\ArtifactRegistry\V1\Package $var + * @return $this + */ + public function setPackage($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\Package::class); + $this->package = $var; + + return $this; + } + + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/UpdateRuleRequest.php b/ArtifactRegistry/src/V1/UpdateRuleRequest.php new file mode 100644 index 000000000000..52743d36ad42 --- /dev/null +++ b/ArtifactRegistry/src/V1/UpdateRuleRequest.php @@ -0,0 +1,146 @@ +google.devtools.artifactregistry.v1.UpdateRuleRequest + */ +class UpdateRuleRequest extends \Google\Protobuf\Internal\Message +{ + /** + * The rule that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule rule = 1; + */ + protected $rule = null; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + */ + protected $update_mask = null; + + /** + * @param \Google\Cloud\ArtifactRegistry\V1\Rule $rule The rule that replaces the resource on the server. + * @param \Google\Protobuf\FieldMask $updateMask The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * @return \Google\Cloud\ArtifactRegistry\V1\UpdateRuleRequest + * + * @experimental + */ + public static function build(\Google\Cloud\ArtifactRegistry\V1\Rule $rule, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setRule($rule) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\ArtifactRegistry\V1\Rule $rule + * The rule that replaces the resource on the server. + * @type \Google\Protobuf\FieldMask $update_mask + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Rule::initOnce(); + parent::__construct($data); + } + + /** + * The rule that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule rule = 1; + * @return \Google\Cloud\ArtifactRegistry\V1\Rule|null + */ + public function getRule() + { + return $this->rule; + } + + public function hasRule() + { + return isset($this->rule); + } + + public function clearRule() + { + unset($this->rule); + } + + /** + * The rule that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Rule rule = 1; + * @param \Google\Cloud\ArtifactRegistry\V1\Rule $var + * @return $this + */ + public function setRule($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\Rule::class); + $this->rule = $var; + + return $this; + } + + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/UpdateVersionRequest.php b/ArtifactRegistry/src/V1/UpdateVersionRequest.php new file mode 100644 index 000000000000..dc65a3000f55 --- /dev/null +++ b/ArtifactRegistry/src/V1/UpdateVersionRequest.php @@ -0,0 +1,146 @@ +google.devtools.artifactregistry.v1.UpdateVersionRequest + */ +class UpdateVersionRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The Version that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Version version = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $version = null; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + */ + protected $update_mask = null; + + /** + * @param \Google\Cloud\ArtifactRegistry\V1\Version $version Required. The Version that replaces the resource on the server. + * @param \Google\Protobuf\FieldMask $updateMask The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * @return \Google\Cloud\ArtifactRegistry\V1\UpdateVersionRequest + * + * @experimental + */ + public static function build(\Google\Cloud\ArtifactRegistry\V1\Version $version, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setVersion($version) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\ArtifactRegistry\V1\Version $version + * Required. The Version that replaces the resource on the server. + * @type \Google\Protobuf\FieldMask $update_mask + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Devtools\Artifactregistry\V1\Version::initOnce(); + parent::__construct($data); + } + + /** + * Required. The Version that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Version version = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\ArtifactRegistry\V1\Version|null + */ + public function getVersion() + { + return $this->version; + } + + public function hasVersion() + { + return isset($this->version); + } + + public function clearVersion() + { + unset($this->version); + } + + /** + * Required. The Version that replaces the resource on the server. + * + * Generated from protobuf field .google.devtools.artifactregistry.v1.Version version = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\ArtifactRegistry\V1\Version $var + * @return $this + */ + public function setVersion($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\ArtifactRegistry\V1\Version::class); + $this->version = $var; + + return $this; + } + + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + +} + diff --git a/ArtifactRegistry/src/V1/Version.php b/ArtifactRegistry/src/V1/Version.php index d0e6b33aa05a..c085f4368d36 100644 --- a/ArtifactRegistry/src/V1/Version.php +++ b/ArtifactRegistry/src/V1/Version.php @@ -19,7 +19,7 @@ class Version extends \Google\Protobuf\Internal\Message { /** * The name of the version, for example: - * "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". + * `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. * If the package or version ID parts contain slashes, the slashes are * escaped. * @@ -61,6 +61,12 @@ class Version extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Struct metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $metadata = null; + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; /** * Constructor. @@ -70,7 +76,7 @@ class Version extends \Google\Protobuf\Internal\Message * * @type string $name * The name of the version, for example: - * "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". + * `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. * If the package or version ID parts contain slashes, the slashes are * escaped. * @type string $description @@ -88,6 +94,8 @@ class Version extends \Google\Protobuf\Internal\Message * resource. Currently, the resources could be: * [DockerImage][google.devtools.artifactregistry.v1.DockerImage] * [MavenArtifact][google.devtools.artifactregistry.v1.MavenArtifact] + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. Client specified annotations. * } */ public function __construct($data = NULL) { @@ -97,7 +105,7 @@ public function __construct($data = NULL) { /** * The name of the version, for example: - * "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". + * `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. * If the package or version ID parts contain slashes, the slashes are * escaped. * @@ -111,7 +119,7 @@ public function getName() /** * The name of the version, for example: - * "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". + * `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. * If the package or version ID parts contain slashes, the slashes are * escaped. * @@ -297,5 +305,31 @@ public function setMetadata($var) return $this; } + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. Client specified annotations. + * + * Generated from protobuf field map annotations = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + } diff --git a/ArtifactRegistry/src/V1/gapic_metadata.json b/ArtifactRegistry/src/V1/gapic_metadata.json index e39fa3da4120..304e0a5ee2f2 100644 --- a/ArtifactRegistry/src/V1/gapic_metadata.json +++ b/ArtifactRegistry/src/V1/gapic_metadata.json @@ -15,16 +15,36 @@ "batchDeleteVersions" ] }, + "CreateAttachment": { + "methods": [ + "createAttachment" + ] + }, "CreateRepository": { "methods": [ "createRepository" ] }, + "CreateRule": { + "methods": [ + "createRule" + ] + }, "CreateTag": { "methods": [ "createTag" ] }, + "DeleteAttachment": { + "methods": [ + "deleteAttachment" + ] + }, + "DeleteFile": { + "methods": [ + "deleteFile" + ] + }, "DeletePackage": { "methods": [ "deletePackage" @@ -35,6 +55,11 @@ "deleteRepository" ] }, + "DeleteRule": { + "methods": [ + "deleteRule" + ] + }, "DeleteTag": { "methods": [ "deleteTag" @@ -45,6 +70,11 @@ "deleteVersion" ] }, + "GetAttachment": { + "methods": [ + "getAttachment" + ] + }, "GetDockerImage": { "methods": [ "getDockerImage" @@ -90,6 +120,11 @@ "getRepository" ] }, + "GetRule": { + "methods": [ + "getRule" + ] + }, "GetTag": { "methods": [ "getTag" @@ -115,6 +150,11 @@ "importYumArtifacts" ] }, + "ListAttachments": { + "methods": [ + "listAttachments" + ] + }, "ListDockerImages": { "methods": [ "listDockerImages" @@ -150,6 +190,11 @@ "listRepositories" ] }, + "ListRules": { + "methods": [ + "listRules" + ] + }, "ListTags": { "methods": [ "listTags" @@ -170,6 +215,16 @@ "testIamPermissions" ] }, + "UpdateFile": { + "methods": [ + "updateFile" + ] + }, + "UpdatePackage": { + "methods": [ + "updatePackage" + ] + }, "UpdateProjectSettings": { "methods": [ "updateProjectSettings" @@ -180,6 +235,11 @@ "updateRepository" ] }, + "UpdateRule": { + "methods": [ + "updateRule" + ] + }, "UpdateTag": { "methods": [ "updateTag" @@ -190,6 +250,11 @@ "updateVPCSCConfig" ] }, + "UpdateVersion": { + "methods": [ + "updateVersion" + ] + }, "GetLocation": { "methods": [ "getLocation" diff --git a/ArtifactRegistry/src/V1/resources/artifact_registry_client_config.json b/ArtifactRegistry/src/V1/resources/artifact_registry_client_config.json index 8ef829a0812e..665bff1a7b12 100644 --- a/ArtifactRegistry/src/V1/resources/artifact_registry_client_config.json +++ b/ArtifactRegistry/src/V1/resources/artifact_registry_client_config.json @@ -31,16 +31,36 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "CreateAttachment": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "CreateRepository": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "CreateRule": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "CreateTag": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "DeleteAttachment": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "DeleteFile": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "DeletePackage": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -51,6 +71,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "DeleteRule": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "DeleteTag": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -61,6 +86,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "GetAttachment": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "GetDockerImage": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -106,6 +136,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "GetRule": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "GetTag": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -131,6 +166,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "ListAttachments": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "ListDockerImages": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -166,6 +206,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "ListRules": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "ListTags": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -186,6 +231,16 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "UpdateFile": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "UpdatePackage": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "UpdateProjectSettings": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -196,6 +251,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "UpdateRule": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "UpdateTag": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", @@ -206,6 +266,11 @@ "retry_codes_name": "no_retry_1_codes", "retry_params_name": "no_retry_1_params" }, + "UpdateVersion": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "GetLocation": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", diff --git a/ArtifactRegistry/src/V1/resources/artifact_registry_descriptor_config.php b/ArtifactRegistry/src/V1/resources/artifact_registry_descriptor_config.php index 277b58a2606b..326ffcd9825b 100644 --- a/ArtifactRegistry/src/V1/resources/artifact_registry_descriptor_config.php +++ b/ArtifactRegistry/src/V1/resources/artifact_registry_descriptor_config.php @@ -42,6 +42,25 @@ ], ], ], + 'CreateAttachment' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\ArtifactRegistry\V1\Attachment', + 'metadataReturnType' => '\Google\Cloud\ArtifactRegistry\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'CreateRepository' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\ArtifactRegistry\V1\Repository', @@ -61,6 +80,44 @@ ], ], ], + 'DeleteAttachment' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Protobuf\GPBEmpty', + 'metadataReturnType' => '\Google\Cloud\ArtifactRegistry\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'DeleteFile' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Protobuf\GPBEmpty', + 'metadataReturnType' => '\Google\Cloud\ArtifactRegistry\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'DeletePackage' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Protobuf\GPBEmpty', @@ -156,6 +213,18 @@ ], ], ], + 'CreateRule' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Rule', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'CreateTag' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Tag', @@ -168,6 +237,18 @@ ], ], ], + 'DeleteRule' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Protobuf\GPBEmpty', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'DeleteTag' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Protobuf\GPBEmpty', @@ -180,6 +261,18 @@ ], ], ], + 'GetAttachment' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Attachment', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'GetDockerImage' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\DockerImage', @@ -288,6 +381,18 @@ ], ], ], + 'GetRule' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Rule', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'GetTag' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Tag', @@ -324,6 +429,26 @@ ], ], ], + 'ListAttachments' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getAttachments', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\ListAttachmentsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'ListDockerImages' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', @@ -464,6 +589,26 @@ ], ], ], + 'ListRules' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getRules', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\ListRulesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'ListTags' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', @@ -528,6 +673,32 @@ ], ], ], + 'UpdateFile' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\File', + 'headerParams' => [ + [ + 'keyName' => 'file.name', + 'fieldAccessors' => [ + 'getFile', + 'getName', + ], + ], + ], + ], + 'UpdatePackage' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Package', + 'headerParams' => [ + [ + 'keyName' => 'package.name', + 'fieldAccessors' => [ + 'getPackage', + 'getName', + ], + ], + ], + ], 'UpdateProjectSettings' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\ProjectSettings', @@ -554,6 +725,19 @@ ], ], ], + 'UpdateRule' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Rule', + 'headerParams' => [ + [ + 'keyName' => 'rule.name', + 'fieldAccessors' => [ + 'getRule', + 'getName', + ], + ], + ], + ], 'UpdateTag' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Tag', @@ -580,6 +764,19 @@ ], ], ], + 'UpdateVersion' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\ArtifactRegistry\V1\Version', + 'headerParams' => [ + [ + 'keyName' => 'version.name', + 'fieldAccessors' => [ + 'getVersion', + 'getName', + ], + ], + ], + ], 'GetLocation' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\Location\Location', @@ -615,6 +812,7 @@ 'interfaceOverride' => 'google.cloud.location.Locations', ], 'templateMap' => [ + 'attachment' => 'projects/{project}/locations/{location}/repositories/{repository}/attachments/{attachment}', 'dockerImage' => 'projects/{project}/locations/{location}/repositories/{repository}/dockerImages/{docker_image}', 'file' => 'projects/{project}/locations/{location}/repositories/{repository}/files/{file}', 'location' => 'projects/{project}/locations/{location}', @@ -624,6 +822,7 @@ 'projectSettings' => 'projects/{project}/projectSettings', 'pythonPackage' => 'projects/{project}/locations/{location}/repositories/{repository}/pythonPackages/{python_package}', 'repository' => 'projects/{project}/locations/{location}/repositories/{repository}', + 'rule' => 'projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}', 'secretVersion' => 'projects/{project}/secrets/{secret}/versions/{secret_version}', 'tag' => 'projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}', 'version' => 'projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}', diff --git a/ArtifactRegistry/src/V1/resources/artifact_registry_rest_client_config.php b/ArtifactRegistry/src/V1/resources/artifact_registry_rest_client_config.php index bc592c9417dc..29ec04db60ad 100644 --- a/ArtifactRegistry/src/V1/resources/artifact_registry_rest_client_config.php +++ b/ArtifactRegistry/src/V1/resources/artifact_registry_rest_client_config.php @@ -59,6 +59,21 @@ ], ], ], + 'CreateAttachment' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*}/attachments', + 'body' => 'attachment', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'attachment_id', + ], + ], 'CreateRepository' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/repositories', @@ -71,6 +86,18 @@ ], ], ], + 'CreateRule' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*}/rules', + 'body' => 'rule', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'CreateTag' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*/packages/*}/tags', @@ -83,6 +110,28 @@ ], ], ], + 'DeleteAttachment' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/attachments/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'DeleteFile' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/files/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'DeletePackage' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/packages/*}', @@ -105,6 +154,17 @@ ], ], ], + 'DeleteRule' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/rules/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'DeleteTag' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/packages/*/tags/*}', @@ -127,6 +187,17 @@ ], ], ], + 'GetAttachment' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/attachments/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetDockerImage' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/dockerImages/*}', @@ -226,6 +297,17 @@ ], ], ], + 'GetRule' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/rules/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetTag' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/repositories/*/packages/*/tags/*}', @@ -283,6 +365,17 @@ ], ], ], + 'ListAttachments' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*}/attachments', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'ListDockerImages' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*}/dockerImages', @@ -360,6 +453,17 @@ ], ], ], + 'ListRules' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*}/rules', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'ListTags' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*/repositories/*/packages/*}/tags', @@ -406,6 +510,35 @@ ], ], ], + 'UpdateFile' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{file.name=projects/*/locations/*/repositories/*/files/*}', + 'body' => 'file', + 'placeholders' => [ + 'file.name' => [ + 'getters' => [ + 'getFile', + 'getName', + ], + ], + ], + 'queryParams' => [ + 'update_mask', + ], + ], + 'UpdatePackage' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{package.name=projects/*/locations/*/repositories/*/packages/*}', + 'body' => 'package', + 'placeholders' => [ + 'package.name' => [ + 'getters' => [ + 'getPackage', + 'getName', + ], + ], + ], + ], 'UpdateProjectSettings' => [ 'method' => 'patch', 'uriTemplate' => '/v1/{project_settings.name=projects/*/projectSettings}', @@ -432,6 +565,19 @@ ], ], ], + 'UpdateRule' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{rule.name=projects/*/locations/*/repositories/*/rules/*}', + 'body' => 'rule', + 'placeholders' => [ + 'rule.name' => [ + 'getters' => [ + 'getRule', + 'getName', + ], + ], + ], + ], 'UpdateTag' => [ 'method' => 'patch', 'uriTemplate' => '/v1/{tag.name=projects/*/locations/*/repositories/*/packages/*/tags/*}', @@ -458,6 +604,19 @@ ], ], ], + 'UpdateVersion' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{version.name=projects/*/locations/*/repositories/*/packages/*/versions/*}', + 'body' => 'version', + 'placeholders' => [ + 'version.name' => [ + 'getters' => [ + 'getVersion', + 'getName', + ], + ], + ], + ], ], 'google.longrunning.Operations' => [ 'GetOperation' => [ diff --git a/ArtifactRegistry/tests/Unit/V1/Client/ArtifactRegistryClientTest.php b/ArtifactRegistry/tests/Unit/V1/Client/ArtifactRegistryClientTest.php index f718ccb27026..03113c0557e7 100644 --- a/ArtifactRegistry/tests/Unit/V1/Client/ArtifactRegistryClientTest.php +++ b/ArtifactRegistry/tests/Unit/V1/Client/ArtifactRegistryClientTest.php @@ -26,16 +26,23 @@ use Google\ApiCore\CredentialsWrapper; use Google\ApiCore\Testing\GeneratedTest; use Google\ApiCore\Testing\MockTransport; +use Google\Cloud\ArtifactRegistry\V1\Attachment; use Google\Cloud\ArtifactRegistry\V1\BatchDeleteVersionsRequest; use Google\Cloud\ArtifactRegistry\V1\Client\ArtifactRegistryClient; +use Google\Cloud\ArtifactRegistry\V1\CreateAttachmentRequest; use Google\Cloud\ArtifactRegistry\V1\CreateRepositoryRequest; +use Google\Cloud\ArtifactRegistry\V1\CreateRuleRequest; use Google\Cloud\ArtifactRegistry\V1\CreateTagRequest; +use Google\Cloud\ArtifactRegistry\V1\DeleteAttachmentRequest; +use Google\Cloud\ArtifactRegistry\V1\DeleteFileRequest; use Google\Cloud\ArtifactRegistry\V1\DeletePackageRequest; use Google\Cloud\ArtifactRegistry\V1\DeleteRepositoryRequest; +use Google\Cloud\ArtifactRegistry\V1\DeleteRuleRequest; use Google\Cloud\ArtifactRegistry\V1\DeleteTagRequest; use Google\Cloud\ArtifactRegistry\V1\DeleteVersionRequest; use Google\Cloud\ArtifactRegistry\V1\DockerImage; use Google\Cloud\ArtifactRegistry\V1\File; +use Google\Cloud\ArtifactRegistry\V1\GetAttachmentRequest; use Google\Cloud\ArtifactRegistry\V1\GetDockerImageRequest; use Google\Cloud\ArtifactRegistry\V1\GetFileRequest; use Google\Cloud\ArtifactRegistry\V1\GetMavenArtifactRequest; @@ -44,6 +51,7 @@ use Google\Cloud\ArtifactRegistry\V1\GetProjectSettingsRequest; use Google\Cloud\ArtifactRegistry\V1\GetPythonPackageRequest; use Google\Cloud\ArtifactRegistry\V1\GetRepositoryRequest; +use Google\Cloud\ArtifactRegistry\V1\GetRuleRequest; use Google\Cloud\ArtifactRegistry\V1\GetTagRequest; use Google\Cloud\ArtifactRegistry\V1\GetVPCSCConfigRequest; use Google\Cloud\ArtifactRegistry\V1\GetVersionRequest; @@ -51,6 +59,8 @@ use Google\Cloud\ArtifactRegistry\V1\ImportAptArtifactsResponse; use Google\Cloud\ArtifactRegistry\V1\ImportYumArtifactsRequest; use Google\Cloud\ArtifactRegistry\V1\ImportYumArtifactsResponse; +use Google\Cloud\ArtifactRegistry\V1\ListAttachmentsRequest; +use Google\Cloud\ArtifactRegistry\V1\ListAttachmentsResponse; use Google\Cloud\ArtifactRegistry\V1\ListDockerImagesRequest; use Google\Cloud\ArtifactRegistry\V1\ListDockerImagesResponse; use Google\Cloud\ArtifactRegistry\V1\ListFilesRequest; @@ -65,6 +75,8 @@ use Google\Cloud\ArtifactRegistry\V1\ListPythonPackagesResponse; use Google\Cloud\ArtifactRegistry\V1\ListRepositoriesRequest; use Google\Cloud\ArtifactRegistry\V1\ListRepositoriesResponse; +use Google\Cloud\ArtifactRegistry\V1\ListRulesRequest; +use Google\Cloud\ArtifactRegistry\V1\ListRulesResponse; use Google\Cloud\ArtifactRegistry\V1\ListTagsRequest; use Google\Cloud\ArtifactRegistry\V1\ListTagsResponse; use Google\Cloud\ArtifactRegistry\V1\ListVersionsRequest; @@ -75,11 +87,16 @@ use Google\Cloud\ArtifactRegistry\V1\ProjectSettings; use Google\Cloud\ArtifactRegistry\V1\PythonPackage; use Google\Cloud\ArtifactRegistry\V1\Repository; +use Google\Cloud\ArtifactRegistry\V1\Rule; use Google\Cloud\ArtifactRegistry\V1\Tag; +use Google\Cloud\ArtifactRegistry\V1\UpdateFileRequest; +use Google\Cloud\ArtifactRegistry\V1\UpdatePackageRequest; use Google\Cloud\ArtifactRegistry\V1\UpdateProjectSettingsRequest; use Google\Cloud\ArtifactRegistry\V1\UpdateRepositoryRequest; +use Google\Cloud\ArtifactRegistry\V1\UpdateRuleRequest; use Google\Cloud\ArtifactRegistry\V1\UpdateTagRequest; use Google\Cloud\ArtifactRegistry\V1\UpdateVPCSCConfigRequest; +use Google\Cloud\ArtifactRegistry\V1\UpdateVersionRequest; use Google\Cloud\ArtifactRegistry\V1\VPCSCConfig; use Google\Cloud\ArtifactRegistry\V1\Version; use Google\Cloud\Iam\V1\GetIamPolicyRequest; @@ -95,6 +112,7 @@ use Google\LongRunning\GetOperationRequest; use Google\LongRunning\Operation; use Google\Protobuf\Any; +use Google\Protobuf\FieldMask; use Google\Protobuf\GPBEmpty; use Google\Rpc\Code; use stdClass; @@ -258,6 +276,160 @@ public function batchDeleteVersionsExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function createAttachmentTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createAttachmentTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $target = 'target-880905839'; + $type = 'type3575610'; + $attachmentNamespace = 'attachmentNamespace1367660863'; + $ociVersionName = 'ociVersionName-1366178692'; + $expectedResponse = new Attachment(); + $expectedResponse->setName($name); + $expectedResponse->setTarget($target); + $expectedResponse->setType($type); + $expectedResponse->setAttachmentNamespace($attachmentNamespace); + $expectedResponse->setOciVersionName($ociVersionName); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createAttachmentTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $attachmentId = 'attachmentId-1506844233'; + $attachment = new Attachment(); + $attachmentTarget = 'attachmentTarget279842964'; + $attachment->setTarget($attachmentTarget); + $attachmentFiles = [$gapicClient->fileName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[FILE]')]; + $attachment->setFiles($attachmentFiles); + $request = (new CreateAttachmentRequest()) + ->setParent($formattedParent) + ->setAttachmentId($attachmentId) + ->setAttachment($attachment); + $response = $gapicClient->createAttachment($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/CreateAttachment', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getAttachmentId(); + $this->assertProtobufEquals($attachmentId, $actualValue); + $actualValue = $actualApiRequestObject->getAttachment(); + $this->assertProtobufEquals($attachment, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createAttachmentTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createAttachmentExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createAttachmentTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $attachmentId = 'attachmentId-1506844233'; + $attachment = new Attachment(); + $attachmentTarget = 'attachmentTarget279842964'; + $attachment->setTarget($attachmentTarget); + $attachmentFiles = [$gapicClient->fileName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[FILE]')]; + $attachment->setFiles($attachmentFiles); + $request = (new CreateAttachmentRequest()) + ->setParent($formattedParent) + ->setAttachmentId($attachmentId) + ->setAttachment($attachment); + $response = $gapicClient->createAttachment($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createAttachmentTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function createRepositoryTest() { @@ -285,6 +457,8 @@ public function createRepositoryTest() $sizeBytes = 1796325715; $satisfiesPzs = false; $cleanupPolicyDryRun = false; + $disallowUnspecifiedMode = false; + $satisfiesPzi = false; $expectedResponse = new Repository(); $expectedResponse->setName($name); $expectedResponse->setDescription($description); @@ -292,6 +466,8 @@ public function createRepositoryTest() $expectedResponse->setSizeBytes($sizeBytes); $expectedResponse->setSatisfiesPzs($satisfiesPzs); $expectedResponse->setCleanupPolicyDryRun($cleanupPolicyDryRun); + $expectedResponse->setDisallowUnspecifiedMode($disallowUnspecifiedMode); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -392,6 +568,73 @@ public function createRepositoryExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function createRuleTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $packageId = 'packageId29331380'; + $expectedResponse = new Rule(); + $expectedResponse->setName($name); + $expectedResponse->setPackageId($packageId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new CreateRuleRequest())->setParent($formattedParent); + $response = $gapicClient->createRule($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/CreateRule', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function createRuleExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new CreateRuleRequest())->setParent($formattedParent); + try { + $gapicClient->createRule($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function createTagTest() { @@ -453,6 +696,250 @@ public function createTagExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function deleteAttachmentTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteAttachmentTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteAttachmentTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->attachmentName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[ATTACHMENT]'); + $request = (new DeleteAttachmentRequest())->setName($formattedName); + $response = $gapicClient->deleteAttachment($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/DeleteAttachment', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteAttachmentTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteAttachmentExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteAttachmentTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->attachmentName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[ATTACHMENT]'); + $request = (new DeleteAttachmentRequest())->setName($formattedName); + $response = $gapicClient->deleteAttachment($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteAttachmentTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteFileTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteFileTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteFileTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->fileName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[FILE]'); + $request = (new DeleteFileRequest())->setName($formattedName); + $response = $gapicClient->deleteFile($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/DeleteFile', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteFileTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteFileExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteFileTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->fileName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[FILE]'); + $request = (new DeleteFileRequest())->setName($formattedName); + $response = $gapicClient->deleteFile($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteFileTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function deletePackageTest() { @@ -673,28 +1160,90 @@ public function deleteRepositoryExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); - $request = (new DeleteRepositoryRequest())->setName($formattedName); - $response = $gapicClient->deleteRepository($request); - $this->assertFalse($response->isDone()); - $this->assertNull($response->getResult()); - $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteRepositoryTest'); + $formattedName = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new DeleteRepositoryRequest())->setName($formattedName); + $response = $gapicClient->deleteRepository($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteRepositoryTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteRuleTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new GPBEmpty(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->ruleName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[RULE]'); + $request = (new DeleteRuleRequest())->setName($formattedName); + $gapicClient->deleteRule($request); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/DeleteRule', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function deleteRuleExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->ruleName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[RULE]'); + $request = (new DeleteRuleRequest())->setName($formattedName); try { - $response->pollUntilComplete([ - 'initialPollDelayMillis' => 1, - ]); - // If the pollUntilComplete() method call did not throw, fail the test + $gapicClient->deleteRule($request); + // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { $this->assertEquals($status->code, $ex->getCode()); $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); } - // Call popReceivedCalls to ensure the stubs are exhausted + // Call popReceivedCalls to ensure the stub is exhausted $transport->popReceivedCalls(); - $operationsTransport->popReceivedCalls(); $this->assertTrue($transport->isExhausted()); - $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ @@ -869,6 +1418,79 @@ public function deleteVersionExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function getAttachmentTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $target = 'target-880905839'; + $type = 'type3575610'; + $attachmentNamespace = 'attachmentNamespace1367660863'; + $ociVersionName = 'ociVersionName-1366178692'; + $expectedResponse = new Attachment(); + $expectedResponse->setName($name2); + $expectedResponse->setTarget($target); + $expectedResponse->setType($type); + $expectedResponse->setAttachmentNamespace($attachmentNamespace); + $expectedResponse->setOciVersionName($ociVersionName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->attachmentName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[ATTACHMENT]'); + $request = (new GetAttachmentRequest())->setName($formattedName); + $response = $gapicClient->getAttachment($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/GetAttachment', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getAttachmentExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->attachmentName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[ATTACHMENT]'); + $request = (new GetAttachmentRequest())->setName($formattedName); + try { + $gapicClient->getAttachment($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function getDockerImageTest() { @@ -1295,8 +1917,10 @@ public function getProjectSettingsTest() $this->assertTrue($transport->isExhausted()); // Mock response $name2 = 'name2-1052831874'; + $pullPercent = 1781572683; $expectedResponse = new ProjectSettings(); $expectedResponse->setName($name2); + $expectedResponse->setPullPercent($pullPercent); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->projectSettingsName('[PROJECT]'); @@ -1436,6 +2060,8 @@ public function getRepositoryTest() $sizeBytes = 1796325715; $satisfiesPzs = false; $cleanupPolicyDryRun = false; + $disallowUnspecifiedMode = false; + $satisfiesPzi = false; $expectedResponse = new Repository(); $expectedResponse->setName($name2); $expectedResponse->setDescription($description); @@ -1443,6 +2069,8 @@ public function getRepositoryTest() $expectedResponse->setSizeBytes($sizeBytes); $expectedResponse->setSatisfiesPzs($satisfiesPzs); $expectedResponse->setCleanupPolicyDryRun($cleanupPolicyDryRun); + $expectedResponse->setDisallowUnspecifiedMode($disallowUnspecifiedMode); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); @@ -1496,6 +2124,73 @@ public function getRepositoryExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function getRuleTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $packageId = 'packageId29331380'; + $expectedResponse = new Rule(); + $expectedResponse->setName($name2); + $expectedResponse->setPackageId($packageId); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->ruleName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[RULE]'); + $request = (new GetRuleRequest())->setName($formattedName); + $response = $gapicClient->getRule($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/GetRule', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getRuleExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->ruleName('[PROJECT]', '[LOCATION]', '[REPOSITORY]', '[RULE]'); + $request = (new GetRuleRequest())->setName($formattedName); + try { + $gapicClient->getRule($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function getTagTest() { @@ -1921,6 +2616,77 @@ public function importYumArtifactsExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function listAttachmentsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $attachmentsElement = new Attachment(); + $attachments = [$attachmentsElement]; + $expectedResponse = new ListAttachmentsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setAttachments($attachments); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new ListAttachmentsRequest())->setParent($formattedParent); + $response = $gapicClient->listAttachments($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getAttachments()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/ListAttachments', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listAttachmentsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new ListAttachmentsRequest())->setParent($formattedParent); + try { + $gapicClient->listAttachments($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function listDockerImagesTest() { @@ -2290,28 +3056,99 @@ public function listPythonPackagesTest() $pythonPackages = [$pythonPackagesElement]; $expectedResponse = new ListPythonPackagesResponse(); $expectedResponse->setNextPageToken($nextPageToken); - $expectedResponse->setPythonPackages($pythonPackages); + $expectedResponse->setPythonPackages($pythonPackages); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new ListPythonPackagesRequest())->setParent($formattedParent); + $response = $gapicClient->listPythonPackages($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getPythonPackages()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/ListPythonPackages', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listPythonPackagesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new ListPythonPackagesRequest())->setParent($formattedParent); + try { + $gapicClient->listPythonPackages($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listRepositoriesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $repositoriesElement = new Repository(); + $repositories = [$repositoriesElement]; + $expectedResponse = new ListRepositoriesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setRepositories($repositories); $transport->addResponse($expectedResponse); // Mock request - $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); - $request = (new ListPythonPackagesRequest())->setParent($formattedParent); - $response = $gapicClient->listPythonPackages($request); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListRepositoriesRequest())->setParent($formattedParent); + $response = $gapicClient->listRepositories($request); $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); $resources = iterator_to_array($response->iterateAllElements()); $this->assertSame(1, count($resources)); - $this->assertEquals($expectedResponse->getPythonPackages()[0], $resources[0]); + $this->assertEquals($expectedResponse->getRepositories()[0], $resources[0]); $actualRequests = $transport->popReceivedCalls(); $this->assertSame(1, count($actualRequests)); $actualFuncCall = $actualRequests[0]->getFuncCall(); $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/ListPythonPackages', $actualFuncCall); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/ListRepositories', $actualFuncCall); $actualValue = $actualRequestObject->getParent(); $this->assertProtobufEquals($formattedParent, $actualValue); $this->assertTrue($transport->isExhausted()); } /** @test */ - public function listPythonPackagesExceptionTest() + public function listRepositoriesExceptionTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -2332,10 +3169,10 @@ public function listPythonPackagesExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); - $request = (new ListPythonPackagesRequest())->setParent($formattedParent); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListRepositoriesRequest())->setParent($formattedParent); try { - $gapicClient->listPythonPackages($request); + $gapicClient->listRepositories($request); // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { @@ -2348,7 +3185,7 @@ public function listPythonPackagesExceptionTest() } /** @test */ - public function listRepositoriesTest() + public function listRulesTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -2357,32 +3194,32 @@ public function listRepositoriesTest() $this->assertTrue($transport->isExhausted()); // Mock response $nextPageToken = ''; - $repositoriesElement = new Repository(); - $repositories = [$repositoriesElement]; - $expectedResponse = new ListRepositoriesResponse(); + $rulesElement = new Rule(); + $rules = [$rulesElement]; + $expectedResponse = new ListRulesResponse(); $expectedResponse->setNextPageToken($nextPageToken); - $expectedResponse->setRepositories($repositories); + $expectedResponse->setRules($rules); $transport->addResponse($expectedResponse); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListRepositoriesRequest())->setParent($formattedParent); - $response = $gapicClient->listRepositories($request); + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new ListRulesRequest())->setParent($formattedParent); + $response = $gapicClient->listRules($request); $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); $resources = iterator_to_array($response->iterateAllElements()); $this->assertSame(1, count($resources)); - $this->assertEquals($expectedResponse->getRepositories()[0], $resources[0]); + $this->assertEquals($expectedResponse->getRules()[0], $resources[0]); $actualRequests = $transport->popReceivedCalls(); $this->assertSame(1, count($actualRequests)); $actualFuncCall = $actualRequests[0]->getFuncCall(); $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/ListRepositories', $actualFuncCall); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/ListRules', $actualFuncCall); $actualValue = $actualRequestObject->getParent(); $this->assertProtobufEquals($formattedParent, $actualValue); $this->assertTrue($transport->isExhausted()); } /** @test */ - public function listRepositoriesExceptionTest() + public function listRulesExceptionTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -2403,10 +3240,10 @@ public function listRepositoriesExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListRepositoriesRequest())->setParent($formattedParent); + $formattedParent = $gapicClient->repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]'); + $request = (new ListRulesRequest())->setParent($formattedParent); try { - $gapicClient->listRepositories($request); + $gapicClient->listRules($request); // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { @@ -2686,6 +3523,140 @@ public function testIamPermissionsExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function updateFileTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $sizeBytes = 1796325715; + $owner = 'owner106164915'; + $expectedResponse = new File(); + $expectedResponse->setName($name); + $expectedResponse->setSizeBytes($sizeBytes); + $expectedResponse->setOwner($owner); + $transport->addResponse($expectedResponse); + // Mock request + $file = new File(); + $updateMask = new FieldMask(); + $request = (new UpdateFileRequest())->setFile($file)->setUpdateMask($updateMask); + $response = $gapicClient->updateFile($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/UpdateFile', $actualFuncCall); + $actualValue = $actualRequestObject->getFile(); + $this->assertProtobufEquals($file, $actualValue); + $actualValue = $actualRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateFileExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $file = new File(); + $updateMask = new FieldMask(); + $request = (new UpdateFileRequest())->setFile($file)->setUpdateMask($updateMask); + try { + $gapicClient->updateFile($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updatePackageTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $displayName = 'displayName1615086568'; + $expectedResponse = new Package(); + $expectedResponse->setName($name); + $expectedResponse->setDisplayName($displayName); + $transport->addResponse($expectedResponse); + $request = new UpdatePackageRequest(); + $response = $gapicClient->updatePackage($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/UpdatePackage', $actualFuncCall); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updatePackageExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + $request = new UpdatePackageRequest(); + try { + $gapicClient->updatePackage($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function updateProjectSettingsTest() { @@ -2696,8 +3667,10 @@ public function updateProjectSettingsTest() $this->assertTrue($transport->isExhausted()); // Mock response $name = 'name3373707'; + $pullPercent = 1781572683; $expectedResponse = new ProjectSettings(); $expectedResponse->setName($name); + $expectedResponse->setPullPercent($pullPercent); $transport->addResponse($expectedResponse); $request = new UpdateProjectSettingsRequest(); $response = $gapicClient->updateProjectSettings($request); @@ -2763,6 +3736,8 @@ public function updateRepositoryTest() $sizeBytes = 1796325715; $satisfiesPzs = false; $cleanupPolicyDryRun = false; + $disallowUnspecifiedMode = false; + $satisfiesPzi = false; $expectedResponse = new Repository(); $expectedResponse->setName($name); $expectedResponse->setDescription($description); @@ -2770,6 +3745,8 @@ public function updateRepositoryTest() $expectedResponse->setSizeBytes($sizeBytes); $expectedResponse->setSatisfiesPzs($satisfiesPzs); $expectedResponse->setCleanupPolicyDryRun($cleanupPolicyDryRun); + $expectedResponse->setDisallowUnspecifiedMode($disallowUnspecifiedMode); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); $request = new UpdateRepositoryRequest(); $response = $gapicClient->updateRepository($request); @@ -2817,6 +3794,67 @@ public function updateRepositoryExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function updateRuleTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $packageId = 'packageId29331380'; + $expectedResponse = new Rule(); + $expectedResponse->setName($name); + $expectedResponse->setPackageId($packageId); + $transport->addResponse($expectedResponse); + $request = new UpdateRuleRequest(); + $response = $gapicClient->updateRule($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/UpdateRule', $actualFuncCall); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateRuleExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + $request = new UpdateRuleRequest(); + try { + $gapicClient->updateRule($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function updateTagTest() { @@ -2937,6 +3975,73 @@ public function updateVPCSCConfigExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function updateVersionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name = 'name3373707'; + $description = 'description-1724546052'; + $expectedResponse = new Version(); + $expectedResponse->setName($name); + $expectedResponse->setDescription($description); + $transport->addResponse($expectedResponse); + // Mock request + $version = new Version(); + $request = (new UpdateVersionRequest())->setVersion($version); + $response = $gapicClient->updateVersion($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.devtools.artifactregistry.v1.ArtifactRegistry/UpdateVersion', $actualFuncCall); + $actualValue = $actualRequestObject->getVersion(); + $this->assertProtobufEquals($version, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function updateVersionExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $version = new Version(); + $request = (new UpdateVersionRequest())->setVersion($version); + try { + $gapicClient->updateVersion($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function getLocationTest() { From b1dcfc615fef5fcbb316d0fa5eb8d41e79ed1565 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 30 Oct 2024 17:19:03 -0400 Subject: [PATCH 049/157] feat: Add feature flags proto for Direct Access (#7770) PiperOrigin-RevId: 690605789 Source-Link: https://github.com/googleapis/googleapis/commit/ab2ad69473e17b813f5555a44b89691f67b66297 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6d1f0a73aa79fe57dffdd95087622d4820499fd5 Copy-Tag: eyJwIjoiQmlndGFibGUvLk93bEJvdC55YW1sIiwiaCI6IjZkMWYwYTczYWE3OWZlNTdkZmZkZDk1MDg3NjIyZDQ4MjA0OTlmZDUifQ== --- Bigtable/metadata/V2/FeatureFlags.php | 9 ++-- Bigtable/src/V2/FeatureFlags.php | 68 +++++++++++++++++++++++++++ 2 files changed, 74 insertions(+), 3 deletions(-) diff --git a/Bigtable/metadata/V2/FeatureFlags.php b/Bigtable/metadata/V2/FeatureFlags.php index 955fbb3fe5e2..fd70d1524270 100644 --- a/Bigtable/metadata/V2/FeatureFlags.php +++ b/Bigtable/metadata/V2/FeatureFlags.php @@ -16,8 +16,8 @@ public static function initOnce() { } $pool->internalAddGeneratedFile( ' -à -&google/bigtable/v2/feature_flags.protogoogle.bigtable.v2"Û +£ +&google/bigtable/v2/feature_flags.protogoogle.bigtable.v2"ž FeatureFlags reverse_scans ( mutate_rows_rate_limit ( @@ -26,7 +26,10 @@ public static function initOnce() { routing_cookie ( retry_info (# -client_side_metrics_enabled (B» +client_side_metrics_enabled ( +traffic_director_enabled ( +direct_access_requested + (B» com.google.bigtable.v2BFeatureFlagsProtoPZ8cloud.google.com/go/bigtable/apiv2/bigtablepb;bigtablepbªGoogle.Cloud.Bigtable.V2ÊGoogle\\Cloud\\Bigtable\\V2êGoogle::Cloud::Bigtable::V2bproto3' , true); diff --git a/Bigtable/src/V2/FeatureFlags.php b/Bigtable/src/V2/FeatureFlags.php index 06504aadd20c..51c17b64d53f 100644 --- a/Bigtable/src/V2/FeatureFlags.php +++ b/Bigtable/src/V2/FeatureFlags.php @@ -72,6 +72,18 @@ class FeatureFlags extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool client_side_metrics_enabled = 8; */ protected $client_side_metrics_enabled = false; + /** + * Notify the server that the client using Traffic Director endpoint. + * + * Generated from protobuf field bool traffic_director_enabled = 9; + */ + protected $traffic_director_enabled = false; + /** + * Notify the server that the client explicitly opted in for Direct Access. + * + * Generated from protobuf field bool direct_access_requested = 10; + */ + protected $direct_access_requested = false; /** * Constructor. @@ -101,6 +113,10 @@ class FeatureFlags extends \Google\Protobuf\Internal\Message * durations to retry requests with. * @type bool $client_side_metrics_enabled * Notify the server that the client has client side metrics enabled. + * @type bool $traffic_director_enabled + * Notify the server that the client using Traffic Director endpoint. + * @type bool $direct_access_requested + * Notify the server that the client explicitly opted in for Direct Access. * } */ public function __construct($data = NULL) { @@ -306,5 +322,57 @@ public function setClientSideMetricsEnabled($var) return $this; } + /** + * Notify the server that the client using Traffic Director endpoint. + * + * Generated from protobuf field bool traffic_director_enabled = 9; + * @return bool + */ + public function getTrafficDirectorEnabled() + { + return $this->traffic_director_enabled; + } + + /** + * Notify the server that the client using Traffic Director endpoint. + * + * Generated from protobuf field bool traffic_director_enabled = 9; + * @param bool $var + * @return $this + */ + public function setTrafficDirectorEnabled($var) + { + GPBUtil::checkBool($var); + $this->traffic_director_enabled = $var; + + return $this; + } + + /** + * Notify the server that the client explicitly opted in for Direct Access. + * + * Generated from protobuf field bool direct_access_requested = 10; + * @return bool + */ + public function getDirectAccessRequested() + { + return $this->direct_access_requested; + } + + /** + * Notify the server that the client explicitly opted in for Direct Access. + * + * Generated from protobuf field bool direct_access_requested = 10; + * @param bool $var + * @return $this + */ + public function setDirectAccessRequested($var) + { + GPBUtil::checkBool($var); + $this->direct_access_requested = $var; + + return $this; + } + } From 4e408c363e197524feb8b2109f07d58d3d812045 Mon Sep 17 00:00:00 2001 From: Thiyagu K Date: Thu, 31 Oct 2024 10:42:22 +0530 Subject: [PATCH 050/157] feat(Storage): add support for restore token (#7775) --- Storage/src/Bucket.php | 5 + .../ServiceDefinition/storage-v1.json | 10786 ++++++++-------- Storage/tests/System/ManageObjectsTest.php | 43 +- Storage/tests/Unit/BucketTest.php | 16 + 4 files changed, 5461 insertions(+), 5389 deletions(-) diff --git a/Storage/src/Bucket.php b/Storage/src/Bucket.php index 5fcd08696c72..946245c7f4e1 100644 --- a/Storage/src/Bucket.php +++ b/Storage/src/Bucket.php @@ -592,6 +592,9 @@ public function getStreamableUploader($data, array $options = []) * from the `encryptionKey` on your behalf if not provided, but * for best performance it is recommended to pass in a cached * version of the already calculated SHA. + * @type boolean $softDeleted If true, returns the metadata of the + * soft-deleted object. If true, generation must also be specified, + * and alt=media cannot be specified. * } * @return StorageObject */ @@ -627,6 +630,8 @@ public function object($name, array $options = []) * @param array $options [optional] { * Configuration Options. * + * @type string $restoreToken Must be specified when getting a soft-deleted object from + * an HNS-enabled bucket that has a name and generation conflict with another object in the same bucket. * @type string $ifGenerationMatch Makes the operation conditional on whether * the object's current generation matches the given value. * @type string $ifGenerationNotMatch Makes the operation conditional on whether diff --git a/Storage/src/Connection/ServiceDefinition/storage-v1.json b/Storage/src/Connection/ServiceDefinition/storage-v1.json index 76ce2ce9d8bf..3a625cc96d2b 100644 --- a/Storage/src/Connection/ServiceDefinition/storage-v1.json +++ b/Storage/src/Connection/ServiceDefinition/storage-v1.json @@ -202,5524 +202,5534 @@ "type": "string", "description": "HTTP 1.1 Entity tag for the bucket." }, - "hierarchicalNamespace": { - "type": "object", - "description": "The bucket's hierarchical namespace configuration.", - "properties": { - "enabled": { - "type": "boolean", - "description": "When set to true, hierarchical namespace is enabled for this bucket." - } - } - }, - "iamConfiguration": { - "type": "object", - "description": "The bucket's IAM configuration.", - "properties": { - "bucketPolicyOnly": { - "type": "object", - "description": "The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.", - "properties": { - "enabled": { - "type": "boolean", - "description": "If set, access is controlled only by bucket-level or above IAM policies." - }, - "lockedTime": { - "type": "string", - "description": "The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.", - "format": "date-time" - } - } - }, - "uniformBucketLevelAccess": { - "type": "object", - "description": "The bucket's uniform bucket-level access configuration.", - "properties": { - "enabled": { - "type": "boolean", - "description": "If set, access is controlled only by bucket-level or above IAM policies." - }, - "lockedTime": { - "type": "string", - "description": "The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.", - "format": "date-time" + "hierarchicalNamespace": { + "type": "object", + "description": "The bucket's hierarchical namespace configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "When set to true, hierarchical namespace is enabled for this bucket." + } } - } - }, - "publicAccessPrevention": { - "type": "string", - "description": "The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported." - } - } - }, - "id": { - "type": "string", - "description": "The ID of the bucket. For buckets, the id and name properties are the same." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For buckets, this is always storage#bucket.", - "default": "storage#bucket" - }, - "labels": { - "type": "object", - "description": "User-provided labels, in key/value pairs.", - "additionalProperties": { - "type": "string", - "description": "An individual label entry." - } - }, - "lifecycle": { - "type": "object", - "description": "The bucket's lifecycle configuration. See lifecycle management for more information.", - "properties": { - "rule": { - "type": "array", - "description": "A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.", - "items": { + }, + "iamConfiguration": { "type": "object", + "description": "The bucket's IAM configuration.", "properties": { - "action": { + "bucketPolicyOnly": { "type": "object", - "description": "The action to take.", + "description": "The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.", "properties": { - "storageClass": { - "type": "string", - "description": "Target storage class. Required iff the type of the action is SetStorageClass." + "enabled": { + "type": "boolean", + "description": "If set, access is controlled only by bucket-level or above IAM policies." }, - "type": { + "lockedTime": { "type": "string", - "description": "Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported." + "description": "The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.", + "format": "date-time" } } }, - "condition": { + "uniformBucketLevelAccess": { "type": "object", - "description": "The condition(s) under which the action will be taken.", + "description": "The bucket's uniform bucket-level access configuration.", "properties": { - "age": { - "type": "integer", - "description": "Age of an object (in days). This condition is satisfied when an object reaches the specified age.", - "format": "int32" - }, - "createdBefore": { - "type": "string", - "description": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when an object is created before midnight of the specified date in UTC.", - "format": "date" - }, - "customTimeBefore": { - "type": "string", - "description": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when the custom time on an object is before this date in UTC.", - "format": "date" - }, - "daysSinceCustomTime": { - "type": "integer", - "description": "Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.", - "format": "int32" - }, - "daysSinceNoncurrentTime": { - "type": "integer", - "description": "Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.", - "format": "int32" - }, - "isLive": { + "enabled": { "type": "boolean", - "description": "Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects." + "description": "If set, access is controlled only by bucket-level or above IAM policies." }, - "matchesPattern": { + "lockedTime": { "type": "string", - "description": "A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the \"Early Access\" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released." - }, - "matchesPrefix": { - "type": "array", - "description": "List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.", - "items": { - "type": "string" - } - }, - "matchesSuffix": { - "type": "array", - "description": "List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.", - "items": { - "type": "string" - } - }, - "matchesStorageClass": { - "type": "array", - "description": "Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.", - "items": { - "type": "string" + "description": "The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.", + "format": "date-time" + } + } + }, + "publicAccessPrevention": { + "type": "string", + "description": "The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported." + } + } + }, + "id": { + "type": "string", + "description": "The ID of the bucket. For buckets, the id and name properties are the same." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For buckets, this is always storage#bucket.", + "default": "storage#bucket" + }, + "labels": { + "type": "object", + "description": "User-provided labels, in key/value pairs.", + "additionalProperties": { + "type": "string", + "description": "An individual label entry." + } + }, + "lifecycle": { + "type": "object", + "description": "The bucket's lifecycle configuration. See lifecycle management for more information.", + "properties": { + "rule": { + "type": "array", + "description": "A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.", + "items": { + "type": "object", + "properties": { + "action": { + "type": "object", + "description": "The action to take.", + "properties": { + "storageClass": { + "type": "string", + "description": "Target storage class. Required iff the type of the action is SetStorageClass." + }, + "type": { + "type": "string", + "description": "Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported." + } + } + }, + "condition": { + "type": "object", + "description": "The condition(s) under which the action will be taken.", + "properties": { + "age": { + "type": "integer", + "description": "Age of an object (in days). This condition is satisfied when an object reaches the specified age.", + "format": "int32" + }, + "createdBefore": { + "type": "string", + "description": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when an object is created before midnight of the specified date in UTC.", + "format": "date" + }, + "customTimeBefore": { + "type": "string", + "description": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when the custom time on an object is before this date in UTC.", + "format": "date" + }, + "daysSinceCustomTime": { + "type": "integer", + "description": "Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.", + "format": "int32" + }, + "daysSinceNoncurrentTime": { + "type": "integer", + "description": "Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.", + "format": "int32" + }, + "isLive": { + "type": "boolean", + "description": "Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects." + }, + "matchesPattern": { + "type": "string", + "description": "A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the \"Early Access\" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released." + }, + "matchesPrefix": { + "type": "array", + "description": "List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.", + "items": { + "type": "string" + } + }, + "matchesSuffix": { + "type": "array", + "description": "List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.", + "items": { + "type": "string" + } + }, + "matchesStorageClass": { + "type": "array", + "description": "Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.", + "items": { + "type": "string" + } + }, + "noncurrentTimeBefore": { + "type": "string", + "description": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.", + "format": "date" + }, + "numNewerVersions": { + "type": "integer", + "description": "Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.", + "format": "int32" + } + } } - }, - "noncurrentTimeBefore": { - "type": "string", - "description": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.", - "format": "date" - }, - "numNewerVersions": { - "type": "integer", - "description": "Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.", - "format": "int32" } } } } - } - } - } - }, - "autoclass": { - "type": "object", - "description": "The bucket's Autoclass configuration.", - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether or not Autoclass is enabled on this bucket" - }, - "toggleTime": { - "type": "string", - "description": "A date and time in RFC 3339 format representing the instant at which \"enabled\" was last toggled.", - "format": "date-time" - }, - "terminalStorageClass": { - "type": "string", - "description": "The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Valid values are NEARLINE and ARCHIVE." - }, - "terminalStorageClassUpdateTime": { - "type": "string", - "description": "A date and time in RFC 3339 format representing the time of the most recent update to \"terminalStorageClass\".", - "format": "date-time" - } - } - }, - "location": { - "type": "string", - "description": "The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list." - }, - "locationType": { - "type": "string", - "description": "The type of the bucket location." - }, - "logging": { - "type": "object", - "description": "The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.", - "properties": { - "logBucket": { - "type": "string", - "description": "The destination bucket where the current bucket's logs should be placed." - }, - "logObjectPrefix": { - "type": "string", - "description": "A prefix for log object names." - } - } - }, - "metageneration": { - "type": "string", - "description": "The metadata generation of this bucket.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the bucket.", - "annotations": { - "required": [ - "storage.buckets.insert" - ] - } - }, - "owner": { - "type": "object", - "description": "The owner of the bucket. This is always the project team's owner group.", - "properties": { - "entity": { - "type": "string", - "description": "The entity, in the form project-owner-projectId." - }, - "entityId": { - "type": "string", - "description": "The ID for the entity." - } - } - }, - "projectNumber": { - "type": "string", - "description": "The project number of the project the bucket belongs to.", - "format": "uint64" - }, - "retentionPolicy": { - "type": "object", - "description": "The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.", - "properties": { - "effectiveTime": { - "type": "string", - "description": "Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.", - "format": "date-time" - }, - "isLocked": { - "type": "boolean", - "description": "Once locked, an object retention policy cannot be modified." - }, - "retentionPeriod": { - "type": "string", - "description": "The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.", - "format": "int64" - } - } - }, - "objectRetention": { - "type": "object", - "description": "The bucket's object retention config.", - "properties": { - "mode": { - "type": "string", - "description": "The bucket's object retention mode. Can be Enabled." - } - } - }, - "rpo": { - "type": "string", - "description": "The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket." - }, - "selfLink": { - "type": "string", - "description": "The URI of this bucket." - }, - "softDeletePolicy": { - "type": "object", - "description": "The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.", - "properties": { - "retentionDurationSeconds": { - "type": "string", - "description": "The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.", - "format": "int64" - }, - "effectiveTime": { - "type": "string", - "description": "Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.", - "format": "date-time" - } - } - }, - "storageClass": { - "type": "string", - "description": "The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes." - }, - "timeCreated": { - "type": "string", - "description": "The creation time of the bucket in RFC 3339 format.", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "The modification time of the bucket in RFC 3339 format.", - "format": "date-time" - }, - "versioning": { - "type": "object", - "description": "The bucket's versioning configuration.", - "properties": { - "enabled": { - "type": "boolean", - "description": "While set to true, versioning is fully enabled for this bucket." - } - } - }, - "website": { - "type": "object", - "description": "The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.", - "properties": { - "mainPageSuffix": { - "type": "string", - "description": "If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages." - }, - "notFoundPage": { - "type": "string", - "description": "If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result." - } - } - }, - "satisfiesPZS": { - "type": "boolean", - "description": "Reserved for future use." - } -} -}, -"AnywhereCache": { -"id": "AnywhereCache", -"type": "object", -"description": "An Anywhere Cache instance.", -"properties": { - "kind": { - "type": "string", - "description": "The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.", - "default": "storage#anywhereCache" - }, - "id": { - "type": "string", - "description": "The ID of the resource, including the project number, bucket name and anywhere cache ID." - }, - "selfLink": { - "type": "string", - "description": "The link to this cache instance." - }, - "bucket": { - "type": "string", - "description": "The name of the bucket containing this cache instance." - }, - "anywhereCacheId": { - "type": "string", - "description": "The ID of the Anywhere cache instance." - }, - "zone": { - "type": "string", - "description": "The zone in which the cache instance is running. For example, us-central1-a." - }, - "state": { - "type": "string", - "description": "The current state of the cache instance." - }, - "createTime": { - "type": "string", - "description": "The creation time of the cache instance in RFC 3339 format.", - "format": "date-time" - }, - "updateTime": { - "type": "string", - "description": "The modification time of the cache instance metadata in RFC 3339 format.", - "format": "date-time" - }, - "ttl": { - "type": "string", - "description": "The TTL of all cache entries in whole seconds. e.g., \"7200s\". ", - "format": "google-duration" - }, - "admissionPolicy": { - "type": "string", - "description": "The cache-level entry admission policy." - }, - "pendingUpdate": { - "type": "boolean", - "description": "True if the cache instance has an active Update long-running operation." - } -} -}, -"AnywhereCaches": { -"id": "AnywhereCaches", -"type": "object", -"description": "A list of Anywhere Caches.", -"properties": { - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of Anywhere Caches, this is always storage#anywhereCaches.", - "default": "storage#anywhereCaches" - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." - }, - "items": { - "type": "array", - "description": "The list of items.", - "items": { - "$ref": "AnywhereCache" - } - } -} -}, -"BucketAccessControl": { -"id": "BucketAccessControl", -"type": "object", -"description": "An access-control entry.", -"properties": { - "bucket": { - "type": "string", - "description": "The name of the bucket." - }, - "domain": { - "type": "string", - "description": "The domain associated with the entity, if any." - }, - "email": { - "type": "string", - "description": "The email address associated with the entity, if any." - }, - "entity": { - "type": "string", - "description": "The entity holding the permission, in one of the following forms: \n- user-userId \n- user-email \n- group-groupId \n- group-email \n- domain-domain \n- project-team-projectId \n- allUsers \n- allAuthenticatedUsers Examples: \n- The user liz@example.com would be user-liz@example.com. \n- The group example@googlegroups.com would be group-example@googlegroups.com. \n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.", - "annotations": { - "required": [ - "storage.bucketAccessControls.insert" - ] - } - }, - "entityId": { - "type": "string", - "description": "The ID for the entity, if any." - }, - "etag": { - "type": "string", - "description": "HTTP 1.1 Entity tag for the access-control entry." - }, - "id": { - "type": "string", - "description": "The ID of the access-control entry." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.", - "default": "storage#bucketAccessControl" - }, - "projectTeam": { - "type": "object", - "description": "The project team associated with the entity, if any.", - "properties": { - "projectNumber": { - "type": "string", - "description": "The project number." - }, - "team": { - "type": "string", - "description": "The team." - } - } - }, - "role": { - "type": "string", - "description": "The access permission for the entity.", - "annotations": { - "required": [ - "storage.bucketAccessControls.insert" - ] - } - }, - "selfLink": { - "type": "string", - "description": "The link to this access-control entry." - } -} -}, -"BucketAccessControls": { -"id": "BucketAccessControls", -"type": "object", -"description": "An access-control list.", -"properties": { - "items": { - "type": "array", - "description": "The list of items.", - "items": { - "$ref": "BucketAccessControl" - } - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.", - "default": "storage#bucketAccessControls" - } -} -}, -"Buckets": { -"id": "Buckets", -"type": "object", -"description": "A list of buckets.", -"properties": { - "items": { - "type": "array", - "description": "The list of items.", - "items": { - "$ref": "Bucket" - } - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of buckets, this is always storage#buckets.", - "default": "storage#buckets" - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." - } -} -}, -"Channel": { -"id": "Channel", -"type": "object", -"description": "An notification channel used to watch for resource changes.", -"properties": { - "address": { - "type": "string", - "description": "The address where notifications are delivered for this channel." - }, - "expiration": { - "type": "string", - "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.", - "format": "int64" - }, - "id": { - "type": "string", - "description": "A UUID or similar unique string that identifies this channel." - }, - "kind": { - "type": "string", - "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", - "default": "api#channel" - }, - "params": { - "type": "object", - "description": "Additional parameters controlling delivery channel behavior. Optional.", - "additionalProperties": { - "type": "string", - "description": "Declares a new parameter by name." - } - }, - "payload": { - "type": "boolean", - "description": "A Boolean value to indicate whether payload is wanted. Optional." - }, - "resourceId": { - "type": "string", - "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions." - }, - "resourceUri": { - "type": "string", - "description": "A version-specific identifier for the watched resource." - }, - "token": { - "type": "string", - "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional." - }, - "type": { - "type": "string", - "description": "The type of delivery mechanism used for this channel." - } -} -}, -"ComposeRequest": { -"id": "ComposeRequest", -"type": "object", -"description": "A Compose request.", -"properties": { - "destination": { - "$ref": "Object", - "description": "Properties of the resulting object." - }, - "kind": { - "type": "string", - "description": "The kind of item this is.", - "default": "storage#composeRequest" - }, - "sourceObjects": { - "type": "array", - "description": "The list of source objects that will be concatenated into a single object.", - "items": { - "type": "object", - "properties": { - "generation": { + }, + "autoclass": { + "type": "object", + "description": "The bucket's Autoclass configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not Autoclass is enabled on this bucket" + }, + "toggleTime": { + "type": "string", + "description": "A date and time in RFC 3339 format representing the instant at which \"enabled\" was last toggled.", + "format": "date-time" + }, + "terminalStorageClass": { + "type": "string", + "description": "The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Valid values are NEARLINE and ARCHIVE." + }, + "terminalStorageClassUpdateTime": { + "type": "string", + "description": "A date and time in RFC 3339 format representing the time of the most recent update to \"terminalStorageClass\".", + "format": "date-time" + } + } + }, + "location": { + "type": "string", + "description": "The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list." + }, + "locationType": { + "type": "string", + "description": "The type of the bucket location." + }, + "logging": { + "type": "object", + "description": "The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.", + "properties": { + "logBucket": { + "type": "string", + "description": "The destination bucket where the current bucket's logs should be placed." + }, + "logObjectPrefix": { + "type": "string", + "description": "A prefix for log object names." + } + } + }, + "metageneration": { "type": "string", - "description": "The generation of this object to use as the source.", + "description": "The metadata generation of this bucket.", "format": "int64" }, "name": { "type": "string", - "description": "The source object's name. All source objects must reside in the same bucket.", + "description": "The name of the bucket.", "annotations": { "required": [ - "storage.objects.compose" + "storage.buckets.insert" ] } }, - "objectPreconditions": { + "owner": { "type": "object", - "description": "Conditions that must be met for this operation to execute.", + "description": "The owner of the bucket. This is always the project team's owner group.", "properties": { - "ifGenerationMatch": { + "entity": { + "type": "string", + "description": "The entity, in the form project-owner-projectId." + }, + "entityId": { + "type": "string", + "description": "The ID for the entity." + } + } + }, + "projectNumber": { + "type": "string", + "description": "The project number of the project the bucket belongs to.", + "format": "uint64" + }, + "retentionPolicy": { + "type": "object", + "description": "The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.", + "properties": { + "effectiveTime": { + "type": "string", + "description": "Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.", + "format": "date-time" + }, + "isLocked": { + "type": "boolean", + "description": "Once locked, an object retention policy cannot be modified." + }, + "retentionPeriod": { "type": "string", - "description": "Only perform the composition if the generation of the source object that would be used matches this value. If this value and a generation are both specified, they must be the same value or the call will fail.", + "description": "The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.", "format": "int64" } } - } - } - }, - "annotations": { - "required": [ - "storage.objects.compose" - ] - } - } -} -}, - "Folder": { - "id": "Folder", - "type": "object", - "description": "A folder. Only available in buckets with hierarchical namespace enabled.", - "properties": { - "bucket": { - "type": "string", - "description": "The name of the bucket containing this folder." - }, - "id": { - "type": "string", - "description": "The ID of the folder, including the bucket name, folder name." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For folders, this is always storage#folder.", - "default": "storage#folder" - }, - "metageneration": { - "type": "string", - "description": "The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the folder. Required if not specified by URL parameter." - }, - "selfLink": { - "type": "string", - "description": "The link to this folder." - }, - "createTime": { - "type": "string", - "description": "The creation time of the folder in RFC 3339 format.", - "format": "date-time" - }, - "updateTime": { - "type": "string", - "description": "The modification time of the folder metadata in RFC 3339 format.", - "format": "date-time" - }, - "pendingRenameInfo": { - "type": "object", - "description": "Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.", - "properties": { - "operationId": { - "type": "string", - "description": "The ID of the rename folder operation." + }, + "objectRetention": { + "type": "object", + "description": "The bucket's object retention config.", + "properties": { + "mode": { + "type": "string", + "description": "The bucket's object retention mode. Can be Enabled." + } } - } - } - } - }, - "Folders": { - "id": "Folders", - "type": "object", - "description": "A list of folders.", - "properties": { - "items": { - "type": "array", - "description": "The list of items.", - "items": { - "$ref": "Folder" - } - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of folders, this is always storage#folders.", - "default": "storage#folders" - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." - } - } - }, - "Expr": { - "id": "Expr", - "type": "object", - "description": "Represents an expression text. Example: title: \"User account presence\" description: \"Determines whether the request has a user account\" expression: \"size(request.user) > 0\"", - "properties": { - "description": { - "type": "string", - "description": "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI." - }, - "expression": { - "type": "string", - "description": "Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported." - }, - "location": { - "type": "string", - "description": "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file." - }, - "title": { - "type": "string", - "description": "An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression." - } - } - }, - "GoogleLongrunningOperation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "GoogleLongrunningOperation", - "properties": { - "done": { - "description": "If the value is \"false\", it means the operation is still in progress. If \"true\", the operation is completed, and either \"error\" or \"response\" is available.", - "type": "boolean" - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the \"name\" should be a resource name ending with \"operations/{operationId}\".", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" + "rpo": { + "type": "string", + "description": "The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket." }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as \"Delete\", the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type \"XxxResponse\", where \"Xxx\" is the original method name. For example, if the original method name is \"TakeSnapshot()\", the inferred response type is \"TakeSnapshotResponse\".", - "type": "object" - } - }, - "type": "object" - }, - "GoogleLongrunningListOperationsResponse": { - "description": "The response message for storage.buckets.operations.list.", - "id": "GoogleLongrunningListOperationsResponse", - "properties": { - "nextPageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." - }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "GoogleLongrunningOperation" + "selfLink": { + "type": "string", + "description": "The URI of this bucket." + }, + "softDeletePolicy": { + "type": "object", + "description": "The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.", + "properties": { + "retentionDurationSeconds": { + "type": "string", + "description": "The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.", + "format": "int64" + }, + "effectiveTime": { + "type": "string", + "description": "Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.", + "format": "date-time" + } + } + }, + "storageClass": { + "type": "string", + "description": "The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes." + }, + "timeCreated": { + "type": "string", + "description": "The creation time of the bucket in RFC 3339 format.", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "The modification time of the bucket in RFC 3339 format.", + "format": "date-time" + }, + "versioning": { + "type": "object", + "description": "The bucket's versioning configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "While set to true, versioning is fully enabled for this bucket." + } + } + }, + "website": { + "type": "object", + "description": "The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.", + "properties": { + "mainPageSuffix": { + "type": "string", + "description": "If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages." + }, + "notFoundPage": { + "type": "string", + "description": "If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result." + } + } }, - "type": "array" + "satisfiesPZS": { + "type": "boolean", + "description": "Reserved for future use." + } } }, - "type": "object" - }, - "GoogleRpcStatus": { - "description": "The \"Status\" type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each \"Status\" message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "GoogleRpcStatus", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" + "AnywhereCache": { + "id": "AnywhereCache", + "type": "object", + "description": "An Anywhere Cache instance.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.", + "default": "storage#anywhereCache" }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English.", - "type": "string" + "id": { + "type": "string", + "description": "The ID of the resource, including the project number, bucket name and anywhere cache ID." + }, + "selfLink": { + "type": "string", + "description": "The link to this cache instance." + }, + "bucket": { + "type": "string", + "description": "The name of the bucket containing this cache instance." + }, + "anywhereCacheId": { + "type": "string", + "description": "The ID of the Anywhere cache instance." + }, + "zone": { + "type": "string", + "description": "The zone in which the cache instance is running. For example, us-central1-a." + }, + "state": { + "type": "string", + "description": "The current state of the cache instance." + }, + "createTime": { + "type": "string", + "description": "The creation time of the cache instance in RFC 3339 format.", + "format": "date-time" + }, + "updateTime": { + "type": "string", + "description": "The modification time of the cache instance metadata in RFC 3339 format.", + "format": "date-time" + }, + "ttl": { + "type": "string", + "description": "The TTL of all cache entries in whole seconds. e.g., \"7200s\". ", + "format": "google-duration" + }, + "admissionPolicy": { + "type": "string", + "description": "The cache-level entry admission policy." + }, + "pendingUpdate": { + "type": "boolean", + "description": "True if the cache instance has an active Update long-running operation." + } } }, - "type": "object" - }, - "HmacKey": { - "id": "HmacKey", - "type": "object", - "description": "JSON template to produce a JSON-style HMAC Key resource for Create responses.", - "properties": { - "kind": { - "type": "string", - "description": "The kind of item this is. For HMAC keys, this is always storage#hmacKey.", - "default": "storage#hmacKey" - }, - "metadata": { - "$ref": "HmacKeyMetadata", - "description": "Key metadata." - }, - "secret": { - "type": "string", - "description": "HMAC secret key material." - } - } - }, - "HmacKeyMetadata": { - "id": "HmacKeyMetadata", - "type": "object", - "description": "JSON template to produce a JSON-style HMAC Key metadata resource.", - "properties": { - "accessId": { - "type": "string", - "description": "The ID of the HMAC Key." - }, - "etag": { - "type": "string", - "description": "HTTP 1.1 Entity tag for the HMAC key." - }, - "id": { - "type": "string", - "description": "The ID of the HMAC key, including the Project ID and the Access ID." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.", - "default": "storage#hmacKeyMetadata" - }, - "projectId": { - "type": "string", - "description": "Project ID owning the service account to which the key authenticates." - }, - "selfLink": { - "type": "string", - "description": "The link to this resource." - }, - "serviceAccountEmail": { - "type": "string", - "description": "The email address of the key's associated service account." - }, - "state": { - "type": "string", - "description": "The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED." - }, - "timeCreated": { - "type": "string", - "description": "The creation time of the HMAC key in RFC 3339 format.", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "The last modification time of the HMAC key metadata in RFC 3339 format.", - "format": "date-time" - } - } - }, - "HmacKeysMetadata": { - "id": "HmacKeysMetadata", - "type": "object", - "description": "A list of hmacKeys.", - "properties": { - "items": { - "type": "array", - "description": "The list of items.", + "AnywhereCaches": { + "id": "AnywhereCaches", + "type": "object", + "description": "A list of Anywhere Caches.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of Anywhere Caches, this is always storage#anywhereCaches.", + "default": "storage#anywhereCaches" + }, + "nextPageToken": { + "type": "string", + "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." + }, "items": { - "$ref": "HmacKeyMetadata" + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "AnywhereCache" + } } - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata.", - "default": "storage#hmacKeysMetadata" - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." } - } - }, - "ManagedFolder": { - "id": "ManagedFolder", - "type": "object", - "description": "A managed folder.", - "properties": { - "bucket": { - "type": "string", - "description": "The name of the bucket containing this managed folder." - }, - "id": { - "type": "string", - "description": "The ID of the managed folder, including the bucket name and managed folder name." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For managed folders, this is always storage#managedFolder.", - "default": "storage#managedFolder" - }, - "metageneration": { - "type": "string", - "description": "The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the managed folder. Required if not specified by URL parameter." - }, - "selfLink": { - "type": "string", - "description": "The link to this managed folder." - }, - "createTime": { - "type": "string", - "description": "The creation time of the managed folder in RFC 3339 format.", - "format": "date-time" - }, - "updateTime": { - "type": "string", - "description": "The last update time of the managed folder metadata in RFC 3339 format.", - "format": "date-time" - } - } - }, - "ManagedFolders": { - "id": "ManagedFolders", - "type": "object", - "description": "A list of managed folders.", - "properties": { - "items": { - "type": "array", - "description": "The list of items.", - "items": { - "$ref": "ManagedFolder" + }, + "BucketAccessControl": { + "id": "BucketAccessControl", + "type": "object", + "description": "An access-control entry.", + "properties": { + "bucket": { + "type": "string", + "description": "The name of the bucket." + }, + "domain": { + "type": "string", + "description": "The domain associated with the entity, if any." + }, + "email": { + "type": "string", + "description": "The email address associated with the entity, if any." + }, + "entity": { + "type": "string", + "description": "The entity holding the permission, in one of the following forms: \n- user-userId \n- user-email \n- group-groupId \n- group-email \n- domain-domain \n- project-team-projectId \n- allUsers \n- allAuthenticatedUsers Examples: \n- The user liz@example.com would be user-liz@example.com. \n- The group example@googlegroups.com would be group-example@googlegroups.com. \n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.", + "annotations": { + "required": [ + "storage.bucketAccessControls.insert" + ] + } + }, + "entityId": { + "type": "string", + "description": "The ID for the entity, if any." + }, + "etag": { + "type": "string", + "description": "HTTP 1.1 Entity tag for the access-control entry." + }, + "id": { + "type": "string", + "description": "The ID of the access-control entry." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.", + "default": "storage#bucketAccessControl" + }, + "projectTeam": { + "type": "object", + "description": "The project team associated with the entity, if any.", + "properties": { + "projectNumber": { + "type": "string", + "description": "The project number." + }, + "team": { + "type": "string", + "description": "The team." + } + } + }, + "role": { + "type": "string", + "description": "The access permission for the entity.", + "annotations": { + "required": [ + "storage.bucketAccessControls.insert" + ] + } + }, + "selfLink": { + "type": "string", + "description": "The link to this access-control entry." } - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of managed folders, this is always storage#managedFolders.", - "default": "storage#managedFolders" - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." } - } - }, - "Notification": { - "id": "Notification", - "type": "object", - "description": "A subscription to receive Google PubSub notifications.", - "properties": { - "custom_attributes": { - "type": "object", - "description": "An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.", - "additionalProperties": { - "type": "string" - } - }, - "etag": { - "type": "string", - "description": "HTTP 1.1 Entity tag for this subscription notification." - }, - "event_types": { - "type": "array", - "description": "If present, only send notifications about listed event types. If empty, sent notifications for all event types.", + }, + "BucketAccessControls": { + "id": "BucketAccessControls", + "type": "object", + "description": "An access-control list.", + "properties": { "items": { - "type": "string" - } - }, - "id": { - "type": "string", - "description": "The ID of the notification." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For notifications, this is always storage#notification.", - "default": "storage#notification" - }, - "object_name_prefix": { - "type": "string", - "description": "If present, only apply this notification configuration to object names that begin with this prefix." - }, - "payload_format": { - "type": "string", - "description": "The desired content of the Payload.", - "default": "JSON_API_V1", - "annotations": { - "required": [ - "storage.notifications.insert" - ] - } - }, - "selfLink": { - "type": "string", - "description": "The canonical URL of this notification." - }, - "topic": { - "type": "string", - "description": "The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'", - "annotations": { - "required": [ - "storage.notifications.insert" - ] + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "BucketAccessControl" + } + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.", + "default": "storage#bucketAccessControls" } } - } - }, - "Notifications": { - "id": "Notifications", - "type": "object", - "description": "A list of notification subscriptions.", - "properties": { - "items": { - "type": "array", - "description": "The list of items.", + }, + "Buckets": { + "id": "Buckets", + "type": "object", + "description": "A list of buckets.", + "properties": { "items": { - "$ref": "Notification" + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "Bucket" + } + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of buckets, this is always storage#buckets.", + "default": "storage#buckets" + }, + "nextPageToken": { + "type": "string", + "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." } - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of notifications, this is always storage#notifications.", - "default": "storage#notifications" } - } - }, - "Object": { - "id": "Object", - "type": "object", - "description": "An object.", - "properties": { - "acl": { - "type": "array", - "description": "Access controls on the object.", - "items": { - "$ref": "ObjectAccessControl" + }, + "Channel": { + "id": "Channel", + "type": "object", + "description": "An notification channel used to watch for resource changes.", + "properties": { + "address": { + "type": "string", + "description": "The address where notifications are delivered for this channel." }, - "annotations": { - "required": [ - "storage.objects.update" - ] - } - }, - "bucket": { - "type": "string", - "description": "The name of the bucket containing this object." - }, - "cacheControl": { - "type": "string", - "description": "Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600." - }, - "componentCount": { - "type": "integer", - "description": "Number of underlying components that make up this object. Components are accumulated by compose operations.", - "format": "int32" - }, - "contentDisposition": { - "type": "string", - "description": "Content-Disposition of the object data." - }, - "contentEncoding": { - "type": "string", - "description": "Content-Encoding of the object data." - }, - "contentLanguage": { - "type": "string", - "description": "Content-Language of the object data." - }, - "contentType": { - "type": "string", - "description": "Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream." - }, - "crc32c": { - "type": "string", - "description": "CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices." - }, - "customTime": { - "type": "string", - "description": "A timestamp in RFC 3339 format specified by the user for an object.", - "format": "date-time" - }, - "customerEncryption": { - "type": "object", - "description": "Metadata of customer-supplied encryption key, if the object is encrypted by such a key.", - "properties": { - "encryptionAlgorithm": { - "type": "string", - "description": "The encryption algorithm." - }, - "keySha256": { - "type": "string", - "description": "SHA256 hash value of the encryption key." - } - } - }, - "etag": { - "type": "string", - "description": "HTTP 1.1 Entity tag for the object." - }, - "eventBasedHold": { - "type": "boolean", - "description": "Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false." - }, - "generation": { - "type": "string", - "description": "The content generation of this object. Used for object versioning.", - "format": "int64" - }, - "id": { - "type": "string", - "description": "The ID of the object, including the bucket name, object name, and generation number." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For objects, this is always storage#object.", - "default": "storage#object" - }, - "kmsKeyName": { - "type": "string", - "description": "Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request." - }, - "md5Hash": { - "type": "string", - "description": "MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices." - }, - "mediaLink": { - "type": "string", - "description": "Media download link." - }, - "metadata": { - "type": "object", - "description": "User-provided metadata, in key/value pairs.", - "additionalProperties": { + "expiration": { "type": "string", - "description": "An individual metadata entry." - } - }, - "metageneration": { - "type": "string", - "description": "The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the object. Required if not specified by URL parameter." - }, - "owner": { - "type": "object", - "description": "The owner of the object. This will always be the uploader of the object.", - "properties": { - "entity": { - "type": "string", - "description": "The entity, in the form user-userId." - }, - "entityId": { - "type": "string", - "description": "The ID for the entity." - } - } - }, - "retentionExpirationTime": { - "type": "string", - "description": "A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).", - "format": "date-time" - }, - "retention": { - "type": "object", - "description": "A collection of object level retention parameters.", - "properties": { - "retainUntilTime": { - "type": "string", - "description": "A time in RFC 3339 format until which object retention protects this object.", - "format": "date-time" - }, - "mode": { + "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "A UUID or similar unique string that identifies this channel." + }, + "kind": { + "type": "string", + "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", + "default": "api#channel" + }, + "params": { + "type": "object", + "description": "Additional parameters controlling delivery channel behavior. Optional.", + "additionalProperties": { "type": "string", - "description": "The bucket's object retention mode, can only be Unlocked or Locked." + "description": "Declares a new parameter by name." } + }, + "payload": { + "type": "boolean", + "description": "A Boolean value to indicate whether payload is wanted. Optional." + }, + "resourceId": { + "type": "string", + "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions." + }, + "resourceUri": { + "type": "string", + "description": "A version-specific identifier for the watched resource." + }, + "token": { + "type": "string", + "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional." + }, + "type": { + "type": "string", + "description": "The type of delivery mechanism used for this channel." } - }, - "selfLink": { - "type": "string", - "description": "The link to this object." - }, - "size": { - "type": "string", - "description": "Content-Length of the data in bytes.", - "format": "uint64" - }, - "storageClass": { - "type": "string", - "description": "Storage class of the object." - }, - "temporaryHold": { - "type": "boolean", - "description": "Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object." - }, - "timeCreated": { - "type": "string", - "description": "The creation time of the object in RFC 3339 format.", - "format": "date-time" - }, - "timeDeleted": { - "type": "string", - "description": "The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.", - "format": "date-time" - }, - "softDeleteTime": { - "type": "string", - "description": "The time at which the object became soft-deleted in RFC 3339 format.", - "format": "date-time" - }, - "hardDeleteTime": { - "type": "string", - "description": "This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.", - "format": "date-time" - }, - "timeStorageClassUpdated": { - "type": "string", - "description": "The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.", - "format": "date-time" } - } - }, - "ObjectAccessControl": { - "id": "ObjectAccessControl", - "type": "object", - "description": "An access-control entry.", - "properties": { - "bucket": { - "type": "string", - "description": "The name of the bucket." - }, - "domain": { - "type": "string", - "description": "The domain associated with the entity, if any." - }, - "email": { - "type": "string", - "description": "The email address associated with the entity, if any." - }, - "entity": { - "type": "string", - "description": "The entity holding the permission, in one of the following forms: \n- user-userId \n- user-email \n- group-groupId \n- group-email \n- domain-domain \n- project-team-projectId \n- allUsers \n- allAuthenticatedUsers Examples: \n- The user liz@example.com would be user-liz@example.com. \n- The group example@googlegroups.com would be group-example@googlegroups.com. \n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.", - "annotations": { - "required": [ - "storage.defaultObjectAccessControls.insert", - "storage.objectAccessControls.insert" - ] - } - }, - "entityId": { - "type": "string", - "description": "The ID for the entity, if any." - }, - "etag": { - "type": "string", - "description": "HTTP 1.1 Entity tag for the access-control entry." - }, - "generation": { - "type": "string", - "description": "The content generation of the object, if applied to an object.", - "format": "int64" - }, - "id": { - "type": "string", - "description": "The ID of the access-control entry." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For object access control entries, this is always storage#objectAccessControl.", - "default": "storage#objectAccessControl" - }, - "object": { - "type": "string", - "description": "The name of the object, if applied to an object." - }, - "projectTeam": { - "type": "object", - "description": "The project team associated with the entity, if any.", - "properties": { - "projectNumber": { - "type": "string", - "description": "The project number." + }, + "ComposeRequest": { + "id": "ComposeRequest", + "type": "object", + "description": "A Compose request.", + "properties": { + "destination": { + "$ref": "Object", + "description": "Properties of the resulting object." + }, + "kind": { + "type": "string", + "description": "The kind of item this is.", + "default": "storage#composeRequest" + }, + "sourceObjects": { + "type": "array", + "description": "The list of source objects that will be concatenated into a single object.", + "items": { + "type": "object", + "properties": { + "generation": { + "type": "string", + "description": "The generation of this object to use as the source.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "The source object's name. All source objects must reside in the same bucket.", + "annotations": { + "required": [ + "storage.objects.compose" + ] + } + }, + "objectPreconditions": { + "type": "object", + "description": "Conditions that must be met for this operation to execute.", + "properties": { + "ifGenerationMatch": { + "type": "string", + "description": "Only perform the composition if the generation of the source object that would be used matches this value. If this value and a generation are both specified, they must be the same value or the call will fail.", + "format": "int64" + } + } + } + } }, - "team": { - "type": "string", - "description": "The team." + "annotations": { + "required": [ + "storage.objects.compose" + ] } } - }, - "role": { - "type": "string", - "description": "The access permission for the entity.", - "annotations": { - "required": [ - "storage.defaultObjectAccessControls.insert", - "storage.objectAccessControls.insert" - ] + } + }, + "Folder": { + "id": "Folder", + "type": "object", + "description": "A folder. Only available in buckets with hierarchical namespace enabled.", + "properties": { + "bucket": { + "type": "string", + "description": "The name of the bucket containing this folder." + }, + "id": { + "type": "string", + "description": "The ID of the folder, including the bucket name, folder name." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For folders, this is always storage#folder.", + "default": "storage#folder" + }, + "metageneration": { + "type": "string", + "description": "The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "The name of the folder. Required if not specified by URL parameter." + }, + "selfLink": { + "type": "string", + "description": "The link to this folder." + }, + "createTime": { + "type": "string", + "description": "The creation time of the folder in RFC 3339 format.", + "format": "date-time" + }, + "updateTime": { + "type": "string", + "description": "The modification time of the folder metadata in RFC 3339 format.", + "format": "date-time" + }, + "pendingRenameInfo": { + "type": "object", + "description": "Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the rename folder operation." + } + } } - }, - "selfLink": { - "type": "string", - "description": "The link to this access-control entry." } - } - }, - "ObjectAccessControls": { - "id": "ObjectAccessControls", - "type": "object", - "description": "An access-control list.", - "properties": { - "items": { - "type": "array", - "description": "The list of items.", + }, + "Folders": { + "id": "Folders", + "type": "object", + "description": "A list of folders.", + "properties": { "items": { - "$ref": "ObjectAccessControl" + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "Folder" + } + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of folders, this is always storage#folders.", + "default": "storage#folders" + }, + "nextPageToken": { + "type": "string", + "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." } - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.", - "default": "storage#objectAccessControls" } - } - }, - "Objects": { - "id": "Objects", - "type": "object", - "description": "A list of objects.", - "properties": { - "items": { - "type": "array", - "description": "The list of items.", - "items": { - "$ref": "Object" + }, + "Expr": { + "id": "Expr", + "type": "object", + "description": "Represents an expression text. Example: title: \"User account presence\" description: \"Determines whether the request has a user account\" expression: \"size(request.user) > 0\"", + "properties": { + "description": { + "type": "string", + "description": "An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI." + }, + "expression": { + "type": "string", + "description": "Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported." + }, + "location": { + "type": "string", + "description": "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file." + }, + "title": { + "type": "string", + "description": "An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression." + } + } + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is \"false\", it means the operation is still in progress. If \"true\", the operation is completed, and either \"error\" or \"response\" is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the \"name\" should be a resource name ending with \"operations/{operationId}\".", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as \"Delete\", the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type \"XxxResponse\", where \"Xxx\" is the original method name. For example, if the original method name is \"TakeSnapshot()\", the inferred response type is \"TakeSnapshotResponse\".", + "type": "object" } }, - "kind": { - "type": "string", - "description": "The kind of item this is. For lists of objects, this is always storage#objects.", - "default": "storage#objects" - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for storage.buckets.operations.list.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "type": "string", + "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } }, - "prefixes": { - "type": "array", - "description": "The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.", - "items": { + "type": "object" + }, + "GoogleRpcStatus": { + "description": "The \"Status\" type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each \"Status\" message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English.", "type": "string" } + }, + "type": "object" + }, + "HmacKey": { + "id": "HmacKey", + "type": "object", + "description": "JSON template to produce a JSON-style HMAC Key resource for Create responses.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of item this is. For HMAC keys, this is always storage#hmacKey.", + "default": "storage#hmacKey" + }, + "metadata": { + "$ref": "HmacKeyMetadata", + "description": "Key metadata." + }, + "secret": { + "type": "string", + "description": "HMAC secret key material." + } } - } - }, - "Policy": { - "id": "Policy", - "type": "object", - "description": "A bucket/object/managedFolder IAM policy.", - "properties": { - "bindings": { - "type": "array", - "description": "An association between a role, which comes with a set of permissions, and members who may assume that role.", + }, + "HmacKeyMetadata": { + "id": "HmacKeyMetadata", + "type": "object", + "description": "JSON template to produce a JSON-style HMAC Key metadata resource.", + "properties": { + "accessId": { + "type": "string", + "description": "The ID of the HMAC Key." + }, + "etag": { + "type": "string", + "description": "HTTP 1.1 Entity tag for the HMAC key." + }, + "id": { + "type": "string", + "description": "The ID of the HMAC key, including the Project ID and the Access ID." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.", + "default": "storage#hmacKeyMetadata" + }, + "projectId": { + "type": "string", + "description": "Project ID owning the service account to which the key authenticates." + }, + "selfLink": { + "type": "string", + "description": "The link to this resource." + }, + "serviceAccountEmail": { + "type": "string", + "description": "The email address of the key's associated service account." + }, + "state": { + "type": "string", + "description": "The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED." + }, + "timeCreated": { + "type": "string", + "description": "The creation time of the HMAC key in RFC 3339 format.", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "The last modification time of the HMAC key metadata in RFC 3339 format.", + "format": "date-time" + } + } + }, + "HmacKeysMetadata": { + "id": "HmacKeysMetadata", + "type": "object", + "description": "A list of hmacKeys.", + "properties": { "items": { - "type": "object", - "properties": { - "condition": { - "$ref": "Expr", - "description": "The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently." - }, - "members": { - "type": "array", - "description": "A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows: \n- allUsers \u2014 A special identifier that represents anyone on the internet; with or without a Google account. \n- allAuthenticatedUsers \u2014 A special identifier that represents anyone who is authenticated with a Google account or a service account. \n- user:emailid \u2014 An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com. \n- serviceAccount:emailid \u2014 An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . \n- group:emailid \u2014 An email address that represents a Google group. For example, group:admins@example.com. \n- domain:domain \u2014 A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com. \n- projectOwner:projectid \u2014 Owners of the given project. For example, projectOwner:my-example-project \n- projectEditor:projectid \u2014 Editors of the given project. For example, projectEditor:my-example-project \n- projectViewer:projectid \u2014 Viewers of the given project. For example, projectViewer:my-example-project", - "items": { - "type": "string" - }, - "annotations": { - "required": [ - "storage.buckets.setIamPolicy", - "storage.objects.setIamPolicy", - "storage.managedFolders.setIamPolicy" - ] - } - }, - "role": { - "type": "string", - "description": "The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.\nThe new IAM roles are: \n- roles/storage.admin \u2014 Full control of Google Cloud Storage resources. \n- roles/storage.objectViewer \u2014 Read-Only access to Google Cloud Storage objects. \n- roles/storage.objectCreator \u2014 Access to create objects in Google Cloud Storage. \n- roles/storage.objectAdmin \u2014 Full control of Google Cloud Storage objects. The legacy IAM roles are: \n- roles/storage.legacyObjectReader \u2014 Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role. \n- roles/storage.legacyObjectOwner \u2014 Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role. \n- roles/storage.legacyBucketReader \u2014 Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role. \n- roles/storage.legacyBucketWriter \u2014 Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role. \n- roles/storage.legacyBucketOwner \u2014 Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.", - "annotations": { - "required": [ - "storage.buckets.setIamPolicy", - "storage.objects.setIamPolicy", - "storage.managedFolders.setIamPolicy" - ] - } - } + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "HmacKeyMetadata" } }, - "annotations": { - "required": [ - "storage.buckets.setIamPolicy", - "storage.objects.setIamPolicy", - "storage.managedFolders.setIamPolicy" - ] + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata.", + "default": "storage#hmacKeysMetadata" + }, + "nextPageToken": { + "type": "string", + "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." } - }, - "etag": { - "type": "string", - "description": "HTTP 1.1 Entity tag for the policy.", - "format": "byte" - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.", - "default": "storage#policy" - }, - "resourceId": { - "type": "string", - "description": "The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input." - }, - "version": { - "type": "integer", - "description": "The IAM policy format version.", - "format": "int32" - } - } - }, - "RewriteResponse": { - "id": "RewriteResponse", - "type": "object", - "description": "A rewrite response.", - "properties": { - "done": { - "type": "boolean", - "description": "true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response." - }, - "kind": { - "type": "string", - "description": "The kind of item this is.", - "default": "storage#rewriteResponse" - }, - "objectSize": { - "type": "string", - "description": "The total size of the object being copied in bytes. This property is always present in the response.", - "format": "int64" - }, - "resource": { - "$ref": "Object", - "description": "A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes." - }, - "rewriteToken": { - "type": "string", - "description": "A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy." - }, - "totalBytesRewritten": { - "type": "string", - "description": "The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.", - "format": "int64" - } - } - }, - "ServiceAccount": { - "id": "ServiceAccount", - "type": "object", - "description": "A subscription to receive Google PubSub notifications.", - "properties": { - "email_address": { - "type": "string", - "description": "The ID of the notification." - }, - "kind": { - "type": "string", - "description": "The kind of item this is. For notifications, this is always storage#notification.", - "default": "storage#serviceAccount" } - } - }, - "TestIamPermissionsResponse": { - "id": "TestIamPermissionsResponse", - "type": "object", - "description": "A storage.(buckets|objects|managedFolders).testIamPermissions response.", - "properties": { - "kind": { - "type": "string", - "description": "The kind of item this is.", - "default": "storage#testIamPermissionsResponse" - }, - "permissions": { - "type": "array", - "description": "The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets, objects, or managedFolders. The supported permissions are as follows: \n- storage.buckets.delete \u2014 Delete bucket. \n- storage.buckets.get \u2014 Read bucket metadata. \n- storage.buckets.getIamPolicy \u2014 Read bucket IAM policy. \n- storage.buckets.create \u2014 Create bucket. \n- storage.buckets.list \u2014 List buckets. \n- storage.buckets.setIamPolicy \u2014 Update bucket IAM policy. \n- storage.buckets.update \u2014 Update bucket metadata. \n- storage.objects.delete \u2014 Delete object. \n- storage.objects.get \u2014 Read object data and metadata. \n- storage.objects.getIamPolicy \u2014 Read object IAM policy. \n- storage.objects.create \u2014 Create object. \n- storage.objects.list \u2014 List objects. \n- storage.objects.setIamPolicy \u2014 Update object IAM policy. \n- storage.objects.update \u2014 Update object metadata. \n- storage.managedFolders.delete \u2014 Delete managed folder. \n- storage.managedFolders.get \u2014 Read managed folder metadata. \n- storage.managedFolders.getIamPolicy \u2014 Read managed folder IAM policy. \n- storage.managedFolders.create \u2014 Create managed folder. \n- storage.managedFolders.list \u2014 List managed folders. \n- storage.managedFolders.setIamPolicy \u2014 Update managed folder IAM policy.", - "items": { - "type": "string" + }, + "ManagedFolder": { + "id": "ManagedFolder", + "type": "object", + "description": "A managed folder.", + "properties": { + "bucket": { + "type": "string", + "description": "The name of the bucket containing this managed folder." + }, + "id": { + "type": "string", + "description": "The ID of the managed folder, including the bucket name and managed folder name." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For managed folders, this is always storage#managedFolder.", + "default": "storage#managedFolder" + }, + "metageneration": { + "type": "string", + "description": "The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "The name of the managed folder. Required if not specified by URL parameter." + }, + "selfLink": { + "type": "string", + "description": "The link to this managed folder." + }, + "createTime": { + "type": "string", + "description": "The creation time of the managed folder in RFC 3339 format.", + "format": "date-time" + }, + "updateTime": { + "type": "string", + "description": "The last update time of the managed folder metadata in RFC 3339 format.", + "format": "date-time" } } - } - }, - "BulkRestoreObjectsRequest": { - "id": "BulkRestoreObjectsRequest", - "type": "object", - "description": "A bulk restore objects request.", - "properties": { - "allowOverwrite": { - "type": "boolean", - "description": "If false (default), the restore will not overwrite live objects with the same name at the destination. This means some deleted objects may be skipped. If true, live objects will be overwritten resulting in a noncurrent object (if versioning is enabled). If versioning is not enabled, overwriting the object will result in a soft-deleted object. In either case, if a noncurrent object already exists with the same name, a live version can be written without issue." - }, - "softDeletedAfterTime": { - "type": "string", - "description": "Restores only the objects that were soft-deleted after this time.", - "format": "date-time" - }, - "softDeletedBeforeTime": { - "type": "string", - "description": "Restores only the objects that were soft-deleted before this time.", - "format": "date-time" - }, - "matchGlobs": { - "type": "array", - "description": "Restores only the objects matching any of the specified glob(s). If this parameter is not specified, all objects will be restored within the specified time range.", + }, + "ManagedFolders": { + "id": "ManagedFolders", + "type": "object", + "description": "A list of managed folders.", + "properties": { "items": { - "type": "string" + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "ManagedFolder" + } + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of managed folders, this is always storage#managedFolders.", + "default": "storage#managedFolders" + }, + "nextPageToken": { + "type": "string", + "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." } - }, - "copySourceAcl": { - "type": "boolean", - "description": "If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false." } - } - } -}, -"resources": { - "anywhereCaches": { - "methods": { - "insert": { - "id": "storage.anywhereCaches.insert", - "path": "b/{bucket}/anywhereCaches", - "httpMethod": "POST", - "description": "Creates an Anywhere Cache instance.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the parent bucket.", - "required": true, - "location": "path" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "AnywhereCache" -}, -"response": { - "$ref": "GoogleLongrunningOperation" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"update": { -"id": "storage.anywhereCaches.update", -"path": "b/{bucket}/anywhereCaches/{anywhereCacheId}", -"httpMethod": "PATCH", -"description": "Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the parent bucket.", - "required": true, - "location": "path" - }, - "anywhereCacheId": { - "type": "string", - "description": "The ID of requested Anywhere Cache instance.", - "required": true, - "location": "path" - } -}, -"parameterOrder": [ - "bucket", - "anywhereCacheId" -], -"request": { - "$ref": "AnywhereCache" -}, -"response": { - "$ref": "GoogleLongrunningOperation" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"get": { -"id": "storage.anywhereCaches.get", -"path": "b/{bucket}/anywhereCaches/{anywhereCacheId}", -"httpMethod": "GET", -"description": "Returns the metadata of an Anywhere Cache instance.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the parent bucket.", - "required": true, - "location": "path" - }, - "anywhereCacheId": { - "type": "string", - "description": "The ID of requested Anywhere Cache instance.", - "required": true, - "location": "path" - } -}, -"parameterOrder": [ - "bucket", - "anywhereCacheId" -], -"response": { - "$ref": "AnywhereCache" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"list": { -"id": "storage.anywhereCaches.list", - "path": "b/{bucket}/anywhereCaches", - "httpMethod": "GET", - "description": "Returns a list of Anywhere Cache instances of the bucket matching the criteria.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the parent bucket.", - "required": true, - "location": "path" - }, - "pageSize": { - "type": "integer", - "description": "Maximum number of items to return in a single page of responses. Maximum 1000.", - "format": "int32", - "minimum": "0", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"response": { - "$ref": "AnywhereCaches" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"pause": { -"id": "storage.anywhereCaches.pause", -"path": "b/{bucket}/anywhereCaches/{anywhereCacheId}/pause", -"httpMethod": "POST", -"description": "Pauses an Anywhere Cache instance.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the parent bucket.", - "required": true, - "location": "path" - }, - "anywhereCacheId": { - "type": "string", - "description": "The ID of requested Anywhere Cache instance.", - "required": true, - "location": "path" - } -}, -"parameterOrder": [ - "bucket", - "anywhereCacheId" -], -"response": { - "$ref": "AnywhereCache" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"resume": { -"id": "storage.anywhereCaches.resume", -"path": "b/{bucket}/anywhereCaches/{anywhereCacheId}/resume", -"httpMethod": "POST", -"description": "Resumes a paused or disabled Anywhere Cache instance.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the parent bucket.", - "required": true, - "location": "path" - }, - "anywhereCacheId": { - "type": "string", - "description": "The ID of requested Anywhere Cache instance.", - "required": true, - "location": "path" - } -}, -"parameterOrder": [ - "bucket", - "anywhereCacheId" -], -"response": { - "$ref": "AnywhereCache" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"disable": { -"id": "storage.anywhereCaches.disable", -"path": "b/{bucket}/anywhereCaches/{anywhereCacheId}/disable", -"httpMethod": "POST", -"description": "Disables an Anywhere Cache instance.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the parent bucket.", - "required": true, - "location": "path" - }, - "anywhereCacheId": { - "type": "string", - "description": "The ID of requested Anywhere Cache instance.", - "required": true, - "location": "path" - } -}, -"parameterOrder": [ - "bucket", - "anywhereCacheId" -], -"response": { - "$ref": "AnywhereCache" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -} -} -}, -"bucketAccessControls": { -"methods": { -"delete": { -"id": "storage.bucketAccessControls.delete", -"path": "b/{bucket}/acl/{entity}", -"httpMethod": "DELETE", -"description": "Permanently deletes the ACL entry for the specified entity on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "entity" -], -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"get": { -"id": "storage.bucketAccessControls.get", -"path": "b/{bucket}/acl/{entity}", -"httpMethod": "GET", -"description": "Returns the ACL entry for the specified entity on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "entity" -], -"response": { - "$ref": "BucketAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"insert": { -"id": "storage.bucketAccessControls.insert", -"path": "b/{bucket}/acl", -"httpMethod": "POST", -"description": "Creates a new ACL entry on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "BucketAccessControl" -}, -"response": { - "$ref": "BucketAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"list": { -"id": "storage.bucketAccessControls.list", -"path": "b/{bucket}/acl", -"httpMethod": "GET", -"description": "Retrieves ACL entries on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"response": { - "$ref": "BucketAccessControls" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"patch": { -"id": "storage.bucketAccessControls.patch", -"path": "b/{bucket}/acl/{entity}", -"httpMethod": "PATCH", -"description": "Patches an ACL entry on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "entity" -], -"request": { - "$ref": "BucketAccessControl" -}, -"response": { - "$ref": "BucketAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"update": { -"id": "storage.bucketAccessControls.update", -"path": "b/{bucket}/acl/{entity}", -"httpMethod": "PUT", -"description": "Updates an ACL entry on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "entity" -], -"request": { - "$ref": "BucketAccessControl" -}, -"response": { - "$ref": "BucketAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -} -} -}, -"buckets": { -"methods": { -"delete": { -"id": "storage.buckets.delete", -"path": "b/{bucket}", -"httpMethod": "DELETE", -"description": "Permanently deletes an empty bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "If set, only deletes the bucket if its metageneration matches this value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "If set, only deletes the bucket if its metageneration does not match this value.", - "format": "int64", - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"get": { -"id": "storage.buckets.get", -"path": "b/{bucket}", -"httpMethod": "GET", -"description": "Returns metadata for the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit owner, acl and defaultObjectAcl properties." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"response": { - "$ref": "Bucket" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"getIamPolicy": { -"id": "storage.buckets.getIamPolicy", -"path": "b/{bucket}/iam", -"httpMethod": "GET", -"description": "Returns an IAM policy for the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "optionsRequestedPolicyVersion": { - "type": "integer", - "description": "The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.", - "format": "int32", - "minimum": "1", - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"response": { - "$ref": "Policy" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"insert": { -"id": "storage.buckets.insert", -"path": "b", -"httpMethod": "POST", -"description": "Creates a new bucket.", -"parameters": { - "predefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to this bucket.", - "enum": [ - "authenticatedRead", - "private", - "projectPrivate", - "publicRead", - "publicReadWrite" - ], - "enumDescriptions": [ - "Project team owners get OWNER access, and allAuthenticatedUsers get READER access.", - "Project team owners get OWNER access.", - "Project team members get access according to their roles.", - "Project team owners get OWNER access, and allUsers get READER access.", - "Project team owners get OWNER access, and allUsers get WRITER access." - ], - "location": "query" - }, - "predefinedDefaultObjectAcl": { - "type": "string", - "description": "Apply a predefined set of default object access controls to this bucket.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "project": { - "type": "string", - "description": "A valid API project identifier.", - "required": true, - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit owner, acl and defaultObjectAcl properties." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request.", - "location": "query" - }, - "enableObjectRetention": { - "type": "boolean", - "description": "When set to true, object retention is enabled for this bucket.", - "default": "false", - "location": "query" - } -}, -"parameterOrder": [ - "project" -], -"request": { - "$ref": "Bucket" -}, -"response": { - "$ref": "Bucket" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"list": { -"id": "storage.buckets.list", -"path": "b", -"httpMethod": "GET", -"description": "Retrieves a list of buckets for a given project.", -"parameters": { - "maxResults": { - "type": "integer", - "description": "Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.", - "default": "1000", - "format": "uint32", - "minimum": "0", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - }, - "prefix": { - "type": "string", - "description": "Filter results to buckets whose names begin with this prefix.", - "location": "query" - }, - "project": { - "type": "string", - "description": "A valid API project identifier.", - "required": true, - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit owner, acl and defaultObjectAcl properties." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request.", - "location": "query" - } -}, -"parameterOrder": [ - "project" -], -"response": { - "$ref": "Buckets" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"lockRetentionPolicy": { -"id": "storage.buckets.lockRetentionPolicy", -"path": "b/{bucket}/lockRetentionPolicy", -"httpMethod": "POST", -"description": "Locks retention policy on a bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether bucket's current metageneration matches the given value.", - "required": true, - "format": "int64", - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "ifMetagenerationMatch" -], -"response": { - "$ref": "Bucket" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"patch": { -"id": "storage.buckets.patch", -"path": "b/{bucket}", -"httpMethod": "PATCH", -"description": "Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "predefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to this bucket.", - "enum": [ - "authenticatedRead", - "private", - "projectPrivate", - "publicRead", - "publicReadWrite" - ], - "enumDescriptions": [ - "Project team owners get OWNER access, and allAuthenticatedUsers get READER access.", - "Project team owners get OWNER access.", - "Project team members get access according to their roles.", - "Project team owners get OWNER access, and allUsers get READER access.", - "Project team owners get OWNER access, and allUsers get WRITER access." - ], - "location": "query" - }, - "predefinedDefaultObjectAcl": { - "type": "string", - "description": "Apply a predefined set of default object access controls to this bucket.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit owner, acl and defaultObjectAcl properties." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "Bucket" -}, -"response": { - "$ref": "Bucket" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"setIamPolicy": { -"id": "storage.buckets.setIamPolicy", -"path": "b/{bucket}/iam", -"httpMethod": "PUT", -"description": "Updates an IAM policy for the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "Policy" -}, -"response": { - "$ref": "Policy" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"testIamPermissions": { -"id": "storage.buckets.testIamPermissions", -"path": "b/{bucket}/iam/testPermissions", -"httpMethod": "GET", -"description": "Tests a set of permissions on the given bucket to see which, if any, are held by the caller.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "permissions": { - "type": "string", - "description": "Permissions to test.", - "required": true, - "repeated": true, - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "permissions" -], -"response": { - "$ref": "TestIamPermissionsResponse" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"update": { -"id": "storage.buckets.update", -"path": "b/{bucket}", -"httpMethod": "PUT", -"description": "Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "predefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to this bucket.", - "enum": [ - "authenticatedRead", - "private", - "projectPrivate", - "publicRead", - "publicReadWrite" - ], - "enumDescriptions": [ - "Project team owners get OWNER access, and allAuthenticatedUsers get READER access.", - "Project team owners get OWNER access.", - "Project team members get access according to their roles.", - "Project team owners get OWNER access, and allUsers get READER access.", - "Project team owners get OWNER access, and allUsers get WRITER access." - ], - "location": "query" - }, - "predefinedDefaultObjectAcl": { - "type": "string", - "description": "Apply a predefined set of default object access controls to this bucket.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit owner, acl and defaultObjectAcl properties." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "Bucket" -}, -"response": { - "$ref": "Bucket" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -} -} -}, -"operations": { -"methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.", -"path": "b/{bucket}/operations/{operationId}/cancel", -"httpMethod": "POST", -"id": "storage.buckets.operations.cancel", -"parameterOrder": [ - "bucket", - "operationId" -], -"parameters": { - "bucket": { - "description": "The parent bucket of the operation resource.", - "location": "path", - "required": true, - "type": "string" - }, - "operationId": { - "description": "The ID of the operation resource.", - "location": "path", - "required": true, - "type": "string" - } -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"get": { -"description": "Gets the latest state of a long-running operation.", -"path": "b/{bucket}/operations/{operationId}", -"httpMethod": "GET", -"id": "storage.buckets.operations.get", -"parameterOrder": [ - "bucket", - "operationId" -], -"parameters": { - "bucket": { - "description": "The parent bucket of the operation resource.", - "location": "path", - "required": true, - "type": "string" - }, - "operationId": { - "description": "The ID of the operation resource.", - "location": "path", - "required": true, - "type": "string" - } -}, -"response": { - "$ref": "GoogleLongrunningOperation" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"list": { -"description": "Lists operations that match the specified filter in the request.", -"path": "b/{bucket}/operations", -"httpMethod": "GET", -"id": "storage.buckets.operations.list", -"parameterOrder": [ - "bucket" -], -"parameters": { - "filter": { - "description": "A filter to narrow down results to a preferred subset. The filtering language is documented in more detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "bucket": { - "description": "Name of the bucket in which to look for operations.", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Maximum number of items to return in a single page of responses. Fewer total results may be returned than requested. The service uses this parameter or 100 items, whichever is smaller.", - "minimum": "0", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query", - "type": "string" - } -}, -"response": { - "$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -} -} -}, -"channels": { -"methods": { -"stop": { -"id": "storage.channels.stop", -"path": "channels/stop", -"httpMethod": "POST", -"description": "Stop watching resources through this channel", -"request": { - "$ref": "Channel", - "parameterName": "resource" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -} -} -}, -"defaultObjectAccessControls": { -"methods": { -"delete": { -"id": "storage.defaultObjectAccessControls.delete", -"path": "b/{bucket}/defaultObjectAcl/{entity}", -"httpMethod": "DELETE", -"description": "Permanently deletes the default object ACL entry for the specified entity on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "entity" -], -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"get": { -"id": "storage.defaultObjectAccessControls.get", -"path": "b/{bucket}/defaultObjectAcl/{entity}", -"httpMethod": "GET", -"description": "Returns the default object ACL entry for the specified entity on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "entity" -], -"response": { - "$ref": "ObjectAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"insert": { -"id": "storage.defaultObjectAccessControls.insert", -"path": "b/{bucket}/defaultObjectAcl", -"httpMethod": "POST", -"description": "Creates a new default object ACL entry on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "ObjectAccessControl" -}, -"response": { - "$ref": "ObjectAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"list": { -"id": "storage.defaultObjectAccessControls.list", -"path": "b/{bucket}/defaultObjectAcl", -"httpMethod": "GET", -"description": "Retrieves default object ACL entries on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "If present, only return default ACL listing if the bucket's current metageneration matches this value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "If present, only return default ACL listing if the bucket's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"response": { - "$ref": "ObjectAccessControls" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"patch": { -"id": "storage.defaultObjectAccessControls.patch", -"path": "b/{bucket}/defaultObjectAcl/{entity}", -"httpMethod": "PATCH", -"description": "Patches a default object ACL entry on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "entity" -], -"request": { - "$ref": "ObjectAccessControl" -}, -"response": { - "$ref": "ObjectAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"update": { -"id": "storage.defaultObjectAccessControls.update", -"path": "b/{bucket}/defaultObjectAcl/{entity}", -"httpMethod": "PUT", -"description": "Updates a default object ACL entry on the specified bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "entity" -], -"request": { - "$ref": "ObjectAccessControl" -}, -"response": { - "$ref": "ObjectAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -} -} -}, - "folders": { - "methods": { - "delete": { - "id": "storage.folders.delete", - "path": "b/{bucket}/folders/{folder}", - "httpMethod": "DELETE", - "description": "Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the folder resides.", - "required": true, - "location": "path" - }, - "folder": { - "type": "string", - "description": "Name of a folder.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "If set, only deletes the folder if its metageneration matches this value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "If set, only deletes the folder if its metageneration does not match this value.", - "format": "int64", - "location": "query" + }, + "Notification": { + "id": "Notification", + "type": "object", + "description": "A subscription to receive Google PubSub notifications.", + "properties": { + "custom_attributes": { + "type": "object", + "description": "An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.", + "additionalProperties": { + "type": "string" } }, - "parameterOrder": [ - "bucket", - "folder" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" - ] - }, - "get": { - "id": "storage.folders.get", - "path": "b/{bucket}/folders/{folder}", - "httpMethod": "GET", - "description": "Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the folder resides.", - "required": true, - "location": "path" - }, - "folder": { - "type": "string", - "description": "Name of a folder.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.", - "format": "int64", - "location": "query" + "etag": { + "type": "string", + "description": "HTTP 1.1 Entity tag for this subscription notification." + }, + "event_types": { + "type": "array", + "description": "If present, only send notifications about listed event types. If empty, sent notifications for all event types.", + "items": { + "type": "string" } }, - "parameterOrder": [ - "bucket", - "folder" - ], - "response": { - "$ref": "Folder" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" - ] - }, - "insert": { - "id": "storage.folders.insert", - "path": "b/{bucket}/folders", - "httpMethod": "POST", - "description": "Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the folder resides.", - "required": true, - "location": "path" - }, - "recursive": { - "type": "boolean", - "description": "If true, any parent folder which doesn\u2019t exist will be created automatically.", - "location": "query" + "id": { + "type": "string", + "description": "The ID of the notification." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For notifications, this is always storage#notification.", + "default": "storage#notification" + }, + "object_name_prefix": { + "type": "string", + "description": "If present, only apply this notification configuration to object names that begin with this prefix." + }, + "payload_format": { + "type": "string", + "description": "The desired content of the Payload.", + "default": "JSON_API_V1", + "annotations": { + "required": [ + "storage.notifications.insert" + ] } }, - "parameterOrder": [ - "bucket" - ], - "request": { - "$ref": "Folder" + "selfLink": { + "type": "string", + "description": "The canonical URL of this notification." }, - "response": { - "$ref": "Folder" + "topic": { + "type": "string", + "description": "The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'", + "annotations": { + "required": [ + "storage.notifications.insert" + ] + } + } + } + }, + "Notifications": { + "id": "Notifications", + "type": "object", + "description": "A list of notification subscriptions.", + "properties": { + "items": { + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "Notification" + } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" - ] - }, - "list": { - "id": "storage.folders.list", - "path": "b/{bucket}/folders", - "httpMethod": "GET", - "description": "Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which to look for folders.", - "required": true, - "location": "path" - }, - "delimiter": { - "type": "string", - "description": "Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.", - "location": "query" - }, - "endOffset": { - "type": "string", - "description": "Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).", - "location": "query" - }, - "pageSize": { - "type": "integer", - "description": "Maximum number of items to return in a single page of responses.", - "format": "int32", - "minimum": "0", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - }, - "prefix": { - "type": "string", - "description": "Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.", - "location": "query" + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of notifications, this is always storage#notifications.", + "default": "storage#notifications" + } + } + }, + "Object": { + "id": "Object", + "type": "object", + "description": "An object.", + "properties": { + "acl": { + "type": "array", + "description": "Access controls on the object.", + "items": { + "$ref": "ObjectAccessControl" }, - "startOffset": { - "type": "string", - "description": "Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).", - "location": "query" + "annotations": { + "required": [ + "storage.objects.update" + ] } }, - "parameterOrder": [ - "bucket" - ], - "response": { - "$ref": "Folders" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" - ] - }, - "rename": { - "id": "storage.folders.rename", - "path": "b/{bucket}/folders/{sourceFolder}/renameTo/folders/{destinationFolder}", - "httpMethod": "POST", - "description": "Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the folders are in.", - "required": true, - "location": "path" - }, - "destinationFolder": { - "type": "string", - "description": "Name of the destination folder.", - "required": true, - "location": "path" - }, - "ifSourceMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "sourceFolder": { - "type": "string", - "description": "Name of the source folder.", - "required": true, - "location": "path" + "bucket": { + "type": "string", + "description": "The name of the bucket containing this object." + }, + "cacheControl": { + "type": "string", + "description": "Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600." + }, + "componentCount": { + "type": "integer", + "description": "Number of underlying components that make up this object. Components are accumulated by compose operations.", + "format": "int32" + }, + "contentDisposition": { + "type": "string", + "description": "Content-Disposition of the object data." + }, + "contentEncoding": { + "type": "string", + "description": "Content-Encoding of the object data." + }, + "contentLanguage": { + "type": "string", + "description": "Content-Language of the object data." + }, + "contentType": { + "type": "string", + "description": "Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream." + }, + "crc32c": { + "type": "string", + "description": "CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices." + }, + "customTime": { + "type": "string", + "description": "A timestamp in RFC 3339 format specified by the user for an object.", + "format": "date-time" + }, + "customerEncryption": { + "type": "object", + "description": "Metadata of customer-supplied encryption key, if the object is encrypted by such a key.", + "properties": { + "encryptionAlgorithm": { + "type": "string", + "description": "The encryption algorithm." + }, + "keySha256": { + "type": "string", + "description": "SHA256 hash value of the encryption key." + } } }, - "parameterOrder": [ - "bucket", - "sourceFolder", - "destinationFolder" - ], - "response": { - "$ref": "GoogleLongrunningOperation" + "etag": { + "type": "string", + "description": "HTTP 1.1 Entity tag for the object." }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" - ] - } - } - }, - "managedFolders": { - "methods": { - "delete": { - "id": "storage.managedFolders.delete", - "path": "b/{bucket}/managedFolders/{managedFolder}", - "httpMethod": "DELETE", - "description": "Permanently deletes a managed folder.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket containing the managed folder.", - "required": true, - "location": "path" - }, - "managedFolder": { - "type": "string", - "description": "The managed folder name/path.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "If set, only deletes the managed folder if its metageneration matches this value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { + "eventBasedHold": { + "type": "boolean", + "description": "Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false." + }, + "generation": { + "type": "string", + "description": "The content generation of this object. Used for object versioning.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "The ID of the object, including the bucket name, object name, and generation number." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For objects, this is always storage#object.", + "default": "storage#object" + }, + "kmsKeyName": { + "type": "string", + "description": "Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request." + }, + "md5Hash": { + "type": "string", + "description": "MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices." + }, + "mediaLink": { + "type": "string", + "description": "Media download link." + }, + "metadata": { + "type": "object", + "description": "User-provided metadata, in key/value pairs.", + "additionalProperties": { "type": "string", - "description": "If set, only deletes the managed folder if its metageneration does not match this value.", - "format": "int64", - "location": "query" - }, - "allowNonEmpty": { - "type": "boolean", - "description": "Allows the deletion of a managed folder even if it is not empty. A managed folder is empty if there are no objects or managed folders that it applies to. Callers must have storage.managedFolders.setIamPolicy permission.", - "location": "query" - } - }, - "parameterOrder": [ - "bucket", - "managedFolder" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" - ] -}, -"get": { - "id": "storage.managedFolders.get", - "path": "b/{bucket}/managedFolders/{managedFolder}", - "httpMethod": "GET", - "description": "Returns metadata of the specified managed folder.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket containing the managed folder.", - "required": true, - "location": "path" - }, - "managedFolder": { - "type": "string", - "description": "The managed folder name/path.", - "required": true, - "location": "path" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - } - }, - "parameterOrder": [ - "bucket", - "managedFolder" - ], - "response": { - "$ref": "ManagedFolder" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" - ] -}, -"getIamPolicy": { - "id": "storage.managedFolders.getIamPolicy", - "path": "b/{bucket}/managedFolders/{managedFolder}/iam", - "httpMethod": "GET", - "description": "Returns an IAM policy for the specified managed folder.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket containing the managed folder.", - "required": true, - "location": "path" - }, - "optionsRequestedPolicyVersion": { - "type": "integer", - "description": "The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.", - "format": "int32", - "minimum": "1", - "location": "query" - }, - "managedFolder": { - "type": "string", - "description": "The managed folder name/path.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } - }, - "parameterOrder": [ - "bucket", - "managedFolder" - ], - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" - ] -}, -"insert": { - "id": "storage.managedFolders.insert", - "path": "b/{bucket}/managedFolders", - "httpMethod": "POST", - "description": "Creates a new managed folder.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket containing the managed folder.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "bucket" - ], - "request": { - "$ref": "ManagedFolder" - }, - "response": { - "$ref": "ManagedFolder" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" - ] -}, -"list": { - "id": "storage.managedFolders.list", - "path": "b/{bucket}/managedFolders", - "httpMethod": "GET", - "description": "Lists managed folders in the given bucket.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket containing the managed folder.", - "required": true, - "location": "path" + "description": "An individual metadata entry." + } + }, + "metageneration": { + "type": "string", + "description": "The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "The name of the object. Required if not specified by URL parameter." + }, + "owner": { + "type": "object", + "description": "The owner of the object. This will always be the uploader of the object.", + "properties": { + "entity": { + "type": "string", + "description": "The entity, in the form user-userId." + }, + "entityId": { + "type": "string", + "description": "The ID for the entity." + } + } + }, + "retentionExpirationTime": { + "type": "string", + "description": "A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).", + "format": "date-time" + }, + "retention": { + "type": "object", + "description": "A collection of object level retention parameters.", + "properties": { + "retainUntilTime": { + "type": "string", + "description": "A time in RFC 3339 format until which object retention protects this object.", + "format": "date-time" + }, + "mode": { + "type": "string", + "description": "The bucket's object retention mode, can only be Unlocked or Locked." + } + } + }, + "selfLink": { + "type": "string", + "description": "The link to this object." + }, + "size": { + "type": "string", + "description": "Content-Length of the data in bytes.", + "format": "uint64" + }, + "storageClass": { + "type": "string", + "description": "Storage class of the object." + }, + "temporaryHold": { + "type": "boolean", + "description": "Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object." + }, + "timeCreated": { + "type": "string", + "description": "The creation time of the object in RFC 3339 format.", + "format": "date-time" + }, + "timeDeleted": { + "type": "string", + "description": "The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.", + "format": "date-time" + }, + "softDeleteTime": { + "type": "string", + "description": "The time at which the object became soft-deleted in RFC 3339 format.", + "format": "date-time" + }, + "hardDeleteTime": { + "type": "string", + "description": "This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.", + "format": "date-time" + }, + "timeStorageClassUpdated": { + "type": "string", + "description": "The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.", + "format": "date-time" + } + } }, - "pageSize": { - "type": "integer", - "description": "Maximum number of items to return in a single page of responses.", - "format": "int32", - "minimum": "0", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - }, - "prefix": { - "type": "string", - "description": "The managed folder name/path prefix to filter the output list of results.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"response": { - "$ref": "ManagedFolders" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"setIamPolicy": { -"id": "storage.managedFolders.setIamPolicy", -"path": "b/{bucket}/managedFolders/{managedFolder}/iam", -"httpMethod": "PUT", -"description": "Updates an IAM policy for the specified managed folder.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket containing the managed folder.", - "required": true, - "location": "path" - }, - "managedFolder": { - "type": "string", - "description": "The managed folder name/path.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "managedFolder" -], -"request": { - "$ref": "Policy" -}, -"response": { - "$ref": "Policy" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"testIamPermissions": { -"id": "storage.managedFolders.testIamPermissions", -"path": "b/{bucket}/managedFolders/{managedFolder}/iam/testPermissions", -"httpMethod": "GET", -"description": "Tests a set of permissions on the given managed folder to see which, if any, are held by the caller.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket containing the managed folder.", - "required": true, - "location": "path" - }, - "managedFolder": { - "type": "string", - "description": "The managed folder name/path.", - "required": true, - "location": "path" - }, - "permissions": { - "type": "string", - "description": "Permissions to test.", - "required": true, - "repeated": true, - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "managedFolder", - "permissions" -], -"response": { - "$ref": "TestIamPermissionsResponse" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -} -} -}, -"notifications": { -"methods": { -"delete": { -"id": "storage.notifications.delete", -"path": "b/{bucket}/notificationConfigs/{notification}", -"httpMethod": "DELETE", -"description": "Permanently deletes a notification subscription.", -"parameters": { - "bucket": { - "type": "string", - "description": "The parent bucket of the notification.", - "required": true, - "location": "path" - }, - "notification": { - "type": "string", - "description": "ID of the notification to delete.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "notification" -], -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"get": { -"id": "storage.notifications.get", -"path": "b/{bucket}/notificationConfigs/{notification}", -"httpMethod": "GET", -"description": "View a notification configuration.", -"parameters": { - "bucket": { - "type": "string", - "description": "The parent bucket of the notification.", - "required": true, - "location": "path" - }, - "notification": { - "type": "string", - "description": "Notification ID", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "notification" -], -"response": { - "$ref": "Notification" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"insert": { -"id": "storage.notifications.insert", -"path": "b/{bucket}/notificationConfigs", -"httpMethod": "POST", -"description": "Creates a notification subscription for a given bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "The parent bucket of the notification.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "Notification" -}, -"response": { - "$ref": "Notification" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"list": { -"id": "storage.notifications.list", -"path": "b/{bucket}/notificationConfigs", -"httpMethod": "GET", -"description": "Retrieves a list of notification subscriptions for a given bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a Google Cloud Storage bucket.", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"response": { - "$ref": "Notifications" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -} -} -}, -"objectAccessControls": { -"methods": { -"delete": { -"id": "storage.objectAccessControls.delete", -"path": "b/{bucket}/o/{object}/acl/{entity}", -"httpMethod": "DELETE", -"description": "Permanently deletes the ACL entry for the specified entity on the specified object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object", - "entity" -], -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"get": { -"id": "storage.objectAccessControls.get", -"path": "b/{bucket}/o/{object}/acl/{entity}", -"httpMethod": "GET", -"description": "Returns the ACL entry for the specified entity on the specified object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object", - "entity" -], -"response": { - "$ref": "ObjectAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"insert": { -"id": "storage.objectAccessControls.insert", -"path": "b/{bucket}/o/{object}/acl", -"httpMethod": "POST", -"description": "Creates a new ACL entry on the specified object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object" -], -"request": { - "$ref": "ObjectAccessControl" -}, -"response": { - "$ref": "ObjectAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"list": { -"id": "storage.objectAccessControls.list", -"path": "b/{bucket}/o/{object}/acl", -"httpMethod": "GET", -"description": "Retrieves ACL entries on the specified object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object" -], -"response": { - "$ref": "ObjectAccessControls" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"patch": { -"id": "storage.objectAccessControls.patch", -"path": "b/{bucket}/o/{object}/acl/{entity}", -"httpMethod": "PATCH", -"description": "Patches an ACL entry on the specified object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object", - "entity" -], -"request": { - "$ref": "ObjectAccessControl" -}, -"response": { - "$ref": "ObjectAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"update": { -"id": "storage.objectAccessControls.update", -"path": "b/{bucket}/o/{object}/acl/{entity}", -"httpMethod": "PUT", -"description": "Updates an ACL entry on the specified object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of a bucket.", - "required": true, - "location": "path" - }, - "entity": { - "type": "string", - "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object", - "entity" -], -"request": { - "$ref": "ObjectAccessControl" -}, -"response": { - "$ref": "ObjectAccessControl" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -} -} -}, -"objects": { -"methods": { -"compose": { -"id": "storage.objects.compose", -"path": "b/{destinationBucket}/o/{destinationObject}/compose", -"httpMethod": "POST", -"description": "Concatenates a list of existing objects into a new object in the same bucket.", -"parameters": { - "destinationBucket": { - "type": "string", - "description": "Name of the bucket containing the source objects. The destination object is stored in this bucket.", - "required": true, - "location": "path" + "ObjectAccessControl": { + "id": "ObjectAccessControl", + "type": "object", + "description": "An access-control entry.", + "properties": { + "bucket": { + "type": "string", + "description": "The name of the bucket." + }, + "domain": { + "type": "string", + "description": "The domain associated with the entity, if any." + }, + "email": { + "type": "string", + "description": "The email address associated with the entity, if any." + }, + "entity": { + "type": "string", + "description": "The entity holding the permission, in one of the following forms: \n- user-userId \n- user-email \n- group-groupId \n- group-email \n- domain-domain \n- project-team-projectId \n- allUsers \n- allAuthenticatedUsers Examples: \n- The user liz@example.com would be user-liz@example.com. \n- The group example@googlegroups.com would be group-example@googlegroups.com. \n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.", + "annotations": { + "required": [ + "storage.defaultObjectAccessControls.insert", + "storage.objectAccessControls.insert" + ] + } + }, + "entityId": { + "type": "string", + "description": "The ID for the entity, if any." + }, + "etag": { + "type": "string", + "description": "HTTP 1.1 Entity tag for the access-control entry." + }, + "generation": { + "type": "string", + "description": "The content generation of the object, if applied to an object.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "The ID of the access-control entry." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For object access control entries, this is always storage#objectAccessControl.", + "default": "storage#objectAccessControl" + }, + "object": { + "type": "string", + "description": "The name of the object, if applied to an object." + }, + "projectTeam": { + "type": "object", + "description": "The project team associated with the entity, if any.", + "properties": { + "projectNumber": { + "type": "string", + "description": "The project number." + }, + "team": { + "type": "string", + "description": "The team." + } + } + }, + "role": { + "type": "string", + "description": "The access permission for the entity.", + "annotations": { + "required": [ + "storage.defaultObjectAccessControls.insert", + "storage.objectAccessControls.insert" + ] + } + }, + "selfLink": { + "type": "string", + "description": "The link to this access-control entry." + } + } + }, + "ObjectAccessControls": { + "id": "ObjectAccessControls", + "type": "object", + "description": "An access-control list.", + "properties": { + "items": { + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "ObjectAccessControl" + } + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.", + "default": "storage#objectAccessControls" + } + } + }, + "Objects": { + "id": "Objects", + "type": "object", + "description": "A list of objects.", + "properties": { + "items": { + "type": "array", + "description": "The list of items.", + "items": { + "$ref": "Object" + } + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For lists of objects, this is always storage#objects.", + "default": "storage#objects" + }, + "nextPageToken": { + "type": "string", + "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results." + }, + "prefixes": { + "type": "array", + "description": "The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.", + "items": { + "type": "string" + } + } + } + }, + "Policy": { + "id": "Policy", + "type": "object", + "description": "A bucket/object/managedFolder IAM policy.", + "properties": { + "bindings": { + "type": "array", + "description": "An association between a role, which comes with a set of permissions, and members who may assume that role.", + "items": { + "type": "object", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently." + }, + "members": { + "type": "array", + "description": "A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows: \n- allUsers \u2014 A special identifier that represents anyone on the internet; with or without a Google account. \n- allAuthenticatedUsers \u2014 A special identifier that represents anyone who is authenticated with a Google account or a service account. \n- user:emailid \u2014 An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com. \n- serviceAccount:emailid \u2014 An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . \n- group:emailid \u2014 An email address that represents a Google group. For example, group:admins@example.com. \n- domain:domain \u2014 A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com. \n- projectOwner:projectid \u2014 Owners of the given project. For example, projectOwner:my-example-project \n- projectEditor:projectid \u2014 Editors of the given project. For example, projectEditor:my-example-project \n- projectViewer:projectid \u2014 Viewers of the given project. For example, projectViewer:my-example-project", + "items": { + "type": "string" + }, + "annotations": { + "required": [ + "storage.buckets.setIamPolicy", + "storage.objects.setIamPolicy", + "storage.managedFolders.setIamPolicy" + ] + } + }, + "role": { + "type": "string", + "description": "The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.\nThe new IAM roles are: \n- roles/storage.admin \u2014 Full control of Google Cloud Storage resources. \n- roles/storage.objectViewer \u2014 Read-Only access to Google Cloud Storage objects. \n- roles/storage.objectCreator \u2014 Access to create objects in Google Cloud Storage. \n- roles/storage.objectAdmin \u2014 Full control of Google Cloud Storage objects. The legacy IAM roles are: \n- roles/storage.legacyObjectReader \u2014 Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role. \n- roles/storage.legacyObjectOwner \u2014 Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role. \n- roles/storage.legacyBucketReader \u2014 Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role. \n- roles/storage.legacyBucketWriter \u2014 Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role. \n- roles/storage.legacyBucketOwner \u2014 Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.", + "annotations": { + "required": [ + "storage.buckets.setIamPolicy", + "storage.objects.setIamPolicy", + "storage.managedFolders.setIamPolicy" + ] + } + } + } + }, + "annotations": { + "required": [ + "storage.buckets.setIamPolicy", + "storage.objects.setIamPolicy", + "storage.managedFolders.setIamPolicy" + ] + } + }, + "etag": { + "type": "string", + "description": "HTTP 1.1 Entity tag for the policy.", + "format": "byte" + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.", + "default": "storage#policy" + }, + "resourceId": { + "type": "string", + "description": "The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input." + }, + "version": { + "type": "integer", + "description": "The IAM policy format version.", + "format": "int32" + } + } + }, + "RewriteResponse": { + "id": "RewriteResponse", + "type": "object", + "description": "A rewrite response.", + "properties": { + "done": { + "type": "boolean", + "description": "true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response." + }, + "kind": { + "type": "string", + "description": "The kind of item this is.", + "default": "storage#rewriteResponse" + }, + "objectSize": { + "type": "string", + "description": "The total size of the object being copied in bytes. This property is always present in the response.", + "format": "int64" + }, + "resource": { + "$ref": "Object", + "description": "A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes." + }, + "rewriteToken": { + "type": "string", + "description": "A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy." + }, + "totalBytesRewritten": { + "type": "string", + "description": "The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.", + "format": "int64" + } + } + }, + "ServiceAccount": { + "id": "ServiceAccount", + "type": "object", + "description": "A subscription to receive Google PubSub notifications.", + "properties": { + "email_address": { + "type": "string", + "description": "The ID of the notification." + }, + "kind": { + "type": "string", + "description": "The kind of item this is. For notifications, this is always storage#notification.", + "default": "storage#serviceAccount" + } + } + }, + "TestIamPermissionsResponse": { + "id": "TestIamPermissionsResponse", + "type": "object", + "description": "A storage.(buckets|objects|managedFolders).testIamPermissions response.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of item this is.", + "default": "storage#testIamPermissionsResponse" + }, + "permissions": { + "type": "array", + "description": "The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets, objects, or managedFolders. The supported permissions are as follows: \n- storage.buckets.delete \u2014 Delete bucket. \n- storage.buckets.get \u2014 Read bucket metadata. \n- storage.buckets.getIamPolicy \u2014 Read bucket IAM policy. \n- storage.buckets.create \u2014 Create bucket. \n- storage.buckets.list \u2014 List buckets. \n- storage.buckets.setIamPolicy \u2014 Update bucket IAM policy. \n- storage.buckets.update \u2014 Update bucket metadata. \n- storage.objects.delete \u2014 Delete object. \n- storage.objects.get \u2014 Read object data and metadata. \n- storage.objects.getIamPolicy \u2014 Read object IAM policy. \n- storage.objects.create \u2014 Create object. \n- storage.objects.list \u2014 List objects. \n- storage.objects.setIamPolicy \u2014 Update object IAM policy. \n- storage.objects.update \u2014 Update object metadata. \n- storage.managedFolders.delete \u2014 Delete managed folder. \n- storage.managedFolders.get \u2014 Read managed folder metadata. \n- storage.managedFolders.getIamPolicy \u2014 Read managed folder IAM policy. \n- storage.managedFolders.create \u2014 Create managed folder. \n- storage.managedFolders.list \u2014 List managed folders. \n- storage.managedFolders.setIamPolicy \u2014 Update managed folder IAM policy.", + "items": { + "type": "string" + } + } + } + }, + "BulkRestoreObjectsRequest": { + "id": "BulkRestoreObjectsRequest", + "type": "object", + "description": "A bulk restore objects request.", + "properties": { + "allowOverwrite": { + "type": "boolean", + "description": "If false (default), the restore will not overwrite live objects with the same name at the destination. This means some deleted objects may be skipped. If true, live objects will be overwritten resulting in a noncurrent object (if versioning is enabled). If versioning is not enabled, overwriting the object will result in a soft-deleted object. In either case, if a noncurrent object already exists with the same name, a live version can be written without issue." + }, + "softDeletedAfterTime": { + "type": "string", + "description": "Restores only the objects that were soft-deleted after this time.", + "format": "date-time" + }, + "softDeletedBeforeTime": { + "type": "string", + "description": "Restores only the objects that were soft-deleted before this time.", + "format": "date-time" + }, + "matchGlobs": { + "type": "array", + "description": "Restores only the objects matching any of the specified glob(s). If this parameter is not specified, all objects will be restored within the specified time range.", + "items": { + "type": "string" + } + }, + "copySourceAcl": { + "type": "boolean", + "description": "If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false." + } + } + } }, - "destinationObject": { - "type": "string", - "description": "Name of the new object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "destinationPredefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to the destination object.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "kmsKeyName": { - "type": "string", - "description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.", - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "destinationBucket", - "destinationObject" -], -"request": { - "$ref": "ComposeRequest" -}, -"response": { - "$ref": "Object" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"copy": { -"id": "storage.objects.copy", -"path": "b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}", -"httpMethod": "POST", -"description": "Copies a source object to a destination object. Optionally overrides metadata.", -"parameters": { - "destinationBucket": { - "type": "string", - "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "destinationKmsKeyName": { - "type": "string", - "description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.", - "location": "query" - }, - "destinationObject": { - "type": "string", - "description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.", - "required": true, - "location": "path" - }, - "destinationPredefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to the destination object.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the destination object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the destination object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current generation matches the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current generation does not match the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "sourceBucket": { - "type": "string", - "description": "Name of the bucket in which to find the source object.", - "required": true, - "location": "path" - }, - "sourceGeneration": { - "type": "string", - "description": "If present, selects a specific revision of the source object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "sourceObject": { - "type": "string", - "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "sourceBucket", - "sourceObject", - "destinationBucket", - "destinationObject" -], -"request": { - "$ref": "Object" -}, -"response": { - "$ref": "Object" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"delete": { -"id": "storage.objects.delete", -"path": "b/{bucket}/o/{object}", -"httpMethod": "DELETE", -"description": "Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object" -], -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"get": { -"id": "storage.objects.get", -"path": "b/{bucket}/o/{object}", -"httpMethod": "GET", -"description": "Retrieves an object or its metadata.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - }, - "softDeleted": { - "type": "boolean", - "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object" -], -"response": { - "$ref": "Object" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -], -"supportsMediaDownload": true, -"useMediaDownloadService": true -}, -"getIamPolicy": { -"id": "storage.objects.getIamPolicy", -"path": "b/{bucket}/o/{object}/iam", -"httpMethod": "GET", -"description": "Returns an IAM policy for the specified object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object" -], -"response": { - "$ref": "Policy" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"insert": { -"id": "storage.objects.insert", -"path": "b/{bucket}/o", -"httpMethod": "POST", -"description": "Stores a new object and metadata.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.", - "required": true, - "location": "path" - }, - "contentEncoding": { - "type": "string", - "description": "If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.", - "location": "query" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "kmsKeyName": { - "type": "string", - "description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.", - "location": "query" - }, - "name": { - "type": "string", - "description": "Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "location": "query" - }, - "predefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to this object.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "Object" -}, -"response": { - "$ref": "Object" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -], -"supportsMediaUpload": true, -"mediaUpload": { - "accept": [ - "*/*" - ], - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/storage/v1/b/{bucket}/o" + "resources": { + "anywhereCaches": { + "methods": { + "insert": { + "id": "storage.anywhereCaches.insert", + "path": "b/{bucket}/anywhereCaches", + "httpMethod": "POST", + "description": "Creates an Anywhere Cache instance.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the parent bucket.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "AnywhereCache" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "update": { + "id": "storage.anywhereCaches.update", + "path": "b/{bucket}/anywhereCaches/{anywhereCacheId}", + "httpMethod": "PATCH", + "description": "Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the parent bucket.", + "required": true, + "location": "path" + }, + "anywhereCacheId": { + "type": "string", + "description": "The ID of requested Anywhere Cache instance.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "bucket", + "anywhereCacheId" + ], + "request": { + "$ref": "AnywhereCache" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "get": { + "id": "storage.anywhereCaches.get", + "path": "b/{bucket}/anywhereCaches/{anywhereCacheId}", + "httpMethod": "GET", + "description": "Returns the metadata of an Anywhere Cache instance.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the parent bucket.", + "required": true, + "location": "path" + }, + "anywhereCacheId": { + "type": "string", + "description": "The ID of requested Anywhere Cache instance.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "bucket", + "anywhereCacheId" + ], + "response": { + "$ref": "AnywhereCache" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "list": { + "id": "storage.anywhereCaches.list", + "path": "b/{bucket}/anywhereCaches", + "httpMethod": "GET", + "description": "Returns a list of Anywhere Cache instances of the bucket matching the criteria.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the parent bucket.", + "required": true, + "location": "path" + }, + "pageSize": { + "type": "integer", + "description": "Maximum number of items to return in a single page of responses. Maximum 1000.", + "format": "int32", + "minimum": "0", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "AnywhereCaches" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "pause": { + "id": "storage.anywhereCaches.pause", + "path": "b/{bucket}/anywhereCaches/{anywhereCacheId}/pause", + "httpMethod": "POST", + "description": "Pauses an Anywhere Cache instance.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the parent bucket.", + "required": true, + "location": "path" + }, + "anywhereCacheId": { + "type": "string", + "description": "The ID of requested Anywhere Cache instance.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "bucket", + "anywhereCacheId" + ], + "response": { + "$ref": "AnywhereCache" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "resume": { + "id": "storage.anywhereCaches.resume", + "path": "b/{bucket}/anywhereCaches/{anywhereCacheId}/resume", + "httpMethod": "POST", + "description": "Resumes a paused or disabled Anywhere Cache instance.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the parent bucket.", + "required": true, + "location": "path" + }, + "anywhereCacheId": { + "type": "string", + "description": "The ID of requested Anywhere Cache instance.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "bucket", + "anywhereCacheId" + ], + "response": { + "$ref": "AnywhereCache" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "disable": { + "id": "storage.anywhereCaches.disable", + "path": "b/{bucket}/anywhereCaches/{anywhereCacheId}/disable", + "httpMethod": "POST", + "description": "Disables an Anywhere Cache instance.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the parent bucket.", + "required": true, + "location": "path" + }, + "anywhereCacheId": { + "type": "string", + "description": "The ID of requested Anywhere Cache instance.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "bucket", + "anywhereCacheId" + ], + "response": { + "$ref": "AnywhereCache" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + } + } + }, + "bucketAccessControls": { + "methods": { + "delete": { + "id": "storage.bucketAccessControls.delete", + "path": "b/{bucket}/acl/{entity}", + "httpMethod": "DELETE", + "description": "Permanently deletes the ACL entry for the specified entity on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "entity" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "get": { + "id": "storage.bucketAccessControls.get", + "path": "b/{bucket}/acl/{entity}", + "httpMethod": "GET", + "description": "Returns the ACL entry for the specified entity on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "entity" + ], + "response": { + "$ref": "BucketAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "insert": { + "id": "storage.bucketAccessControls.insert", + "path": "b/{bucket}/acl", + "httpMethod": "POST", + "description": "Creates a new ACL entry on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "BucketAccessControl" + }, + "response": { + "$ref": "BucketAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "list": { + "id": "storage.bucketAccessControls.list", + "path": "b/{bucket}/acl", + "httpMethod": "GET", + "description": "Retrieves ACL entries on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "BucketAccessControls" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "patch": { + "id": "storage.bucketAccessControls.patch", + "path": "b/{bucket}/acl/{entity}", + "httpMethod": "PATCH", + "description": "Patches an ACL entry on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "entity" + ], + "request": { + "$ref": "BucketAccessControl" + }, + "response": { + "$ref": "BucketAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "update": { + "id": "storage.bucketAccessControls.update", + "path": "b/{bucket}/acl/{entity}", + "httpMethod": "PUT", + "description": "Updates an ACL entry on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "entity" + ], + "request": { + "$ref": "BucketAccessControl" + }, + "response": { + "$ref": "BucketAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + } + } + }, + "buckets": { + "methods": { + "delete": { + "id": "storage.buckets.delete", + "path": "b/{bucket}", + "httpMethod": "DELETE", + "description": "Permanently deletes an empty bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "If set, only deletes the bucket if its metageneration matches this value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "If set, only deletes the bucket if its metageneration does not match this value.", + "format": "int64", + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "get": { + "id": "storage.buckets.get", + "path": "b/{bucket}", + "httpMethod": "GET", + "description": "Returns metadata for the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit owner, acl and defaultObjectAcl properties." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "Bucket" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "getIamPolicy": { + "id": "storage.buckets.getIamPolicy", + "path": "b/{bucket}/iam", + "httpMethod": "GET", + "description": "Returns an IAM policy for the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "optionsRequestedPolicyVersion": { + "type": "integer", + "description": "The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.", + "format": "int32", + "minimum": "1", + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "insert": { + "id": "storage.buckets.insert", + "path": "b", + "httpMethod": "POST", + "description": "Creates a new bucket.", + "parameters": { + "predefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to this bucket.", + "enum": [ + "authenticatedRead", + "private", + "projectPrivate", + "publicRead", + "publicReadWrite" + ], + "enumDescriptions": [ + "Project team owners get OWNER access, and allAuthenticatedUsers get READER access.", + "Project team owners get OWNER access.", + "Project team members get access according to their roles.", + "Project team owners get OWNER access, and allUsers get READER access.", + "Project team owners get OWNER access, and allUsers get WRITER access." + ], + "location": "query" + }, + "predefinedDefaultObjectAcl": { + "type": "string", + "description": "Apply a predefined set of default object access controls to this bucket.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "project": { + "type": "string", + "description": "A valid API project identifier.", + "required": true, + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit owner, acl and defaultObjectAcl properties." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request.", + "location": "query" + }, + "enableObjectRetention": { + "type": "boolean", + "description": "When set to true, object retention is enabled for this bucket.", + "default": "false", + "location": "query" + } + }, + "parameterOrder": [ + "project" + ], + "request": { + "$ref": "Bucket" + }, + "response": { + "$ref": "Bucket" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "list": { + "id": "storage.buckets.list", + "path": "b", + "httpMethod": "GET", + "description": "Retrieves a list of buckets for a given project.", + "parameters": { + "maxResults": { + "type": "integer", + "description": "Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.", + "default": "1000", + "format": "uint32", + "minimum": "0", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query" + }, + "prefix": { + "type": "string", + "description": "Filter results to buckets whose names begin with this prefix.", + "location": "query" + }, + "project": { + "type": "string", + "description": "A valid API project identifier.", + "required": true, + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit owner, acl and defaultObjectAcl properties." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request.", + "location": "query" + } + }, + "parameterOrder": [ + "project" + ], + "response": { + "$ref": "Buckets" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "lockRetentionPolicy": { + "id": "storage.buckets.lockRetentionPolicy", + "path": "b/{bucket}/lockRetentionPolicy", + "httpMethod": "POST", + "description": "Locks retention policy on a bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether bucket's current metageneration matches the given value.", + "required": true, + "format": "int64", + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "ifMetagenerationMatch" + ], + "response": { + "$ref": "Bucket" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "patch": { + "id": "storage.buckets.patch", + "path": "b/{bucket}", + "httpMethod": "PATCH", + "description": "Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "predefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to this bucket.", + "enum": [ + "authenticatedRead", + "private", + "projectPrivate", + "publicRead", + "publicReadWrite" + ], + "enumDescriptions": [ + "Project team owners get OWNER access, and allAuthenticatedUsers get READER access.", + "Project team owners get OWNER access.", + "Project team members get access according to their roles.", + "Project team owners get OWNER access, and allUsers get READER access.", + "Project team owners get OWNER access, and allUsers get WRITER access." + ], + "location": "query" + }, + "predefinedDefaultObjectAcl": { + "type": "string", + "description": "Apply a predefined set of default object access controls to this bucket.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit owner, acl and defaultObjectAcl properties." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "Bucket" + }, + "response": { + "$ref": "Bucket" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "setIamPolicy": { + "id": "storage.buckets.setIamPolicy", + "path": "b/{bucket}/iam", + "httpMethod": "PUT", + "description": "Updates an IAM policy for the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "Policy" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "testIamPermissions": { + "id": "storage.buckets.testIamPermissions", + "path": "b/{bucket}/iam/testPermissions", + "httpMethod": "GET", + "description": "Tests a set of permissions on the given bucket to see which, if any, are held by the caller.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "permissions": { + "type": "string", + "description": "Permissions to test.", + "required": true, + "repeated": true, + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "permissions" + ], + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "update": { + "id": "storage.buckets.update", + "path": "b/{bucket}", + "httpMethod": "PUT", + "description": "Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "predefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to this bucket.", + "enum": [ + "authenticatedRead", + "private", + "projectPrivate", + "publicRead", + "publicReadWrite" + ], + "enumDescriptions": [ + "Project team owners get OWNER access, and allAuthenticatedUsers get READER access.", + "Project team owners get OWNER access.", + "Project team members get access according to their roles.", + "Project team owners get OWNER access, and allUsers get READER access.", + "Project team owners get OWNER access, and allUsers get WRITER access." + ], + "location": "query" + }, + "predefinedDefaultObjectAcl": { + "type": "string", + "description": "Apply a predefined set of default object access controls to this bucket.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit owner, acl and defaultObjectAcl properties." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "Bucket" + }, + "response": { + "$ref": "Bucket" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.", + "path": "b/{bucket}/operations/{operationId}/cancel", + "httpMethod": "POST", + "id": "storage.buckets.operations.cancel", + "parameterOrder": [ + "bucket", + "operationId" + ], + "parameters": { + "bucket": { + "description": "The parent bucket of the operation resource.", + "location": "path", + "required": true, + "type": "string" + }, + "operationId": { + "description": "The ID of the operation resource.", + "location": "path", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation.", + "path": "b/{bucket}/operations/{operationId}", + "httpMethod": "GET", + "id": "storage.buckets.operations.get", + "parameterOrder": [ + "bucket", + "operationId" + ], + "parameters": { + "bucket": { + "description": "The parent bucket of the operation resource.", + "location": "path", + "required": true, + "type": "string" + }, + "operationId": { + "description": "The ID of the operation resource.", + "location": "path", + "required": true, + "type": "string" + } + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request.", + "path": "b/{bucket}/operations", + "httpMethod": "GET", + "id": "storage.buckets.operations.list", + "parameterOrder": [ + "bucket" + ], + "parameters": { + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "bucket": { + "description": "Name of the bucket in which to look for operations.", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of items to return in a single page of responses. Fewer total results may be returned than requested. The service uses this parameter or 100 items, whichever is smaller.", + "minimum": "0", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query", + "type": "string" + } + }, + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + } + } + }, + "channels": { + "methods": { + "stop": { + "id": "storage.channels.stop", + "path": "channels/stop", + "httpMethod": "POST", + "description": "Stop watching resources through this channel", + "request": { + "$ref": "Channel", + "parameterName": "resource" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + } + } + }, + "defaultObjectAccessControls": { + "methods": { + "delete": { + "id": "storage.defaultObjectAccessControls.delete", + "path": "b/{bucket}/defaultObjectAcl/{entity}", + "httpMethod": "DELETE", + "description": "Permanently deletes the default object ACL entry for the specified entity on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "entity" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "get": { + "id": "storage.defaultObjectAccessControls.get", + "path": "b/{bucket}/defaultObjectAcl/{entity}", + "httpMethod": "GET", + "description": "Returns the default object ACL entry for the specified entity on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "entity" + ], + "response": { + "$ref": "ObjectAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "insert": { + "id": "storage.defaultObjectAccessControls.insert", + "path": "b/{bucket}/defaultObjectAcl", + "httpMethod": "POST", + "description": "Creates a new default object ACL entry on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "ObjectAccessControl" + }, + "response": { + "$ref": "ObjectAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "list": { + "id": "storage.defaultObjectAccessControls.list", + "path": "b/{bucket}/defaultObjectAcl", + "httpMethod": "GET", + "description": "Retrieves default object ACL entries on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "If present, only return default ACL listing if the bucket's current metageneration matches this value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "If present, only return default ACL listing if the bucket's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "ObjectAccessControls" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "patch": { + "id": "storage.defaultObjectAccessControls.patch", + "path": "b/{bucket}/defaultObjectAcl/{entity}", + "httpMethod": "PATCH", + "description": "Patches a default object ACL entry on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "entity" + ], + "request": { + "$ref": "ObjectAccessControl" + }, + "response": { + "$ref": "ObjectAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "update": { + "id": "storage.defaultObjectAccessControls.update", + "path": "b/{bucket}/defaultObjectAcl/{entity}", + "httpMethod": "PUT", + "description": "Updates a default object ACL entry on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "entity" + ], + "request": { + "$ref": "ObjectAccessControl" + }, + "response": { + "$ref": "ObjectAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + } + } + }, + "folders": { + "methods": { + "delete": { + "id": "storage.folders.delete", + "path": "b/{bucket}/folders/{folder}", + "httpMethod": "DELETE", + "description": "Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the folder resides.", + "required": true, + "location": "path" + }, + "folder": { + "type": "string", + "description": "Name of a folder.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "If set, only deletes the folder if its metageneration matches this value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "If set, only deletes the folder if its metageneration does not match this value.", + "format": "int64", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "folder" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "get": { + "id": "storage.folders.get", + "path": "b/{bucket}/folders/{folder}", + "httpMethod": "GET", + "description": "Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the folder resides.", + "required": true, + "location": "path" + }, + "folder": { + "type": "string", + "description": "Name of a folder.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "folder" + ], + "response": { + "$ref": "Folder" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "insert": { + "id": "storage.folders.insert", + "path": "b/{bucket}/folders", + "httpMethod": "POST", + "description": "Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the folder resides.", + "required": true, + "location": "path" + }, + "recursive": { + "type": "boolean", + "description": "If true, any parent folder which doesn\u2019t exist will be created automatically.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "Folder" + }, + "response": { + "$ref": "Folder" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "list": { + "id": "storage.folders.list", + "path": "b/{bucket}/folders", + "httpMethod": "GET", + "description": "Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which to look for folders.", + "required": true, + "location": "path" + }, + "delimiter": { + "type": "string", + "description": "Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.", + "location": "query" + }, + "endOffset": { + "type": "string", + "description": "Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).", + "location": "query" + }, + "pageSize": { + "type": "integer", + "description": "Maximum number of items to return in a single page of responses.", + "format": "int32", + "minimum": "0", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query" + }, + "prefix": { + "type": "string", + "description": "Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.", + "location": "query" + }, + "startOffset": { + "type": "string", + "description": "Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "Folders" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "rename": { + "id": "storage.folders.rename", + "path": "b/{bucket}/folders/{sourceFolder}/renameTo/folders/{destinationFolder}", + "httpMethod": "POST", + "description": "Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the folders are in.", + "required": true, + "location": "path" + }, + "destinationFolder": { + "type": "string", + "description": "Name of the destination folder.", + "required": true, + "location": "path" + }, + "ifSourceMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "sourceFolder": { + "type": "string", + "description": "Name of the source folder.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "bucket", + "sourceFolder", + "destinationFolder" + ], + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + } + } }, - "resumable": { - "multipart": true, - "path": "/resumable/upload/storage/v1/b/{bucket}/o" - } - } -} -}, -"list": { -"id": "storage.objects.list", -"path": "b/{bucket}/o", -"httpMethod": "GET", -"description": "Retrieves a list of objects matching the criteria.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which to look for objects.", - "required": true, - "location": "path" - }, - "delimiter": { - "type": "string", - "description": "Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.", - "location": "query" - }, - "endOffset": { - "type": "string", - "description": "Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).", - "location": "query" - }, - "includeTrailingDelimiter": { - "type": "boolean", - "description": "If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.", - "default": "1000", - "format": "uint32", - "minimum": "0", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - }, - "prefix": { - "type": "string", - "description": "Filter results to objects whose names begin with this prefix.", - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "startOffset": { - "type": "string", - "description": "Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).", - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - }, - "versions": { - "type": "boolean", - "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.", - "location": "query" - }, - "matchGlob": { - "type": "string", - "description": "Filter results to objects and prefixes that match this glob pattern.", - "location": "query" - }, - "softDeleted": { - "type": "boolean", - "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.", - "location": "query" - }, - "includeFoldersAsPrefixes": { - "type": "boolean", - "description": "Only applicable if delimiter is set to '/'. If true, will also include folders and managed folders (besides objects) in the returned prefixes.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"response": { - "$ref": "Objects" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -], -"supportsSubscription": true -}, -"patch": { -"id": "storage.objects.patch", -"path": "b/{bucket}/o/{object}", -"httpMethod": "PATCH", -"description": "Patches an object's metadata.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "overrideUnlockedRetention": { - "type": "boolean", - "description": "Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "predefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to this object.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request, for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object" -], -"request": { - "$ref": "Object" -}, -"response": { - "$ref": "Object" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"rewrite": { -"id": "storage.objects.rewrite", -"path": "b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}", -"httpMethod": "POST", -"description": "Rewrites a source object to a destination object. Optionally overrides metadata.", -"parameters": { - "destinationBucket": { - "type": "string", - "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.", - "required": true, - "location": "path" - }, - "destinationKmsKeyName": { - "type": "string", - "description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.", - "location": "query" - }, - "destinationObject": { - "type": "string", - "description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "destinationPredefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to the destination object.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the destination object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the destination object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current generation matches the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current generation does not match the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifSourceMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "maxBytesRewrittenPerCall": { - "type": "string", - "description": "The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.", - "format": "int64", - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "rewriteToken": { - "type": "string", - "description": "Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.", - "location": "query" - }, - "sourceBucket": { - "type": "string", - "description": "Name of the bucket in which to find the source object.", - "required": true, - "location": "path" - }, - "sourceGeneration": { - "type": "string", - "description": "If present, selects a specific revision of the source object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "sourceObject": { - "type": "string", - "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "sourceBucket", - "sourceObject", - "destinationBucket", - "destinationObject" -], -"request": { - "$ref": "Object" -}, -"response": { - "$ref": "RewriteResponse" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"setIamPolicy": { -"id": "storage.objects.setIamPolicy", -"path": "b/{bucket}/o/{object}/iam", -"httpMethod": "PUT", -"description": "Updates an IAM policy for the specified object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object" -], -"request": { - "$ref": "Policy" -}, -"response": { - "$ref": "Policy" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"testIamPermissions": { -"id": "storage.objects.testIamPermissions", -"path": "b/{bucket}/o/{object}/iam/testPermissions", -"httpMethod": "GET", -"description": "Tests a set of permissions on the given object to see which, if any, are held by the caller.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "permissions": { - "type": "string", - "description": "Permissions to test.", - "required": true, - "repeated": true, - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object", - "permissions" -], -"response": { - "$ref": "TestIamPermissionsResponse" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -] -}, -"update": { -"id": "storage.objects.update", -"path": "b/{bucket}/o/{object}", -"httpMethod": "PUT", -"description": "Updates an object's metadata.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", - "format": "int64", - "location": "query" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", - "format": "int64", - "location": "query" - }, - "overrideUnlockedRetention": { - "type": "boolean", - "description": "Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", - "required": true, - "location": "path" - }, - "predefinedAcl": { - "type": "string", - "description": "Apply a predefined set of access controls to this object.", - "enum": [ - "authenticatedRead", - "bucketOwnerFullControl", - "bucketOwnerRead", - "private", - "projectPrivate", - "publicRead" - ], - "enumDescriptions": [ - "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", - "Object owner gets OWNER access, and project team owners get OWNER access.", - "Object owner gets OWNER access, and project team owners get READER access.", - "Object owner gets OWNER access.", - "Object owner gets OWNER access, and project team members get access according to their roles.", - "Object owner gets OWNER access, and allUsers get READER access." - ], - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object" -], -"request": { - "$ref": "Object" -}, -"response": { - "$ref": "Object" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" -] -}, -"watchAll": { -"id": "storage.objects.watchAll", -"path": "b/{bucket}/o/watch", -"httpMethod": "POST", -"description": "Watch for changes on all objects in a bucket.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which to look for objects.", - "required": true, - "location": "path" - }, - "delimiter": { - "type": "string", - "description": "Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.", - "location": "query" - }, - "endOffset": { - "type": "string", - "description": "Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).", - "location": "query" - }, - "includeTrailingDelimiter": { - "type": "boolean", - "description": "If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.", - "default": "1000", - "format": "uint32", - "minimum": "0", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - }, - "prefix": { - "type": "string", - "description": "Filter results to objects whose names begin with this prefix.", - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to noAcl.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "startOffset": { - "type": "string", - "description": "Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).", - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - }, - "versions": { - "type": "boolean", - "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket" -], -"request": { - "$ref": "Channel", - "parameterName": "resource" -}, -"response": { - "$ref": "Channel" -}, -"scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" -], -"supportsSubscription": true -}, -"restore": { -"id": "storage.objects.restore", -"path": "b/{bucket}/o/{object}/restore", -"httpMethod": "POST", -"description": "Restores a soft-deleted object.", -"parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" - }, - "generation": { - "type": "string", - "description": "Selects a specific revision of this object.", - "required": true, - "format": "int64", - "location": "query" - }, - "object": { - "type": "string", - "description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.", - "required": true, - "location": "path" - }, - "ifGenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's one live generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", - "format": "int64", - "location": "query" - }, - "ifGenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether none of the object's live generations match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationMatch": { - "type": "string", - "description": "Makes the operation conditional on whether the object's one live metageneration matches the given value.", - "format": "int64", - "location": "query" - }, - "ifMetagenerationNotMatch": { - "type": "string", - "description": "Makes the operation conditional on whether none of the object's live metagenerations match the given value.", - "format": "int64", - "location": "query" - }, - "copySourceAcl": { - "type": "boolean", - "description": "If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.", - "location": "query" - }, - "projection": { - "type": "string", - "description": "Set of properties to return. Defaults to full.", - "enum": [ - "full", - "noAcl" - ], - "enumDescriptions": [ - "Include all properties.", - "Omit the owner, acl property." - ], - "location": "query" - }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request. Required for Requester Pays buckets.", - "location": "query" - } -}, -"parameterOrder": [ - "bucket", - "object", - "generation" - ], - "response": { - "$ref": "Object" + "managedFolders": { + "methods": { + "delete": { + "id": "storage.managedFolders.delete", + "path": "b/{bucket}/managedFolders/{managedFolder}", + "httpMethod": "DELETE", + "description": "Permanently deletes a managed folder.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket containing the managed folder.", + "required": true, + "location": "path" + }, + "managedFolder": { + "type": "string", + "description": "The managed folder name/path.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "If set, only deletes the managed folder if its metageneration matches this value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "If set, only deletes the managed folder if its metageneration does not match this value.", + "format": "int64", + "location": "query" + }, + "allowNonEmpty": { + "type": "boolean", + "description": "Allows the deletion of a managed folder even if it is not empty. A managed folder is empty if there are no objects or managed folders that it applies to. Callers must have storage.managedFolders.setIamPolicy permission.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "managedFolder" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "get": { + "id": "storage.managedFolders.get", + "path": "b/{bucket}/managedFolders/{managedFolder}", + "httpMethod": "GET", + "description": "Returns metadata of the specified managed folder.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket containing the managed folder.", + "required": true, + "location": "path" + }, + "managedFolder": { + "type": "string", + "description": "The managed folder name/path.", + "required": true, + "location": "path" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "managedFolder" + ], + "response": { + "$ref": "ManagedFolder" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "getIamPolicy": { + "id": "storage.managedFolders.getIamPolicy", + "path": "b/{bucket}/managedFolders/{managedFolder}/iam", + "httpMethod": "GET", + "description": "Returns an IAM policy for the specified managed folder.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket containing the managed folder.", + "required": true, + "location": "path" + }, + "optionsRequestedPolicyVersion": { + "type": "integer", + "description": "The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.", + "format": "int32", + "minimum": "1", + "location": "query" + }, + "managedFolder": { + "type": "string", + "description": "The managed folder name/path.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "managedFolder" + ], + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "insert": { + "id": "storage.managedFolders.insert", + "path": "b/{bucket}/managedFolders", + "httpMethod": "POST", + "description": "Creates a new managed folder.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket containing the managed folder.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "ManagedFolder" + }, + "response": { + "$ref": "ManagedFolder" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "list": { + "id": "storage.managedFolders.list", + "path": "b/{bucket}/managedFolders", + "httpMethod": "GET", + "description": "Lists managed folders in the given bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket containing the managed folder.", + "required": true, + "location": "path" + }, + "pageSize": { + "type": "integer", + "description": "Maximum number of items to return in a single page of responses.", + "format": "int32", + "minimum": "0", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query" + }, + "prefix": { + "type": "string", + "description": "The managed folder name/path prefix to filter the output list of results.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "ManagedFolders" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "setIamPolicy": { + "id": "storage.managedFolders.setIamPolicy", + "path": "b/{bucket}/managedFolders/{managedFolder}/iam", + "httpMethod": "PUT", + "description": "Updates an IAM policy for the specified managed folder.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket containing the managed folder.", + "required": true, + "location": "path" + }, + "managedFolder": { + "type": "string", + "description": "The managed folder name/path.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "managedFolder" + ], + "request": { + "$ref": "Policy" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "testIamPermissions": { + "id": "storage.managedFolders.testIamPermissions", + "path": "b/{bucket}/managedFolders/{managedFolder}/iam/testPermissions", + "httpMethod": "GET", + "description": "Tests a set of permissions on the given managed folder to see which, if any, are held by the caller.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket containing the managed folder.", + "required": true, + "location": "path" + }, + "managedFolder": { + "type": "string", + "description": "The managed folder name/path.", + "required": true, + "location": "path" + }, + "permissions": { + "type": "string", + "description": "Permissions to test.", + "required": true, + "repeated": true, + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "managedFolder", + "permissions" + ], + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + } + } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" - ] - }, - "bulkRestore": { - "id": "storage.objects.bulkRestore", - "path": "b/{bucket}/o/bulkRestore", - "httpMethod": "POST", - "description": "Initiates a long-running bulk restore operation on the specified bucket.", - "parameters": { - "bucket": { - "type": "string", - "description": "Name of the bucket in which the object resides.", - "required": true, - "location": "path" + "notifications": { + "methods": { + "delete": { + "id": "storage.notifications.delete", + "path": "b/{bucket}/notificationConfigs/{notification}", + "httpMethod": "DELETE", + "description": "Permanently deletes a notification subscription.", + "parameters": { + "bucket": { + "type": "string", + "description": "The parent bucket of the notification.", + "required": true, + "location": "path" + }, + "notification": { + "type": "string", + "description": "ID of the notification to delete.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "notification" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "get": { + "id": "storage.notifications.get", + "path": "b/{bucket}/notificationConfigs/{notification}", + "httpMethod": "GET", + "description": "View a notification configuration.", + "parameters": { + "bucket": { + "type": "string", + "description": "The parent bucket of the notification.", + "required": true, + "location": "path" + }, + "notification": { + "type": "string", + "description": "Notification ID", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "notification" + ], + "response": { + "$ref": "Notification" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "insert": { + "id": "storage.notifications.insert", + "path": "b/{bucket}/notificationConfigs", + "httpMethod": "POST", + "description": "Creates a notification subscription for a given bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "The parent bucket of the notification.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "Notification" + }, + "response": { + "$ref": "Notification" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "list": { + "id": "storage.notifications.list", + "path": "b/{bucket}/notificationConfigs", + "httpMethod": "GET", + "description": "Retrieves a list of notification subscriptions for a given bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a Google Cloud Storage bucket.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "Notifications" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + } + } + }, + "objectAccessControls": { + "methods": { + "delete": { + "id": "storage.objectAccessControls.delete", + "path": "b/{bucket}/o/{object}/acl/{entity}", + "httpMethod": "DELETE", + "description": "Permanently deletes the ACL entry for the specified entity on the specified object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object", + "entity" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "get": { + "id": "storage.objectAccessControls.get", + "path": "b/{bucket}/o/{object}/acl/{entity}", + "httpMethod": "GET", + "description": "Returns the ACL entry for the specified entity on the specified object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object", + "entity" + ], + "response": { + "$ref": "ObjectAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "insert": { + "id": "storage.objectAccessControls.insert", + "path": "b/{bucket}/o/{object}/acl", + "httpMethod": "POST", + "description": "Creates a new ACL entry on the specified object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object" + ], + "request": { + "$ref": "ObjectAccessControl" + }, + "response": { + "$ref": "ObjectAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "list": { + "id": "storage.objectAccessControls.list", + "path": "b/{bucket}/o/{object}/acl", + "httpMethod": "GET", + "description": "Retrieves ACL entries on the specified object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object" + ], + "response": { + "$ref": "ObjectAccessControls" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "patch": { + "id": "storage.objectAccessControls.patch", + "path": "b/{bucket}/o/{object}/acl/{entity}", + "httpMethod": "PATCH", + "description": "Patches an ACL entry on the specified object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object", + "entity" + ], + "request": { + "$ref": "ObjectAccessControl" + }, + "response": { + "$ref": "ObjectAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "update": { + "id": "storage.objectAccessControls.update", + "path": "b/{bucket}/o/{object}/acl/{entity}", + "httpMethod": "PUT", + "description": "Updates an ACL entry on the specified object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of a bucket.", + "required": true, + "location": "path" + }, + "entity": { + "type": "string", + "description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object", + "entity" + ], + "request": { + "$ref": "ObjectAccessControl" + }, + "response": { + "$ref": "ObjectAccessControl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + } } }, - "parameterOrder": [ - "bucket" - ], - "request": { - "$ref": "BulkRestoreObjectsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" - ] - } -} -}, -"projects": { -"resources": { - "hmacKeys": { - "methods": { - "create": { - "id": "storage.projects.hmacKeys.create", - "path": "projects/{projectId}/hmacKeys", - "httpMethod": "POST", - "description": "Creates a new HMAC key for the specified service account.", - "parameters": { - "projectId": { - "type": "string", - "description": "Project ID owning the service account.", - "required": true, - "location": "path" + "objects": { + "methods": { + "compose": { + "id": "storage.objects.compose", + "path": "b/{destinationBucket}/o/{destinationObject}/compose", + "httpMethod": "POST", + "description": "Concatenates a list of existing objects into a new object in the same bucket.", + "parameters": { + "destinationBucket": { + "type": "string", + "description": "Name of the bucket containing the source objects. The destination object is stored in this bucket.", + "required": true, + "location": "path" + }, + "destinationObject": { + "type": "string", + "description": "Name of the new object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "destinationPredefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to the destination object.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "kmsKeyName": { + "type": "string", + "description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.", + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "destinationBucket", + "destinationObject" + ], + "request": { + "$ref": "ComposeRequest" + }, + "response": { + "$ref": "Object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "copy": { + "id": "storage.objects.copy", + "path": "b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}", + "httpMethod": "POST", + "description": "Copies a source object to a destination object. Optionally overrides metadata.", + "parameters": { + "destinationBucket": { + "type": "string", + "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "destinationKmsKeyName": { + "type": "string", + "description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.", + "location": "query" + }, + "destinationObject": { + "type": "string", + "description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.", + "required": true, + "location": "path" + }, + "destinationPredefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to the destination object.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the destination object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the destination object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current generation matches the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current generation does not match the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "sourceBucket": { + "type": "string", + "description": "Name of the bucket in which to find the source object.", + "required": true, + "location": "path" + }, + "sourceGeneration": { + "type": "string", + "description": "If present, selects a specific revision of the source object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "sourceObject": { + "type": "string", + "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "sourceBucket", + "sourceObject", + "destinationBucket", + "destinationObject" + ], + "request": { + "$ref": "Object" + }, + "response": { + "$ref": "Object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "delete": { + "id": "storage.objects.delete", + "path": "b/{bucket}/o/{object}", + "httpMethod": "DELETE", + "description": "Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "get": { + "id": "storage.objects.get", + "path": "b/{bucket}/o/{object}", + "httpMethod": "GET", + "description": "Retrieves an object or its metadata.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + }, + "softDeleted": { + "type": "boolean", + "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.", + "location": "query" + }, + "restoreToken": { + "type": "string", + "description": "If you have enabled hierarchical namespace on your bucket and are working with soft-deleted objects, the restoreToken, a universally unique identifier (UUID), along with the object's name and generation value, uniquely identifies the object.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object" + ], + "response": { + "$ref": "Object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ], + "supportsMediaDownload": true, + "useMediaDownloadService": true + }, + "getIamPolicy": { + "id": "storage.objects.getIamPolicy", + "path": "b/{bucket}/o/{object}/iam", + "httpMethod": "GET", + "description": "Returns an IAM policy for the specified object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object" + ], + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "insert": { + "id": "storage.objects.insert", + "path": "b/{bucket}/o", + "httpMethod": "POST", + "description": "Stores a new object and metadata.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.", + "required": true, + "location": "path" + }, + "contentEncoding": { + "type": "string", + "description": "If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.", + "location": "query" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "kmsKeyName": { + "type": "string", + "description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.", + "location": "query" + }, + "name": { + "type": "string", + "description": "Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "location": "query" + }, + "predefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to this object.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "Object" + }, + "response": { + "$ref": "Object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ], + "supportsMediaUpload": true, + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/storage/v1/b/{bucket}/o" + }, + "resumable": { + "multipart": true, + "path": "/resumable/upload/storage/v1/b/{bucket}/o" + } + } + } + }, + "list": { + "id": "storage.objects.list", + "path": "b/{bucket}/o", + "httpMethod": "GET", + "description": "Retrieves a list of objects matching the criteria.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which to look for objects.", + "required": true, + "location": "path" + }, + "delimiter": { + "type": "string", + "description": "Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.", + "location": "query" + }, + "endOffset": { + "type": "string", + "description": "Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).", + "location": "query" + }, + "includeTrailingDelimiter": { + "type": "boolean", + "description": "If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.", + "default": "1000", + "format": "uint32", + "minimum": "0", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query" + }, + "prefix": { + "type": "string", + "description": "Filter results to objects whose names begin with this prefix.", + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "startOffset": { + "type": "string", + "description": "Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).", + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + }, + "versions": { + "type": "boolean", + "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.", + "location": "query" + }, + "matchGlob": { + "type": "string", + "description": "Filter results to objects and prefixes that match this glob pattern.", + "location": "query" + }, + "softDeleted": { + "type": "boolean", + "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.", + "location": "query" + }, + "includeFoldersAsPrefixes": { + "type": "boolean", + "description": "Only applicable if delimiter is set to '/'. If true, will also include folders and managed folders (besides objects) in the returned prefixes.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket" + ], + "response": { + "$ref": "Objects" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ], + "supportsSubscription": true + }, + "patch": { + "id": "storage.objects.patch", + "path": "b/{bucket}/o/{object}", + "httpMethod": "PATCH", + "description": "Patches an object's metadata.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "overrideUnlockedRetention": { + "type": "boolean", + "description": "Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "predefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to this object.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request, for Requester Pays buckets.", + "location": "query" + } }, - "serviceAccountEmail": { - "type": "string", - "description": "Email address of the service account.", - "required": true, - "location": "query" + "parameterOrder": [ + "bucket", + "object" + ], + "request": { + "$ref": "Object" }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request.", - "location": "query" - } - }, - "parameterOrder": [ - "projectId", - "serviceAccountEmail" - ], - "response": { - "$ref": "HmacKey" + "response": { + "$ref": "Object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" - ] - }, - "delete": { - "id": "storage.projects.hmacKeys.delete", - "path": "projects/{projectId}/hmacKeys/{accessId}", - "httpMethod": "DELETE", - "description": "Deletes an HMAC key.", - "parameters": { - "accessId": { - "type": "string", - "description": "Name of the HMAC key to be deleted.", - "required": true, - "location": "path" + "rewrite": { + "id": "storage.objects.rewrite", + "path": "b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}", + "httpMethod": "POST", + "description": "Rewrites a source object to a destination object. Optionally overrides metadata.", + "parameters": { + "destinationBucket": { + "type": "string", + "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.", + "required": true, + "location": "path" + }, + "destinationKmsKeyName": { + "type": "string", + "description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.", + "location": "query" + }, + "destinationObject": { + "type": "string", + "description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "destinationPredefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to the destination object.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the destination object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the destination object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current generation matches the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current generation does not match the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifSourceMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "maxBytesRewrittenPerCall": { + "type": "string", + "description": "The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.", + "format": "int64", + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "rewriteToken": { + "type": "string", + "description": "Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.", + "location": "query" + }, + "sourceBucket": { + "type": "string", + "description": "Name of the bucket in which to find the source object.", + "required": true, + "location": "path" + }, + "sourceGeneration": { + "type": "string", + "description": "If present, selects a specific revision of the source object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "sourceObject": { + "type": "string", + "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } }, - "projectId": { - "type": "string", - "description": "Project ID owning the requested key", - "required": true, - "location": "path" + "parameterOrder": [ + "sourceBucket", + "sourceObject", + "destinationBucket", + "destinationObject" + ], + "request": { + "$ref": "Object" }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request.", - "location": "query" - } + "response": { + "$ref": "RewriteResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] }, - "parameterOrder": [ - "projectId", - "accessId" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_write" - ] - }, - "get": { - "id": "storage.projects.hmacKeys.get", - "path": "projects/{projectId}/hmacKeys/{accessId}", - "httpMethod": "GET", - "description": "Retrieves an HMAC key's metadata", - "parameters": { - "accessId": { - "type": "string", - "description": "Name of the HMAC key.", - "required": true, - "location": "path" + "setIamPolicy": { + "id": "storage.objects.setIamPolicy", + "path": "b/{bucket}/o/{object}/iam", + "httpMethod": "PUT", + "description": "Updates an IAM policy for the specified object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } }, - "projectId": { - "type": "string", - "description": "Project ID owning the service account of the requested key.", - "required": true, - "location": "path" + "parameterOrder": [ + "bucket", + "object" + ], + "request": { + "$ref": "Policy" }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request.", - "location": "query" - } + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] }, - "parameterOrder": [ - "projectId", - "accessId" - ], - "response": { - "$ref": "HmacKeyMetadata" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only" - ] - }, - "list": { - "id": "storage.projects.hmacKeys.list", - "path": "projects/{projectId}/hmacKeys", - "httpMethod": "GET", - "description": "Retrieves a list of HMAC keys matching the criteria.", - "parameters": { - "maxResults": { - "type": "integer", - "description": "Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.", - "default": "250", - "format": "uint32", - "minimum": "0", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" + "testIamPermissions": { + "id": "storage.objects.testIamPermissions", + "path": "b/{bucket}/o/{object}/iam/testPermissions", + "httpMethod": "GET", + "description": "Tests a set of permissions on the given object to see which, if any, are held by the caller.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "permissions": { + "type": "string", + "description": "Permissions to test.", + "required": true, + "repeated": true, + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } }, - "projectId": { - "type": "string", - "description": "Name of the project in which to look for HMAC keys.", - "required": true, - "location": "path" + "parameterOrder": [ + "bucket", + "object", + "permissions" + ], + "response": { + "$ref": "TestIamPermissionsResponse" }, - "serviceAccountEmail": { - "type": "string", - "description": "If present, only keys for the given service account are returned.", - "location": "query" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "update": { + "id": "storage.objects.update", + "path": "b/{bucket}/o/{object}", + "httpMethod": "PUT", + "description": "Updates an object's metadata.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", + "format": "int64", + "location": "query" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.", + "format": "int64", + "location": "query" + }, + "overrideUnlockedRetention": { + "type": "boolean", + "description": "Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", + "required": true, + "location": "path" + }, + "predefinedAcl": { + "type": "string", + "description": "Apply a predefined set of access controls to this object.", + "enum": [ + "authenticatedRead", + "bucketOwnerFullControl", + "bucketOwnerRead", + "private", + "projectPrivate", + "publicRead" + ], + "enumDescriptions": [ + "Object owner gets OWNER access, and allAuthenticatedUsers get READER access.", + "Object owner gets OWNER access, and project team owners get OWNER access.", + "Object owner gets OWNER access, and project team owners get READER access.", + "Object owner gets OWNER access.", + "Object owner gets OWNER access, and project team members get access according to their roles.", + "Object owner gets OWNER access, and allUsers get READER access." + ], + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + } }, - "showDeletedKeys": { - "type": "boolean", - "description": "Whether or not to show keys in the DELETED state.", - "location": "query" + "parameterOrder": [ + "bucket", + "object" + ], + "request": { + "$ref": "Object" }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request.", - "location": "query" - } + "response": { + "$ref": "Object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "HmacKeysMetadata" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only" - ] - }, - "update": { - "id": "storage.projects.hmacKeys.update", - "path": "projects/{projectId}/hmacKeys/{accessId}", - "httpMethod": "PUT", - "description": "Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.", - "parameters": { - "accessId": { - "type": "string", - "description": "Name of the HMAC key being updated.", - "required": true, - "location": "path" + "watchAll": { + "id": "storage.objects.watchAll", + "path": "b/{bucket}/o/watch", + "httpMethod": "POST", + "description": "Watch for changes on all objects in a bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which to look for objects.", + "required": true, + "location": "path" + }, + "delimiter": { + "type": "string", + "description": "Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.", + "location": "query" + }, + "endOffset": { + "type": "string", + "description": "Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).", + "location": "query" + }, + "includeTrailingDelimiter": { + "type": "boolean", + "description": "If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.", + "default": "1000", + "format": "uint32", + "minimum": "0", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query" + }, + "prefix": { + "type": "string", + "description": "Filter results to objects whose names begin with this prefix.", + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to noAcl.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "startOffset": { + "type": "string", + "description": "Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).", + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + }, + "versions": { + "type": "boolean", + "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.", + "location": "query" + } }, - "projectId": { - "type": "string", - "description": "Project ID owning the service account of the updated key.", - "required": true, - "location": "path" + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "Channel", + "parameterName": "resource" }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request.", - "location": "query" - } - }, - "parameterOrder": [ - "projectId", - "accessId" - ], - "request": { - "$ref": "HmacKeyMetadata" + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ], + "supportsSubscription": true }, - "response": { - "$ref": "HmacKeyMetadata" + "restore": { + "id": "storage.objects.restore", + "path": "b/{bucket}/o/{object}/restore", + "httpMethod": "POST", + "description": "Restores a soft-deleted object.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + }, + "generation": { + "type": "string", + "description": "Selects a specific revision of this object.", + "required": true, + "format": "int64", + "location": "query" + }, + "object": { + "type": "string", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.", + "required": true, + "location": "path" + }, + "ifGenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's one live generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.", + "format": "int64", + "location": "query" + }, + "ifGenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether none of the object's live generations match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationMatch": { + "type": "string", + "description": "Makes the operation conditional on whether the object's one live metageneration matches the given value.", + "format": "int64", + "location": "query" + }, + "ifMetagenerationNotMatch": { + "type": "string", + "description": "Makes the operation conditional on whether none of the object's live metagenerations match the given value.", + "format": "int64", + "location": "query" + }, + "copySourceAcl": { + "type": "boolean", + "description": "If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.", + "location": "query" + }, + "projection": { + "type": "string", + "description": "Set of properties to return. Defaults to full.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query" + }, + "restoreToken": { + "type": "string", + "description": "The restoreToken is required to restore a soft-deleted object only if its name and generation value do not uniquely identify it.", + "location": "query" + } + }, + "parameterOrder": [ + "bucket", + "object", + "generation" + ], + "response": { + "$ref": "Object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/devstorage.full_control" - ] - } - } - }, - "serviceAccount": { - "methods": { - "get": { - "id": "storage.projects.serviceAccount.get", - "path": "projects/{projectId}/serviceAccount", - "httpMethod": "GET", - "description": "Get the email address of this project's Google Cloud Storage service account.", - "parameters": { - "projectId": { - "type": "string", - "description": "Project ID", - "required": true, - "location": "path" + "bulkRestore": { + "id": "storage.objects.bulkRestore", + "path": "b/{bucket}/o/bulkRestore", + "httpMethod": "POST", + "description": "Initiates a long-running bulk restore operation on the specified bucket.", + "parameters": { + "bucket": { + "type": "string", + "description": "Name of the bucket in which the object resides.", + "required": true, + "location": "path" + } }, - "userProject": { - "type": "string", - "description": "The project to be billed for this request.", - "location": "query" + "parameterOrder": [ + "bucket" + ], + "request": { + "$ref": "BulkRestoreObjectsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + } + } + }, + "projects": { + "resources": { + "hmacKeys": { + "methods": { + "create": { + "id": "storage.projects.hmacKeys.create", + "path": "projects/{projectId}/hmacKeys", + "httpMethod": "POST", + "description": "Creates a new HMAC key for the specified service account.", + "parameters": { + "projectId": { + "type": "string", + "description": "Project ID owning the service account.", + "required": true, + "location": "path" + }, + "serviceAccountEmail": { + "type": "string", + "description": "Email address of the service account.", + "required": true, + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId", + "serviceAccountEmail" + ], + "response": { + "$ref": "HmacKey" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + }, + "delete": { + "id": "storage.projects.hmacKeys.delete", + "path": "projects/{projectId}/hmacKeys/{accessId}", + "httpMethod": "DELETE", + "description": "Deletes an HMAC key.", + "parameters": { + "accessId": { + "type": "string", + "description": "Name of the HMAC key to be deleted.", + "required": true, + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID owning the requested key", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId", + "accessId" + ], + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, + "get": { + "id": "storage.projects.hmacKeys.get", + "path": "projects/{projectId}/hmacKeys/{accessId}", + "httpMethod": "GET", + "description": "Retrieves an HMAC key's metadata", + "parameters": { + "accessId": { + "type": "string", + "description": "Name of the HMAC key.", + "required": true, + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID owning the service account of the requested key.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId", + "accessId" + ], + "response": { + "$ref": "HmacKeyMetadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only" + ] + }, + "list": { + "id": "storage.projects.hmacKeys.list", + "path": "projects/{projectId}/hmacKeys", + "httpMethod": "GET", + "description": "Retrieves a list of HMAC keys matching the criteria.", + "parameters": { + "maxResults": { + "type": "integer", + "description": "Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.", + "default": "250", + "format": "uint32", + "minimum": "0", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query" + }, + "projectId": { + "type": "string", + "description": "Name of the project in which to look for HMAC keys.", + "required": true, + "location": "path" + }, + "serviceAccountEmail": { + "type": "string", + "description": "If present, only keys for the given service account are returned.", + "location": "query" + }, + "showDeletedKeys": { + "type": "boolean", + "description": "Whether or not to show keys in the DELETED state.", + "location": "query" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "HmacKeysMetadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only" + ] + }, + "update": { + "id": "storage.projects.hmacKeys.update", + "path": "projects/{projectId}/hmacKeys/{accessId}", + "httpMethod": "PUT", + "description": "Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.", + "parameters": { + "accessId": { + "type": "string", + "description": "Name of the HMAC key being updated.", + "required": true, + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID owning the service account of the updated key.", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId", + "accessId" + ], + "request": { + "$ref": "HmacKeyMetadata" + }, + "response": { + "$ref": "HmacKeyMetadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control" + ] + } } }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "ServiceAccount" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/devstorage.full_control", - "https://www.googleapis.com/auth/devstorage.read_only", - "https://www.googleapis.com/auth/devstorage.read_write" - ] + "serviceAccount": { + "methods": { + "get": { + "id": "storage.projects.serviceAccount.get", + "path": "projects/{projectId}/serviceAccount", + "httpMethod": "GET", + "description": "Get the email address of this project's Google Cloud Storage service account.", + "parameters": { + "projectId": { + "type": "string", + "description": "Project ID", + "required": true, + "location": "path" + }, + "userProject": { + "type": "string", + "description": "The project to be billed for this request.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "ServiceAccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + } + } + } } } - } -} -} -}, + }, "revision": "20240501", "etag": "\"3135313638313632393935373531333737363832\"" } diff --git a/Storage/tests/System/ManageObjectsTest.php b/Storage/tests/System/ManageObjectsTest.php index 07ec7450e34e..0bea7709b161 100644 --- a/Storage/tests/System/ManageObjectsTest.php +++ b/Storage/tests/System/ManageObjectsTest.php @@ -295,7 +295,7 @@ public function testSoftDeleteObject() $softDeleteBucketName, [ 'location' => 'us-west1', - 'softDeletePolicy' => ['retentionDurationSeconds' => 8*24*60*60] + 'softDeletePolicy' => ['retentionDurationSeconds' => 8 * 24 * 60 * 60] ] ); $object = $softDeleteBucket->upload(self::DATA, ['name' => uniqid(self::TESTING_PREFIX)]); @@ -316,6 +316,47 @@ public function testSoftDeleteObject() $this->assertStorageObjectExists($softDeleteBucket, $restoredObject); } + public function testSoftDeleteHNSObject() + { + $softDeleteBucketName = "soft-delete-hns-bucket-" . uniqid(); + $softDeleteHNSBucket = self::createBucket( + self::$client, + $softDeleteBucketName, + [ + 'location' => 'us-west1', + 'softDeletePolicy' => ['retentionDurationSeconds' => 8 * 24 * 60 * 60], + 'hierarchicalNamespace' => ['enabled' => true,], + 'iamConfiguration' => ['uniformBucketLevelAccess' => ['enabled' => true]] + ] + ); + $object = $softDeleteHNSBucket->upload(self::DATA, ['name' => uniqid(self::TESTING_PREFIX)]); + $this->assertStorageObjectExists($softDeleteHNSBucket, $object); + $generation = $object->info()['generation']; + $objectName = $object->info()['name']; + $options = [ + 'softDeleted' => true, + 'generation' => $generation + ]; + + $object->delete(); + + $deletedObject = $softDeleteHNSBucket->object($objectName, $options); + $restoreToken = $deletedObject->info($options)['restoreToken']; + + $this->assertStorageObjectNotExists($softDeleteHNSBucket, $object); + $this->assertStorageObjectExists($softDeleteHNSBucket, $object, [ + 'softDeleted' => true, + 'generation' => $generation + ]); + + $restoredObject = $softDeleteHNSBucket->restore($object->name(), $generation, [ + 'restoreToken' => $restoreToken + ]); + $this->assertNotEquals($generation, $restoredObject->info()['generation']); + + $this->assertStorageObjectExists($softDeleteHNSBucket, $restoredObject); + } + public function testRotatesCustomerSuppliedEncrpytion() { $key = base64_encode(openssl_random_pseudo_bytes(32)); diff --git a/Storage/tests/Unit/BucketTest.php b/Storage/tests/Unit/BucketTest.php index ed01a9ef6f54..4f993ea66e73 100644 --- a/Storage/tests/Unit/BucketTest.php +++ b/Storage/tests/Unit/BucketTest.php @@ -291,6 +291,22 @@ public function testRestore() $this->assertEquals('abc', $restoredObject->info()['generation']); } + public function testRestoreWithRestoreToken() + { + $this->connection->restoreObject(Argument::any()) + ->willReturn([ + 'name' => 'file.txt', + 'generation' => 'abc' + ]); + + $bucket = $this->getBucket(); + $restoredObject = $bucket->restore('file.txt', 'abc', ['restoreToken' => 'def']); + + $this->assertInstanceOf(StorageObject::class, $restoredObject); + $this->assertEquals('file.txt', $restoredObject->name()); + $this->assertEquals('abc', $restoredObject->info()['generation']); + } + public function testComposeThrowsExceptionWithLessThanTwoSources() { $this->expectException(InvalidArgumentException::class); From e0b9c6f1a962fbe441fd8ab15b7275a101354553 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:15:06 -0400 Subject: [PATCH 051/157] feat: add multi-speaker markup, which allows generating dialogue between multiple speakers (#7769) PiperOrigin-RevId: 690597076 Source-Link: https://github.com/googleapis/googleapis/commit/3bc81b79e538f42917797898eded82bcf79d024c Source-Link: https://github.com/googleapis/googleapis-gen/commit/a2253a01e6e93e79a1dec7e0b2aeea708b634d1e Copy-Tag: eyJwIjoiVGV4dFRvU3BlZWNoLy5Pd2xCb3QueWFtbCIsImgiOiJhMjI1M2EwMWU2ZTkzZTc5YTFkZWM3ZTBiMmFlZWE3MDhiNjM0ZDFlIn0= --- TextToSpeech/metadata/V1/CloudTts.php | Bin 4683 -> 4912 bytes TextToSpeech/src/V1/MultiSpeakerMarkup.php | 67 +++++++++++ .../src/V1/MultiSpeakerMarkup/Turn.php | 108 ++++++++++++++++++ TextToSpeech/src/V1/SynthesisInput.php | 36 ++++++ 4 files changed, 211 insertions(+) create mode 100644 TextToSpeech/src/V1/MultiSpeakerMarkup.php create mode 100644 TextToSpeech/src/V1/MultiSpeakerMarkup/Turn.php diff --git a/TextToSpeech/metadata/V1/CloudTts.php b/TextToSpeech/metadata/V1/CloudTts.php index cee048c39aed1706ac68ec1f4ab27f126319418c..6d6a89bd79873be88fbb9d20cbd0fb45ad7189e0 100644 GIT binary patch delta 208 zcmX@DvO#UbAtsi^3S2r9y>&K!ViIOmpTNi^D6R54kP&hE|FZ2_3=c3Ne_Atsi6a$GtSy>&K!ViIO$nZd}#H#v@1Zt^Y;!OgOq!dw9S4huv8 diff --git a/TextToSpeech/src/V1/MultiSpeakerMarkup.php b/TextToSpeech/src/V1/MultiSpeakerMarkup.php new file mode 100644 index 000000000000..bb7faf68acc0 --- /dev/null +++ b/TextToSpeech/src/V1/MultiSpeakerMarkup.php @@ -0,0 +1,67 @@ +google.cloud.texttospeech.v1.MultiSpeakerMarkup + */ +class MultiSpeakerMarkup extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Speaker turns. + * + * Generated from protobuf field repeated .google.cloud.texttospeech.v1.MultiSpeakerMarkup.Turn turns = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $turns; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\TextToSpeech\V1\MultiSpeakerMarkup\Turn>|\Google\Protobuf\Internal\RepeatedField $turns + * Required. Speaker turns. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Texttospeech\V1\CloudTts::initOnce(); + parent::__construct($data); + } + + /** + * Required. Speaker turns. + * + * Generated from protobuf field repeated .google.cloud.texttospeech.v1.MultiSpeakerMarkup.Turn turns = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTurns() + { + return $this->turns; + } + + /** + * Required. Speaker turns. + * + * Generated from protobuf field repeated .google.cloud.texttospeech.v1.MultiSpeakerMarkup.Turn turns = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Cloud\TextToSpeech\V1\MultiSpeakerMarkup\Turn>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTurns($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\TextToSpeech\V1\MultiSpeakerMarkup\Turn::class); + $this->turns = $arr; + + return $this; + } + +} + diff --git a/TextToSpeech/src/V1/MultiSpeakerMarkup/Turn.php b/TextToSpeech/src/V1/MultiSpeakerMarkup/Turn.php new file mode 100644 index 000000000000..380e3001b4ed --- /dev/null +++ b/TextToSpeech/src/V1/MultiSpeakerMarkup/Turn.php @@ -0,0 +1,108 @@ +google.cloud.texttospeech.v1.MultiSpeakerMarkup.Turn + */ +class Turn extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer + * to documentation for available speakers. + * + * Generated from protobuf field string speaker = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $speaker = ''; + /** + * Required. The text to speak. + * + * Generated from protobuf field string text = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $text = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $speaker + * Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer + * to documentation for available speakers. + * @type string $text + * Required. The text to speak. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Texttospeech\V1\CloudTts::initOnce(); + parent::__construct($data); + } + + /** + * Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer + * to documentation for available speakers. + * + * Generated from protobuf field string speaker = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getSpeaker() + { + return $this->speaker; + } + + /** + * Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer + * to documentation for available speakers. + * + * Generated from protobuf field string speaker = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setSpeaker($var) + { + GPBUtil::checkString($var, True); + $this->speaker = $var; + + return $this; + } + + /** + * Required. The text to speak. + * + * Generated from protobuf field string text = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getText() + { + return $this->text; + } + + /** + * Required. The text to speak. + * + * Generated from protobuf field string text = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->text = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(Turn::class, \Google\Cloud\TextToSpeech\V1\MultiSpeakerMarkup_Turn::class); + diff --git a/TextToSpeech/src/V1/SynthesisInput.php b/TextToSpeech/src/V1/SynthesisInput.php index 8c54e52eaaff..d0cee9b951b4 100644 --- a/TextToSpeech/src/V1/SynthesisInput.php +++ b/TextToSpeech/src/V1/SynthesisInput.php @@ -49,6 +49,9 @@ class SynthesisInput extends \Google\Protobuf\Internal\Message * [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For * more information, see * [SSML](https://cloud.google.com/text-to-speech/docs/ssml). + * @type \Google\Cloud\TextToSpeech\V1\MultiSpeakerMarkup $multi_speaker_markup + * The multi-speaker input to be synthesized. Only applicable for + * multi-speaker synthesis. * @type \Google\Cloud\TextToSpeech\V1\CustomPronunciations $custom_pronunciations * Optional. The pronunciation customizations to be applied to the input. If * this is set, the input will be synthesized using the given pronunciation @@ -137,6 +140,39 @@ public function setSsml($var) return $this; } + /** + * The multi-speaker input to be synthesized. Only applicable for + * multi-speaker synthesis. + * + * Generated from protobuf field .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4; + * @return \Google\Cloud\TextToSpeech\V1\MultiSpeakerMarkup|null + */ + public function getMultiSpeakerMarkup() + { + return $this->readOneof(4); + } + + public function hasMultiSpeakerMarkup() + { + return $this->hasOneof(4); + } + + /** + * The multi-speaker input to be synthesized. Only applicable for + * multi-speaker synthesis. + * + * Generated from protobuf field .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4; + * @param \Google\Cloud\TextToSpeech\V1\MultiSpeakerMarkup $var + * @return $this + */ + public function setMultiSpeakerMarkup($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\TextToSpeech\V1\MultiSpeakerMarkup::class); + $this->writeOneof(4, $var); + + return $this; + } + /** * Optional. The pronunciation customizations to be applied to the input. If * this is set, the input will be synthesized using the given pronunciation From 9e21daa78f8bd303777ac87409d31cb3bcdb71c8 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:16:32 -0400 Subject: [PATCH 052/157] feat: Publish Eventarc Advanced protos (#7772) docs: Clarified multiple comments in Eventarc Standard protos PiperOrigin-RevId: 690678736 Source-Link: https://github.com/googleapis/googleapis/commit/8949e1719ba5956f0271a17cd5fa0cda900b9167 Source-Link: https://github.com/googleapis/googleapis-gen/commit/53e76b69392439a3bf830a3270d6b5eb3a21f0e1 Copy-Tag: eyJwIjoiRXZlbnRhcmMvLk93bEJvdC55YW1sIiwiaCI6IjUzZTc2YjY5MzkyNDM5YTNiZjgzMGEzMjcwZDZiNWViM2EyMWYwZTEifQ== --- Eventarc/metadata/V1/Channel.php | Bin 1611 -> 1636 bytes Eventarc/metadata/V1/Enrollment.php | 53 + Eventarc/metadata/V1/Eventarc.php | 199 +- Eventarc/metadata/V1/GoogleApiSource.php | 54 + Eventarc/metadata/V1/LoggingConfig.php | Bin 0 -> 1148 bytes Eventarc/metadata/V1/MessageBus.php | 53 + Eventarc/metadata/V1/NetworkConfig.php | 32 + Eventarc/metadata/V1/Pipeline.php | Bin 0 -> 4457 bytes Eventarc/metadata/V1/Trigger.php | Bin 3008 -> 3485 bytes .../V1/EventarcClient/create_channel.php | 11 +- .../V1/EventarcClient/create_enrollment.php | 119 + .../create_google_api_source.php | 107 + .../V1/EventarcClient/create_message_bus.php | 89 + .../V1/EventarcClient/create_pipeline.php | 91 + .../V1/EventarcClient/create_trigger.php | 22 +- .../V1/EventarcClient/delete_channel.php | 10 +- .../V1/EventarcClient/delete_enrollment.php | 83 + .../delete_google_api_source.php | 87 + .../V1/EventarcClient/delete_message_bus.php | 83 + .../V1/EventarcClient/delete_pipeline.php | 83 + .../V1/EventarcClient/delete_trigger.php | 10 +- .../V1/EventarcClient/get_enrollment.php | 71 + .../EventarcClient/get_google_api_source.php | 75 + .../V1/EventarcClient/get_message_bus.php | 71 + .../V1/EventarcClient/get_pipeline.php | 71 + .../V1/EventarcClient/list_enrollments.php | 76 + .../list_google_api_sources.php | 76 + .../list_message_bus_enrollments.php | 75 + .../V1/EventarcClient/list_message_buses.php | 76 + .../V1/EventarcClient/list_pipelines.php | 76 + .../V1/EventarcClient/update_channel.php | 28 +- .../V1/EventarcClient/update_enrollment.php | 107 + .../update_google_api_source.php | 92 + .../V1/EventarcClient/update_message_bus.php | 71 + .../V1/EventarcClient/update_pipeline.php | 74 + .../V1/EventarcClient/update_trigger.php | 28 +- Eventarc/src/V1/Channel.php | 52 +- Eventarc/src/V1/Client/EventarcClient.php | 720 ++++ Eventarc/src/V1/CloudRun.php | 12 +- Eventarc/src/V1/CreateChannelRequest.php | 14 +- Eventarc/src/V1/CreateEnrollmentRequest.php | 206 ++ .../src/V1/CreateGoogleApiSourceRequest.php | 206 ++ Eventarc/src/V1/CreateMessageBusRequest.php | 206 ++ Eventarc/src/V1/CreatePipelineRequest.php | 201 ++ Eventarc/src/V1/CreateTriggerRequest.php | 14 +- Eventarc/src/V1/DeleteChannelRequest.php | 14 +- Eventarc/src/V1/DeleteEnrollmentRequest.php | 198 + .../src/V1/DeleteGoogleApiSourceRequest.php | 198 + Eventarc/src/V1/DeleteMessageBusRequest.php | 198 + Eventarc/src/V1/DeletePipelineRequest.php | 198 + Eventarc/src/V1/DeleteTriggerRequest.php | 14 +- Eventarc/src/V1/Destination.php | 103 +- Eventarc/src/V1/Enrollment.php | 469 +++ Eventarc/src/V1/EventFilter.php | 44 +- Eventarc/src/V1/FilteringAttribute.php | 32 +- Eventarc/src/V1/GKE.php | 56 +- Eventarc/src/V1/GetEnrollmentRequest.php | 81 + Eventarc/src/V1/GetGoogleApiSourceRequest.php | 81 + Eventarc/src/V1/GetMessageBusRequest.php | 81 + Eventarc/src/V1/GetPipelineRequest.php | 81 + Eventarc/src/V1/GoogleApiSource.php | 481 +++ Eventarc/src/V1/HttpEndpoint.php | 91 + Eventarc/src/V1/ListEnrollmentsRequest.php | 249 ++ Eventarc/src/V1/ListEnrollmentsResponse.php | 139 + .../src/V1/ListGoogleApiSourcesRequest.php | 249 ++ .../src/V1/ListGoogleApiSourcesResponse.php | 139 + .../V1/ListMessageBusEnrollmentsRequest.php | 165 + .../V1/ListMessageBusEnrollmentsResponse.php | 139 + Eventarc/src/V1/ListMessageBusesRequest.php | 249 ++ Eventarc/src/V1/ListMessageBusesResponse.php | 139 + Eventarc/src/V1/ListPipelinesRequest.php | 249 ++ Eventarc/src/V1/ListPipelinesResponse.php | 139 + Eventarc/src/V1/LoggingConfig.php | 76 + Eventarc/src/V1/LoggingConfig/LogSeverity.php | 118 + Eventarc/src/V1/MessageBus.php | 446 +++ Eventarc/src/V1/NetworkConfig.php | 75 + Eventarc/src/V1/OperationMetadata.php | 20 +- Eventarc/src/V1/Pipeline.php | 667 ++++ Eventarc/src/V1/Pipeline/Destination.php | 375 ++ .../Destination/AuthenticationConfig.php | 127 + .../AuthenticationConfig/OAuthToken.php | 141 + .../AuthenticationConfig/OidcToken.php | 137 + .../V1/Pipeline/Destination/HttpEndpoint.php | 738 ++++ .../V1/Pipeline/Destination/NetworkConfig.php | 77 + Eventarc/src/V1/Pipeline/Mediation.php | 76 + .../V1/Pipeline/Mediation/Transformation.php | 368 ++ .../src/V1/Pipeline/MessagePayloadFormat.php | 142 + .../MessagePayloadFormat/AvroFormat.php | 68 + .../MessagePayloadFormat/JsonFormat.php | 34 + .../MessagePayloadFormat/ProtobufFormat.php | 68 + Eventarc/src/V1/Pipeline/RetryPolicy.php | 183 + Eventarc/src/V1/Provider.php | 28 +- Eventarc/src/V1/Pubsub.php | 16 +- Eventarc/src/V1/Trigger.php | 232 +- Eventarc/src/V1/UpdateChannelRequest.php | 14 +- Eventarc/src/V1/UpdateEnrollmentRequest.php | 222 ++ .../src/V1/UpdateGoogleApiSourceRequest.php | 226 ++ Eventarc/src/V1/UpdateMessageBusRequest.php | 222 ++ Eventarc/src/V1/UpdatePipelineRequest.php | 222 ++ Eventarc/src/V1/UpdateTriggerRequest.php | 14 +- Eventarc/src/V1/gapic_metadata.json | 105 + .../V1/resources/eventarc_client_config.json | 202 +- .../resources/eventarc_descriptor_config.php | 386 ++ .../resources/eventarc_rest_client_config.php | 323 +- .../Unit/V1/Client/EventarcClientTest.php | 3197 ++++++++++++++--- 105 files changed, 16734 insertions(+), 771 deletions(-) create mode 100644 Eventarc/metadata/V1/Enrollment.php create mode 100644 Eventarc/metadata/V1/GoogleApiSource.php create mode 100644 Eventarc/metadata/V1/LoggingConfig.php create mode 100644 Eventarc/metadata/V1/MessageBus.php create mode 100644 Eventarc/metadata/V1/NetworkConfig.php create mode 100644 Eventarc/metadata/V1/Pipeline.php create mode 100644 Eventarc/samples/V1/EventarcClient/create_enrollment.php create mode 100644 Eventarc/samples/V1/EventarcClient/create_google_api_source.php create mode 100644 Eventarc/samples/V1/EventarcClient/create_message_bus.php create mode 100644 Eventarc/samples/V1/EventarcClient/create_pipeline.php create mode 100644 Eventarc/samples/V1/EventarcClient/delete_enrollment.php create mode 100644 Eventarc/samples/V1/EventarcClient/delete_google_api_source.php create mode 100644 Eventarc/samples/V1/EventarcClient/delete_message_bus.php create mode 100644 Eventarc/samples/V1/EventarcClient/delete_pipeline.php create mode 100644 Eventarc/samples/V1/EventarcClient/get_enrollment.php create mode 100644 Eventarc/samples/V1/EventarcClient/get_google_api_source.php create mode 100644 Eventarc/samples/V1/EventarcClient/get_message_bus.php create mode 100644 Eventarc/samples/V1/EventarcClient/get_pipeline.php create mode 100644 Eventarc/samples/V1/EventarcClient/list_enrollments.php create mode 100644 Eventarc/samples/V1/EventarcClient/list_google_api_sources.php create mode 100644 Eventarc/samples/V1/EventarcClient/list_message_bus_enrollments.php create mode 100644 Eventarc/samples/V1/EventarcClient/list_message_buses.php create mode 100644 Eventarc/samples/V1/EventarcClient/list_pipelines.php create mode 100644 Eventarc/samples/V1/EventarcClient/update_enrollment.php create mode 100644 Eventarc/samples/V1/EventarcClient/update_google_api_source.php create mode 100644 Eventarc/samples/V1/EventarcClient/update_message_bus.php create mode 100644 Eventarc/samples/V1/EventarcClient/update_pipeline.php create mode 100644 Eventarc/src/V1/CreateEnrollmentRequest.php create mode 100644 Eventarc/src/V1/CreateGoogleApiSourceRequest.php create mode 100644 Eventarc/src/V1/CreateMessageBusRequest.php create mode 100644 Eventarc/src/V1/CreatePipelineRequest.php create mode 100644 Eventarc/src/V1/DeleteEnrollmentRequest.php create mode 100644 Eventarc/src/V1/DeleteGoogleApiSourceRequest.php create mode 100644 Eventarc/src/V1/DeleteMessageBusRequest.php create mode 100644 Eventarc/src/V1/DeletePipelineRequest.php create mode 100644 Eventarc/src/V1/Enrollment.php create mode 100644 Eventarc/src/V1/GetEnrollmentRequest.php create mode 100644 Eventarc/src/V1/GetGoogleApiSourceRequest.php create mode 100644 Eventarc/src/V1/GetMessageBusRequest.php create mode 100644 Eventarc/src/V1/GetPipelineRequest.php create mode 100644 Eventarc/src/V1/GoogleApiSource.php create mode 100644 Eventarc/src/V1/HttpEndpoint.php create mode 100644 Eventarc/src/V1/ListEnrollmentsRequest.php create mode 100644 Eventarc/src/V1/ListEnrollmentsResponse.php create mode 100644 Eventarc/src/V1/ListGoogleApiSourcesRequest.php create mode 100644 Eventarc/src/V1/ListGoogleApiSourcesResponse.php create mode 100644 Eventarc/src/V1/ListMessageBusEnrollmentsRequest.php create mode 100644 Eventarc/src/V1/ListMessageBusEnrollmentsResponse.php create mode 100644 Eventarc/src/V1/ListMessageBusesRequest.php create mode 100644 Eventarc/src/V1/ListMessageBusesResponse.php create mode 100644 Eventarc/src/V1/ListPipelinesRequest.php create mode 100644 Eventarc/src/V1/ListPipelinesResponse.php create mode 100644 Eventarc/src/V1/LoggingConfig.php create mode 100644 Eventarc/src/V1/LoggingConfig/LogSeverity.php create mode 100644 Eventarc/src/V1/MessageBus.php create mode 100644 Eventarc/src/V1/NetworkConfig.php create mode 100644 Eventarc/src/V1/Pipeline.php create mode 100644 Eventarc/src/V1/Pipeline/Destination.php create mode 100644 Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig.php create mode 100644 Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig/OAuthToken.php create mode 100644 Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig/OidcToken.php create mode 100644 Eventarc/src/V1/Pipeline/Destination/HttpEndpoint.php create mode 100644 Eventarc/src/V1/Pipeline/Destination/NetworkConfig.php create mode 100644 Eventarc/src/V1/Pipeline/Mediation.php create mode 100644 Eventarc/src/V1/Pipeline/Mediation/Transformation.php create mode 100644 Eventarc/src/V1/Pipeline/MessagePayloadFormat.php create mode 100644 Eventarc/src/V1/Pipeline/MessagePayloadFormat/AvroFormat.php create mode 100644 Eventarc/src/V1/Pipeline/MessagePayloadFormat/JsonFormat.php create mode 100644 Eventarc/src/V1/Pipeline/MessagePayloadFormat/ProtobufFormat.php create mode 100644 Eventarc/src/V1/Pipeline/RetryPolicy.php create mode 100644 Eventarc/src/V1/UpdateEnrollmentRequest.php create mode 100644 Eventarc/src/V1/UpdateGoogleApiSourceRequest.php create mode 100644 Eventarc/src/V1/UpdateMessageBusRequest.php create mode 100644 Eventarc/src/V1/UpdatePipelineRequest.php diff --git a/Eventarc/metadata/V1/Channel.php b/Eventarc/metadata/V1/Channel.php index 48048e508aa272a3cf80bebfc42d386f4173d11e..591f38500aa820dd47c40ed6b299efab1cb5a499 100644 GIT binary patch delta 72 zcmX@j^Mq$Z8xzZ9b}qGv-fELKFoiRo-ps+Q!N_Po*^otoQEjp>i<*p(6c=xCVo7Fk cT4ri-d_h&Q1djrv28R>#14rh~#Vj`%0rCtKHvj+t delta 46 zcmaFDbDC#E8xzYfHZHY^-fELKFoiR2+RVYM!N}+|*^otoMe~6p<76)uwaq;&Hy8n3 C-3|c& diff --git a/Eventarc/metadata/V1/Enrollment.php b/Eventarc/metadata/V1/Enrollment.php new file mode 100644 index 000000000000..2edfc789c5e4 --- /dev/null +++ b/Eventarc/metadata/V1/Enrollment.php @@ -0,0 +1,53 @@ +internalAddGeneratedFile( + ' +Œ +)google/cloud/eventarc/v1/enrollment.protogoogle.cloud.eventarc.v1google/api/resource.protogoogle/protobuf/timestamp.proto"¾ + +Enrollment +name ( BàA +uid ( BàA +etag ( BàA4 + create_time ( 2.google.protobuf.TimestampBàA4 + update_time ( 2.google.protobuf.TimestampBàAE +labels ( 20.google.cloud.eventarc.v1.Enrollment.LabelsEntryBàAO + annotations ( 25.google.cloud.eventarc.v1.Enrollment.AnnotationsEntryBàA + display_name ( BàA + cel_match ( BàA? + message_bus + ( B*àAúA$ +"eventarc.googleapis.com/MessageBus + destination ( BàA- + LabelsEntry +key (  +value ( :82 +AnnotationsEntry +key (  +value ( :8:‚êA +"eventarc.googleapis.com/Enrollment@projects/{project}/locations/{location}/enrollments/{enrollment}* enrollments2 +enrollmentB¿ +com.google.cloud.eventarc.v1BEnrollmentProtoPZ8cloud.google.com/go/eventarc/apiv1/eventarcpb;eventarcpbªGoogle.Cloud.Eventarc.V1ÊGoogle\\Cloud\\Eventarc\\V1êGoogle::Cloud::Eventarc::V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/Eventarc/metadata/V1/Eventarc.php b/Eventarc/metadata/V1/Eventarc.php index 306654a39702..69c3be8ae46f 100644 --- a/Eventarc/metadata/V1/Eventarc.php +++ b/Eventarc/metadata/V1/Eventarc.php @@ -21,15 +21,19 @@ public static function initOnce() { \GPBMetadata\Google\Cloud\Eventarc\V1\Channel::initOnce(); \GPBMetadata\Google\Cloud\Eventarc\V1\ChannelConnection::initOnce(); \GPBMetadata\Google\Cloud\Eventarc\V1\Discovery::initOnce(); + \GPBMetadata\Google\Cloud\Eventarc\V1\Enrollment::initOnce(); + \GPBMetadata\Google\Cloud\Eventarc\V1\GoogleApiSource::initOnce(); \GPBMetadata\Google\Cloud\Eventarc\V1\GoogleChannelConfig::initOnce(); + \GPBMetadata\Google\Cloud\Eventarc\V1\MessageBus::initOnce(); + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); \GPBMetadata\Google\Cloud\Eventarc\V1\Trigger::initOnce(); \GPBMetadata\Google\Longrunning\Operations::initOnce(); \GPBMetadata\Google\Protobuf\FieldMask::initOnce(); \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -°< -\'google/cloud/eventarc/v1/eventarc.protogoogle.cloud.eventarc.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto&google/cloud/eventarc/v1/channel.proto1google/cloud/eventarc/v1/channel_connection.proto(google/cloud/eventarc/v1/discovery.proto4google/cloud/eventarc/v1/google_channel_config.proto&google/cloud/eventarc/v1/trigger.proto#google/longrunning/operations.proto google/protobuf/field_mask.protogoogle/protobuf/timestamp.proto"J +Ó +\'google/cloud/eventarc/v1/eventarc.protogoogle.cloud.eventarc.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto&google/cloud/eventarc/v1/channel.proto1google/cloud/eventarc/v1/channel_connection.proto(google/cloud/eventarc/v1/discovery.proto)google/cloud/eventarc/v1/enrollment.proto0google/cloud/eventarc/v1/google_api_source.proto4google/cloud/eventarc/v1/google_channel_config.proto*google/cloud/eventarc/v1/message_bus.proto\'google/cloud/eventarc/v1/pipeline.proto&google/cloud/eventarc/v1/trigger.proto#google/longrunning/operations.proto google/protobuf/field_mask.protogoogle/protobuf/timestamp.proto"J GetTriggerRequest5 name ( B\'àAúA! eventarc.googleapis.com/Trigger"— @@ -49,18 +53,18 @@ public static function initOnce() { trigger ( 2!.google.cloud.eventarc.v1.TriggerBàA trigger_id ( BàA - validate_only (BàA"® + validate_only (BàA"® UpdateTriggerRequest2 trigger ( 2!.google.cloud.eventarc.v1.Trigger/ update_mask ( 2.google.protobuf.FieldMask allow_missing ( - validate_only (BàA"Ž + validate_only (BàA"Ž DeleteTriggerRequest5 name ( B\'àAúA! eventarc.googleapis.com/Trigger etag (  allow_missing ( - validate_only (BàA"J + validate_only (BàA"J GetChannelRequest5 name ( B\'àAúA! eventarc.googleapis.com/Channel"‡ @@ -79,15 +83,15 @@ public static function initOnce() { channel ( 2!.google.cloud.eventarc.v1.ChannelBàA channel_id ( BàA - validate_only (BàA"— + validate_only (BàA"— UpdateChannelRequest2 channel ( 2!.google.cloud.eventarc.v1.Channel/ update_mask ( 2.google.protobuf.FieldMask - validate_only (BàA"i + validate_only (BàA"i DeleteChannelRequest5 name ( B\'àAúA! eventarc.googleapis.com/Channel - validate_only (BàA"L + validate_only (BàA"L GetProviderRequest6 name ( B(àAúA" eventarc.googleapis.com/Provider"™ @@ -126,7 +130,139 @@ public static function initOnce() { update_mask ( 2.google.protobuf.FieldMask"b GetGoogleChannelConfigRequestA name ( B3àAúA- -+eventarc.googleapis.com/GoogleChannelConfig"€ ++eventarc.googleapis.com/GoogleChannelConfig"P +GetMessageBusRequest8 +name ( B*àAúA$ +"eventarc.googleapis.com/MessageBus"² +ListMessageBusesRequest: +parent ( B*àAúA$"eventarc.googleapis.com/MessageBus + page_size (BàA + +page_token ( BàA +order_by ( BàA +filter ( BàA"… +ListMessageBusesResponse; + message_buses ( 2$.google.cloud.eventarc.v1.MessageBus +next_page_token (  + unreachable ( " + ListMessageBusEnrollmentsRequest: +parent ( B*àAúA$ +"eventarc.googleapis.com/MessageBus + page_size (BàA + +page_token ( BàA"f +!ListMessageBusEnrollmentsResponse + enrollments (  +next_page_token (  + unreachable ( "Î +CreateMessageBusRequest: +parent ( B*àAúA$"eventarc.googleapis.com/MessageBus> + message_bus ( 2$.google.cloud.eventarc.v1.MessageBusBàA +message_bus_id ( BàA + validate_only (BàA"Ç +UpdateMessageBusRequest> + message_bus ( 2$.google.cloud.eventarc.v1.MessageBusBàA4 + update_mask ( 2.google.protobuf.FieldMaskBàA + allow_missing (BàA + validate_only (BàA"ž +DeleteMessageBusRequest8 +name ( B*àAúA$ +"eventarc.googleapis.com/MessageBus +etag ( BàA + allow_missing (BàA + validate_only (BàA"P +GetEnrollmentRequest8 +name ( B*àAúA$ +"eventarc.googleapis.com/Enrollment"± +ListEnrollmentsRequest: +parent ( B*àAúA$"eventarc.googleapis.com/Enrollment + page_size (BàA + +page_token ( BàA +order_by ( BàA +filter ( BàA"‚ +ListEnrollmentsResponse9 + enrollments ( 2$.google.cloud.eventarc.v1.Enrollment +next_page_token (  + unreachable ( "Ì +CreateEnrollmentRequest: +parent ( B*àAúA$"eventarc.googleapis.com/Enrollment= + +enrollment ( 2$.google.cloud.eventarc.v1.EnrollmentBàA + enrollment_id ( BàA + validate_only (BàA"Æ +UpdateEnrollmentRequest= + +enrollment ( 2$.google.cloud.eventarc.v1.EnrollmentBàA4 + update_mask ( 2.google.protobuf.FieldMaskBàA + allow_missing (BàA + validate_only (BàA"ž +DeleteEnrollmentRequest8 +name ( B*àAúA$ +"eventarc.googleapis.com/Enrollment +etag ( BàA + allow_missing (BàA + validate_only (BàA"L +GetPipelineRequest6 +name ( B(àAúA" + eventarc.googleapis.com/Pipeline"­ +ListPipelinesRequest8 +parent ( B(àAúA" eventarc.googleapis.com/Pipeline + page_size (BàA + +page_token ( BàA +order_by ( BàA +filter ( BàA"| +ListPipelinesResponse5 + pipelines ( 2".google.cloud.eventarc.v1.Pipeline +next_page_token (  + unreachable ( " +CreatePipelineRequest8 +parent ( B(àAúA" eventarc.googleapis.com/Pipeline9 +pipeline ( 2".google.cloud.eventarc.v1.PipelineBàA + pipeline_id ( BàA + validate_only (BàA"À +UpdatePipelineRequest9 +pipeline ( 2".google.cloud.eventarc.v1.PipelineBàA4 + update_mask ( 2.google.protobuf.FieldMaskBàA + allow_missing (BàA + validate_only (BàA"š +DeletePipelineRequest6 +name ( B(àAúA" + eventarc.googleapis.com/Pipeline +etag ( BàA + allow_missing (BàA + validate_only (BàA"Z +GetGoogleApiSourceRequest= +name ( B/àAúA) +\'eventarc.googleapis.com/GoogleApiSource"» +ListGoogleApiSourcesRequest? +parent ( B/àAúA)\'eventarc.googleapis.com/GoogleApiSource + page_size (BàA + +page_token ( BàA +order_by ( BàA +filter ( BàA"“ +ListGoogleApiSourcesResponseE +google_api_sources ( 2).google.cloud.eventarc.v1.GoogleApiSource +next_page_token (  + unreachable ( "é +CreateGoogleApiSourceRequest? +parent ( B/àAúA)\'eventarc.googleapis.com/GoogleApiSourceI +google_api_source ( 2).google.cloud.eventarc.v1.GoogleApiSourceBàA! +google_api_source_id ( BàA + validate_only (BàA"× +UpdateGoogleApiSourceRequestI +google_api_source ( 2).google.cloud.eventarc.v1.GoogleApiSourceBàA4 + update_mask ( 2.google.protobuf.FieldMaskBàA + allow_missing (BàA + validate_only (BàA"¨ +DeleteGoogleApiSourceRequest= +name ( B/àAúA) +\'eventarc.googleapis.com/GoogleApiSource +etag ( BàA + allow_missing (BàA + validate_only (BàA"€ OperationMetadata4 create_time ( 2.google.protobuf.TimestampBàA1 end_time ( 2.google.protobuf.TimestampBàA @@ -134,7 +270,7 @@ public static function initOnce() { verb ( BàA status_message ( BàA# requested_cancellation (BàA - api_version ( BàA2Ï + api_version ( BàA2õ@ Eventarc™ GetTrigger+.google.cloud.eventarc.v1.GetTriggerRequest!.google.cloud.eventarc.v1.Trigger";ÚAname‚Óä“.,/v1/{name=projects/*/locations/*/triggers/*}¬ @@ -163,7 +299,48 @@ public static function initOnce() { DeleteChannelConnection8.google.cloud.eventarc.v1.DeleteChannelConnectionRequest.google.longrunning.Operation"nÊA& ChannelConnectionOperationMetadataÚAname‚Óä“8*6/v1/{name=projects/*/locations/*/channelConnections/*}Æ GetGoogleChannelConfig7.google.cloud.eventarc.v1.GetGoogleChannelConfigRequest-.google.cloud.eventarc.v1.GoogleChannelConfig"DÚAname‚Óä“75/v1/{name=projects/*/locations/*/googleChannelConfig}— -UpdateGoogleChannelConfig:.google.cloud.eventarc.v1.UpdateGoogleChannelConfigRequest-.google.cloud.eventarc.v1.GoogleChannelConfig"ŽÚA!google_channel_config,update_mask‚Óä“d2K/v1/{google_channel_config.name=projects/*/locations/*/googleChannelConfig}:google_channel_configKÊAeventarc.googleapis.comÒA.https://www.googleapis.com/auth/cloud-platformB½ +UpdateGoogleChannelConfig:.google.cloud.eventarc.v1.UpdateGoogleChannelConfigRequest-.google.cloud.eventarc.v1.GoogleChannelConfig"ŽÚA!google_channel_config,update_mask‚Óä“d2K/v1/{google_channel_config.name=projects/*/locations/*/googleChannelConfig}:google_channel_config¦ + GetMessageBus..google.cloud.eventarc.v1.GetMessageBusRequest$.google.cloud.eventarc.v1.MessageBus"?ÚAname‚Óä“20/v1/{name=projects/*/locations/*/messageBuses/*}¼ +ListMessageBuses1.google.cloud.eventarc.v1.ListMessageBusesRequest2.google.cloud.eventarc.v1.ListMessageBusesResponse"AÚAparent‚Óä“20/v1/{parent=projects/*/locations/*}/messageBusesé +ListMessageBusEnrollments:.google.cloud.eventarc.v1.ListMessageBusEnrollmentsRequest;.google.cloud.eventarc.v1.ListMessageBusEnrollmentsResponse"SÚAparent‚Óä“DB/v1/{parent=projects/*/locations/*/messageBuses/*}:listEnrollmentsò +CreateMessageBus1.google.cloud.eventarc.v1.CreateMessageBusRequest.google.longrunning.Operation"‹ÊA + +MessageBusOperationMetadataÚA!parent,message_bus,message_bus_id‚Óä“?"0/v1/{parent=projects/*/locations/*}/messageBuses: message_busô +UpdateMessageBus1.google.cloud.eventarc.v1.UpdateMessageBusRequest.google.longrunning.Operation"ÊA + +MessageBusOperationMetadataÚAmessage_bus,update_mask‚Óä“K2ÚAname‚Óä“1//v1/{name=projects/*/locations/*/enrollments/*}¸ +ListEnrollments0.google.cloud.eventarc.v1.ListEnrollmentsRequest1.google.cloud.eventarc.v1.ListEnrollmentsResponse"@ÚAparent‚Óä“1//v1/{parent=projects/*/locations/*}/enrollmentsî +CreateEnrollment1.google.cloud.eventarc.v1.CreateEnrollmentRequest.google.longrunning.Operation"‡ÊA + +EnrollmentOperationMetadataÚAparent,enrollment,enrollment_id‚Óä“="//v1/{parent=projects/*/locations/*}/enrollments: +enrollmentð +UpdateEnrollment1.google.cloud.eventarc.v1.UpdateEnrollmentRequest.google.longrunning.Operation"‰ÊA + +EnrollmentOperationMetadataÚAenrollment,update_mask‚Óä“H2:/v1/{enrollment.name=projects/*/locations/*/enrollments/*}: +enrollmentË +DeleteEnrollment1.google.cloud.eventarc.v1.DeleteEnrollmentRequest.google.longrunning.Operation"eÊA + +EnrollmentOperationMetadataÚA name,etag‚Óä“1*//v1/{name=projects/*/locations/*/enrollments/*} + GetPipeline,.google.cloud.eventarc.v1.GetPipelineRequest".google.cloud.eventarc.v1.Pipeline"<ÚAname‚Óä“/-/v1/{name=projects/*/locations/*/pipelines/*}° + ListPipelines..google.cloud.eventarc.v1.ListPipelinesRequest/.google.cloud.eventarc.v1.ListPipelinesResponse">ÚAparent‚Óä“/-/v1/{parent=projects/*/locations/*}/pipelinesß +CreatePipeline/.google.cloud.eventarc.v1.CreatePipelineRequest.google.longrunning.Operation"}ÊA +PipelineOperationMetadataÚAparent,pipeline,pipeline_id‚Óä“9"-/v1/{parent=projects/*/locations/*}/pipelines:pipelineá +UpdatePipeline/.google.cloud.eventarc.v1.UpdatePipelineRequest.google.longrunning.Operation"ÊA +PipelineOperationMetadataÚApipeline,update_mask‚Óä“B26/v1/{pipeline.name=projects/*/locations/*/pipelines/*}:pipelineà +DeletePipeline/.google.cloud.eventarc.v1.DeletePipelineRequest.google.longrunning.Operation"aÊA +PipelineOperationMetadataÚA name,etag‚Óä“/*-/v1/{name=projects/*/locations/*/pipelines/*}¹ +GetGoogleApiSource3.google.cloud.eventarc.v1.GetGoogleApiSourceRequest).google.cloud.eventarc.v1.GoogleApiSource"CÚAname‚Óä“64/v1/{name=projects/*/locations/*/googleApiSources/*}Ì +ListGoogleApiSources5.google.cloud.eventarc.v1.ListGoogleApiSourcesRequest6.google.cloud.eventarc.v1.ListGoogleApiSourcesResponse"EÚAparent‚Óä“64/v1/{parent=projects/*/locations/*}/googleApiSources— +CreateGoogleApiSource6.google.cloud.eventarc.v1.CreateGoogleApiSourceRequest.google.longrunning.Operation"¦ÊA$ +GoogleApiSourceOperationMetadataÚA-parent,google_api_source,google_api_source_id‚Óä“I"4/v1/{parent=projects/*/locations/*}/googleApiSources:google_api_source™ +UpdateGoogleApiSource6.google.cloud.eventarc.v1.UpdateGoogleApiSourceRequest.google.longrunning.Operation"¨ÊA$ +GoogleApiSourceOperationMetadataÚAgoogle_api_source,update_mask‚Óä“[2F/v1/{google_api_source.name=projects/*/locations/*/googleApiSources/*}:google_api_sourceß +DeleteGoogleApiSource6.google.cloud.eventarc.v1.DeleteGoogleApiSourceRequest.google.longrunning.Operation"oÊA$ +GoogleApiSourceOperationMetadataÚA name,etag‚Óä“6*4/v1/{name=projects/*/locations/*/googleApiSources/*}KÊAeventarc.googleapis.comÒA.https://www.googleapis.com/auth/cloud-platformB½ com.google.cloud.eventarc.v1B EventarcProtoPZ8cloud.google.com/go/eventarc/apiv1/eventarcpb;eventarcpbªGoogle.Cloud.Eventarc.V1ÊGoogle\\Cloud\\Eventarc\\V1êGoogle::Cloud::Eventarc::V1bproto3' , true); diff --git a/Eventarc/metadata/V1/GoogleApiSource.php b/Eventarc/metadata/V1/GoogleApiSource.php new file mode 100644 index 000000000000..2d3a1acb1c57 --- /dev/null +++ b/Eventarc/metadata/V1/GoogleApiSource.php @@ -0,0 +1,54 @@ +internalAddGeneratedFile( + ' +ï +0google/cloud/eventarc/v1/google_api_source.protogoogle.cloud.eventarc.v1google/api/field_info.protogoogle/api/resource.proto-google/cloud/eventarc/v1/logging_config.protogoogle/protobuf/timestamp.proto"É +GoogleApiSource +name ( BàA +uid ( B àAâŒÏ× +etag ( BàA4 + create_time ( 2.google.protobuf.TimestampBàA4 + update_time ( 2.google.protobuf.TimestampBàAJ +labels ( 25.google.cloud.eventarc.v1.GoogleApiSource.LabelsEntryBàAT + annotations ( 2:.google.cloud.eventarc.v1.GoogleApiSource.AnnotationsEntryBàA + display_name ( BàA? + destination ( B*àAúA$ +"eventarc.googleapis.com/MessageBusB +crypto_key_name + ( B)àAúA# +!cloudkms.googleapis.com/CryptoKeyD +logging_config ( 2\'.google.cloud.eventarc.v1.LoggingConfigBàA- + LabelsEntry +key (  +value ( :82 +AnnotationsEntry +key (  +value ( :8:žêAš +\'eventarc.googleapis.com/GoogleApiSourceLprojects/{project}/locations/{location}/googleApiSources/{google_api_source}*googleApiSources2googleApiSourceBÄ +com.google.cloud.eventarc.v1BGoogleApiSourceProtoPZ8cloud.google.com/go/eventarc/apiv1/eventarcpb;eventarcpbªGoogle.Cloud.Eventarc.V1ÊGoogle\\Cloud\\Eventarc\\V1êGoogle::Cloud::Eventarc::V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/Eventarc/metadata/V1/LoggingConfig.php b/Eventarc/metadata/V1/LoggingConfig.php new file mode 100644 index 0000000000000000000000000000000000000000..73f9aeba0dea53dc963ac3b5a6c03f02dfc90ef6 GIT binary patch literal 1148 zcmb7D%WB&|6s_{kBq>5GL$jEsfjH2}xY-n?X|d(85IB-i9G4V<8OvjNK+%ZN$dHzN zL^u72enyx5imv+wU3Mh-k&tFlZ8VR2&%O7|IqyCslLWki7KsVRf{fts7K#ah31@-@ zEP}&qJSH3l>?WZR;W~sZ7dmbaqL$rzDN|FH@qidGWGswGEr?h)s*x#)1?E9*TCYVc z3~3w=0v3;Hs29ip#Q27!2@VLfy3GqB@CXa+TLp-3<{&G|$*mfBqX)ld$;DPZT`p|%ey9oHIMqCWEM-u2+hx$Gj-ZriA(KGU|qn&Uc1 zRkUre-a^eQOI^tiZKv(3s~P|sQs=gb)HQ7fY<_Hbj_p|LdLE5D&-K&|Z5M2r64^Ez z9d$FmXmpU*Q@6A|u#GN|XCcSDR=1l!6tFKX^yFYo?ZIS)(z?p0wlI@nDuWJ_=1 zgi3qO8BT_0%jNf#id9%iFRY}anU(Z@{pbA3pV@5bGikKnD=*4K!zeNhW1eal{rYgD baPR5SLM5+D-QJV=lM*i?OCjEYI{^LykLhUp literal 0 HcmV?d00001 diff --git a/Eventarc/metadata/V1/MessageBus.php b/Eventarc/metadata/V1/MessageBus.php new file mode 100644 index 000000000000..1b8f2ed0c15f --- /dev/null +++ b/Eventarc/metadata/V1/MessageBus.php @@ -0,0 +1,53 @@ +internalAddGeneratedFile( + ' +× +*google/cloud/eventarc/v1/message_bus.protogoogle.cloud.eventarc.v1google/api/resource.proto-google/cloud/eventarc/v1/logging_config.protogoogle/protobuf/timestamp.proto"Ù + +MessageBus +name ( BàA +uid ( BàA +etag ( BàA4 + create_time ( 2.google.protobuf.TimestampBàA4 + update_time ( 2.google.protobuf.TimestampBàAE +labels ( 20.google.cloud.eventarc.v1.MessageBus.LabelsEntryBàAO + annotations ( 25.google.cloud.eventarc.v1.MessageBus.AnnotationsEntryBàA + display_name ( BàAB +crypto_key_name + ( B)àAúA# +!cloudkms.googleapis.com/CryptoKeyD +logging_config ( 2\'.google.cloud.eventarc.v1.LoggingConfigBàA- + LabelsEntry +key (  +value ( :82 +AnnotationsEntry +key (  +value ( :8:†êA‚ +"eventarc.googleapis.com/MessageBusBprojects/{project}/locations/{location}/messageBuses/{message_bus}* messageBuses2 +messageBusB¿ +com.google.cloud.eventarc.v1BMessageBusProtoPZ8cloud.google.com/go/eventarc/apiv1/eventarcpb;eventarcpbªGoogle.Cloud.Eventarc.V1ÊGoogle\\Cloud\\Eventarc\\V1êGoogle::Cloud::Eventarc::V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/Eventarc/metadata/V1/NetworkConfig.php b/Eventarc/metadata/V1/NetworkConfig.php new file mode 100644 index 000000000000..f04fa3828dde --- /dev/null +++ b/Eventarc/metadata/V1/NetworkConfig.php @@ -0,0 +1,32 @@ +internalAddGeneratedFile( + ' + +-google/cloud/eventarc/v1/network_config.protogoogle.cloud.eventarc.v1google/api/resource.proto"] + NetworkConfigL +network_attachment ( B0àAúA* +(compute.googleapis.com/NetworkAttachmentB +com.google.cloud.eventarc.v1BNetworkConfigProtoPZ8cloud.google.com/go/eventarc/apiv1/eventarcpb;eventarcpbªGoogle.Cloud.Eventarc.V1ÊGoogle\\Cloud\\Eventarc\\V1êGoogle::Cloud::Eventarc::V1bproto3' + , true); + + static::$is_initialized = true; + } +} + diff --git a/Eventarc/metadata/V1/Pipeline.php b/Eventarc/metadata/V1/Pipeline.php new file mode 100644 index 0000000000000000000000000000000000000000..65ff91e3be27fd79330f9945a53ded06f7492e89 GIT binary patch literal 4457 zcmb_g+iuiG81ClO&A&+ii^F1iFo%kOz)J!uXaj9`lMrYLiD(3ZZe>mE+078I$Fj$P z6h-O-^a*;?`@TTmp*Ov()SDip-tY)q^`G(B>m>;+l-#W2neY4m`Oo9)pNAVEoVJ!| zKqDfkXRU8rVuM;?#07V`Z>=ZoHjONocSGjW$hNG773=QGnzguad+j7bW1d7Vty>+= zJ3g(sK2N+F-J*dYkz3oEsf8@0J`1R=H~|9ErEy4HYAvlcm#H8g5u~-G;H`NHZ!Kzg z>;B9ffa{YuwpKL_JOc~=!erfNt`!R+@aGJR9TqUbh|j*mQ{1rH#E&V0ckgW{fh!mf zED2Z%TsnQuN;&1;Ga<)Q->@=;R;3}(2(8XC=5GeON43)j7PiZ+tvkHaVL@k}2W{3FTzu}1g#_ajz4#W;HHHBwNH^RY zt0LgyXH5IM;d!}xZ(<5e=MItXISYTBfY#XogWss88*P;(c9tdf){J>VQ;?9=+R~#K z&uyOOjCs7U7-{3{rHlKD_EQTxt}?OS{*m6UauLJ2=4m_X^^ad(7n!lr4X6G-2IVXj zjYBXZv$=`kf>paNw($rKvmi`_6OwJ86VGY$s7pk(qP%-`Af@7%bm(e|zp3D2==m0)s<#4e;S6v%XGK) zh6Cj+_f*hhlewc8TNBw(9bzMP71B<^_PBwy)dW9D|Wf7I@~r<4`GN zkMR(u0xF*HXj4~A?VjrcSg^oj-%Ux<#+HW0LzvtUB6Mirg&g~e_RZWIGT%auMNOfI z(c3qmELCp%{E2eRcr#DX?ES6`eV_pdZ$Jfmq0BL7J&|Qp*75Ty#m~U0yg#MYJ5O;P zjm;!RiYqWGc*xvpS%FV0@P}{$2edd@*GJ5uYjP{1I&g#}IA{hqy{TH28C}-l%Iy3b znx@gmRkZy#aD*pfk18~#1pTinWPS^ieeO2yfRP0e5rViIT|A+V)k|2OUo_6cw49|A zL0>kFW@_X(a|tGjJ~s|xtBP1J^oNX3pql#+gBk}aN6;?z7(sP7$R20@iPdN?6B!ID zsc#+5JXc5j@;flTy@Gsee3J%Qq&|iUmo9gNe5+I7?mH1Bk5-grwqZP%Z(u8nX|%;$ z>JZoEN$wEL6m$r-GDf;DJLBsV(MSQt5h#>rluQp`B^Ulq1Q{?IyF4sP zX`TX08m^ElT`D%XhvhK4i8QNl6#vUcfx?RUO9{sF=8ipiN<<`x+p3r1T%&zHNG-}) z?6p1$?P2p%nCf3J&cLyLX}##|)$is}IGm3xMa_RKL8Z`U4IH4lQA3H60r6w!r5$KT*sq5rml!<&-Bwy&F5)V#dq1`PJR)W z8}(&+=lpo~7|)io$L9A#@Bvn-%yzrR>E>i6UA5}f(xYqX9zEvEIk3ZfUjeZEXN$p+w=13Z!hYrzkPq^*KDb!KMVA}3*d)==R+q_V7;!8^?C-a*KxJ+ v#VcEoadHo;U`+XB@^* literal 0 HcmV?d00001 diff --git a/Eventarc/metadata/V1/Trigger.php b/Eventarc/metadata/V1/Trigger.php index 16e2f1153d939d2afd30673e4e2e9fa042a081a7..047dcf6b0f487d8b142d86839ba79bdb5399a81b 100644 GIT binary patch delta 402 zcmX>gK395!KGVbrf_yQ4sU_w4McK~zd1;yHlO36~ChIeGGF=gwyo)K0QFrnlCP}_L zh?4kZh#Em=d!~8pn}e7=nQT}I04NfQK2ab$F zQe3>ni6xoEX_=|T@dZ`I62d?^j?Gh9*E2FrWS;EC{zp>Co{Kl5q@*A|H7}(gKQpgH zf)%KS+emHl0ZvIRJrAIiD^$jVLCA#*%~29;VAV0|Amze(D4qhlVY3rQ8KbI_0v8Xm zQ9=S-%%w${5{xjnGC6Hz*}R)`2c!Ng$1*OBsetParent($formattedParent) ->setChannel($channel) - ->setChannelId($channelId) - ->setValidateOnly($validateOnly); + ->setChannelId($channelId); // Call the API and handle any network failures. try { @@ -94,8 +90,7 @@ function callSample(): void $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); $channelName = '[NAME]'; $channelId = '[CHANNEL_ID]'; - $validateOnly = false; - create_channel_sample($formattedParent, $channelName, $channelId, $validateOnly); + create_channel_sample($formattedParent, $channelName, $channelId); } // [END eventarc_v1_generated_Eventarc_CreateChannel_sync] diff --git a/Eventarc/samples/V1/EventarcClient/create_enrollment.php b/Eventarc/samples/V1/EventarcClient/create_enrollment.php new file mode 100644 index 000000000000..dfa7ba61b56c --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/create_enrollment.php @@ -0,0 +1,119 @@ +setCelMatch($enrollmentCelMatch) + ->setMessageBus($formattedEnrollmentMessageBus) + ->setDestination($enrollmentDestination); + $request = (new CreateEnrollmentRequest()) + ->setParent($formattedParent) + ->setEnrollment($enrollment) + ->setEnrollmentId($enrollmentId); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->createEnrollment($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Enrollment $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 +{ + $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); + $enrollmentCelMatch = '[CEL_MATCH]'; + $formattedEnrollmentMessageBus = EventarcClient::messageBusName( + '[PROJECT]', + '[LOCATION]', + '[MESSAGE_BUS]' + ); + $enrollmentDestination = '[DESTINATION]'; + $enrollmentId = '[ENROLLMENT_ID]'; + + create_enrollment_sample( + $formattedParent, + $enrollmentCelMatch, + $formattedEnrollmentMessageBus, + $enrollmentDestination, + $enrollmentId + ); +} +// [END eventarc_v1_generated_Eventarc_CreateEnrollment_sync] diff --git a/Eventarc/samples/V1/EventarcClient/create_google_api_source.php b/Eventarc/samples/V1/EventarcClient/create_google_api_source.php new file mode 100644 index 000000000000..cea200a0bfa6 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/create_google_api_source.php @@ -0,0 +1,107 @@ +setDestination($formattedGoogleApiSourceDestination); + $request = (new CreateGoogleApiSourceRequest()) + ->setParent($formattedParent) + ->setGoogleApiSource($googleApiSource) + ->setGoogleApiSourceId($googleApiSourceId); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->createGoogleApiSource($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var GoogleApiSource $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 +{ + $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); + $formattedGoogleApiSourceDestination = EventarcClient::messageBusName( + '[PROJECT]', + '[LOCATION]', + '[MESSAGE_BUS]' + ); + $googleApiSourceId = '[GOOGLE_API_SOURCE_ID]'; + + create_google_api_source_sample( + $formattedParent, + $formattedGoogleApiSourceDestination, + $googleApiSourceId + ); +} +// [END eventarc_v1_generated_Eventarc_CreateGoogleApiSource_sync] diff --git a/Eventarc/samples/V1/EventarcClient/create_message_bus.php b/Eventarc/samples/V1/EventarcClient/create_message_bus.php new file mode 100644 index 000000000000..9aca0e8d8b9f --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/create_message_bus.php @@ -0,0 +1,89 @@ +setParent($formattedParent) + ->setMessageBus($messageBus) + ->setMessageBusId($messageBusId); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->createMessageBus($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var MessageBus $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 +{ + $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); + $messageBusId = '[MESSAGE_BUS_ID]'; + + create_message_bus_sample($formattedParent, $messageBusId); +} +// [END eventarc_v1_generated_Eventarc_CreateMessageBus_sync] diff --git a/Eventarc/samples/V1/EventarcClient/create_pipeline.php b/Eventarc/samples/V1/EventarcClient/create_pipeline.php new file mode 100644 index 000000000000..f3911821a94d --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/create_pipeline.php @@ -0,0 +1,91 @@ +setDestinations($pipelineDestinations); + $request = (new CreatePipelineRequest()) + ->setParent($formattedParent) + ->setPipeline($pipeline) + ->setPipelineId($pipelineId); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->createPipeline($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Pipeline $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 +{ + $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); + $pipelineId = '[PIPELINE_ID]'; + + create_pipeline_sample($formattedParent, $pipelineId); +} +// [END eventarc_v1_generated_Eventarc_CreatePipeline_sync] diff --git a/Eventarc/samples/V1/EventarcClient/create_trigger.php b/Eventarc/samples/V1/EventarcClient/create_trigger.php index 808ebe0792a9..85808f930bdc 100644 --- a/Eventarc/samples/V1/EventarcClient/create_trigger.php +++ b/Eventarc/samples/V1/EventarcClient/create_trigger.php @@ -37,25 +37,24 @@ * * @param string $formattedParent The parent collection in which to add this trigger. Please see * {@see EventarcClient::locationName()} for help formatting this field. - * @param string $triggerName The resource name of the trigger. Must be unique within the location of the - * project and must be in + * @param string $triggerName The resource name of the trigger. Must be unique within the + * location of the project and must be in * `projects/{project}/locations/{location}/triggers/{trigger}` format. - * @param string $triggerEventFiltersAttribute The name of a CloudEvents attribute. Currently, only a subset of attributes - * are supported for filtering. + * @param string $triggerEventFiltersAttribute The name of a CloudEvents attribute. Currently, only a subset of + * attributes are supported for filtering. You can [retrieve a specific + * provider's supported event + * types](/eventarc/docs/list-providers#describe-provider). * * All triggers MUST provide a filter for the 'type' attribute. * @param string $triggerEventFiltersValue The value for the attribute. * @param string $triggerId The user-provided ID to be assigned to the trigger. - * @param bool $validateOnly If set, validate the request and preview the review, but do not - * post it. */ function create_trigger_sample( string $formattedParent, string $triggerName, string $triggerEventFiltersAttribute, string $triggerEventFiltersValue, - string $triggerId, - bool $validateOnly + string $triggerId ): void { // Create a client. $eventarcClient = new EventarcClient(); @@ -73,8 +72,7 @@ function create_trigger_sample( $request = (new CreateTriggerRequest()) ->setParent($formattedParent) ->setTrigger($trigger) - ->setTriggerId($triggerId) - ->setValidateOnly($validateOnly); + ->setTriggerId($triggerId); // Call the API and handle any network failures. try { @@ -112,15 +110,13 @@ function callSample(): void $triggerEventFiltersAttribute = '[ATTRIBUTE]'; $triggerEventFiltersValue = '[VALUE]'; $triggerId = '[TRIGGER_ID]'; - $validateOnly = false; create_trigger_sample( $formattedParent, $triggerName, $triggerEventFiltersAttribute, $triggerEventFiltersValue, - $triggerId, - $validateOnly + $triggerId ); } // [END eventarc_v1_generated_Eventarc_CreateTrigger_sync] diff --git a/Eventarc/samples/V1/EventarcClient/delete_channel.php b/Eventarc/samples/V1/EventarcClient/delete_channel.php index 50a8f8bca2ca..e81087bb17c4 100644 --- a/Eventarc/samples/V1/EventarcClient/delete_channel.php +++ b/Eventarc/samples/V1/EventarcClient/delete_channel.php @@ -35,18 +35,15 @@ * * @param string $formattedName The name of the channel to be deleted. Please see * {@see EventarcClient::channelName()} for help formatting this field. - * @param bool $validateOnly If set, validate the request and preview the review, but do not - * post it. */ -function delete_channel_sample(string $formattedName, bool $validateOnly): void +function delete_channel_sample(string $formattedName): void { // Create a client. $eventarcClient = new EventarcClient(); // Prepare the request message. $request = (new DeleteChannelRequest()) - ->setName($formattedName) - ->setValidateOnly($validateOnly); + ->setName($formattedName); // Call the API and handle any network failures. try { @@ -80,8 +77,7 @@ function delete_channel_sample(string $formattedName, bool $validateOnly): void function callSample(): void { $formattedName = EventarcClient::channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); - $validateOnly = false; - delete_channel_sample($formattedName, $validateOnly); + delete_channel_sample($formattedName); } // [END eventarc_v1_generated_Eventarc_DeleteChannel_sync] diff --git a/Eventarc/samples/V1/EventarcClient/delete_enrollment.php b/Eventarc/samples/V1/EventarcClient/delete_enrollment.php new file mode 100644 index 000000000000..411125b20bcd --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/delete_enrollment.php @@ -0,0 +1,83 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->deleteEnrollment($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Enrollment $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 +{ + $formattedName = EventarcClient::enrollmentName('[PROJECT]', '[LOCATION]', '[ENROLLMENT]'); + + delete_enrollment_sample($formattedName); +} +// [END eventarc_v1_generated_Eventarc_DeleteEnrollment_sync] diff --git a/Eventarc/samples/V1/EventarcClient/delete_google_api_source.php b/Eventarc/samples/V1/EventarcClient/delete_google_api_source.php new file mode 100644 index 000000000000..11b4caf3fd3e --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/delete_google_api_source.php @@ -0,0 +1,87 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->deleteGoogleApiSource($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var GoogleApiSource $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 +{ + $formattedName = EventarcClient::googleApiSourceName( + '[PROJECT]', + '[LOCATION]', + '[GOOGLE_API_SOURCE]' + ); + + delete_google_api_source_sample($formattedName); +} +// [END eventarc_v1_generated_Eventarc_DeleteGoogleApiSource_sync] diff --git a/Eventarc/samples/V1/EventarcClient/delete_message_bus.php b/Eventarc/samples/V1/EventarcClient/delete_message_bus.php new file mode 100644 index 000000000000..cc88f5738e9b --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/delete_message_bus.php @@ -0,0 +1,83 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->deleteMessageBus($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var MessageBus $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 +{ + $formattedName = EventarcClient::messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + + delete_message_bus_sample($formattedName); +} +// [END eventarc_v1_generated_Eventarc_DeleteMessageBus_sync] diff --git a/Eventarc/samples/V1/EventarcClient/delete_pipeline.php b/Eventarc/samples/V1/EventarcClient/delete_pipeline.php new file mode 100644 index 000000000000..e5bcc5436686 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/delete_pipeline.php @@ -0,0 +1,83 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->deletePipeline($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Pipeline $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 +{ + $formattedName = EventarcClient::pipelineName('[PROJECT]', '[LOCATION]', '[PIPELINE]'); + + delete_pipeline_sample($formattedName); +} +// [END eventarc_v1_generated_Eventarc_DeletePipeline_sync] diff --git a/Eventarc/samples/V1/EventarcClient/delete_trigger.php b/Eventarc/samples/V1/EventarcClient/delete_trigger.php index 145664754c4a..b478719abe9a 100644 --- a/Eventarc/samples/V1/EventarcClient/delete_trigger.php +++ b/Eventarc/samples/V1/EventarcClient/delete_trigger.php @@ -35,18 +35,15 @@ * * @param string $formattedName The name of the trigger to be deleted. Please see * {@see EventarcClient::triggerName()} for help formatting this field. - * @param bool $validateOnly If set, validate the request and preview the review, but do not - * post it. */ -function delete_trigger_sample(string $formattedName, bool $validateOnly): void +function delete_trigger_sample(string $formattedName): void { // Create a client. $eventarcClient = new EventarcClient(); // Prepare the request message. $request = (new DeleteTriggerRequest()) - ->setName($formattedName) - ->setValidateOnly($validateOnly); + ->setName($formattedName); // Call the API and handle any network failures. try { @@ -80,8 +77,7 @@ function delete_trigger_sample(string $formattedName, bool $validateOnly): void function callSample(): void { $formattedName = EventarcClient::triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); - $validateOnly = false; - delete_trigger_sample($formattedName, $validateOnly); + delete_trigger_sample($formattedName); } // [END eventarc_v1_generated_Eventarc_DeleteTrigger_sync] diff --git a/Eventarc/samples/V1/EventarcClient/get_enrollment.php b/Eventarc/samples/V1/EventarcClient/get_enrollment.php new file mode 100644 index 000000000000..e05d928e417a --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/get_enrollment.php @@ -0,0 +1,71 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Enrollment $response */ + $response = $eventarcClient->getEnrollment($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = EventarcClient::enrollmentName('[PROJECT]', '[LOCATION]', '[ENROLLMENT]'); + + get_enrollment_sample($formattedName); +} +// [END eventarc_v1_generated_Eventarc_GetEnrollment_sync] diff --git a/Eventarc/samples/V1/EventarcClient/get_google_api_source.php b/Eventarc/samples/V1/EventarcClient/get_google_api_source.php new file mode 100644 index 000000000000..c45c874e198d --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/get_google_api_source.php @@ -0,0 +1,75 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var GoogleApiSource $response */ + $response = $eventarcClient->getGoogleApiSource($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = EventarcClient::googleApiSourceName( + '[PROJECT]', + '[LOCATION]', + '[GOOGLE_API_SOURCE]' + ); + + get_google_api_source_sample($formattedName); +} +// [END eventarc_v1_generated_Eventarc_GetGoogleApiSource_sync] diff --git a/Eventarc/samples/V1/EventarcClient/get_message_bus.php b/Eventarc/samples/V1/EventarcClient/get_message_bus.php new file mode 100644 index 000000000000..5e6d2cbab565 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/get_message_bus.php @@ -0,0 +1,71 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var MessageBus $response */ + $response = $eventarcClient->getMessageBus($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = EventarcClient::messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + + get_message_bus_sample($formattedName); +} +// [END eventarc_v1_generated_Eventarc_GetMessageBus_sync] diff --git a/Eventarc/samples/V1/EventarcClient/get_pipeline.php b/Eventarc/samples/V1/EventarcClient/get_pipeline.php new file mode 100644 index 000000000000..b720c97a70cb --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/get_pipeline.php @@ -0,0 +1,71 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var Pipeline $response */ + $response = $eventarcClient->getPipeline($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = EventarcClient::pipelineName('[PROJECT]', '[LOCATION]', '[PIPELINE]'); + + get_pipeline_sample($formattedName); +} +// [END eventarc_v1_generated_Eventarc_GetPipeline_sync] diff --git a/Eventarc/samples/V1/EventarcClient/list_enrollments.php b/Eventarc/samples/V1/EventarcClient/list_enrollments.php new file mode 100644 index 000000000000..a45acb7d1683 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/list_enrollments.php @@ -0,0 +1,76 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $eventarcClient->listEnrollments($request); + + /** @var Enrollment $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); + + list_enrollments_sample($formattedParent); +} +// [END eventarc_v1_generated_Eventarc_ListEnrollments_sync] diff --git a/Eventarc/samples/V1/EventarcClient/list_google_api_sources.php b/Eventarc/samples/V1/EventarcClient/list_google_api_sources.php new file mode 100644 index 000000000000..c54259e74936 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/list_google_api_sources.php @@ -0,0 +1,76 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $eventarcClient->listGoogleApiSources($request); + + /** @var GoogleApiSource $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); + + list_google_api_sources_sample($formattedParent); +} +// [END eventarc_v1_generated_Eventarc_ListGoogleApiSources_sync] diff --git a/Eventarc/samples/V1/EventarcClient/list_message_bus_enrollments.php b/Eventarc/samples/V1/EventarcClient/list_message_bus_enrollments.php new file mode 100644 index 000000000000..6ca12dfcb569 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/list_message_bus_enrollments.php @@ -0,0 +1,75 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $eventarcClient->listMessageBusEnrollments($request); + + /** @var string $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element); + } + } 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 +{ + $formattedParent = EventarcClient::messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + + list_message_bus_enrollments_sample($formattedParent); +} +// [END eventarc_v1_generated_Eventarc_ListMessageBusEnrollments_sync] diff --git a/Eventarc/samples/V1/EventarcClient/list_message_buses.php b/Eventarc/samples/V1/EventarcClient/list_message_buses.php new file mode 100644 index 000000000000..0d80ec0418b6 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/list_message_buses.php @@ -0,0 +1,76 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $eventarcClient->listMessageBuses($request); + + /** @var MessageBus $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); + + list_message_buses_sample($formattedParent); +} +// [END eventarc_v1_generated_Eventarc_ListMessageBuses_sync] diff --git a/Eventarc/samples/V1/EventarcClient/list_pipelines.php b/Eventarc/samples/V1/EventarcClient/list_pipelines.php new file mode 100644 index 000000000000..0555619a030b --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/list_pipelines.php @@ -0,0 +1,76 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $eventarcClient->listPipelines($request); + + /** @var Pipeline $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = EventarcClient::locationName('[PROJECT]', '[LOCATION]'); + + list_pipelines_sample($formattedParent); +} +// [END eventarc_v1_generated_Eventarc_ListPipelines_sync] diff --git a/Eventarc/samples/V1/EventarcClient/update_channel.php b/Eventarc/samples/V1/EventarcClient/update_channel.php index 5b7155e0b218..6e2f23ad1338 100644 --- a/Eventarc/samples/V1/EventarcClient/update_channel.php +++ b/Eventarc/samples/V1/EventarcClient/update_channel.php @@ -33,17 +33,19 @@ /** * Update a single channel. * - * @param bool $validateOnly If set, validate the request and preview the review, but do not - * post it. + * 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 update_channel_sample(bool $validateOnly): void +function update_channel_sample(): void { // Create a client. $eventarcClient = new EventarcClient(); // Prepare the request message. - $request = (new UpdateChannelRequest()) - ->setValidateOnly($validateOnly); + $request = new UpdateChannelRequest(); // Call the API and handle any network failures. try { @@ -64,20 +66,4 @@ function update_channel_sample(bool $validateOnly): void 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 -{ - $validateOnly = false; - - update_channel_sample($validateOnly); -} // [END eventarc_v1_generated_Eventarc_UpdateChannel_sync] diff --git a/Eventarc/samples/V1/EventarcClient/update_enrollment.php b/Eventarc/samples/V1/EventarcClient/update_enrollment.php new file mode 100644 index 000000000000..e545745a7362 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/update_enrollment.php @@ -0,0 +1,107 @@ +setCelMatch($enrollmentCelMatch) + ->setMessageBus($formattedEnrollmentMessageBus) + ->setDestination($enrollmentDestination); + $request = (new UpdateEnrollmentRequest()) + ->setEnrollment($enrollment); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->updateEnrollment($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Enrollment $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 +{ + $enrollmentCelMatch = '[CEL_MATCH]'; + $formattedEnrollmentMessageBus = EventarcClient::messageBusName( + '[PROJECT]', + '[LOCATION]', + '[MESSAGE_BUS]' + ); + $enrollmentDestination = '[DESTINATION]'; + + update_enrollment_sample( + $enrollmentCelMatch, + $formattedEnrollmentMessageBus, + $enrollmentDestination + ); +} +// [END eventarc_v1_generated_Eventarc_UpdateEnrollment_sync] diff --git a/Eventarc/samples/V1/EventarcClient/update_google_api_source.php b/Eventarc/samples/V1/EventarcClient/update_google_api_source.php new file mode 100644 index 000000000000..02a93fc736ea --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/update_google_api_source.php @@ -0,0 +1,92 @@ +setDestination($formattedGoogleApiSourceDestination); + $request = (new UpdateGoogleApiSourceRequest()) + ->setGoogleApiSource($googleApiSource); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->updateGoogleApiSource($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var GoogleApiSource $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 +{ + $formattedGoogleApiSourceDestination = EventarcClient::messageBusName( + '[PROJECT]', + '[LOCATION]', + '[MESSAGE_BUS]' + ); + + update_google_api_source_sample($formattedGoogleApiSourceDestination); +} +// [END eventarc_v1_generated_Eventarc_UpdateGoogleApiSource_sync] diff --git a/Eventarc/samples/V1/EventarcClient/update_message_bus.php b/Eventarc/samples/V1/EventarcClient/update_message_bus.php new file mode 100644 index 000000000000..2797696cf25a --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/update_message_bus.php @@ -0,0 +1,71 @@ +setMessageBus($messageBus); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->updateMessageBus($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var MessageBus $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()); + } +} +// [END eventarc_v1_generated_Eventarc_UpdateMessageBus_sync] diff --git a/Eventarc/samples/V1/EventarcClient/update_pipeline.php b/Eventarc/samples/V1/EventarcClient/update_pipeline.php new file mode 100644 index 000000000000..379b26852258 --- /dev/null +++ b/Eventarc/samples/V1/EventarcClient/update_pipeline.php @@ -0,0 +1,74 @@ +setDestinations($pipelineDestinations); + $request = (new UpdatePipelineRequest()) + ->setPipeline($pipeline); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $eventarcClient->updatePipeline($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var Pipeline $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()); + } +} +// [END eventarc_v1_generated_Eventarc_UpdatePipeline_sync] diff --git a/Eventarc/samples/V1/EventarcClient/update_trigger.php b/Eventarc/samples/V1/EventarcClient/update_trigger.php index f2904620802b..5d28febc7f94 100644 --- a/Eventarc/samples/V1/EventarcClient/update_trigger.php +++ b/Eventarc/samples/V1/EventarcClient/update_trigger.php @@ -33,17 +33,19 @@ /** * Update a single trigger. * - * @param bool $validateOnly If set, validate the request and preview the review, but do not - * post it. + * 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 update_trigger_sample(bool $validateOnly): void +function update_trigger_sample(): void { // Create a client. $eventarcClient = new EventarcClient(); // Prepare the request message. - $request = (new UpdateTriggerRequest()) - ->setValidateOnly($validateOnly); + $request = new UpdateTriggerRequest(); // Call the API and handle any network failures. try { @@ -64,20 +66,4 @@ function update_trigger_sample(bool $validateOnly): void 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 -{ - $validateOnly = false; - - update_trigger_sample($validateOnly); -} // [END eventarc_v1_generated_Eventarc_UpdateTrigger_sync] diff --git a/Eventarc/src/V1/Channel.php b/Eventarc/src/V1/Channel.php index 79707cee439b..6a51e006a6f7 100644 --- a/Eventarc/src/V1/Channel.php +++ b/Eventarc/src/V1/Channel.php @@ -69,14 +69,21 @@ class Channel extends \Google\Protobuf\Internal\Message */ protected $activation_token = ''; /** - * Optional. Resource name of a KMS crypto key (managed by the user) used to + * Resource name of a KMS crypto key (managed by the user) used to * encrypt/decrypt their event data. * It must match the pattern * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. * - * Generated from protobuf field string crypto_key_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * Generated from protobuf field string crypto_key_name = 11 [(.google.api.resource_reference) = { */ protected $crypto_key_name = ''; + /** + * Output only. Whether or not this Channel satisfies the requirements of + * physical zone separation + * + * Generated from protobuf field bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $satisfies_pzs = false; protected $transport; /** @@ -112,10 +119,13 @@ class Channel extends \Google\Protobuf\Internal\Message * Output only. The activation token for the channel. The token must be used * by the provider to register the channel for publishing. * @type string $crypto_key_name - * Optional. Resource name of a KMS crypto key (managed by the user) used to + * Resource name of a KMS crypto key (managed by the user) used to * encrypt/decrypt their event data. * It must match the pattern * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * @type bool $satisfies_pzs + * Output only. Whether or not this Channel satisfies the requirements of + * physical zone separation * } */ public function __construct($data = NULL) { @@ -377,12 +387,12 @@ public function setActivationToken($var) } /** - * Optional. Resource name of a KMS crypto key (managed by the user) used to + * Resource name of a KMS crypto key (managed by the user) used to * encrypt/decrypt their event data. * It must match the pattern * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. * - * Generated from protobuf field string crypto_key_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * Generated from protobuf field string crypto_key_name = 11 [(.google.api.resource_reference) = { * @return string */ public function getCryptoKeyName() @@ -391,12 +401,12 @@ public function getCryptoKeyName() } /** - * Optional. Resource name of a KMS crypto key (managed by the user) used to + * Resource name of a KMS crypto key (managed by the user) used to * encrypt/decrypt their event data. * It must match the pattern * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. * - * Generated from protobuf field string crypto_key_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * Generated from protobuf field string crypto_key_name = 11 [(.google.api.resource_reference) = { * @param string $var * @return $this */ @@ -408,6 +418,34 @@ public function setCryptoKeyName($var) return $this; } + /** + * Output only. Whether or not this Channel satisfies the requirements of + * physical zone separation + * + * Generated from protobuf field bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzs() + { + return $this->satisfies_pzs; + } + + /** + * Output only. Whether or not this Channel satisfies the requirements of + * physical zone separation + * + * Generated from protobuf field bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + /** * @return string */ diff --git a/Eventarc/src/V1/Client/EventarcClient.php b/Eventarc/src/V1/Client/EventarcClient.php index 75f4c4a1bc56..75b327f6e27c 100644 --- a/Eventarc/src/V1/Client/EventarcClient.php +++ b/Eventarc/src/V1/Client/EventarcClient.php @@ -38,24 +38,49 @@ use Google\Cloud\Eventarc\V1\ChannelConnection; use Google\Cloud\Eventarc\V1\CreateChannelConnectionRequest; use Google\Cloud\Eventarc\V1\CreateChannelRequest; +use Google\Cloud\Eventarc\V1\CreateEnrollmentRequest; +use Google\Cloud\Eventarc\V1\CreateGoogleApiSourceRequest; +use Google\Cloud\Eventarc\V1\CreateMessageBusRequest; +use Google\Cloud\Eventarc\V1\CreatePipelineRequest; use Google\Cloud\Eventarc\V1\CreateTriggerRequest; use Google\Cloud\Eventarc\V1\DeleteChannelConnectionRequest; use Google\Cloud\Eventarc\V1\DeleteChannelRequest; +use Google\Cloud\Eventarc\V1\DeleteEnrollmentRequest; +use Google\Cloud\Eventarc\V1\DeleteGoogleApiSourceRequest; +use Google\Cloud\Eventarc\V1\DeleteMessageBusRequest; +use Google\Cloud\Eventarc\V1\DeletePipelineRequest; use Google\Cloud\Eventarc\V1\DeleteTriggerRequest; +use Google\Cloud\Eventarc\V1\Enrollment; use Google\Cloud\Eventarc\V1\GetChannelConnectionRequest; use Google\Cloud\Eventarc\V1\GetChannelRequest; +use Google\Cloud\Eventarc\V1\GetEnrollmentRequest; +use Google\Cloud\Eventarc\V1\GetGoogleApiSourceRequest; use Google\Cloud\Eventarc\V1\GetGoogleChannelConfigRequest; +use Google\Cloud\Eventarc\V1\GetMessageBusRequest; +use Google\Cloud\Eventarc\V1\GetPipelineRequest; use Google\Cloud\Eventarc\V1\GetProviderRequest; use Google\Cloud\Eventarc\V1\GetTriggerRequest; +use Google\Cloud\Eventarc\V1\GoogleApiSource; use Google\Cloud\Eventarc\V1\GoogleChannelConfig; use Google\Cloud\Eventarc\V1\ListChannelConnectionsRequest; use Google\Cloud\Eventarc\V1\ListChannelsRequest; +use Google\Cloud\Eventarc\V1\ListEnrollmentsRequest; +use Google\Cloud\Eventarc\V1\ListGoogleApiSourcesRequest; +use Google\Cloud\Eventarc\V1\ListMessageBusEnrollmentsRequest; +use Google\Cloud\Eventarc\V1\ListMessageBusesRequest; +use Google\Cloud\Eventarc\V1\ListPipelinesRequest; use Google\Cloud\Eventarc\V1\ListProvidersRequest; use Google\Cloud\Eventarc\V1\ListTriggersRequest; +use Google\Cloud\Eventarc\V1\MessageBus; +use Google\Cloud\Eventarc\V1\Pipeline; use Google\Cloud\Eventarc\V1\Provider; use Google\Cloud\Eventarc\V1\Trigger; use Google\Cloud\Eventarc\V1\UpdateChannelRequest; +use Google\Cloud\Eventarc\V1\UpdateEnrollmentRequest; +use Google\Cloud\Eventarc\V1\UpdateGoogleApiSourceRequest; use Google\Cloud\Eventarc\V1\UpdateGoogleChannelConfigRequest; +use Google\Cloud\Eventarc\V1\UpdateMessageBusRequest; +use Google\Cloud\Eventarc\V1\UpdatePipelineRequest; use Google\Cloud\Eventarc\V1\UpdateTriggerRequest; use Google\Cloud\Iam\V1\GetIamPolicyRequest; use Google\Cloud\Iam\V1\Policy; @@ -83,21 +108,42 @@ * * @method PromiseInterface createChannelAsync(CreateChannelRequest $request, array $optionalArgs = []) * @method PromiseInterface createChannelConnectionAsync(CreateChannelConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEnrollmentAsync(CreateEnrollmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGoogleApiSourceAsync(CreateGoogleApiSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMessageBusAsync(CreateMessageBusRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPipelineAsync(CreatePipelineRequest $request, array $optionalArgs = []) * @method PromiseInterface createTriggerAsync(CreateTriggerRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteChannelAsync(DeleteChannelRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteChannelConnectionAsync(DeleteChannelConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEnrollmentAsync(DeleteEnrollmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGoogleApiSourceAsync(DeleteGoogleApiSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMessageBusAsync(DeleteMessageBusRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePipelineAsync(DeletePipelineRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteTriggerAsync(DeleteTriggerRequest $request, array $optionalArgs = []) * @method PromiseInterface getChannelAsync(GetChannelRequest $request, array $optionalArgs = []) * @method PromiseInterface getChannelConnectionAsync(GetChannelConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnrollmentAsync(GetEnrollmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGoogleApiSourceAsync(GetGoogleApiSourceRequest $request, array $optionalArgs = []) * @method PromiseInterface getGoogleChannelConfigAsync(GetGoogleChannelConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMessageBusAsync(GetMessageBusRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPipelineAsync(GetPipelineRequest $request, array $optionalArgs = []) * @method PromiseInterface getProviderAsync(GetProviderRequest $request, array $optionalArgs = []) * @method PromiseInterface getTriggerAsync(GetTriggerRequest $request, array $optionalArgs = []) * @method PromiseInterface listChannelConnectionsAsync(ListChannelConnectionsRequest $request, array $optionalArgs = []) * @method PromiseInterface listChannelsAsync(ListChannelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEnrollmentsAsync(ListEnrollmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGoogleApiSourcesAsync(ListGoogleApiSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMessageBusEnrollmentsAsync(ListMessageBusEnrollmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMessageBusesAsync(ListMessageBusesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPipelinesAsync(ListPipelinesRequest $request, array $optionalArgs = []) * @method PromiseInterface listProvidersAsync(ListProvidersRequest $request, array $optionalArgs = []) * @method PromiseInterface listTriggersAsync(ListTriggersRequest $request, array $optionalArgs = []) * @method PromiseInterface updateChannelAsync(UpdateChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEnrollmentAsync(UpdateEnrollmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGoogleApiSourceAsync(UpdateGoogleApiSourceRequest $request, array $optionalArgs = []) * @method PromiseInterface updateGoogleChannelConfigAsync(UpdateGoogleChannelConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMessageBusAsync(UpdateMessageBusRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePipelineAsync(UpdatePipelineRequest $request, array $optionalArgs = []) * @method PromiseInterface updateTriggerAsync(UpdateTriggerRequest $request, array $optionalArgs = []) * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) @@ -281,6 +327,44 @@ public static function cryptoKeyName(string $project, string $location, string $ ]); } + /** + * Formats a string containing the fully-qualified path to represent a enrollment + * resource. + * + * @param string $project + * @param string $location + * @param string $enrollment + * + * @return string The formatted enrollment resource. + */ + public static function enrollmentName(string $project, string $location, string $enrollment): string + { + return self::getPathTemplate('enrollment')->render([ + 'project' => $project, + 'location' => $location, + 'enrollment' => $enrollment, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * google_api_source resource. + * + * @param string $project + * @param string $location + * @param string $googleApiSource + * + * @return string The formatted google_api_source resource. + */ + public static function googleApiSourceName(string $project, string $location, string $googleApiSource): string + { + return self::getPathTemplate('googleApiSource')->render([ + 'project' => $project, + 'location' => $location, + 'google_api_source' => $googleApiSource, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a * google_channel_config resource. @@ -315,6 +399,63 @@ public static function locationName(string $project, string $location): string ]); } + /** + * Formats a string containing the fully-qualified path to represent a message_bus + * resource. + * + * @param string $project + * @param string $location + * @param string $messageBus + * + * @return string The formatted message_bus resource. + */ + public static function messageBusName(string $project, string $location, string $messageBus): string + { + return self::getPathTemplate('messageBus')->render([ + 'project' => $project, + 'location' => $location, + 'message_bus' => $messageBus, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a + * network_attachment resource. + * + * @param string $project + * @param string $region + * @param string $networkattachment + * + * @return string The formatted network_attachment resource. + */ + public static function networkAttachmentName(string $project, string $region, string $networkattachment): string + { + return self::getPathTemplate('networkAttachment')->render([ + 'project' => $project, + 'region' => $region, + 'networkattachment' => $networkattachment, + ]); + } + + /** + * Formats a string containing the fully-qualified path to represent a pipeline + * resource. + * + * @param string $project + * @param string $location + * @param string $pipeline + * + * @return string The formatted pipeline resource. + */ + public static function pipelineName(string $project, string $location, string $pipeline): string + { + return self::getPathTemplate('pipeline')->render([ + 'project' => $project, + 'location' => $location, + 'pipeline' => $pipeline, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a provider * resource. @@ -351,6 +492,23 @@ public static function serviceAccountName(string $project, string $serviceAccoun ]); } + /** + * Formats a string containing the fully-qualified path to represent a topic + * resource. + * + * @param string $project + * @param string $topic + * + * @return string The formatted topic resource. + */ + public static function topicName(string $project, string $topic): string + { + return self::getPathTemplate('topic')->render([ + 'project' => $project, + 'topic' => $topic, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a trigger * resource. @@ -397,10 +555,16 @@ public static function workflowName(string $project, string $location, string $w * - channelConnection: projects/{project}/locations/{location}/channelConnections/{channel_connection} * - cloudFunction: projects/{project}/locations/{location}/functions/{function} * - cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} + * - enrollment: projects/{project}/locations/{location}/enrollments/{enrollment} + * - googleApiSource: projects/{project}/locations/{location}/googleApiSources/{google_api_source} * - googleChannelConfig: projects/{project}/locations/{location}/googleChannelConfig * - location: projects/{project}/locations/{location} + * - messageBus: projects/{project}/locations/{location}/messageBuses/{message_bus} + * - networkAttachment: projects/{project}/regions/{region}/networkAttachments/{networkattachment} + * - pipeline: projects/{project}/locations/{location}/pipelines/{pipeline} * - provider: projects/{project}/locations/{location}/providers/{provider} * - serviceAccount: projects/{project}/serviceAccounts/{service_account} + * - topic: projects/{project}/topics/{topic} * - trigger: projects/{project}/locations/{location}/triggers/{trigger} * - workflow: projects/{project}/locations/{location}/workflows/{workflow} * @@ -548,6 +712,112 @@ public function createChannelConnection( return $this->startApiCall('CreateChannelConnection', $request, $callOptions)->wait(); } + /** + * Create a new Enrollment in a particular project and location. + * + * The async variant is {@see EventarcClient::createEnrollmentAsync()} . + * + * @example samples/V1/EventarcClient/create_enrollment.php + * + * @param CreateEnrollmentRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createEnrollment(CreateEnrollmentRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreateEnrollment', $request, $callOptions)->wait(); + } + + /** + * Create a new GoogleApiSource in a particular project and location. + * + * The async variant is {@see EventarcClient::createGoogleApiSourceAsync()} . + * + * @example samples/V1/EventarcClient/create_google_api_source.php + * + * @param CreateGoogleApiSourceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createGoogleApiSource( + CreateGoogleApiSourceRequest $request, + array $callOptions = [] + ): OperationResponse { + return $this->startApiCall('CreateGoogleApiSource', $request, $callOptions)->wait(); + } + + /** + * Create a new MessageBus in a particular project and location. + * + * The async variant is {@see EventarcClient::createMessageBusAsync()} . + * + * @example samples/V1/EventarcClient/create_message_bus.php + * + * @param CreateMessageBusRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createMessageBus(CreateMessageBusRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreateMessageBus', $request, $callOptions)->wait(); + } + + /** + * Create a new Pipeline in a particular project and location. + * + * The async variant is {@see EventarcClient::createPipelineAsync()} . + * + * @example samples/V1/EventarcClient/create_pipeline.php + * + * @param CreatePipelineRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createPipeline(CreatePipelineRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreatePipeline', $request, $callOptions)->wait(); + } + /** * Create a new trigger in a particular project and location. * @@ -628,6 +898,112 @@ public function deleteChannelConnection( return $this->startApiCall('DeleteChannelConnection', $request, $callOptions)->wait(); } + /** + * Delete a single Enrollment. + * + * The async variant is {@see EventarcClient::deleteEnrollmentAsync()} . + * + * @example samples/V1/EventarcClient/delete_enrollment.php + * + * @param DeleteEnrollmentRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteEnrollment(DeleteEnrollmentRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteEnrollment', $request, $callOptions)->wait(); + } + + /** + * Delete a single GoogleApiSource. + * + * The async variant is {@see EventarcClient::deleteGoogleApiSourceAsync()} . + * + * @example samples/V1/EventarcClient/delete_google_api_source.php + * + * @param DeleteGoogleApiSourceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteGoogleApiSource( + DeleteGoogleApiSourceRequest $request, + array $callOptions = [] + ): OperationResponse { + return $this->startApiCall('DeleteGoogleApiSource', $request, $callOptions)->wait(); + } + + /** + * Delete a single message bus. + * + * The async variant is {@see EventarcClient::deleteMessageBusAsync()} . + * + * @example samples/V1/EventarcClient/delete_message_bus.php + * + * @param DeleteMessageBusRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteMessageBus(DeleteMessageBusRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeleteMessageBus', $request, $callOptions)->wait(); + } + + /** + * Delete a single pipeline. + * + * The async variant is {@see EventarcClient::deletePipelineAsync()} . + * + * @example samples/V1/EventarcClient/delete_pipeline.php + * + * @param DeletePipelineRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deletePipeline(DeletePipelineRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('DeletePipeline', $request, $callOptions)->wait(); + } + /** * Delete a single trigger. * @@ -708,6 +1084,58 @@ public function getChannelConnection( return $this->startApiCall('GetChannelConnection', $request, $callOptions)->wait(); } + /** + * Get a single Enrollment. + * + * The async variant is {@see EventarcClient::getEnrollmentAsync()} . + * + * @example samples/V1/EventarcClient/get_enrollment.php + * + * @param GetEnrollmentRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Enrollment + * + * @throws ApiException Thrown if the API call fails. + */ + public function getEnrollment(GetEnrollmentRequest $request, array $callOptions = []): Enrollment + { + return $this->startApiCall('GetEnrollment', $request, $callOptions)->wait(); + } + + /** + * Get a single GoogleApiSource. + * + * The async variant is {@see EventarcClient::getGoogleApiSourceAsync()} . + * + * @example samples/V1/EventarcClient/get_google_api_source.php + * + * @param GetGoogleApiSourceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return GoogleApiSource + * + * @throws ApiException Thrown if the API call fails. + */ + public function getGoogleApiSource(GetGoogleApiSourceRequest $request, array $callOptions = []): GoogleApiSource + { + return $this->startApiCall('GetGoogleApiSource', $request, $callOptions)->wait(); + } + /** * Get a GoogleChannelConfig * @@ -736,6 +1164,58 @@ public function getGoogleChannelConfig( return $this->startApiCall('GetGoogleChannelConfig', $request, $callOptions)->wait(); } + /** + * Get a single MessageBus. + * + * The async variant is {@see EventarcClient::getMessageBusAsync()} . + * + * @example samples/V1/EventarcClient/get_message_bus.php + * + * @param GetMessageBusRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return MessageBus + * + * @throws ApiException Thrown if the API call fails. + */ + public function getMessageBus(GetMessageBusRequest $request, array $callOptions = []): MessageBus + { + return $this->startApiCall('GetMessageBus', $request, $callOptions)->wait(); + } + + /** + * Get a single Pipeline. + * + * The async variant is {@see EventarcClient::getPipelineAsync()} . + * + * @example samples/V1/EventarcClient/get_pipeline.php + * + * @param GetPipelineRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return Pipeline + * + * @throws ApiException Thrown if the API call fails. + */ + public function getPipeline(GetPipelineRequest $request, array $callOptions = []): Pipeline + { + return $this->startApiCall('GetPipeline', $request, $callOptions)->wait(); + } + /** * Get a single Provider. * @@ -842,6 +1322,140 @@ public function listChannels(ListChannelsRequest $request, array $callOptions = return $this->startApiCall('ListChannels', $request, $callOptions); } + /** + * List Enrollments. + * + * The async variant is {@see EventarcClient::listEnrollmentsAsync()} . + * + * @example samples/V1/EventarcClient/list_enrollments.php + * + * @param ListEnrollmentsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listEnrollments(ListEnrollmentsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListEnrollments', $request, $callOptions); + } + + /** + * List GoogleApiSources. + * + * The async variant is {@see EventarcClient::listGoogleApiSourcesAsync()} . + * + * @example samples/V1/EventarcClient/list_google_api_sources.php + * + * @param ListGoogleApiSourcesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listGoogleApiSources( + ListGoogleApiSourcesRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('ListGoogleApiSources', $request, $callOptions); + } + + /** + * List message bus enrollments. + * + * The async variant is {@see EventarcClient::listMessageBusEnrollmentsAsync()} . + * + * @example samples/V1/EventarcClient/list_message_bus_enrollments.php + * + * @param ListMessageBusEnrollmentsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listMessageBusEnrollments( + ListMessageBusEnrollmentsRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('ListMessageBusEnrollments', $request, $callOptions); + } + + /** + * List message buses. + * + * The async variant is {@see EventarcClient::listMessageBusesAsync()} . + * + * @example samples/V1/EventarcClient/list_message_buses.php + * + * @param ListMessageBusesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listMessageBuses(ListMessageBusesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListMessageBuses', $request, $callOptions); + } + + /** + * List pipelines. + * + * The async variant is {@see EventarcClient::listPipelinesAsync()} . + * + * @example samples/V1/EventarcClient/list_pipelines.php + * + * @param ListPipelinesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listPipelines(ListPipelinesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListPipelines', $request, $callOptions); + } + /** * List providers. * @@ -920,6 +1534,60 @@ public function updateChannel(UpdateChannelRequest $request, array $callOptions return $this->startApiCall('UpdateChannel', $request, $callOptions)->wait(); } + /** + * Update a single Enrollment. + * + * The async variant is {@see EventarcClient::updateEnrollmentAsync()} . + * + * @example samples/V1/EventarcClient/update_enrollment.php + * + * @param UpdateEnrollmentRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateEnrollment(UpdateEnrollmentRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('UpdateEnrollment', $request, $callOptions)->wait(); + } + + /** + * Update a single GoogleApiSource. + * + * The async variant is {@see EventarcClient::updateGoogleApiSourceAsync()} . + * + * @example samples/V1/EventarcClient/update_google_api_source.php + * + * @param UpdateGoogleApiSourceRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateGoogleApiSource( + UpdateGoogleApiSourceRequest $request, + array $callOptions = [] + ): OperationResponse { + return $this->startApiCall('UpdateGoogleApiSource', $request, $callOptions)->wait(); + } + /** * Update a single GoogleChannelConfig * @@ -948,6 +1616,58 @@ public function updateGoogleChannelConfig( return $this->startApiCall('UpdateGoogleChannelConfig', $request, $callOptions)->wait(); } + /** + * Update a single message bus. + * + * The async variant is {@see EventarcClient::updateMessageBusAsync()} . + * + * @example samples/V1/EventarcClient/update_message_bus.php + * + * @param UpdateMessageBusRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updateMessageBus(UpdateMessageBusRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('UpdateMessageBus', $request, $callOptions)->wait(); + } + + /** + * Update a single pipeline. + * + * The async variant is {@see EventarcClient::updatePipelineAsync()} . + * + * @example samples/V1/EventarcClient/update_pipeline.php + * + * @param UpdatePipelineRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function updatePipeline(UpdatePipelineRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('UpdatePipeline', $request, $callOptions)->wait(); + } + /** * Update a single trigger. * diff --git a/Eventarc/src/V1/CloudRun.php b/Eventarc/src/V1/CloudRun.php index 9594f339c5fc..1b030dca2294 100644 --- a/Eventarc/src/V1/CloudRun.php +++ b/Eventarc/src/V1/CloudRun.php @@ -25,7 +25,8 @@ class CloudRun extends \Google\Protobuf\Internal\Message */ protected $service = ''; /** - * Optional. The relative path on the Cloud Run service the events should be sent to. + * Optional. The relative path on the Cloud Run service the events should be + * sent to. * The value must conform to the definition of a URI path segment (section 3.3 * of RFC2396). Examples: "/route", "route", "route/subroute". * @@ -51,7 +52,8 @@ class CloudRun extends \Google\Protobuf\Internal\Message * Only services located in the same project as the trigger object * can be addressed. * @type string $path - * Optional. The relative path on the Cloud Run service the events should be sent to. + * Optional. The relative path on the Cloud Run service the events should be + * sent to. * The value must conform to the definition of a URI path segment (section 3.3 * of RFC2396). Examples: "/route", "route", "route/subroute". * @type string $region @@ -96,7 +98,8 @@ public function setService($var) } /** - * Optional. The relative path on the Cloud Run service the events should be sent to. + * Optional. The relative path on the Cloud Run service the events should be + * sent to. * The value must conform to the definition of a URI path segment (section 3.3 * of RFC2396). Examples: "/route", "route", "route/subroute". * @@ -109,7 +112,8 @@ public function getPath() } /** - * Optional. The relative path on the Cloud Run service the events should be sent to. + * Optional. The relative path on the Cloud Run service the events should be + * sent to. * The value must conform to the definition of a URI path segment (section 3.3 * of RFC2396). Examples: "/route", "route", "route/subroute". * diff --git a/Eventarc/src/V1/CreateChannelRequest.php b/Eventarc/src/V1/CreateChannelRequest.php index 6e7d042f16ca..be57772dd014 100644 --- a/Eventarc/src/V1/CreateChannelRequest.php +++ b/Eventarc/src/V1/CreateChannelRequest.php @@ -34,10 +34,10 @@ class CreateChannelRequest extends \Google\Protobuf\Internal\Message */ protected $channel_id = ''; /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; @@ -72,7 +72,7 @@ public static function build(string $parent, \Google\Cloud\Eventarc\V1\Channel $ * @type string $channel_id * Required. The user-provided ID to be assigned to the channel. * @type bool $validate_only - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * } */ @@ -170,10 +170,10 @@ public function setChannelId($var) } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getValidateOnly() @@ -182,10 +182,10 @@ public function getValidateOnly() } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/Eventarc/src/V1/CreateEnrollmentRequest.php b/Eventarc/src/V1/CreateEnrollmentRequest.php new file mode 100644 index 000000000000..541e6796863a --- /dev/null +++ b/Eventarc/src/V1/CreateEnrollmentRequest.php @@ -0,0 +1,206 @@ +google.cloud.eventarc.v1.CreateEnrollmentRequest + */ +class CreateEnrollmentRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent collection in which to add this enrollment. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The enrollment to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Enrollment enrollment = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $enrollment = null; + /** + * Required. The user-provided ID to be assigned to the Enrollment. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * + * Generated from protobuf field string enrollment_id = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $enrollment_id = ''; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $parent Required. The parent collection in which to add this enrollment. Please see + * {@see EventarcClient::locationName()} for help formatting this field. + * @param \Google\Cloud\Eventarc\V1\Enrollment $enrollment Required. The enrollment to create. + * @param string $enrollmentId Required. The user-provided ID to be assigned to the Enrollment. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * + * @return \Google\Cloud\Eventarc\V1\CreateEnrollmentRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\Eventarc\V1\Enrollment $enrollment, string $enrollmentId): self + { + return (new self()) + ->setParent($parent) + ->setEnrollment($enrollment) + ->setEnrollmentId($enrollmentId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent collection in which to add this enrollment. + * @type \Google\Cloud\Eventarc\V1\Enrollment $enrollment + * Required. The enrollment to create. + * @type string $enrollment_id + * Required. The user-provided ID to be assigned to the Enrollment. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent collection in which to add this enrollment. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent collection in which to add this enrollment. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The enrollment to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Enrollment enrollment = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Eventarc\V1\Enrollment|null + */ + public function getEnrollment() + { + return $this->enrollment; + } + + public function hasEnrollment() + { + return isset($this->enrollment); + } + + public function clearEnrollment() + { + unset($this->enrollment); + } + + /** + * Required. The enrollment to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Enrollment enrollment = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Eventarc\V1\Enrollment $var + * @return $this + */ + public function setEnrollment($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Enrollment::class); + $this->enrollment = $var; + + return $this; + } + + /** + * Required. The user-provided ID to be assigned to the Enrollment. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * + * Generated from protobuf field string enrollment_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getEnrollmentId() + { + return $this->enrollment_id; + } + + /** + * Required. The user-provided ID to be assigned to the Enrollment. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * + * Generated from protobuf field string enrollment_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setEnrollmentId($var) + { + GPBUtil::checkString($var, True); + $this->enrollment_id = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/CreateGoogleApiSourceRequest.php b/Eventarc/src/V1/CreateGoogleApiSourceRequest.php new file mode 100644 index 000000000000..5070ae20182c --- /dev/null +++ b/Eventarc/src/V1/CreateGoogleApiSourceRequest.php @@ -0,0 +1,206 @@ +google.cloud.eventarc.v1.CreateGoogleApiSourceRequest + */ +class CreateGoogleApiSourceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent collection in which to add this google api source. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The google api source to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.GoogleApiSource google_api_source = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $google_api_source = null; + /** + * Required. The user-provided ID to be assigned to the GoogleApiSource. It + * should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * + * Generated from protobuf field string google_api_source_id = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $google_api_source_id = ''; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $parent Required. The parent collection in which to add this google api source. Please see + * {@see EventarcClient::locationName()} for help formatting this field. + * @param \Google\Cloud\Eventarc\V1\GoogleApiSource $googleApiSource Required. The google api source to create. + * @param string $googleApiSourceId Required. The user-provided ID to be assigned to the GoogleApiSource. It + * should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * + * @return \Google\Cloud\Eventarc\V1\CreateGoogleApiSourceRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\Eventarc\V1\GoogleApiSource $googleApiSource, string $googleApiSourceId): self + { + return (new self()) + ->setParent($parent) + ->setGoogleApiSource($googleApiSource) + ->setGoogleApiSourceId($googleApiSourceId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent collection in which to add this google api source. + * @type \Google\Cloud\Eventarc\V1\GoogleApiSource $google_api_source + * Required. The google api source to create. + * @type string $google_api_source_id + * Required. The user-provided ID to be assigned to the GoogleApiSource. It + * should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent collection in which to add this google api source. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent collection in which to add this google api source. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The google api source to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.GoogleApiSource google_api_source = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Eventarc\V1\GoogleApiSource|null + */ + public function getGoogleApiSource() + { + return $this->google_api_source; + } + + public function hasGoogleApiSource() + { + return isset($this->google_api_source); + } + + public function clearGoogleApiSource() + { + unset($this->google_api_source); + } + + /** + * Required. The google api source to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.GoogleApiSource google_api_source = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Eventarc\V1\GoogleApiSource $var + * @return $this + */ + public function setGoogleApiSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\GoogleApiSource::class); + $this->google_api_source = $var; + + return $this; + } + + /** + * Required. The user-provided ID to be assigned to the GoogleApiSource. It + * should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * + * Generated from protobuf field string google_api_source_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getGoogleApiSourceId() + { + return $this->google_api_source_id; + } + + /** + * Required. The user-provided ID to be assigned to the GoogleApiSource. It + * should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + * + * Generated from protobuf field string google_api_source_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setGoogleApiSourceId($var) + { + GPBUtil::checkString($var, True); + $this->google_api_source_id = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/CreateMessageBusRequest.php b/Eventarc/src/V1/CreateMessageBusRequest.php new file mode 100644 index 000000000000..76d38e323df2 --- /dev/null +++ b/Eventarc/src/V1/CreateMessageBusRequest.php @@ -0,0 +1,206 @@ +google.cloud.eventarc.v1.CreateMessageBusRequest + */ +class CreateMessageBusRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent collection in which to add this message bus. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The message bus to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.MessageBus message_bus = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $message_bus = null; + /** + * Required. The user-provided ID to be assigned to the MessageBus. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) + * + * Generated from protobuf field string message_bus_id = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $message_bus_id = ''; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $parent Required. The parent collection in which to add this message bus. Please see + * {@see EventarcClient::locationName()} for help formatting this field. + * @param \Google\Cloud\Eventarc\V1\MessageBus $messageBus Required. The message bus to create. + * @param string $messageBusId Required. The user-provided ID to be assigned to the MessageBus. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) + * + * @return \Google\Cloud\Eventarc\V1\CreateMessageBusRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\Eventarc\V1\MessageBus $messageBus, string $messageBusId): self + { + return (new self()) + ->setParent($parent) + ->setMessageBus($messageBus) + ->setMessageBusId($messageBusId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent collection in which to add this message bus. + * @type \Google\Cloud\Eventarc\V1\MessageBus $message_bus + * Required. The message bus to create. + * @type string $message_bus_id + * Required. The user-provided ID to be assigned to the MessageBus. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent collection in which to add this message bus. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent collection in which to add this message bus. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The message bus to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.MessageBus message_bus = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Eventarc\V1\MessageBus|null + */ + public function getMessageBus() + { + return $this->message_bus; + } + + public function hasMessageBus() + { + return isset($this->message_bus); + } + + public function clearMessageBus() + { + unset($this->message_bus); + } + + /** + * Required. The message bus to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.MessageBus message_bus = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Eventarc\V1\MessageBus $var + * @return $this + */ + public function setMessageBus($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\MessageBus::class); + $this->message_bus = $var; + + return $this; + } + + /** + * Required. The user-provided ID to be assigned to the MessageBus. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) + * + * Generated from protobuf field string message_bus_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getMessageBusId() + { + return $this->message_bus_id; + } + + /** + * Required. The user-provided ID to be assigned to the MessageBus. It should + * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) + * + * Generated from protobuf field string message_bus_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setMessageBusId($var) + { + GPBUtil::checkString($var, True); + $this->message_bus_id = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/CreatePipelineRequest.php b/Eventarc/src/V1/CreatePipelineRequest.php new file mode 100644 index 000000000000..c09197f49b40 --- /dev/null +++ b/Eventarc/src/V1/CreatePipelineRequest.php @@ -0,0 +1,201 @@ +google.cloud.eventarc.v1.CreatePipelineRequest + */ +class CreatePipelineRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent collection in which to add this pipeline. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The pipeline to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline pipeline = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $pipeline = null; + /** + * Required. The user-provided ID to be assigned to the Pipeline. + * + * Generated from protobuf field string pipeline_id = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $pipeline_id = ''; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $parent Required. The parent collection in which to add this pipeline. Please see + * {@see EventarcClient::locationName()} for help formatting this field. + * @param \Google\Cloud\Eventarc\V1\Pipeline $pipeline Required. The pipeline to create. + * @param string $pipelineId Required. The user-provided ID to be assigned to the Pipeline. + * + * @return \Google\Cloud\Eventarc\V1\CreatePipelineRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\Eventarc\V1\Pipeline $pipeline, string $pipelineId): self + { + return (new self()) + ->setParent($parent) + ->setPipeline($pipeline) + ->setPipelineId($pipelineId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent collection in which to add this pipeline. + * @type \Google\Cloud\Eventarc\V1\Pipeline $pipeline + * Required. The pipeline to create. + * @type string $pipeline_id + * Required. The user-provided ID to be assigned to the Pipeline. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent collection in which to add this pipeline. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent collection in which to add this pipeline. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The pipeline to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline pipeline = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Eventarc\V1\Pipeline|null + */ + public function getPipeline() + { + return $this->pipeline; + } + + public function hasPipeline() + { + return isset($this->pipeline); + } + + public function clearPipeline() + { + unset($this->pipeline); + } + + /** + * Required. The pipeline to create. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline pipeline = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Eventarc\V1\Pipeline $var + * @return $this + */ + public function setPipeline($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline::class); + $this->pipeline = $var; + + return $this; + } + + /** + * Required. The user-provided ID to be assigned to the Pipeline. + * + * Generated from protobuf field string pipeline_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getPipelineId() + { + return $this->pipeline_id; + } + + /** + * Required. The user-provided ID to be assigned to the Pipeline. + * + * Generated from protobuf field string pipeline_id = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setPipelineId($var) + { + GPBUtil::checkString($var, True); + $this->pipeline_id = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/CreateTriggerRequest.php b/Eventarc/src/V1/CreateTriggerRequest.php index 96788a4152fa..98083421cc3b 100644 --- a/Eventarc/src/V1/CreateTriggerRequest.php +++ b/Eventarc/src/V1/CreateTriggerRequest.php @@ -34,10 +34,10 @@ class CreateTriggerRequest extends \Google\Protobuf\Internal\Message */ protected $trigger_id = ''; /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; @@ -72,7 +72,7 @@ public static function build(string $parent, \Google\Cloud\Eventarc\V1\Trigger $ * @type string $trigger_id * Required. The user-provided ID to be assigned to the trigger. * @type bool $validate_only - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * } */ @@ -170,10 +170,10 @@ public function setTriggerId($var) } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getValidateOnly() @@ -182,10 +182,10 @@ public function getValidateOnly() } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/Eventarc/src/V1/DeleteChannelRequest.php b/Eventarc/src/V1/DeleteChannelRequest.php index 30b84491f7e6..590a423a9f6e 100644 --- a/Eventarc/src/V1/DeleteChannelRequest.php +++ b/Eventarc/src/V1/DeleteChannelRequest.php @@ -22,10 +22,10 @@ class DeleteChannelRequest extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; @@ -52,7 +52,7 @@ public static function build(string $name): self * @type string $name * Required. The name of the channel to be deleted. * @type bool $validate_only - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * } */ @@ -88,10 +88,10 @@ public function setName($var) } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getValidateOnly() @@ -100,10 +100,10 @@ public function getValidateOnly() } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/Eventarc/src/V1/DeleteEnrollmentRequest.php b/Eventarc/src/V1/DeleteEnrollmentRequest.php new file mode 100644 index 000000000000..4eef495161bc --- /dev/null +++ b/Eventarc/src/V1/DeleteEnrollmentRequest.php @@ -0,0 +1,198 @@ +google.cloud.eventarc.v1.DeleteEnrollmentRequest + */ +class DeleteEnrollmentRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the Enrollment to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. If provided, the Enrollment will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = ''; + /** + * Optional. If set to true, and the Enrollment is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $name Required. The name of the Enrollment to be deleted. Please see + * {@see EventarcClient::enrollmentName()} for help formatting this field. + * @param string $etag Optional. If provided, the Enrollment will only be deleted if the etag + * matches the current etag on the resource. + * + * @return \Google\Cloud\Eventarc\V1\DeleteEnrollmentRequest + * + * @experimental + */ + public static function build(string $name, string $etag): self + { + return (new self()) + ->setName($name) + ->setEtag($etag); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the Enrollment to be deleted. + * @type string $etag + * Optional. If provided, the Enrollment will only be deleted if the etag + * matches the current etag on the resource. + * @type bool $allow_missing + * Optional. If set to true, and the Enrollment is not found, the request will + * succeed but no action will be taken on the server. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the Enrollment to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the Enrollment to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. If provided, the Enrollment will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Optional. If provided, the Enrollment will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Optional. If set to true, and the Enrollment is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the Enrollment is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/DeleteGoogleApiSourceRequest.php b/Eventarc/src/V1/DeleteGoogleApiSourceRequest.php new file mode 100644 index 000000000000..dc9beaf2e21d --- /dev/null +++ b/Eventarc/src/V1/DeleteGoogleApiSourceRequest.php @@ -0,0 +1,198 @@ +google.cloud.eventarc.v1.DeleteGoogleApiSourceRequest + */ +class DeleteGoogleApiSourceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the GoogleApiSource to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = ''; + /** + * Optional. If set to true, and the MessageBus is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $name Required. The name of the GoogleApiSource to be deleted. Please see + * {@see EventarcClient::googleApiSourceName()} for help formatting this field. + * @param string $etag Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * + * @return \Google\Cloud\Eventarc\V1\DeleteGoogleApiSourceRequest + * + * @experimental + */ + public static function build(string $name, string $etag): self + { + return (new self()) + ->setName($name) + ->setEtag($etag); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the GoogleApiSource to be deleted. + * @type string $etag + * Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * @type bool $allow_missing + * Optional. If set to true, and the MessageBus is not found, the request will + * succeed but no action will be taken on the server. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the GoogleApiSource to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the GoogleApiSource to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Optional. If set to true, and the MessageBus is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the MessageBus is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/DeleteMessageBusRequest.php b/Eventarc/src/V1/DeleteMessageBusRequest.php new file mode 100644 index 000000000000..8b71397cc98d --- /dev/null +++ b/Eventarc/src/V1/DeleteMessageBusRequest.php @@ -0,0 +1,198 @@ +google.cloud.eventarc.v1.DeleteMessageBusRequest + */ +class DeleteMessageBusRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the MessageBus to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = ''; + /** + * Optional. If set to true, and the MessageBus is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $name Required. The name of the MessageBus to be deleted. Please see + * {@see EventarcClient::messageBusName()} for help formatting this field. + * @param string $etag Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * + * @return \Google\Cloud\Eventarc\V1\DeleteMessageBusRequest + * + * @experimental + */ + public static function build(string $name, string $etag): self + { + return (new self()) + ->setName($name) + ->setEtag($etag); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the MessageBus to be deleted. + * @type string $etag + * Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * @type bool $allow_missing + * Optional. If set to true, and the MessageBus is not found, the request will + * succeed but no action will be taken on the server. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the MessageBus to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the MessageBus to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Optional. If provided, the MessageBus will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Optional. If set to true, and the MessageBus is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the MessageBus is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/DeletePipelineRequest.php b/Eventarc/src/V1/DeletePipelineRequest.php new file mode 100644 index 000000000000..360d61522744 --- /dev/null +++ b/Eventarc/src/V1/DeletePipelineRequest.php @@ -0,0 +1,198 @@ +google.cloud.eventarc.v1.DeletePipelineRequest + */ +class DeletePipelineRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the Pipeline to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. If provided, the Pipeline will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $etag = ''; + /** + * Optional. If set to true, and the Pipeline is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $name Required. The name of the Pipeline to be deleted. Please see + * {@see EventarcClient::pipelineName()} for help formatting this field. + * @param string $etag Optional. If provided, the Pipeline will only be deleted if the etag + * matches the current etag on the resource. + * + * @return \Google\Cloud\Eventarc\V1\DeletePipelineRequest + * + * @experimental + */ + public static function build(string $name, string $etag): self + { + return (new self()) + ->setName($name) + ->setEtag($etag); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the Pipeline to be deleted. + * @type string $etag + * Optional. If provided, the Pipeline will only be deleted if the etag + * matches the current etag on the resource. + * @type bool $allow_missing + * Optional. If set to true, and the Pipeline is not found, the request will + * succeed but no action will be taken on the server. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the Pipeline to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the Pipeline to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. If provided, the Pipeline will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Optional. If provided, the Pipeline will only be deleted if the etag + * matches the current etag on the resource. + * + * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Optional. If set to true, and the Pipeline is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the Pipeline is not found, the request will + * succeed but no action will be taken on the server. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/DeleteTriggerRequest.php b/Eventarc/src/V1/DeleteTriggerRequest.php index 830d69a020f1..43ad08d1b38e 100644 --- a/Eventarc/src/V1/DeleteTriggerRequest.php +++ b/Eventarc/src/V1/DeleteTriggerRequest.php @@ -36,10 +36,10 @@ class DeleteTriggerRequest extends \Google\Protobuf\Internal\Message */ protected $allow_missing = false; /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; @@ -75,7 +75,7 @@ public static function build(string $name, bool $allowMissing): self * If set to true, and the trigger is not found, the request will succeed * but no action will be taken on the server. * @type bool $validate_only - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * } */ @@ -167,10 +167,10 @@ public function setAllowMissing($var) } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getValidateOnly() @@ -179,10 +179,10 @@ public function getValidateOnly() } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/Eventarc/src/V1/Destination.php b/Eventarc/src/V1/Destination.php index b8dd4dfddb15..0399e85771e5 100644 --- a/Eventarc/src/V1/Destination.php +++ b/Eventarc/src/V1/Destination.php @@ -15,6 +15,14 @@ */ class Destination extends \Google\Protobuf\Internal\Message { + /** + * Optional. Network config is used to configure how Eventarc resolves and + * connect to a destination. + * This should only be used with HttpEndpoint destination type. + * + * Generated from protobuf field .google.cloud.eventarc.v1.NetworkConfig network_config = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $network_config = null; protected $descriptor; /** @@ -27,8 +35,12 @@ class Destination extends \Google\Protobuf\Internal\Message * Cloud Run fully-managed resource that receives the events. The resource * should be in the same project as the trigger. * @type string $cloud_function - * The Cloud Function resource name. Only Cloud Functions V2 is supported. + * The Cloud Function resource name. Cloud Functions V1 and V2 are + * supported. * Format: `projects/{project}/locations/{location}/functions/{function}` + * This is a read-only field. Creating Cloud Functions V1/V2 triggers is + * only supported via the Cloud Functions product. An error will be returned + * if the user sets this value. * @type \Google\Cloud\Eventarc\V1\GKE $gke * A GKE service capable of receiving events. The service should be running * in the same project as the trigger. @@ -37,6 +49,12 @@ class Destination extends \Google\Protobuf\Internal\Message * the events. The Workflow resource should be deployed in the same project * as the trigger. * Format: `projects/{project}/locations/{location}/workflows/{workflow}` + * @type \Google\Cloud\Eventarc\V1\HttpEndpoint $http_endpoint + * An HTTP endpoint destination described by an URI. + * @type \Google\Cloud\Eventarc\V1\NetworkConfig $network_config + * Optional. Network config is used to configure how Eventarc resolves and + * connect to a destination. + * This should only be used with HttpEndpoint destination type. * } */ public function __construct($data = NULL) { @@ -78,8 +96,12 @@ public function setCloudRun($var) } /** - * The Cloud Function resource name. Only Cloud Functions V2 is supported. + * The Cloud Function resource name. Cloud Functions V1 and V2 are + * supported. * Format: `projects/{project}/locations/{location}/functions/{function}` + * This is a read-only field. Creating Cloud Functions V1/V2 triggers is + * only supported via the Cloud Functions product. An error will be returned + * if the user sets this value. * * Generated from protobuf field string cloud_function = 2 [(.google.api.resource_reference) = { * @return string @@ -95,8 +117,12 @@ public function hasCloudFunction() } /** - * The Cloud Function resource name. Only Cloud Functions V2 is supported. + * The Cloud Function resource name. Cloud Functions V1 and V2 are + * supported. * Format: `projects/{project}/locations/{location}/functions/{function}` + * This is a read-only field. Creating Cloud Functions V1/V2 triggers is + * only supported via the Cloud Functions product. An error will be returned + * if the user sets this value. * * Generated from protobuf field string cloud_function = 2 [(.google.api.resource_reference) = { * @param string $var @@ -180,6 +206,77 @@ public function setWorkflow($var) return $this; } + /** + * An HTTP endpoint destination described by an URI. + * + * Generated from protobuf field .google.cloud.eventarc.v1.HttpEndpoint http_endpoint = 5; + * @return \Google\Cloud\Eventarc\V1\HttpEndpoint|null + */ + public function getHttpEndpoint() + { + return $this->readOneof(5); + } + + public function hasHttpEndpoint() + { + return $this->hasOneof(5); + } + + /** + * An HTTP endpoint destination described by an URI. + * + * Generated from protobuf field .google.cloud.eventarc.v1.HttpEndpoint http_endpoint = 5; + * @param \Google\Cloud\Eventarc\V1\HttpEndpoint $var + * @return $this + */ + public function setHttpEndpoint($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\HttpEndpoint::class); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * Optional. Network config is used to configure how Eventarc resolves and + * connect to a destination. + * This should only be used with HttpEndpoint destination type. + * + * Generated from protobuf field .google.cloud.eventarc.v1.NetworkConfig network_config = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\NetworkConfig|null + */ + public function getNetworkConfig() + { + return $this->network_config; + } + + public function hasNetworkConfig() + { + return isset($this->network_config); + } + + public function clearNetworkConfig() + { + unset($this->network_config); + } + + /** + * Optional. Network config is used to configure how Eventarc resolves and + * connect to a destination. + * This should only be used with HttpEndpoint destination type. + * + * Generated from protobuf field .google.cloud.eventarc.v1.NetworkConfig network_config = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\NetworkConfig $var + * @return $this + */ + public function setNetworkConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\NetworkConfig::class); + $this->network_config = $var; + + return $this; + } + /** * @return string */ diff --git a/Eventarc/src/V1/Enrollment.php b/Eventarc/src/V1/Enrollment.php new file mode 100644 index 000000000000..c4ed1239392d --- /dev/null +++ b/Eventarc/src/V1/Enrollment.php @@ -0,0 +1,469 @@ +google.cloud.eventarc.v1.Enrollment + */ +class Enrollment extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/enrollments/{enrollment} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $uid = ''; + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $etag = ''; + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Required. A CEL expression identifying which messages this enrollment + * applies to. + * + * Generated from protobuf field string cel_match = 9 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $cel_match = ''; + /** + * Required. Resource name of the message bus identifying the source of the + * messages. It matches the form + * projects/{project}/locations/{location}/messageBuses/{messageBus}. + * + * Generated from protobuf field string message_bus = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $message_bus = ''; + /** + * Required. Destination is the Pipeline that the Enrollment is delivering to. + * It must point to the full resource name of a Pipeline. Format: + * "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)" + * + * Generated from protobuf field string destination = 11 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $destination = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/enrollments/{enrollment} + * @type string $uid + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * @type string $etag + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The creation time. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The last-modified time. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. Resource labels. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. Resource annotations. + * @type string $display_name + * Optional. Resource display name. + * @type string $cel_match + * Required. A CEL expression identifying which messages this enrollment + * applies to. + * @type string $message_bus + * Required. Resource name of the message bus identifying the source of the + * messages. It matches the form + * projects/{project}/locations/{location}/messageBuses/{messageBus}. + * @type string $destination + * Required. Destination is the Pipeline that the Enrollment is delivering to. + * It must point to the full resource name of a Pipeline. Format: + * "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)" + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Enrollment::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/enrollments/{enrollment} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/enrollments/{enrollment} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getUid() + { + return $this->uid; + } + + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setUid($var) + { + GPBUtil::checkString($var, True); + $this->uid = $var; + + return $this; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Required. A CEL expression identifying which messages this enrollment + * applies to. + * + * Generated from protobuf field string cel_match = 9 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getCelMatch() + { + return $this->cel_match; + } + + /** + * Required. A CEL expression identifying which messages this enrollment + * applies to. + * + * Generated from protobuf field string cel_match = 9 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setCelMatch($var) + { + GPBUtil::checkString($var, True); + $this->cel_match = $var; + + return $this; + } + + /** + * Required. Resource name of the message bus identifying the source of the + * messages. It matches the form + * projects/{project}/locations/{location}/messageBuses/{messageBus}. + * + * Generated from protobuf field string message_bus = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getMessageBus() + { + return $this->message_bus; + } + + /** + * Required. Resource name of the message bus identifying the source of the + * messages. It matches the form + * projects/{project}/locations/{location}/messageBuses/{messageBus}. + * + * Generated from protobuf field string message_bus = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setMessageBus($var) + { + GPBUtil::checkString($var, True); + $this->message_bus = $var; + + return $this; + } + + /** + * Required. Destination is the Pipeline that the Enrollment is delivering to. + * It must point to the full resource name of a Pipeline. Format: + * "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)" + * + * Generated from protobuf field string destination = 11 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getDestination() + { + return $this->destination; + } + + /** + * Required. Destination is the Pipeline that the Enrollment is delivering to. + * It must point to the full resource name of a Pipeline. Format: + * "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)" + * + * Generated from protobuf field string destination = 11 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setDestination($var) + { + GPBUtil::checkString($var, True); + $this->destination = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/EventFilter.php b/Eventarc/src/V1/EventFilter.php index f4f75630fc18..1e48fa154dda 100644 --- a/Eventarc/src/V1/EventFilter.php +++ b/Eventarc/src/V1/EventFilter.php @@ -16,8 +16,10 @@ class EventFilter extends \Google\Protobuf\Internal\Message { /** - * Required. The name of a CloudEvents attribute. Currently, only a subset of attributes - * are supported for filtering. + * Required. The name of a CloudEvents attribute. Currently, only a subset of + * attributes are supported for filtering. You can [retrieve a specific + * provider's supported event + * types](/eventarc/docs/list-providers#describe-provider). * All triggers MUST provide a filter for the 'type' attribute. * * Generated from protobuf field string attribute = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -32,8 +34,9 @@ class EventFilter extends \Google\Protobuf\Internal\Message /** * Optional. The operator used for matching the events with the value of the * filter. If not specified, only events that have an exact key-value pair - * specified in the filter are matched. The only allowed value is - * `match-path-pattern`. + * specified in the filter are matched. The allowed values are `path_pattern` + * and `match-path-pattern`. `path_pattern` is only allowed for GCFv1 + * triggers. * * Generated from protobuf field string operator = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -46,16 +49,19 @@ class EventFilter extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $attribute - * Required. The name of a CloudEvents attribute. Currently, only a subset of attributes - * are supported for filtering. + * Required. The name of a CloudEvents attribute. Currently, only a subset of + * attributes are supported for filtering. You can [retrieve a specific + * provider's supported event + * types](/eventarc/docs/list-providers#describe-provider). * All triggers MUST provide a filter for the 'type' attribute. * @type string $value * Required. The value for the attribute. * @type string $operator * Optional. The operator used for matching the events with the value of the * filter. If not specified, only events that have an exact key-value pair - * specified in the filter are matched. The only allowed value is - * `match-path-pattern`. + * specified in the filter are matched. The allowed values are `path_pattern` + * and `match-path-pattern`. `path_pattern` is only allowed for GCFv1 + * triggers. * } */ public function __construct($data = NULL) { @@ -64,8 +70,10 @@ public function __construct($data = NULL) { } /** - * Required. The name of a CloudEvents attribute. Currently, only a subset of attributes - * are supported for filtering. + * Required. The name of a CloudEvents attribute. Currently, only a subset of + * attributes are supported for filtering. You can [retrieve a specific + * provider's supported event + * types](/eventarc/docs/list-providers#describe-provider). * All triggers MUST provide a filter for the 'type' attribute. * * Generated from protobuf field string attribute = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -77,8 +85,10 @@ public function getAttribute() } /** - * Required. The name of a CloudEvents attribute. Currently, only a subset of attributes - * are supported for filtering. + * Required. The name of a CloudEvents attribute. Currently, only a subset of + * attributes are supported for filtering. You can [retrieve a specific + * provider's supported event + * types](/eventarc/docs/list-providers#describe-provider). * All triggers MUST provide a filter for the 'type' attribute. * * Generated from protobuf field string attribute = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -122,8 +132,9 @@ public function setValue($var) /** * Optional. The operator used for matching the events with the value of the * filter. If not specified, only events that have an exact key-value pair - * specified in the filter are matched. The only allowed value is - * `match-path-pattern`. + * specified in the filter are matched. The allowed values are `path_pattern` + * and `match-path-pattern`. `path_pattern` is only allowed for GCFv1 + * triggers. * * Generated from protobuf field string operator = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -136,8 +147,9 @@ public function getOperator() /** * Optional. The operator used for matching the events with the value of the * filter. If not specified, only events that have an exact key-value pair - * specified in the filter are matched. The only allowed value is - * `match-path-pattern`. + * specified in the filter are matched. The allowed values are `path_pattern` + * and `match-path-pattern`. `path_pattern` is only allowed for GCFv1 + * triggers. * * Generated from protobuf field string operator = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/Eventarc/src/V1/FilteringAttribute.php b/Eventarc/src/V1/FilteringAttribute.php index ac17a5a683b0..d36025d717b0 100644 --- a/Eventarc/src/V1/FilteringAttribute.php +++ b/Eventarc/src/V1/FilteringAttribute.php @@ -29,15 +29,15 @@ class FilteringAttribute extends \Google\Protobuf\Internal\Message */ protected $description = ''; /** - * Output only. If true, the triggers for this provider should always specify a filter - * on these attributes. Trigger creation will fail otherwise. + * Output only. If true, the triggers for this provider should always specify + * a filter on these attributes. Trigger creation will fail otherwise. * * Generated from protobuf field bool required = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $required = false; /** - * Output only. If true, the attribute accepts matching expressions in the Eventarc - * PathPattern format. + * Output only. If true, the attribute accepts matching expressions in the + * Eventarc PathPattern format. * * Generated from protobuf field bool path_pattern_supported = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -54,11 +54,11 @@ class FilteringAttribute extends \Google\Protobuf\Internal\Message * @type string $description * Output only. Description of the purpose of the attribute. * @type bool $required - * Output only. If true, the triggers for this provider should always specify a filter - * on these attributes. Trigger creation will fail otherwise. + * Output only. If true, the triggers for this provider should always specify + * a filter on these attributes. Trigger creation will fail otherwise. * @type bool $path_pattern_supported - * Output only. If true, the attribute accepts matching expressions in the Eventarc - * PathPattern format. + * Output only. If true, the attribute accepts matching expressions in the + * Eventarc PathPattern format. * } */ public function __construct($data = NULL) { @@ -119,8 +119,8 @@ public function setDescription($var) } /** - * Output only. If true, the triggers for this provider should always specify a filter - * on these attributes. Trigger creation will fail otherwise. + * Output only. If true, the triggers for this provider should always specify + * a filter on these attributes. Trigger creation will fail otherwise. * * Generated from protobuf field bool required = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return bool @@ -131,8 +131,8 @@ public function getRequired() } /** - * Output only. If true, the triggers for this provider should always specify a filter - * on these attributes. Trigger creation will fail otherwise. + * Output only. If true, the triggers for this provider should always specify + * a filter on these attributes. Trigger creation will fail otherwise. * * Generated from protobuf field bool required = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param bool $var @@ -147,8 +147,8 @@ public function setRequired($var) } /** - * Output only. If true, the attribute accepts matching expressions in the Eventarc - * PathPattern format. + * Output only. If true, the attribute accepts matching expressions in the + * Eventarc PathPattern format. * * Generated from protobuf field bool path_pattern_supported = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return bool @@ -159,8 +159,8 @@ public function getPathPatternSupported() } /** - * Output only. If true, the attribute accepts matching expressions in the Eventarc - * PathPattern format. + * Output only. If true, the attribute accepts matching expressions in the + * Eventarc PathPattern format. * * Generated from protobuf field bool path_pattern_supported = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param bool $var diff --git a/Eventarc/src/V1/GKE.php b/Eventarc/src/V1/GKE.php index 205d41d90ddc..428c452b3e82 100644 --- a/Eventarc/src/V1/GKE.php +++ b/Eventarc/src/V1/GKE.php @@ -16,16 +16,17 @@ class GKE extends \Google\Protobuf\Internal\Message { /** - * Required. The name of the cluster the GKE service is running in. The cluster must be - * running in the same project as the trigger being created. + * Required. The name of the cluster the GKE service is running in. The + * cluster must be running in the same project as the trigger being created. * * Generated from protobuf field string cluster = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $cluster = ''; /** - * Required. The name of the Google Compute Engine in which the cluster resides, which - * can either be compute zone (for example, us-central1-a) for the zonal - * clusters or region (for example, us-central1) for regional clusters. + * Required. The name of the Google Compute Engine in which the cluster + * resides, which can either be compute zone (for example, us-central1-a) for + * the zonal clusters or region (for example, us-central1) for regional + * clusters. * * Generated from protobuf field string location = 2 [(.google.api.field_behavior) = REQUIRED]; */ @@ -43,7 +44,8 @@ class GKE extends \Google\Protobuf\Internal\Message */ protected $service = ''; /** - * Optional. The relative path on the GKE service the events should be sent to. + * Optional. The relative path on the GKE service the events should be sent + * to. * The value must conform to the definition of a URI path segment (section 3.3 * of RFC2396). Examples: "/route", "route", "route/subroute". * @@ -58,18 +60,20 @@ class GKE extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $cluster - * Required. The name of the cluster the GKE service is running in. The cluster must be - * running in the same project as the trigger being created. + * Required. The name of the cluster the GKE service is running in. The + * cluster must be running in the same project as the trigger being created. * @type string $location - * Required. The name of the Google Compute Engine in which the cluster resides, which - * can either be compute zone (for example, us-central1-a) for the zonal - * clusters or region (for example, us-central1) for regional clusters. + * Required. The name of the Google Compute Engine in which the cluster + * resides, which can either be compute zone (for example, us-central1-a) for + * the zonal clusters or region (for example, us-central1) for regional + * clusters. * @type string $namespace * Required. The namespace the GKE service is running in. * @type string $service * Required. Name of the GKE service. * @type string $path - * Optional. The relative path on the GKE service the events should be sent to. + * Optional. The relative path on the GKE service the events should be sent + * to. * The value must conform to the definition of a URI path segment (section 3.3 * of RFC2396). Examples: "/route", "route", "route/subroute". * } @@ -80,8 +84,8 @@ public function __construct($data = NULL) { } /** - * Required. The name of the cluster the GKE service is running in. The cluster must be - * running in the same project as the trigger being created. + * Required. The name of the cluster the GKE service is running in. The + * cluster must be running in the same project as the trigger being created. * * Generated from protobuf field string cluster = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -92,8 +96,8 @@ public function getCluster() } /** - * Required. The name of the cluster the GKE service is running in. The cluster must be - * running in the same project as the trigger being created. + * Required. The name of the cluster the GKE service is running in. The + * cluster must be running in the same project as the trigger being created. * * Generated from protobuf field string cluster = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var @@ -108,9 +112,10 @@ public function setCluster($var) } /** - * Required. The name of the Google Compute Engine in which the cluster resides, which - * can either be compute zone (for example, us-central1-a) for the zonal - * clusters or region (for example, us-central1) for regional clusters. + * Required. The name of the Google Compute Engine in which the cluster + * resides, which can either be compute zone (for example, us-central1-a) for + * the zonal clusters or region (for example, us-central1) for regional + * clusters. * * Generated from protobuf field string location = 2 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -121,9 +126,10 @@ public function getLocation() } /** - * Required. The name of the Google Compute Engine in which the cluster resides, which - * can either be compute zone (for example, us-central1-a) for the zonal - * clusters or region (for example, us-central1) for regional clusters. + * Required. The name of the Google Compute Engine in which the cluster + * resides, which can either be compute zone (for example, us-central1-a) for + * the zonal clusters or region (for example, us-central1) for regional + * clusters. * * Generated from protobuf field string location = 2 [(.google.api.field_behavior) = REQUIRED]; * @param string $var @@ -190,7 +196,8 @@ public function setService($var) } /** - * Optional. The relative path on the GKE service the events should be sent to. + * Optional. The relative path on the GKE service the events should be sent + * to. * The value must conform to the definition of a URI path segment (section 3.3 * of RFC2396). Examples: "/route", "route", "route/subroute". * @@ -203,7 +210,8 @@ public function getPath() } /** - * Optional. The relative path on the GKE service the events should be sent to. + * Optional. The relative path on the GKE service the events should be sent + * to. * The value must conform to the definition of a URI path segment (section 3.3 * of RFC2396). Examples: "/route", "route", "route/subroute". * diff --git a/Eventarc/src/V1/GetEnrollmentRequest.php b/Eventarc/src/V1/GetEnrollmentRequest.php new file mode 100644 index 000000000000..8cd21daa3843 --- /dev/null +++ b/Eventarc/src/V1/GetEnrollmentRequest.php @@ -0,0 +1,81 @@ +google.cloud.eventarc.v1.GetEnrollmentRequest + */ +class GetEnrollmentRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the Enrollment to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the Enrollment to get. Please see + * {@see EventarcClient::enrollmentName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\GetEnrollmentRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the Enrollment to get. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the Enrollment to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the Enrollment to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/GetGoogleApiSourceRequest.php b/Eventarc/src/V1/GetGoogleApiSourceRequest.php new file mode 100644 index 000000000000..9cda03c132e4 --- /dev/null +++ b/Eventarc/src/V1/GetGoogleApiSourceRequest.php @@ -0,0 +1,81 @@ +google.cloud.eventarc.v1.GetGoogleApiSourceRequest + */ +class GetGoogleApiSourceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the google api source to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the google api source to get. Please see + * {@see EventarcClient::googleApiSourceName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\GetGoogleApiSourceRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the google api source to get. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the google api source to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the google api source to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/GetMessageBusRequest.php b/Eventarc/src/V1/GetMessageBusRequest.php new file mode 100644 index 000000000000..bcc8663131d1 --- /dev/null +++ b/Eventarc/src/V1/GetMessageBusRequest.php @@ -0,0 +1,81 @@ +google.cloud.eventarc.v1.GetMessageBusRequest + */ +class GetMessageBusRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the message bus to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the message bus to get. Please see + * {@see EventarcClient::messageBusName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\GetMessageBusRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the message bus to get. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the message bus to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the message bus to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/GetPipelineRequest.php b/Eventarc/src/V1/GetPipelineRequest.php new file mode 100644 index 000000000000..82d14ada1ede --- /dev/null +++ b/Eventarc/src/V1/GetPipelineRequest.php @@ -0,0 +1,81 @@ +google.cloud.eventarc.v1.GetPipelineRequest + */ +class GetPipelineRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the pipeline to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the pipeline to get. Please see + * {@see EventarcClient::pipelineName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\GetPipelineRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the pipeline to get. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the pipeline to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the pipeline to get. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/GoogleApiSource.php b/Eventarc/src/V1/GoogleApiSource.php new file mode 100644 index 000000000000..4ddd79e5c6a8 --- /dev/null +++ b/Eventarc/src/V1/GoogleApiSource.php @@ -0,0 +1,481 @@ +google.cloud.eventarc.v1.GoogleApiSource + */ +class GoogleApiSource extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/googleApiSources/{google_api_source} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + */ + protected $uid = ''; + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $etag = ''; + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Required. Destination is the message bus that the GoogleApiSource is + * delivering to. It must be point to the full resource name of a MessageBus. + * Format: + * "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID) + * + * Generated from protobuf field string destination = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $destination = ''; + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt their event data. + * It must match the pattern + * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $crypto_key_name = ''; + /** + * Optional. Config to control Platform logging for the GoogleApiSource. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $logging_config = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/googleApiSources/{google_api_source} + * @type string $uid + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * @type string $etag + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The creation time. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The last-modified time. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. Resource labels. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. Resource annotations. + * @type string $display_name + * Optional. Resource display name. + * @type string $destination + * Required. Destination is the message bus that the GoogleApiSource is + * delivering to. It must be point to the full resource name of a MessageBus. + * Format: + * "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID) + * @type string $crypto_key_name + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt their event data. + * It must match the pattern + * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * @type \Google\Cloud\Eventarc\V1\LoggingConfig $logging_config + * Optional. Config to control Platform logging for the GoogleApiSource. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\GoogleApiSource::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/googleApiSources/{google_api_source} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/googleApiSources/{google_api_source} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @return string + */ + public function getUid() + { + return $this->uid; + } + + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setUid($var) + { + GPBUtil::checkString($var, True); + $this->uid = $var; + + return $this; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Required. Destination is the message bus that the GoogleApiSource is + * delivering to. It must be point to the full resource name of a MessageBus. + * Format: + * "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID) + * + * Generated from protobuf field string destination = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getDestination() + { + return $this->destination; + } + + /** + * Required. Destination is the message bus that the GoogleApiSource is + * delivering to. It must be point to the full resource name of a MessageBus. + * Format: + * "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID) + * + * Generated from protobuf field string destination = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setDestination($var) + { + GPBUtil::checkString($var, True); + $this->destination = $var; + + return $this; + } + + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt their event data. + * It must match the pattern + * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getCryptoKeyName() + { + return $this->crypto_key_name; + } + + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt their event data. + * It must match the pattern + * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setCryptoKeyName($var) + { + GPBUtil::checkString($var, True); + $this->crypto_key_name = $var; + + return $this; + } + + /** + * Optional. Config to control Platform logging for the GoogleApiSource. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\LoggingConfig|null + */ + public function getLoggingConfig() + { + return $this->logging_config; + } + + public function hasLoggingConfig() + { + return isset($this->logging_config); + } + + public function clearLoggingConfig() + { + unset($this->logging_config); + } + + /** + * Optional. Config to control Platform logging for the GoogleApiSource. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\LoggingConfig $var + * @return $this + */ + public function setLoggingConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\LoggingConfig::class); + $this->logging_config = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/HttpEndpoint.php b/Eventarc/src/V1/HttpEndpoint.php new file mode 100644 index 000000000000..61cb425db51a --- /dev/null +++ b/Eventarc/src/V1/HttpEndpoint.php @@ -0,0 +1,91 @@ +google.cloud.eventarc.v1.HttpEndpoint + */ +class HttpEndpoint extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The URI of the HTTP enpdoint. + * The value must be a RFC2396 URI string. + * Examples: `http://10.10.10.8:80/route`, + * `http://svc.us-central1.p.local:8080/`. + * Only HTTP and HTTPS protocols are supported. The host can be either a + * static IP addressable from the VPC specified by the network config, or + * an internal DNS hostname of the service resolvable via Cloud DNS. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $uri = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * Required. The URI of the HTTP enpdoint. + * The value must be a RFC2396 URI string. + * Examples: `http://10.10.10.8:80/route`, + * `http://svc.us-central1.p.local:8080/`. + * Only HTTP and HTTPS protocols are supported. The host can be either a + * static IP addressable from the VPC specified by the network config, or + * an internal DNS hostname of the service resolvable via Cloud DNS. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Trigger::initOnce(); + parent::__construct($data); + } + + /** + * Required. The URI of the HTTP enpdoint. + * The value must be a RFC2396 URI string. + * Examples: `http://10.10.10.8:80/route`, + * `http://svc.us-central1.p.local:8080/`. + * Only HTTP and HTTPS protocols are supported. The host can be either a + * static IP addressable from the VPC specified by the network config, or + * an internal DNS hostname of the service resolvable via Cloud DNS. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * Required. The URI of the HTTP enpdoint. + * The value must be a RFC2396 URI string. + * Examples: `http://10.10.10.8:80/route`, + * `http://svc.us-central1.p.local:8080/`. + * Only HTTP and HTTPS protocols are supported. The host can be either a + * static IP addressable from the VPC specified by the network config, or + * an internal DNS hostname of the service resolvable via Cloud DNS. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListEnrollmentsRequest.php b/Eventarc/src/V1/ListEnrollmentsRequest.php new file mode 100644 index 000000000000..e54b7d747086 --- /dev/null +++ b/Eventarc/src/V1/ListEnrollmentsRequest.php @@ -0,0 +1,249 @@ +google.cloud.eventarc.v1.ListEnrollmentsRequest + */ +class ListEnrollmentsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent collection to list triggers on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + + /** + * @param string $parent Required. The parent collection to list triggers on. Please see + * {@see EventarcClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\ListEnrollmentsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent collection to list triggers on. + * @type int $page_size + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * @type string $page_token + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * @type string $order_by + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * @type string $filter + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent collection to list triggers on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent collection to list triggers on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListEnrollmentsResponse.php b/Eventarc/src/V1/ListEnrollmentsResponse.php new file mode 100644 index 000000000000..f467a1b3d593 --- /dev/null +++ b/Eventarc/src/V1/ListEnrollmentsResponse.php @@ -0,0 +1,139 @@ +google.cloud.eventarc.v1.ListEnrollmentsResponse + */ +class ListEnrollmentsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The requested Enrollments, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Enrollment enrollments = 1; + */ + private $enrollments; + /** + * A page token that can be sent to `ListEnrollments` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Eventarc\V1\Enrollment>|\Google\Protobuf\Internal\RepeatedField $enrollments + * The requested Enrollments, up to the number specified in `page_size`. + * @type string $next_page_token + * A page token that can be sent to `ListEnrollments` to request the next + * page. If this is empty, then there are no more pages. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Unreachable resources, if any. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * The requested Enrollments, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Enrollment enrollments = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEnrollments() + { + return $this->enrollments; + } + + /** + * The requested Enrollments, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Enrollment enrollments = 1; + * @param array<\Google\Cloud\Eventarc\V1\Enrollment>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEnrollments($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Eventarc\V1\Enrollment::class); + $this->enrollments = $arr; + + return $this; + } + + /** + * A page token that can be sent to `ListEnrollments` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A page token that can be sent to `ListEnrollments` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListGoogleApiSourcesRequest.php b/Eventarc/src/V1/ListGoogleApiSourcesRequest.php new file mode 100644 index 000000000000..afc0e23c4e35 --- /dev/null +++ b/Eventarc/src/V1/ListGoogleApiSourcesRequest.php @@ -0,0 +1,249 @@ +google.cloud.eventarc.v1.ListGoogleApiSourcesRequest + */ +class ListGoogleApiSourcesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent collection to list GoogleApiSources on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + + /** + * @param string $parent Required. The parent collection to list GoogleApiSources on. Please see + * {@see EventarcClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\ListGoogleApiSourcesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent collection to list GoogleApiSources on. + * @type int $page_size + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * @type string $page_token + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * @type string $order_by + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * @type string $filter + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent collection to list GoogleApiSources on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent collection to list GoogleApiSources on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListGoogleApiSourcesResponse.php b/Eventarc/src/V1/ListGoogleApiSourcesResponse.php new file mode 100644 index 000000000000..9994f064503f --- /dev/null +++ b/Eventarc/src/V1/ListGoogleApiSourcesResponse.php @@ -0,0 +1,139 @@ +google.cloud.eventarc.v1.ListGoogleApiSourcesResponse + */ +class ListGoogleApiSourcesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The requested GoogleApiSources, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.GoogleApiSource google_api_sources = 1; + */ + private $google_api_sources; + /** + * A page token that can be sent to `ListMessageBusEnrollments` to request the + * next page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Eventarc\V1\GoogleApiSource>|\Google\Protobuf\Internal\RepeatedField $google_api_sources + * The requested GoogleApiSources, up to the number specified in `page_size`. + * @type string $next_page_token + * A page token that can be sent to `ListMessageBusEnrollments` to request the + * next page. If this is empty, then there are no more pages. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Unreachable resources, if any. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * The requested GoogleApiSources, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.GoogleApiSource google_api_sources = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGoogleApiSources() + { + return $this->google_api_sources; + } + + /** + * The requested GoogleApiSources, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.GoogleApiSource google_api_sources = 1; + * @param array<\Google\Cloud\Eventarc\V1\GoogleApiSource>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGoogleApiSources($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Eventarc\V1\GoogleApiSource::class); + $this->google_api_sources = $arr; + + return $this; + } + + /** + * A page token that can be sent to `ListMessageBusEnrollments` to request the + * next page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A page token that can be sent to `ListMessageBusEnrollments` to request the + * next page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListMessageBusEnrollmentsRequest.php b/Eventarc/src/V1/ListMessageBusEnrollmentsRequest.php new file mode 100644 index 000000000000..782b7a29711a --- /dev/null +++ b/Eventarc/src/V1/ListMessageBusEnrollmentsRequest.php @@ -0,0 +1,165 @@ +google.cloud.eventarc.v1.ListMessageBusEnrollmentsRequest + */ +class ListMessageBusEnrollmentsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent message bus to list enrollments on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + + /** + * @param string $parent Required. The parent message bus to list enrollments on. Please see + * {@see EventarcClient::messageBusName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\ListMessageBusEnrollmentsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent message bus to list enrollments on. + * @type int $page_size + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * @type string $page_token + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent message bus to list enrollments on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent message bus to list enrollments on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListMessageBusEnrollmentsResponse.php b/Eventarc/src/V1/ListMessageBusEnrollmentsResponse.php new file mode 100644 index 000000000000..f58a262aad2c --- /dev/null +++ b/Eventarc/src/V1/ListMessageBusEnrollmentsResponse.php @@ -0,0 +1,139 @@ +google.cloud.eventarc.v1.ListMessageBusEnrollmentsResponse + */ +class ListMessageBusEnrollmentsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The requested enrollments, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated string enrollments = 1; + */ + private $enrollments; + /** + * A page token that can be sent to `ListMessageBusEnrollments` to request the + * next page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $enrollments + * The requested enrollments, up to the number specified in `page_size`. + * @type string $next_page_token + * A page token that can be sent to `ListMessageBusEnrollments` to request the + * next page. If this is empty, then there are no more pages. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Unreachable resources, if any. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * The requested enrollments, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated string enrollments = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEnrollments() + { + return $this->enrollments; + } + + /** + * The requested enrollments, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated string enrollments = 1; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEnrollments($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->enrollments = $arr; + + return $this; + } + + /** + * A page token that can be sent to `ListMessageBusEnrollments` to request the + * next page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A page token that can be sent to `ListMessageBusEnrollments` to request the + * next page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListMessageBusesRequest.php b/Eventarc/src/V1/ListMessageBusesRequest.php new file mode 100644 index 000000000000..7058037078d5 --- /dev/null +++ b/Eventarc/src/V1/ListMessageBusesRequest.php @@ -0,0 +1,249 @@ +google.cloud.eventarc.v1.ListMessageBusesRequest + */ +class ListMessageBusesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent collection to list triggers on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + + /** + * @param string $parent Required. The parent collection to list triggers on. Please see + * {@see EventarcClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\ListMessageBusesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent collection to list triggers on. + * @type int $page_size + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * @type string $page_token + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * @type string $order_by + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * @type string $filter + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent collection to list triggers on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent collection to list triggers on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. The filter field that the list request will filter on. + * Possible filtersare described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListMessageBusesResponse.php b/Eventarc/src/V1/ListMessageBusesResponse.php new file mode 100644 index 000000000000..1ec7d56ab37f --- /dev/null +++ b/Eventarc/src/V1/ListMessageBusesResponse.php @@ -0,0 +1,139 @@ +google.cloud.eventarc.v1.ListMessageBusesResponse + */ +class ListMessageBusesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The requested message buses, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.MessageBus message_buses = 1; + */ + private $message_buses; + /** + * A page token that can be sent to `ListMessageBuses` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Eventarc\V1\MessageBus>|\Google\Protobuf\Internal\RepeatedField $message_buses + * The requested message buses, up to the number specified in `page_size`. + * @type string $next_page_token + * A page token that can be sent to `ListMessageBuses` to request the next + * page. If this is empty, then there are no more pages. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Unreachable resources, if any. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * The requested message buses, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.MessageBus message_buses = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMessageBuses() + { + return $this->message_buses; + } + + /** + * The requested message buses, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.MessageBus message_buses = 1; + * @param array<\Google\Cloud\Eventarc\V1\MessageBus>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMessageBuses($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Eventarc\V1\MessageBus::class); + $this->message_buses = $arr; + + return $this; + } + + /** + * A page token that can be sent to `ListMessageBuses` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A page token that can be sent to `ListMessageBuses` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListPipelinesRequest.php b/Eventarc/src/V1/ListPipelinesRequest.php new file mode 100644 index 000000000000..fe3533060eb7 --- /dev/null +++ b/Eventarc/src/V1/ListPipelinesRequest.php @@ -0,0 +1,249 @@ +google.cloud.eventarc.v1.ListPipelinesRequest + */ +class ListPipelinesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent collection to list pipelines on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. The filter field that the list request will filter on. + * Possible filters are described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + + /** + * @param string $parent Required. The parent collection to list pipelines on. Please see + * {@see EventarcClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\Eventarc\V1\ListPipelinesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent collection to list pipelines on. + * @type int $page_size + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * @type string $page_token + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * @type string $order_by + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * @type string $filter + * Optional. The filter field that the list request will filter on. + * Possible filters are described in https://google.aip.dev/160. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent collection to list pipelines on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent collection to list pipelines on. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of results to return on each page. + * Note: The service may send fewer. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The page token; provide the value from the `next_page_token` + * field in a previous call to retrieve the subsequent page. + * When paginating, all other parameters provided must match + * the previous call that provided the page token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The sorting order of the resources returned. Value should be a + * comma-separated list of fields. The default sorting order is ascending. To + * specify descending order for a field, append a `desc` suffix; for example: + * `name desc, update_time`. + * + * Generated from protobuf field string order_by = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. The filter field that the list request will filter on. + * Possible filters are described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. The filter field that the list request will filter on. + * Possible filters are described in https://google.aip.dev/160. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/ListPipelinesResponse.php b/Eventarc/src/V1/ListPipelinesResponse.php new file mode 100644 index 000000000000..db5624cef798 --- /dev/null +++ b/Eventarc/src/V1/ListPipelinesResponse.php @@ -0,0 +1,139 @@ +google.cloud.eventarc.v1.ListPipelinesResponse + */ +class ListPipelinesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * The requested pipelines, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline pipelines = 1; + */ + private $pipelines; + /** + * A page token that can be sent to `ListPipelines` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + */ + private $unreachable; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Eventarc\V1\Pipeline>|\Google\Protobuf\Internal\RepeatedField $pipelines + * The requested pipelines, up to the number specified in `page_size`. + * @type string $next_page_token + * A page token that can be sent to `ListPipelines` to request the next + * page. If this is empty, then there are no more pages. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable + * Unreachable resources, if any. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * The requested pipelines, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline pipelines = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPipelines() + { + return $this->pipelines; + } + + /** + * The requested pipelines, up to the number specified in `page_size`. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline pipelines = 1; + * @param array<\Google\Cloud\Eventarc\V1\Pipeline>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPipelines($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Eventarc\V1\Pipeline::class); + $this->pipelines = $arr; + + return $this; + } + + /** + * A page token that can be sent to `ListPipelines` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A page token that can be sent to `ListPipelines` to request the next + * page. If this is empty, then there are no more pages. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachable() + { + return $this->unreachable; + } + + /** + * Unreachable resources, if any. + * + * Generated from protobuf field repeated string unreachable = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachable($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable = $arr; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/LoggingConfig.php b/Eventarc/src/V1/LoggingConfig.php new file mode 100644 index 000000000000..68522bb64d27 --- /dev/null +++ b/Eventarc/src/V1/LoggingConfig.php @@ -0,0 +1,76 @@ +google.cloud.eventarc.v1.LoggingConfig + */ +class LoggingConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The minimum severity of logs that will be sent to + * Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be + * sent, unless it is NONE. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig.LogSeverity log_severity = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $log_severity = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $log_severity + * Optional. The minimum severity of logs that will be sent to + * Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be + * sent, unless it is NONE. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\LoggingConfig::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The minimum severity of logs that will be sent to + * Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be + * sent, unless it is NONE. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig.LogSeverity log_severity = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getLogSeverity() + { + return $this->log_severity; + } + + /** + * Optional. The minimum severity of logs that will be sent to + * Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be + * sent, unless it is NONE. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig.LogSeverity log_severity = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setLogSeverity($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Eventarc\V1\LoggingConfig\LogSeverity::class); + $this->log_severity = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/LoggingConfig/LogSeverity.php b/Eventarc/src/V1/LoggingConfig/LogSeverity.php new file mode 100644 index 000000000000..24c24b89c169 --- /dev/null +++ b/Eventarc/src/V1/LoggingConfig/LogSeverity.php @@ -0,0 +1,118 @@ +google.cloud.eventarc.v1.LoggingConfig.LogSeverity + */ +class LogSeverity +{ + /** + * Log severity is not specified. This value is treated the same as NONE, + * but is used to distinguish between no update and update to NONE in + * update_masks. + * + * Generated from protobuf enum LOG_SEVERITY_UNSPECIFIED = 0; + */ + const LOG_SEVERITY_UNSPECIFIED = 0; + /** + * Default value at resource creation, presence of this value must be + * treated as no logging/disable logging. + * + * Generated from protobuf enum NONE = 1; + */ + const NONE = 1; + /** + * Debug or trace level logging. + * + * Generated from protobuf enum DEBUG = 2; + */ + const DEBUG = 2; + /** + * Routine information, such as ongoing status or performance. + * + * Generated from protobuf enum INFO = 3; + */ + const INFO = 3; + /** + * Normal but significant events, such as start up, shut down, or a + * configuration change. + * + * Generated from protobuf enum NOTICE = 4; + */ + const NOTICE = 4; + /** + * Warning events might cause problems. + * + * Generated from protobuf enum WARNING = 5; + */ + const WARNING = 5; + /** + * Error events are likely to cause problems. + * + * Generated from protobuf enum ERROR = 6; + */ + const ERROR = 6; + /** + * Critical events cause more severe problems or outages. + * + * Generated from protobuf enum CRITICAL = 7; + */ + const CRITICAL = 7; + /** + * A person must take action immediately. + * + * Generated from protobuf enum ALERT = 8; + */ + const ALERT = 8; + /** + * One or more systems are unusable. + * + * Generated from protobuf enum EMERGENCY = 9; + */ + const EMERGENCY = 9; + + private static $valueToName = [ + self::LOG_SEVERITY_UNSPECIFIED => 'LOG_SEVERITY_UNSPECIFIED', + self::NONE => 'NONE', + self::DEBUG => 'DEBUG', + self::INFO => 'INFO', + self::NOTICE => 'NOTICE', + self::WARNING => 'WARNING', + self::ERROR => 'ERROR', + self::CRITICAL => 'CRITICAL', + self::ALERT => 'ALERT', + self::EMERGENCY => 'EMERGENCY', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Eventarc/src/V1/MessageBus.php b/Eventarc/src/V1/MessageBus.php new file mode 100644 index 000000000000..125bd3c86db6 --- /dev/null +++ b/Eventarc/src/V1/MessageBus.php @@ -0,0 +1,446 @@ +google.cloud.eventarc.v1.MessageBus + */ +class MessageBus extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/messageBuses/{message_bus} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $uid = ''; + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $etag = ''; + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt their event data. + * It must match the pattern + * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $crypto_key_name = ''; + /** + * Optional. Config to control Platform logging for the Message Bus. This log + * configuration is applied to the Message Bus itself, and all the Enrollments + * attached to it. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $logging_config = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/messageBuses/{message_bus} + * @type string $uid + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * @type string $etag + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The creation time. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The last-modified time. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. Resource labels. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. Resource annotations. + * @type string $display_name + * Optional. Resource display name. + * @type string $crypto_key_name + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt their event data. + * It must match the pattern + * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * @type \Google\Cloud\Eventarc\V1\LoggingConfig $logging_config + * Optional. Config to control Platform logging for the Message Bus. This log + * configuration is applied to the Message Bus itself, and all the Enrollments + * attached to it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\MessageBus::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/messageBuses/{message_bus} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. Resource name of the form + * projects/{project}/locations/{location}/messageBuses/{message_bus} + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getUid() + { + return $this->uid; + } + + /** + * Output only. Server assigned unique identifier for the channel. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setUid($var) + { + GPBUtil::checkString($var, True); + $this->uid = $var; + + return $this; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on update and delete requests to + * ensure that the client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The creation time. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The last-modified time. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. Resource labels. + * + * Generated from protobuf field map labels = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. Resource annotations. + * + * Generated from protobuf field map annotations = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Resource display name. + * + * Generated from protobuf field string display_name = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt their event data. + * It must match the pattern + * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getCryptoKeyName() + { + return $this->crypto_key_name; + } + + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt their event data. + * It must match the pattern + * `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setCryptoKeyName($var) + { + GPBUtil::checkString($var, True); + $this->crypto_key_name = $var; + + return $this; + } + + /** + * Optional. Config to control Platform logging for the Message Bus. This log + * configuration is applied to the Message Bus itself, and all the Enrollments + * attached to it. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\LoggingConfig|null + */ + public function getLoggingConfig() + { + return $this->logging_config; + } + + public function hasLoggingConfig() + { + return isset($this->logging_config); + } + + public function clearLoggingConfig() + { + unset($this->logging_config); + } + + /** + * Optional. Config to control Platform logging for the Message Bus. This log + * configuration is applied to the Message Bus itself, and all the Enrollments + * attached to it. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\LoggingConfig $var + * @return $this + */ + public function setLoggingConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\LoggingConfig::class); + $this->logging_config = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/NetworkConfig.php b/Eventarc/src/V1/NetworkConfig.php new file mode 100644 index 000000000000..715d1d668793 --- /dev/null +++ b/Eventarc/src/V1/NetworkConfig.php @@ -0,0 +1,75 @@ +google.cloud.eventarc.v1.NetworkConfig + */ +class NetworkConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the NetworkAttachment that allows access to the + * customer's VPC. Format: + * `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}` + * + * Generated from protobuf field string network_attachment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $network_attachment = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $network_attachment + * Required. Name of the NetworkAttachment that allows access to the + * customer's VPC. Format: + * `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\NetworkConfig::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the NetworkAttachment that allows access to the + * customer's VPC. Format: + * `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}` + * + * Generated from protobuf field string network_attachment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getNetworkAttachment() + { + return $this->network_attachment; + } + + /** + * Required. Name of the NetworkAttachment that allows access to the + * customer's VPC. Format: + * `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}` + * + * Generated from protobuf field string network_attachment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setNetworkAttachment($var) + { + GPBUtil::checkString($var, True); + $this->network_attachment = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/OperationMetadata.php b/Eventarc/src/V1/OperationMetadata.php index 5e68aca2f8c3..bb3d67a302da 100644 --- a/Eventarc/src/V1/OperationMetadata.php +++ b/Eventarc/src/V1/OperationMetadata.php @@ -48,8 +48,9 @@ class OperationMetadata extends \Google\Protobuf\Internal\Message /** * Output only. Identifies whether the user has requested cancellation * of the operation. Operations that have successfully been cancelled - * have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, - * corresponding to `Code.CANCELLED`. + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. * * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -80,8 +81,9 @@ class OperationMetadata extends \Google\Protobuf\Internal\Message * @type bool $requested_cancellation * Output only. Identifies whether the user has requested cancellation * of the operation. Operations that have successfully been cancelled - * have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, - * corresponding to `Code.CANCELLED`. + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. * @type string $api_version * Output only. API version used to start the operation. * } @@ -244,8 +246,9 @@ public function setStatusMessage($var) /** * Output only. Identifies whether the user has requested cancellation * of the operation. Operations that have successfully been cancelled - * have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, - * corresponding to `Code.CANCELLED`. + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. * * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return bool @@ -258,8 +261,9 @@ public function getRequestedCancellation() /** * Output only. Identifies whether the user has requested cancellation * of the operation. Operations that have successfully been cancelled - * have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, - * corresponding to `Code.CANCELLED`. + * have [Operation.error][] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + * `Code.CANCELLED`. * * Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param bool $var diff --git a/Eventarc/src/V1/Pipeline.php b/Eventarc/src/V1/Pipeline.php new file mode 100644 index 000000000000..28217c019e05 --- /dev/null +++ b/Eventarc/src/V1/Pipeline.php @@ -0,0 +1,667 @@ +google.cloud.eventarc.v1.Pipeline + */ +class Pipeline extends \Google\Protobuf\Internal\Message +{ + /** + * Identifier. The resource name of the Pipeline. Must be unique within the + * location of the project and must be in + * `projects/{project}/locations/{location}/pipelines/{pipeline}` format. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. The creation time. + * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up + * to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and + * "2014-10-02T15:01:23.045123456Z". + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The last-modified time. + * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up + * to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and + * "2014-10-02T15:01:23.045123456Z". + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. User labels attached to the Pipeline that can be used to group + * resources. An object containing a list of "key": value pairs. Example: { + * "name": "wrench", "mass": "1.3kg", "count": "3" }. + * + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Output only. Server-assigned unique identifier for the Pipeline. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + */ + protected $uid = ''; + /** + * Optional. User-defined annotations. See + * https://google.aip.dev/128#annotations. + * + * Generated from protobuf field map annotations = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $annotations; + /** + * Optional. Display name of resource. + * + * Generated from protobuf field string display_name = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $display_name = ''; + /** + * Required. List of destinations to which messages will be forwarded. + * Currently, exactly one destination is supported per Pipeline. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline.Destination destinations = 8 [(.google.api.field_behavior) = REQUIRED]; + */ + private $destinations; + /** + * Optional. List of mediation operations to be performed on the message. + * Currently, only one Transformation operation is allowed in each Pipeline. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline.Mediation mediations = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $mediations; + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt the event data. If not set, an internal Google-owned key + * will be used to encrypt messages. It must match the pattern + * "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}". + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $crypto_key_name = ''; + /** + * Optional. The payload format expected for the messages received by the + * Pipeline. If input_payload_format is set then any messages not matching + * this format will be treated as persistent errors. If input_payload_format + * is not set, then the message data will be treated as an opaque binary and + * no output format can be set on the Pipeline through the + * Pipeline.Destination.output_payload_format field. Any Mediations on the + * Pipeline that involve access to the data field will fail as persistent + * errors. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat input_payload_format = 11 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $input_payload_format = null; + /** + * Optional. Config to control Platform Logging for Pipelines. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $logging_config = null; + /** + * Optional. The retry policy to use in the pipeline. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.RetryPolicy retry_policy = 13 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $retry_policy = null; + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on create requests to ensure that the + * client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 99; + */ + protected $etag = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Identifier. The resource name of the Pipeline. Must be unique within the + * location of the project and must be in + * `projects/{project}/locations/{location}/pipelines/{pipeline}` format. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The creation time. + * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up + * to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and + * "2014-10-02T15:01:23.045123456Z". + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The last-modified time. + * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up + * to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and + * "2014-10-02T15:01:23.045123456Z". + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. User labels attached to the Pipeline that can be used to group + * resources. An object containing a list of "key": value pairs. Example: { + * "name": "wrench", "mass": "1.3kg", "count": "3" }. + * @type string $uid + * Output only. Server-assigned unique identifier for the Pipeline. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * @type array|\Google\Protobuf\Internal\MapField $annotations + * Optional. User-defined annotations. See + * https://google.aip.dev/128#annotations. + * @type string $display_name + * Optional. Display name of resource. + * @type array<\Google\Cloud\Eventarc\V1\Pipeline\Destination>|\Google\Protobuf\Internal\RepeatedField $destinations + * Required. List of destinations to which messages will be forwarded. + * Currently, exactly one destination is supported per Pipeline. + * @type array<\Google\Cloud\Eventarc\V1\Pipeline\Mediation>|\Google\Protobuf\Internal\RepeatedField $mediations + * Optional. List of mediation operations to be performed on the message. + * Currently, only one Transformation operation is allowed in each Pipeline. + * @type string $crypto_key_name + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt the event data. If not set, an internal Google-owned key + * will be used to encrypt messages. It must match the pattern + * "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}". + * @type \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat $input_payload_format + * Optional. The payload format expected for the messages received by the + * Pipeline. If input_payload_format is set then any messages not matching + * this format will be treated as persistent errors. If input_payload_format + * is not set, then the message data will be treated as an opaque binary and + * no output format can be set on the Pipeline through the + * Pipeline.Destination.output_payload_format field. Any Mediations on the + * Pipeline that involve access to the data field will fail as persistent + * errors. + * @type \Google\Cloud\Eventarc\V1\LoggingConfig $logging_config + * Optional. Config to control Platform Logging for Pipelines. + * @type \Google\Cloud\Eventarc\V1\Pipeline\RetryPolicy $retry_policy + * Optional. The retry policy to use in the pipeline. + * @type string $etag + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on create requests to ensure that the + * client has an up-to-date value before proceeding. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Identifier. The resource name of the Pipeline. Must be unique within the + * location of the project and must be in + * `projects/{project}/locations/{location}/pipelines/{pipeline}` format. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Identifier. The resource name of the Pipeline. Must be unique within the + * location of the project and must be in + * `projects/{project}/locations/{location}/pipelines/{pipeline}` format. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. The creation time. + * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up + * to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and + * "2014-10-02T15:01:23.045123456Z". + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The creation time. + * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up + * to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and + * "2014-10-02T15:01:23.045123456Z". + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The last-modified time. + * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up + * to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and + * "2014-10-02T15:01:23.045123456Z". + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The last-modified time. + * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up + * to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and + * "2014-10-02T15:01:23.045123456Z". + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. User labels attached to the Pipeline that can be used to group + * resources. An object containing a list of "key": value pairs. Example: { + * "name": "wrench", "mass": "1.3kg", "count": "3" }. + * + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. User labels attached to the Pipeline that can be used to group + * resources. An object containing a list of "key": value pairs. Example: { + * "name": "wrench", "mass": "1.3kg", "count": "3" }. + * + * Generated from protobuf field map labels = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Output only. Server-assigned unique identifier for the Pipeline. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @return string + */ + public function getUid() + { + return $this->uid; + } + + /** + * Output only. Server-assigned unique identifier for the Pipeline. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. + * + * Generated from protobuf field string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setUid($var) + { + GPBUtil::checkString($var, True); + $this->uid = $var; + + return $this; + } + + /** + * Optional. User-defined annotations. See + * https://google.aip.dev/128#annotations. + * + * Generated from protobuf field map annotations = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAnnotations() + { + return $this->annotations; + } + + /** + * Optional. User-defined annotations. See + * https://google.aip.dev/128#annotations. + * + * Generated from protobuf field map annotations = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAnnotations($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->annotations = $arr; + + return $this; + } + + /** + * Optional. Display name of resource. + * + * Generated from protobuf field string display_name = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * Optional. Display name of resource. + * + * Generated from protobuf field string display_name = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Required. List of destinations to which messages will be forwarded. + * Currently, exactly one destination is supported per Pipeline. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline.Destination destinations = 8 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDestinations() + { + return $this->destinations; + } + + /** + * Required. List of destinations to which messages will be forwarded. + * Currently, exactly one destination is supported per Pipeline. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline.Destination destinations = 8 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Cloud\Eventarc\V1\Pipeline\Destination>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDestinations($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Eventarc\V1\Pipeline\Destination::class); + $this->destinations = $arr; + + return $this; + } + + /** + * Optional. List of mediation operations to be performed on the message. + * Currently, only one Transformation operation is allowed in each Pipeline. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline.Mediation mediations = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMediations() + { + return $this->mediations; + } + + /** + * Optional. List of mediation operations to be performed on the message. + * Currently, only one Transformation operation is allowed in each Pipeline. + * + * Generated from protobuf field repeated .google.cloud.eventarc.v1.Pipeline.Mediation mediations = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Eventarc\V1\Pipeline\Mediation>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMediations($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Eventarc\V1\Pipeline\Mediation::class); + $this->mediations = $arr; + + return $this; + } + + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt the event data. If not set, an internal Google-owned key + * will be used to encrypt messages. It must match the pattern + * "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}". + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getCryptoKeyName() + { + return $this->crypto_key_name; + } + + /** + * Optional. Resource name of a KMS crypto key (managed by the user) used to + * encrypt/decrypt the event data. If not set, an internal Google-owned key + * will be used to encrypt messages. It must match the pattern + * "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}". + * + * Generated from protobuf field string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setCryptoKeyName($var) + { + GPBUtil::checkString($var, True); + $this->crypto_key_name = $var; + + return $this; + } + + /** + * Optional. The payload format expected for the messages received by the + * Pipeline. If input_payload_format is set then any messages not matching + * this format will be treated as persistent errors. If input_payload_format + * is not set, then the message data will be treated as an opaque binary and + * no output format can be set on the Pipeline through the + * Pipeline.Destination.output_payload_format field. Any Mediations on the + * Pipeline that involve access to the data field will fail as persistent + * errors. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat input_payload_format = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat|null + */ + public function getInputPayloadFormat() + { + return $this->input_payload_format; + } + + public function hasInputPayloadFormat() + { + return isset($this->input_payload_format); + } + + public function clearInputPayloadFormat() + { + unset($this->input_payload_format); + } + + /** + * Optional. The payload format expected for the messages received by the + * Pipeline. If input_payload_format is set then any messages not matching + * this format will be treated as persistent errors. If input_payload_format + * is not set, then the message data will be treated as an opaque binary and + * no output format can be set on the Pipeline through the + * Pipeline.Destination.output_payload_format field. Any Mediations on the + * Pipeline that involve access to the data field will fail as persistent + * errors. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat input_payload_format = 11 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat $var + * @return $this + */ + public function setInputPayloadFormat($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat::class); + $this->input_payload_format = $var; + + return $this; + } + + /** + * Optional. Config to control Platform Logging for Pipelines. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\LoggingConfig|null + */ + public function getLoggingConfig() + { + return $this->logging_config; + } + + public function hasLoggingConfig() + { + return isset($this->logging_config); + } + + public function clearLoggingConfig() + { + unset($this->logging_config); + } + + /** + * Optional. Config to control Platform Logging for Pipelines. + * + * Generated from protobuf field .google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\LoggingConfig $var + * @return $this + */ + public function setLoggingConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\LoggingConfig::class); + $this->logging_config = $var; + + return $this; + } + + /** + * Optional. The retry policy to use in the pipeline. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.RetryPolicy retry_policy = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\RetryPolicy|null + */ + public function getRetryPolicy() + { + return $this->retry_policy; + } + + public function hasRetryPolicy() + { + return isset($this->retry_policy); + } + + public function clearRetryPolicy() + { + unset($this->retry_policy); + } + + /** + * Optional. The retry policy to use in the pipeline. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.RetryPolicy retry_policy = 13 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\RetryPolicy $var + * @return $this + */ + public function setRetryPolicy($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\RetryPolicy::class); + $this->retry_policy = $var; + + return $this; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on create requests to ensure that the + * client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 99; + * @return string + */ + public function getEtag() + { + return $this->etag; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on create requests to ensure that the + * client has an up-to-date value before proceeding. + * + * Generated from protobuf field string etag = 99; + * @param string $var + * @return $this + */ + public function setEtag($var) + { + GPBUtil::checkString($var, True); + $this->etag = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/Pipeline/Destination.php b/Eventarc/src/V1/Pipeline/Destination.php new file mode 100644 index 000000000000..3ca75ce13faf --- /dev/null +++ b/Eventarc/src/V1/Pipeline/Destination.php @@ -0,0 +1,375 @@ +google.cloud.eventarc.v1.Pipeline.Destination + */ +class Destination extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Network config is used to configure how Pipeline resolves and + * connects to a destination. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.NetworkConfig network_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $network_config = null; + /** + * Optional. An authentication config used to authenticate message requests, + * such that destinations can verify the source. For example, this can be + * used with private GCP destinations that require GCP credentials to access + * like Cloud Run. This field is optional and should be set only by users + * interested in authenticated push + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig authentication_config = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $authentication_config = null; + /** + * Optional. The message format before it is delivered to the destination. + * If not set, the message will be delivered in the format it was originally + * delivered to the Pipeline. This field can only be set if + * Pipeline.input_payload_format is also set. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat output_payload_format = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $output_payload_format = null; + protected $destination_descriptor; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Eventarc\V1\Pipeline\Destination\NetworkConfig $network_config + * Optional. Network config is used to configure how Pipeline resolves and + * connects to a destination. + * @type \Google\Cloud\Eventarc\V1\Pipeline\Destination\HttpEndpoint $http_endpoint + * Optional. An HTTP endpoint destination described by an URI. + * If a DNS FQDN is provided as the endpoint, Pipeline will create a + * peering zone to the consumer VPC and forward DNS requests to the VPC + * specified by network config to resolve the service endpoint. See: + * https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones + * @type string $workflow + * Optional. The resource name of the Workflow whose Executions are + * triggered by the events. The Workflow resource should be deployed in + * the same project as the Pipeline. Format: + * `projects/{project}/locations/{location}/workflows/{workflow}` + * @type string $message_bus + * Optional. The resource name of the Message Bus to which events should + * be published. The Message Bus resource should exist in the same project + * as the Pipeline. Format: + * `projects/{project}/locations/{location}/messageBuses/{message_bus}` + * @type string $topic + * Optional. The resource name of the Pub/Sub topic to which events should + * be published. Format: + * `projects/{project}/locations/{location}/topics/{topic}` + * @type \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig $authentication_config + * Optional. An authentication config used to authenticate message requests, + * such that destinations can verify the source. For example, this can be + * used with private GCP destinations that require GCP credentials to access + * like Cloud Run. This field is optional and should be set only by users + * interested in authenticated push + * @type \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat $output_payload_format + * Optional. The message format before it is delivered to the destination. + * If not set, the message will be delivered in the format it was originally + * delivered to the Pipeline. This field can only be set if + * Pipeline.input_payload_format is also set. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Network config is used to configure how Pipeline resolves and + * connects to a destination. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.NetworkConfig network_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\Destination\NetworkConfig|null + */ + public function getNetworkConfig() + { + return $this->network_config; + } + + public function hasNetworkConfig() + { + return isset($this->network_config); + } + + public function clearNetworkConfig() + { + unset($this->network_config); + } + + /** + * Optional. Network config is used to configure how Pipeline resolves and + * connects to a destination. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.NetworkConfig network_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\Destination\NetworkConfig $var + * @return $this + */ + public function setNetworkConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\Destination\NetworkConfig::class); + $this->network_config = $var; + + return $this; + } + + /** + * Optional. An HTTP endpoint destination described by an URI. + * If a DNS FQDN is provided as the endpoint, Pipeline will create a + * peering zone to the consumer VPC and forward DNS requests to the VPC + * specified by network config to resolve the service endpoint. See: + * https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.HttpEndpoint http_endpoint = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\Destination\HttpEndpoint|null + */ + public function getHttpEndpoint() + { + return $this->readOneof(2); + } + + public function hasHttpEndpoint() + { + return $this->hasOneof(2); + } + + /** + * Optional. An HTTP endpoint destination described by an URI. + * If a DNS FQDN is provided as the endpoint, Pipeline will create a + * peering zone to the consumer VPC and forward DNS requests to the VPC + * specified by network config to resolve the service endpoint. See: + * https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.HttpEndpoint http_endpoint = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\Destination\HttpEndpoint $var + * @return $this + */ + public function setHttpEndpoint($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\Destination\HttpEndpoint::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Optional. The resource name of the Workflow whose Executions are + * triggered by the events. The Workflow resource should be deployed in + * the same project as the Pipeline. Format: + * `projects/{project}/locations/{location}/workflows/{workflow}` + * + * Generated from protobuf field string workflow = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getWorkflow() + { + return $this->readOneof(3); + } + + public function hasWorkflow() + { + return $this->hasOneof(3); + } + + /** + * Optional. The resource name of the Workflow whose Executions are + * triggered by the events. The Workflow resource should be deployed in + * the same project as the Pipeline. Format: + * `projects/{project}/locations/{location}/workflows/{workflow}` + * + * Generated from protobuf field string workflow = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setWorkflow($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Optional. The resource name of the Message Bus to which events should + * be published. The Message Bus resource should exist in the same project + * as the Pipeline. Format: + * `projects/{project}/locations/{location}/messageBuses/{message_bus}` + * + * Generated from protobuf field string message_bus = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getMessageBus() + { + return $this->readOneof(4); + } + + public function hasMessageBus() + { + return $this->hasOneof(4); + } + + /** + * Optional. The resource name of the Message Bus to which events should + * be published. The Message Bus resource should exist in the same project + * as the Pipeline. Format: + * `projects/{project}/locations/{location}/messageBuses/{message_bus}` + * + * Generated from protobuf field string message_bus = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setMessageBus($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * Optional. The resource name of the Pub/Sub topic to which events should + * be published. Format: + * `projects/{project}/locations/{location}/topics/{topic}` + * + * Generated from protobuf field string topic = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getTopic() + { + return $this->readOneof(8); + } + + public function hasTopic() + { + return $this->hasOneof(8); + } + + /** + * Optional. The resource name of the Pub/Sub topic to which events should + * be published. Format: + * `projects/{project}/locations/{location}/topics/{topic}` + * + * Generated from protobuf field string topic = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setTopic($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(8, $var); + + return $this; + } + + /** + * Optional. An authentication config used to authenticate message requests, + * such that destinations can verify the source. For example, this can be + * used with private GCP destinations that require GCP credentials to access + * like Cloud Run. This field is optional and should be set only by users + * interested in authenticated push + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig authentication_config = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig|null + */ + public function getAuthenticationConfig() + { + return $this->authentication_config; + } + + public function hasAuthenticationConfig() + { + return isset($this->authentication_config); + } + + public function clearAuthenticationConfig() + { + unset($this->authentication_config); + } + + /** + * Optional. An authentication config used to authenticate message requests, + * such that destinations can verify the source. For example, this can be + * used with private GCP destinations that require GCP credentials to access + * like Cloud Run. This field is optional and should be set only by users + * interested in authenticated push + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig authentication_config = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig $var + * @return $this + */ + public function setAuthenticationConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig::class); + $this->authentication_config = $var; + + return $this; + } + + /** + * Optional. The message format before it is delivered to the destination. + * If not set, the message will be delivered in the format it was originally + * delivered to the Pipeline. This field can only be set if + * Pipeline.input_payload_format is also set. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat output_payload_format = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat|null + */ + public function getOutputPayloadFormat() + { + return $this->output_payload_format; + } + + public function hasOutputPayloadFormat() + { + return isset($this->output_payload_format); + } + + public function clearOutputPayloadFormat() + { + unset($this->output_payload_format); + } + + /** + * Optional. The message format before it is delivered to the destination. + * If not set, the message will be delivered in the format it was originally + * delivered to the Pipeline. This field can only be set if + * Pipeline.input_payload_format is also set. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat output_payload_format = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat $var + * @return $this + */ + public function setOutputPayloadFormat($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat::class); + $this->output_payload_format = $var; + + return $this; + } + + /** + * @return string + */ + public function getDestinationDescriptor() + { + return $this->whichOneof("destination_descriptor"); + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig.php b/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig.php new file mode 100644 index 000000000000..5bba2ffb9e28 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig.php @@ -0,0 +1,127 @@ +google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig + */ +class AuthenticationConfig extends \Google\Protobuf\Internal\Message +{ + protected $authentication_method_descriptor; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig\OidcToken $google_oidc + * Optional. This authenticate method will apply Google OIDC tokens + * signed by a GCP service account to the requests. + * @type \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig\OAuthToken $oauth_token + * Optional. If specified, an [OAuth + * token](https://developers.google.com/identity/protocols/OAuth2) will + * be generated and attached as an `Authorization` header in the HTTP + * request. + * This type of authorization should generally only be used when calling + * Google APIs hosted on *.googleapis.com. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Optional. This authenticate method will apply Google OIDC tokens + * signed by a GCP service account to the requests. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OidcToken google_oidc = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig\OidcToken|null + */ + public function getGoogleOidc() + { + return $this->readOneof(1); + } + + public function hasGoogleOidc() + { + return $this->hasOneof(1); + } + + /** + * Optional. This authenticate method will apply Google OIDC tokens + * signed by a GCP service account to the requests. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OidcToken google_oidc = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig\OidcToken $var + * @return $this + */ + public function setGoogleOidc($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig\OidcToken::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * Optional. If specified, an [OAuth + * token](https://developers.google.com/identity/protocols/OAuth2) will + * be generated and attached as an `Authorization` header in the HTTP + * request. + * This type of authorization should generally only be used when calling + * Google APIs hosted on *.googleapis.com. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OAuthToken oauth_token = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig\OAuthToken|null + */ + public function getOauthToken() + { + return $this->readOneof(2); + } + + public function hasOauthToken() + { + return $this->hasOneof(2); + } + + /** + * Optional. If specified, an [OAuth + * token](https://developers.google.com/identity/protocols/OAuth2) will + * be generated and attached as an `Authorization` header in the HTTP + * request. + * This type of authorization should generally only be used when calling + * Google APIs hosted on *.googleapis.com. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OAuthToken oauth_token = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig\OAuthToken $var + * @return $this + */ + public function setOauthToken($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig\OAuthToken::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * @return string + */ + public function getAuthenticationMethodDescriptor() + { + return $this->whichOneof("authentication_method_descriptor"); + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig/OAuthToken.php b/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig/OAuthToken.php new file mode 100644 index 000000000000..323b00a3ab69 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig/OAuthToken.php @@ -0,0 +1,141 @@ +google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OAuthToken + */ +class OAuthToken extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Service account email used to generate the [OAuth + * token](https://developers.google.com/identity/protocols/OAuth2). + * The principal who calls this API must have + * iam.serviceAccounts.actAs permission in the service account. See + * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common + * for more information. Eventarc service agents must have + * roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline + * to create OAuth2 tokens for authenticated requests. + * + * Generated from protobuf field string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $service_account = ''; + /** + * Optional. OAuth scope to be used for generating OAuth access token. + * If not specified, "https://www.googleapis.com/auth/cloud-platform" + * will be used. + * + * Generated from protobuf field string scope = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $scope = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $service_account + * Required. Service account email used to generate the [OAuth + * token](https://developers.google.com/identity/protocols/OAuth2). + * The principal who calls this API must have + * iam.serviceAccounts.actAs permission in the service account. See + * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common + * for more information. Eventarc service agents must have + * roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline + * to create OAuth2 tokens for authenticated requests. + * @type string $scope + * Optional. OAuth scope to be used for generating OAuth access token. + * If not specified, "https://www.googleapis.com/auth/cloud-platform" + * will be used. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Required. Service account email used to generate the [OAuth + * token](https://developers.google.com/identity/protocols/OAuth2). + * The principal who calls this API must have + * iam.serviceAccounts.actAs permission in the service account. See + * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common + * for more information. Eventarc service agents must have + * roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline + * to create OAuth2 tokens for authenticated requests. + * + * Generated from protobuf field string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getServiceAccount() + { + return $this->service_account; + } + + /** + * Required. Service account email used to generate the [OAuth + * token](https://developers.google.com/identity/protocols/OAuth2). + * The principal who calls this API must have + * iam.serviceAccounts.actAs permission in the service account. See + * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common + * for more information. Eventarc service agents must have + * roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline + * to create OAuth2 tokens for authenticated requests. + * + * Generated from protobuf field string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->service_account = $var; + + return $this; + } + + /** + * Optional. OAuth scope to be used for generating OAuth access token. + * If not specified, "https://www.googleapis.com/auth/cloud-platform" + * will be used. + * + * Generated from protobuf field string scope = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getScope() + { + return $this->scope; + } + + /** + * Optional. OAuth scope to be used for generating OAuth access token. + * If not specified, "https://www.googleapis.com/auth/cloud-platform" + * will be used. + * + * Generated from protobuf field string scope = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setScope($var) + { + GPBUtil::checkString($var, True); + $this->scope = $var; + + return $this; + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig/OidcToken.php b/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig/OidcToken.php new file mode 100644 index 000000000000..db97a3e1f937 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/Destination/AuthenticationConfig/OidcToken.php @@ -0,0 +1,137 @@ +google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OidcToken + */ +class OidcToken extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Service account email used to generate the OIDC Token. + * The principal who calls this API must have + * iam.serviceAccounts.actAs permission in the service account. See + * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common + * for more information. Eventarc service agents must have + * roles/roles/iam.serviceAccountTokenCreator role to allow the + * Pipeline to create OpenID tokens for authenticated requests. + * + * Generated from protobuf field string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $service_account = ''; + /** + * Optional. Audience to be used to generate the OIDC Token. The + * audience claim identifies the recipient that the JWT is intended for. + * If unspecified, the destination URI will be used. + * + * Generated from protobuf field string audience = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $audience = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $service_account + * Required. Service account email used to generate the OIDC Token. + * The principal who calls this API must have + * iam.serviceAccounts.actAs permission in the service account. See + * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common + * for more information. Eventarc service agents must have + * roles/roles/iam.serviceAccountTokenCreator role to allow the + * Pipeline to create OpenID tokens for authenticated requests. + * @type string $audience + * Optional. Audience to be used to generate the OIDC Token. The + * audience claim identifies the recipient that the JWT is intended for. + * If unspecified, the destination URI will be used. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Required. Service account email used to generate the OIDC Token. + * The principal who calls this API must have + * iam.serviceAccounts.actAs permission in the service account. See + * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common + * for more information. Eventarc service agents must have + * roles/roles/iam.serviceAccountTokenCreator role to allow the + * Pipeline to create OpenID tokens for authenticated requests. + * + * Generated from protobuf field string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getServiceAccount() + { + return $this->service_account; + } + + /** + * Required. Service account email used to generate the OIDC Token. + * The principal who calls this API must have + * iam.serviceAccounts.actAs permission in the service account. See + * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common + * for more information. Eventarc service agents must have + * roles/roles/iam.serviceAccountTokenCreator role to allow the + * Pipeline to create OpenID tokens for authenticated requests. + * + * Generated from protobuf field string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->service_account = $var; + + return $this; + } + + /** + * Optional. Audience to be used to generate the OIDC Token. The + * audience claim identifies the recipient that the JWT is intended for. + * If unspecified, the destination URI will be used. + * + * Generated from protobuf field string audience = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getAudience() + { + return $this->audience; + } + + /** + * Optional. Audience to be used to generate the OIDC Token. The + * audience claim identifies the recipient that the JWT is intended for. + * If unspecified, the destination URI will be used. + * + * Generated from protobuf field string audience = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setAudience($var) + { + GPBUtil::checkString($var, True); + $this->audience = $var; + + return $this; + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/Destination/HttpEndpoint.php b/Eventarc/src/V1/Pipeline/Destination/HttpEndpoint.php new file mode 100644 index 000000000000..c7900af14d5c --- /dev/null +++ b/Eventarc/src/V1/Pipeline/Destination/HttpEndpoint.php @@ -0,0 +1,738 @@ +google.cloud.eventarc.v1.Pipeline.Destination.HttpEndpoint + */ +class HttpEndpoint extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The URI of the HTTP enpdoint. + * The value must be a RFC2396 URI string. + * Examples: `https://svc.us-central1.p.local:8080/route`. + * Only the HTTPS protocol is supported. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $uri = ''; + /** + * Optional. The CEL expression used to modify how the destination-bound + * HTTP request is constructed. + * If a binding expression is not specified here, the message + * is treated as a CloudEvent and is mapped to the HTTP request according + * to the CloudEvent HTTP Protocol Binding Binary Content Mode. In this + * representation, all fields except the `data` and `datacontenttype` + * field on the message are mapped to HTTP request headers with a prefix + * of `ce-`. + * To construct the HTTP request payload and the value of the content-type + * HTTP header, the payload format is defined as follows: + * 1) Use the output_payload_format_type on the Pipeline.Destination if it + * is set, else: + * 2) Use the input_payload_format_type on the Pipeline if it is set, + * else: + * 3) Treat the payload as opaque binary data. + * The `data` field of the message is converted to the payload format or + * left as-is for case 3) and then attached as the payload of the HTTP + * request. The `content-type` header on the HTTP request is set to the + * payload format type or left empty for case 3). However, if a mediation + * has updated the `datacontenttype` field on the message so that it is + * not the same as the payload format type but it is still a prefix of the + * payload format type, then the `content-type` header on the HTTP request + * is set to this `datacontenttype` value. For example, if the + * `datacontenttype` is "application/json" and the payload format type is + * "application/json; charset=utf-8", then the `content-type` header on + * the HTTP request is set to "application/json; charset=utf-8". + * If a non-empty binding expression is specified then this expression is + * used to modify the default CloudEvent HTTP Protocol Binding Binary + * Content representation. + * The result of the CEL expression must be a map of key/value pairs + * which is used as follows: + * - If a map named `headers` exists on the result of the expression, + * then its key/value pairs are directly mapped to the HTTP request + * headers. The headers values are constructed from the corresponding + * value type’s canonical representation. If the `headers` field doesn’t + * exist then the resulting HTTP request will be the headers of the + * CloudEvent HTTP Binding Binary Content Mode representation of the final + * message. Note: If the specified binding expression, has updated the + * `datacontenttype` field on the message so that it is not the same as + * the payload format type but it is still a prefix of the payload format + * type, then the `content-type` header in the `headers` map is set to + * this `datacontenttype` value. + * - If a field named `body` exists on the result of the expression then + * its value is directly mapped to the body of the request. If the value + * of the `body` field is of type bytes or string then it is used for + * the HTTP request body as-is, with no conversion. If the body field is + * of any other type then it is converted to a JSON string. If the body + * field does not exist then the resulting payload of the HTTP request + * will be data value of the CloudEvent HTTP Binding Binary Content Mode + * representation of the final message as described earlier. + * - Any other fields in the resulting expression will be ignored. + * The CEL expression may access the incoming CloudEvent message in its + * definition, as follows: + * - The `data` field of the incoming CloudEvent message can be accessed + * using the `message.data` value. Subfields of `message.data` may also be + * accessed if an input_payload_format has been specified on the Pipeline. + * - Each attribute of the incoming CloudEvent message can be accessed + * using the `message.` value, where is replaced with the + * name of the attribute. + * - Existing headers can be accessed in the CEL expression using the + * `headers` variable. The `headers` variable defines a map of key/value + * pairs corresponding to the HTTP headers of the CloudEvent HTTP Binding + * Binary Content Mode representation of the final message as described + * earlier. For example, the following CEL expression can be used to + * construct an HTTP request by adding an additional header to the HTTP + * headers of the CloudEvent HTTP Binding Binary Content Mode + * representation of the final message and by overwriting the body of the + * request: + * ``` + * { + * "headers": headers.merge({"new-header-key": "new-header-value"}), + * "body": "new-body" + * } + * ``` + * Additionally, the following CEL extension functions are provided for + * use in this CEL expression: + * - toBase64Url: + * map.toBase64Url() -> string + * - Converts a CelValue to a base64url encoded string + * - toJsonString: map.toJsonString() -> string + * - Converts a CelValue to a JSON string + * - merge: + * map1.merge(map2) -> map3 + * - Merges the passed CEL map with the existing CEL map the + * function is applied to. + * - If the same key exists in both maps, if the key's value is type + * map both maps are merged else the value from the passed map is + * used. + * - denormalize: + * map.denormalize() -> map + * - Denormalizes a CEL map such that every value of type map or key + * in the map is expanded to return a single level map. + * - The resulting keys are "." separated indices of the map keys. + * - For example: + * { + * "a": 1, + * "b": { + * "c": 2, + * "d": 3 + * } + * "e": [4, 5] + * } + * .denormalize() + * -> { + * "a": 1, + * "b.c": 2, + * "b.d": 3, + * "e.0": 4, + * "e.1": 5 + * } + * - setField: + * map.setField(key, value) -> message + * - Sets the field of the message with the given key to the + * given value. + * - If the field is not present it will be added. + * - If the field is present it will be overwritten. + * - The key can be a dot separated path to set a field in a nested + * message. + * - Key must be of type string. + * - Value may be any valid type. + * - removeFields: + * map.removeFields([key1, key2, ...]) -> message + * - Removes the fields of the map with the given keys. + * - The keys can be a dot separated path to remove a field in a + * nested message. + * - If a key is not found it will be ignored. + * - Keys must be of type string. + * - toMap: + * [map1, map2, ...].toMap() -> map + * - Converts a CEL list of CEL maps to a single CEL map + * - toDestinationPayloadFormat(): + * message.data.toDestinationPayloadFormat() -> string or bytes + * - Converts the message data to the destination payload format + * specified in Pipeline.Destination.output_payload_format + * - This function is meant to be applied to the message.data field. + * - If the destination payload format is not set, the function will + * return the message data unchanged. + * - toCloudEventJsonWithPayloadFormat: + * message.toCloudEventJsonWithPayloadFormat() -> map + * - Converts a message to the corresponding structure of JSON + * format for CloudEvents + * - This function applies toDestinationPayloadFormat() to the + * message data. It also sets the corresponding datacontenttype of + * the CloudEvent, as indicated by + * Pipeline.Destination.output_payload_format. If no + * output_payload_format is set it will use the existing + * datacontenttype on the CloudEvent if present, else leave + * datacontenttype absent. + * - This function expects that the content of the message will + * adhere to the standard CloudEvent format. If it doesn’t then this + * function will fail. + * - The result is a CEL map that corresponds to the JSON + * representation of the CloudEvent. To convert that data to a JSON + * string it can be chained with the toJsonString function. + * The Pipeline expects that the message it receives adheres to the + * standard CloudEvent format. If it doesn’t then the outgoing message + * request may fail with a persistent error. + * + * Generated from protobuf field string message_binding_template = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $message_binding_template = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * Required. The URI of the HTTP enpdoint. + * The value must be a RFC2396 URI string. + * Examples: `https://svc.us-central1.p.local:8080/route`. + * Only the HTTPS protocol is supported. + * @type string $message_binding_template + * Optional. The CEL expression used to modify how the destination-bound + * HTTP request is constructed. + * If a binding expression is not specified here, the message + * is treated as a CloudEvent and is mapped to the HTTP request according + * to the CloudEvent HTTP Protocol Binding Binary Content Mode. In this + * representation, all fields except the `data` and `datacontenttype` + * field on the message are mapped to HTTP request headers with a prefix + * of `ce-`. + * To construct the HTTP request payload and the value of the content-type + * HTTP header, the payload format is defined as follows: + * 1) Use the output_payload_format_type on the Pipeline.Destination if it + * is set, else: + * 2) Use the input_payload_format_type on the Pipeline if it is set, + * else: + * 3) Treat the payload as opaque binary data. + * The `data` field of the message is converted to the payload format or + * left as-is for case 3) and then attached as the payload of the HTTP + * request. The `content-type` header on the HTTP request is set to the + * payload format type or left empty for case 3). However, if a mediation + * has updated the `datacontenttype` field on the message so that it is + * not the same as the payload format type but it is still a prefix of the + * payload format type, then the `content-type` header on the HTTP request + * is set to this `datacontenttype` value. For example, if the + * `datacontenttype` is "application/json" and the payload format type is + * "application/json; charset=utf-8", then the `content-type` header on + * the HTTP request is set to "application/json; charset=utf-8". + * If a non-empty binding expression is specified then this expression is + * used to modify the default CloudEvent HTTP Protocol Binding Binary + * Content representation. + * The result of the CEL expression must be a map of key/value pairs + * which is used as follows: + * - If a map named `headers` exists on the result of the expression, + * then its key/value pairs are directly mapped to the HTTP request + * headers. The headers values are constructed from the corresponding + * value type’s canonical representation. If the `headers` field doesn’t + * exist then the resulting HTTP request will be the headers of the + * CloudEvent HTTP Binding Binary Content Mode representation of the final + * message. Note: If the specified binding expression, has updated the + * `datacontenttype` field on the message so that it is not the same as + * the payload format type but it is still a prefix of the payload format + * type, then the `content-type` header in the `headers` map is set to + * this `datacontenttype` value. + * - If a field named `body` exists on the result of the expression then + * its value is directly mapped to the body of the request. If the value + * of the `body` field is of type bytes or string then it is used for + * the HTTP request body as-is, with no conversion. If the body field is + * of any other type then it is converted to a JSON string. If the body + * field does not exist then the resulting payload of the HTTP request + * will be data value of the CloudEvent HTTP Binding Binary Content Mode + * representation of the final message as described earlier. + * - Any other fields in the resulting expression will be ignored. + * The CEL expression may access the incoming CloudEvent message in its + * definition, as follows: + * - The `data` field of the incoming CloudEvent message can be accessed + * using the `message.data` value. Subfields of `message.data` may also be + * accessed if an input_payload_format has been specified on the Pipeline. + * - Each attribute of the incoming CloudEvent message can be accessed + * using the `message.` value, where is replaced with the + * name of the attribute. + * - Existing headers can be accessed in the CEL expression using the + * `headers` variable. The `headers` variable defines a map of key/value + * pairs corresponding to the HTTP headers of the CloudEvent HTTP Binding + * Binary Content Mode representation of the final message as described + * earlier. For example, the following CEL expression can be used to + * construct an HTTP request by adding an additional header to the HTTP + * headers of the CloudEvent HTTP Binding Binary Content Mode + * representation of the final message and by overwriting the body of the + * request: + * ``` + * { + * "headers": headers.merge({"new-header-key": "new-header-value"}), + * "body": "new-body" + * } + * ``` + * Additionally, the following CEL extension functions are provided for + * use in this CEL expression: + * - toBase64Url: + * map.toBase64Url() -> string + * - Converts a CelValue to a base64url encoded string + * - toJsonString: map.toJsonString() -> string + * - Converts a CelValue to a JSON string + * - merge: + * map1.merge(map2) -> map3 + * - Merges the passed CEL map with the existing CEL map the + * function is applied to. + * - If the same key exists in both maps, if the key's value is type + * map both maps are merged else the value from the passed map is + * used. + * - denormalize: + * map.denormalize() -> map + * - Denormalizes a CEL map such that every value of type map or key + * in the map is expanded to return a single level map. + * - The resulting keys are "." separated indices of the map keys. + * - For example: + * { + * "a": 1, + * "b": { + * "c": 2, + * "d": 3 + * } + * "e": [4, 5] + * } + * .denormalize() + * -> { + * "a": 1, + * "b.c": 2, + * "b.d": 3, + * "e.0": 4, + * "e.1": 5 + * } + * - setField: + * map.setField(key, value) -> message + * - Sets the field of the message with the given key to the + * given value. + * - If the field is not present it will be added. + * - If the field is present it will be overwritten. + * - The key can be a dot separated path to set a field in a nested + * message. + * - Key must be of type string. + * - Value may be any valid type. + * - removeFields: + * map.removeFields([key1, key2, ...]) -> message + * - Removes the fields of the map with the given keys. + * - The keys can be a dot separated path to remove a field in a + * nested message. + * - If a key is not found it will be ignored. + * - Keys must be of type string. + * - toMap: + * [map1, map2, ...].toMap() -> map + * - Converts a CEL list of CEL maps to a single CEL map + * - toDestinationPayloadFormat(): + * message.data.toDestinationPayloadFormat() -> string or bytes + * - Converts the message data to the destination payload format + * specified in Pipeline.Destination.output_payload_format + * - This function is meant to be applied to the message.data field. + * - If the destination payload format is not set, the function will + * return the message data unchanged. + * - toCloudEventJsonWithPayloadFormat: + * message.toCloudEventJsonWithPayloadFormat() -> map + * - Converts a message to the corresponding structure of JSON + * format for CloudEvents + * - This function applies toDestinationPayloadFormat() to the + * message data. It also sets the corresponding datacontenttype of + * the CloudEvent, as indicated by + * Pipeline.Destination.output_payload_format. If no + * output_payload_format is set it will use the existing + * datacontenttype on the CloudEvent if present, else leave + * datacontenttype absent. + * - This function expects that the content of the message will + * adhere to the standard CloudEvent format. If it doesn’t then this + * function will fail. + * - The result is a CEL map that corresponds to the JSON + * representation of the CloudEvent. To convert that data to a JSON + * string it can be chained with the toJsonString function. + * The Pipeline expects that the message it receives adheres to the + * standard CloudEvent format. If it doesn’t then the outgoing message + * request may fail with a persistent error. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Required. The URI of the HTTP enpdoint. + * The value must be a RFC2396 URI string. + * Examples: `https://svc.us-central1.p.local:8080/route`. + * Only the HTTPS protocol is supported. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * Required. The URI of the HTTP enpdoint. + * The value must be a RFC2396 URI string. + * Examples: `https://svc.us-central1.p.local:8080/route`. + * Only the HTTPS protocol is supported. + * + * Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + + /** + * Optional. The CEL expression used to modify how the destination-bound + * HTTP request is constructed. + * If a binding expression is not specified here, the message + * is treated as a CloudEvent and is mapped to the HTTP request according + * to the CloudEvent HTTP Protocol Binding Binary Content Mode. In this + * representation, all fields except the `data` and `datacontenttype` + * field on the message are mapped to HTTP request headers with a prefix + * of `ce-`. + * To construct the HTTP request payload and the value of the content-type + * HTTP header, the payload format is defined as follows: + * 1) Use the output_payload_format_type on the Pipeline.Destination if it + * is set, else: + * 2) Use the input_payload_format_type on the Pipeline if it is set, + * else: + * 3) Treat the payload as opaque binary data. + * The `data` field of the message is converted to the payload format or + * left as-is for case 3) and then attached as the payload of the HTTP + * request. The `content-type` header on the HTTP request is set to the + * payload format type or left empty for case 3). However, if a mediation + * has updated the `datacontenttype` field on the message so that it is + * not the same as the payload format type but it is still a prefix of the + * payload format type, then the `content-type` header on the HTTP request + * is set to this `datacontenttype` value. For example, if the + * `datacontenttype` is "application/json" and the payload format type is + * "application/json; charset=utf-8", then the `content-type` header on + * the HTTP request is set to "application/json; charset=utf-8". + * If a non-empty binding expression is specified then this expression is + * used to modify the default CloudEvent HTTP Protocol Binding Binary + * Content representation. + * The result of the CEL expression must be a map of key/value pairs + * which is used as follows: + * - If a map named `headers` exists on the result of the expression, + * then its key/value pairs are directly mapped to the HTTP request + * headers. The headers values are constructed from the corresponding + * value type’s canonical representation. If the `headers` field doesn’t + * exist then the resulting HTTP request will be the headers of the + * CloudEvent HTTP Binding Binary Content Mode representation of the final + * message. Note: If the specified binding expression, has updated the + * `datacontenttype` field on the message so that it is not the same as + * the payload format type but it is still a prefix of the payload format + * type, then the `content-type` header in the `headers` map is set to + * this `datacontenttype` value. + * - If a field named `body` exists on the result of the expression then + * its value is directly mapped to the body of the request. If the value + * of the `body` field is of type bytes or string then it is used for + * the HTTP request body as-is, with no conversion. If the body field is + * of any other type then it is converted to a JSON string. If the body + * field does not exist then the resulting payload of the HTTP request + * will be data value of the CloudEvent HTTP Binding Binary Content Mode + * representation of the final message as described earlier. + * - Any other fields in the resulting expression will be ignored. + * The CEL expression may access the incoming CloudEvent message in its + * definition, as follows: + * - The `data` field of the incoming CloudEvent message can be accessed + * using the `message.data` value. Subfields of `message.data` may also be + * accessed if an input_payload_format has been specified on the Pipeline. + * - Each attribute of the incoming CloudEvent message can be accessed + * using the `message.` value, where is replaced with the + * name of the attribute. + * - Existing headers can be accessed in the CEL expression using the + * `headers` variable. The `headers` variable defines a map of key/value + * pairs corresponding to the HTTP headers of the CloudEvent HTTP Binding + * Binary Content Mode representation of the final message as described + * earlier. For example, the following CEL expression can be used to + * construct an HTTP request by adding an additional header to the HTTP + * headers of the CloudEvent HTTP Binding Binary Content Mode + * representation of the final message and by overwriting the body of the + * request: + * ``` + * { + * "headers": headers.merge({"new-header-key": "new-header-value"}), + * "body": "new-body" + * } + * ``` + * Additionally, the following CEL extension functions are provided for + * use in this CEL expression: + * - toBase64Url: + * map.toBase64Url() -> string + * - Converts a CelValue to a base64url encoded string + * - toJsonString: map.toJsonString() -> string + * - Converts a CelValue to a JSON string + * - merge: + * map1.merge(map2) -> map3 + * - Merges the passed CEL map with the existing CEL map the + * function is applied to. + * - If the same key exists in both maps, if the key's value is type + * map both maps are merged else the value from the passed map is + * used. + * - denormalize: + * map.denormalize() -> map + * - Denormalizes a CEL map such that every value of type map or key + * in the map is expanded to return a single level map. + * - The resulting keys are "." separated indices of the map keys. + * - For example: + * { + * "a": 1, + * "b": { + * "c": 2, + * "d": 3 + * } + * "e": [4, 5] + * } + * .denormalize() + * -> { + * "a": 1, + * "b.c": 2, + * "b.d": 3, + * "e.0": 4, + * "e.1": 5 + * } + * - setField: + * map.setField(key, value) -> message + * - Sets the field of the message with the given key to the + * given value. + * - If the field is not present it will be added. + * - If the field is present it will be overwritten. + * - The key can be a dot separated path to set a field in a nested + * message. + * - Key must be of type string. + * - Value may be any valid type. + * - removeFields: + * map.removeFields([key1, key2, ...]) -> message + * - Removes the fields of the map with the given keys. + * - The keys can be a dot separated path to remove a field in a + * nested message. + * - If a key is not found it will be ignored. + * - Keys must be of type string. + * - toMap: + * [map1, map2, ...].toMap() -> map + * - Converts a CEL list of CEL maps to a single CEL map + * - toDestinationPayloadFormat(): + * message.data.toDestinationPayloadFormat() -> string or bytes + * - Converts the message data to the destination payload format + * specified in Pipeline.Destination.output_payload_format + * - This function is meant to be applied to the message.data field. + * - If the destination payload format is not set, the function will + * return the message data unchanged. + * - toCloudEventJsonWithPayloadFormat: + * message.toCloudEventJsonWithPayloadFormat() -> map + * - Converts a message to the corresponding structure of JSON + * format for CloudEvents + * - This function applies toDestinationPayloadFormat() to the + * message data. It also sets the corresponding datacontenttype of + * the CloudEvent, as indicated by + * Pipeline.Destination.output_payload_format. If no + * output_payload_format is set it will use the existing + * datacontenttype on the CloudEvent if present, else leave + * datacontenttype absent. + * - This function expects that the content of the message will + * adhere to the standard CloudEvent format. If it doesn’t then this + * function will fail. + * - The result is a CEL map that corresponds to the JSON + * representation of the CloudEvent. To convert that data to a JSON + * string it can be chained with the toJsonString function. + * The Pipeline expects that the message it receives adheres to the + * standard CloudEvent format. If it doesn’t then the outgoing message + * request may fail with a persistent error. + * + * Generated from protobuf field string message_binding_template = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getMessageBindingTemplate() + { + return $this->message_binding_template; + } + + /** + * Optional. The CEL expression used to modify how the destination-bound + * HTTP request is constructed. + * If a binding expression is not specified here, the message + * is treated as a CloudEvent and is mapped to the HTTP request according + * to the CloudEvent HTTP Protocol Binding Binary Content Mode. In this + * representation, all fields except the `data` and `datacontenttype` + * field on the message are mapped to HTTP request headers with a prefix + * of `ce-`. + * To construct the HTTP request payload and the value of the content-type + * HTTP header, the payload format is defined as follows: + * 1) Use the output_payload_format_type on the Pipeline.Destination if it + * is set, else: + * 2) Use the input_payload_format_type on the Pipeline if it is set, + * else: + * 3) Treat the payload as opaque binary data. + * The `data` field of the message is converted to the payload format or + * left as-is for case 3) and then attached as the payload of the HTTP + * request. The `content-type` header on the HTTP request is set to the + * payload format type or left empty for case 3). However, if a mediation + * has updated the `datacontenttype` field on the message so that it is + * not the same as the payload format type but it is still a prefix of the + * payload format type, then the `content-type` header on the HTTP request + * is set to this `datacontenttype` value. For example, if the + * `datacontenttype` is "application/json" and the payload format type is + * "application/json; charset=utf-8", then the `content-type` header on + * the HTTP request is set to "application/json; charset=utf-8". + * If a non-empty binding expression is specified then this expression is + * used to modify the default CloudEvent HTTP Protocol Binding Binary + * Content representation. + * The result of the CEL expression must be a map of key/value pairs + * which is used as follows: + * - If a map named `headers` exists on the result of the expression, + * then its key/value pairs are directly mapped to the HTTP request + * headers. The headers values are constructed from the corresponding + * value type’s canonical representation. If the `headers` field doesn’t + * exist then the resulting HTTP request will be the headers of the + * CloudEvent HTTP Binding Binary Content Mode representation of the final + * message. Note: If the specified binding expression, has updated the + * `datacontenttype` field on the message so that it is not the same as + * the payload format type but it is still a prefix of the payload format + * type, then the `content-type` header in the `headers` map is set to + * this `datacontenttype` value. + * - If a field named `body` exists on the result of the expression then + * its value is directly mapped to the body of the request. If the value + * of the `body` field is of type bytes or string then it is used for + * the HTTP request body as-is, with no conversion. If the body field is + * of any other type then it is converted to a JSON string. If the body + * field does not exist then the resulting payload of the HTTP request + * will be data value of the CloudEvent HTTP Binding Binary Content Mode + * representation of the final message as described earlier. + * - Any other fields in the resulting expression will be ignored. + * The CEL expression may access the incoming CloudEvent message in its + * definition, as follows: + * - The `data` field of the incoming CloudEvent message can be accessed + * using the `message.data` value. Subfields of `message.data` may also be + * accessed if an input_payload_format has been specified on the Pipeline. + * - Each attribute of the incoming CloudEvent message can be accessed + * using the `message.` value, where is replaced with the + * name of the attribute. + * - Existing headers can be accessed in the CEL expression using the + * `headers` variable. The `headers` variable defines a map of key/value + * pairs corresponding to the HTTP headers of the CloudEvent HTTP Binding + * Binary Content Mode representation of the final message as described + * earlier. For example, the following CEL expression can be used to + * construct an HTTP request by adding an additional header to the HTTP + * headers of the CloudEvent HTTP Binding Binary Content Mode + * representation of the final message and by overwriting the body of the + * request: + * ``` + * { + * "headers": headers.merge({"new-header-key": "new-header-value"}), + * "body": "new-body" + * } + * ``` + * Additionally, the following CEL extension functions are provided for + * use in this CEL expression: + * - toBase64Url: + * map.toBase64Url() -> string + * - Converts a CelValue to a base64url encoded string + * - toJsonString: map.toJsonString() -> string + * - Converts a CelValue to a JSON string + * - merge: + * map1.merge(map2) -> map3 + * - Merges the passed CEL map with the existing CEL map the + * function is applied to. + * - If the same key exists in both maps, if the key's value is type + * map both maps are merged else the value from the passed map is + * used. + * - denormalize: + * map.denormalize() -> map + * - Denormalizes a CEL map such that every value of type map or key + * in the map is expanded to return a single level map. + * - The resulting keys are "." separated indices of the map keys. + * - For example: + * { + * "a": 1, + * "b": { + * "c": 2, + * "d": 3 + * } + * "e": [4, 5] + * } + * .denormalize() + * -> { + * "a": 1, + * "b.c": 2, + * "b.d": 3, + * "e.0": 4, + * "e.1": 5 + * } + * - setField: + * map.setField(key, value) -> message + * - Sets the field of the message with the given key to the + * given value. + * - If the field is not present it will be added. + * - If the field is present it will be overwritten. + * - The key can be a dot separated path to set a field in a nested + * message. + * - Key must be of type string. + * - Value may be any valid type. + * - removeFields: + * map.removeFields([key1, key2, ...]) -> message + * - Removes the fields of the map with the given keys. + * - The keys can be a dot separated path to remove a field in a + * nested message. + * - If a key is not found it will be ignored. + * - Keys must be of type string. + * - toMap: + * [map1, map2, ...].toMap() -> map + * - Converts a CEL list of CEL maps to a single CEL map + * - toDestinationPayloadFormat(): + * message.data.toDestinationPayloadFormat() -> string or bytes + * - Converts the message data to the destination payload format + * specified in Pipeline.Destination.output_payload_format + * - This function is meant to be applied to the message.data field. + * - If the destination payload format is not set, the function will + * return the message data unchanged. + * - toCloudEventJsonWithPayloadFormat: + * message.toCloudEventJsonWithPayloadFormat() -> map + * - Converts a message to the corresponding structure of JSON + * format for CloudEvents + * - This function applies toDestinationPayloadFormat() to the + * message data. It also sets the corresponding datacontenttype of + * the CloudEvent, as indicated by + * Pipeline.Destination.output_payload_format. If no + * output_payload_format is set it will use the existing + * datacontenttype on the CloudEvent if present, else leave + * datacontenttype absent. + * - This function expects that the content of the message will + * adhere to the standard CloudEvent format. If it doesn’t then this + * function will fail. + * - The result is a CEL map that corresponds to the JSON + * representation of the CloudEvent. To convert that data to a JSON + * string it can be chained with the toJsonString function. + * The Pipeline expects that the message it receives adheres to the + * standard CloudEvent format. If it doesn’t then the outgoing message + * request may fail with a persistent error. + * + * Generated from protobuf field string message_binding_template = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setMessageBindingTemplate($var) + { + GPBUtil::checkString($var, True); + $this->message_binding_template = $var; + + return $this; + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/Destination/NetworkConfig.php b/Eventarc/src/V1/Pipeline/Destination/NetworkConfig.php new file mode 100644 index 000000000000..eaede052b443 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/Destination/NetworkConfig.php @@ -0,0 +1,77 @@ +google.cloud.eventarc.v1.Pipeline.Destination.NetworkConfig + */ +class NetworkConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Name of the NetworkAttachment that allows access to the + * consumer VPC. Format: + * `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}` + * + * Generated from protobuf field string network_attachment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $network_attachment = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $network_attachment + * Required. Name of the NetworkAttachment that allows access to the + * consumer VPC. Format: + * `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Required. Name of the NetworkAttachment that allows access to the + * consumer VPC. Format: + * `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}` + * + * Generated from protobuf field string network_attachment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getNetworkAttachment() + { + return $this->network_attachment; + } + + /** + * Required. Name of the NetworkAttachment that allows access to the + * consumer VPC. Format: + * `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}` + * + * Generated from protobuf field string network_attachment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setNetworkAttachment($var) + { + GPBUtil::checkString($var, True); + $this->network_attachment = $var; + + return $this; + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/Mediation.php b/Eventarc/src/V1/Pipeline/Mediation.php new file mode 100644 index 000000000000..026629778c07 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/Mediation.php @@ -0,0 +1,76 @@ +google.cloud.eventarc.v1.Pipeline.Mediation + */ +class Mediation extends \Google\Protobuf\Internal\Message +{ + protected $mediation_descriptor; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Eventarc\V1\Pipeline\Mediation\Transformation $transformation + * Optional. How the Pipeline is to transform messages + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Optional. How the Pipeline is to transform messages + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Mediation.Transformation transformation = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\Mediation\Transformation|null + */ + public function getTransformation() + { + return $this->readOneof(1); + } + + public function hasTransformation() + { + return $this->hasOneof(1); + } + + /** + * Optional. How the Pipeline is to transform messages + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.Mediation.Transformation transformation = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\Mediation\Transformation $var + * @return $this + */ + public function setTransformation($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\Mediation\Transformation::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * @return string + */ + public function getMediationDescriptor() + { + return $this->whichOneof("mediation_descriptor"); + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/Mediation/Transformation.php b/Eventarc/src/V1/Pipeline/Mediation/Transformation.php new file mode 100644 index 000000000000..7c4ad3d64610 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/Mediation/Transformation.php @@ -0,0 +1,368 @@ +google.cloud.eventarc.v1.Pipeline.Mediation.Transformation + */ +class Transformation extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The CEL expression template to apply to transform messages. + * The following CEL extension functions are provided for + * use in this CEL expression: + * - merge: + * map1.merge(map2) -> map3 + * - Merges the passed CEL map with the existing CEL map the + * function is applied to. + * - If the same key exists in both maps, if the key's value is type + * map both maps are merged else the value from the passed map is + * used. + * - denormalize: + * map.denormalize() -> map + * - Denormalizes a CEL map such that every value of type map or key + * in the map is expanded to return a single level map. + * - The resulting keys are "." separated indices of the map keys. + * - For example: + * { + * "a": 1, + * "b": { + * "c": 2, + * "d": 3 + * } + * "e": [4, 5] + * } + * .denormalize() + * -> { + * "a": 1, + * "b.c": 2, + * "b.d": 3, + * "e.0": 4, + * "e.1": 5 + * } + * - setField: + * map.setField(key, value) -> message + * - Sets the field of the message with the given key to the + * given value. + * - If the field is not present it will be added. + * - If the field is present it will be overwritten. + * - The key can be a dot separated path to set a field in a nested + * message. + * - Key must be of type string. + * - Value may be any valid type. + * - removeFields: + * map.removeFields([key1, key2, ...]) -> message + * - Removes the fields of the map with the given keys. + * - The keys can be a dot separated path to remove a field in a + * nested message. + * - If a key is not found it will be ignored. + * - Keys must be of type string. + * - toMap: + * [map1, map2, ...].toMap() -> map + * - Converts a CEL list of CEL maps to a single CEL map + * - toDestinationPayloadFormat(): + * message.data.toDestinationPayloadFormat() -> string or bytes + * - Converts the message data to the destination payload format + * specified in Pipeline.Destination.output_payload_format + * - This function is meant to be applied to the message.data field. + * - If the destination payload format is not set, the function will + * return the message data unchanged. + * - toCloudEventJsonWithPayloadFormat: + * message.toCloudEventJsonWithPayloadFormat() -> map + * - Converts a message to the corresponding structure of JSON + * format for CloudEvents + * - This function applies toDestinationPayloadFormat() to the + * message data. It also sets the corresponding datacontenttype of + * the CloudEvent, as indicated by + * Pipeline.Destination.output_payload_format. If no + * output_payload_format is set it will use the existing + * datacontenttype on the CloudEvent if present, else leave + * datacontenttype absent. + * - This function expects that the content of the message will + * adhere to the standard CloudEvent format. If it doesn’t then this + * function will fail. + * - The result is a CEL map that corresponds to the JSON + * representation of the CloudEvent. To convert that data to a JSON + * string it can be chained with the toJsonString function. + * + * Generated from protobuf field string transformation_template = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $transformation_template = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $transformation_template + * Optional. The CEL expression template to apply to transform messages. + * The following CEL extension functions are provided for + * use in this CEL expression: + * - merge: + * map1.merge(map2) -> map3 + * - Merges the passed CEL map with the existing CEL map the + * function is applied to. + * - If the same key exists in both maps, if the key's value is type + * map both maps are merged else the value from the passed map is + * used. + * - denormalize: + * map.denormalize() -> map + * - Denormalizes a CEL map such that every value of type map or key + * in the map is expanded to return a single level map. + * - The resulting keys are "." separated indices of the map keys. + * - For example: + * { + * "a": 1, + * "b": { + * "c": 2, + * "d": 3 + * } + * "e": [4, 5] + * } + * .denormalize() + * -> { + * "a": 1, + * "b.c": 2, + * "b.d": 3, + * "e.0": 4, + * "e.1": 5 + * } + * - setField: + * map.setField(key, value) -> message + * - Sets the field of the message with the given key to the + * given value. + * - If the field is not present it will be added. + * - If the field is present it will be overwritten. + * - The key can be a dot separated path to set a field in a nested + * message. + * - Key must be of type string. + * - Value may be any valid type. + * - removeFields: + * map.removeFields([key1, key2, ...]) -> message + * - Removes the fields of the map with the given keys. + * - The keys can be a dot separated path to remove a field in a + * nested message. + * - If a key is not found it will be ignored. + * - Keys must be of type string. + * - toMap: + * [map1, map2, ...].toMap() -> map + * - Converts a CEL list of CEL maps to a single CEL map + * - toDestinationPayloadFormat(): + * message.data.toDestinationPayloadFormat() -> string or bytes + * - Converts the message data to the destination payload format + * specified in Pipeline.Destination.output_payload_format + * - This function is meant to be applied to the message.data field. + * - If the destination payload format is not set, the function will + * return the message data unchanged. + * - toCloudEventJsonWithPayloadFormat: + * message.toCloudEventJsonWithPayloadFormat() -> map + * - Converts a message to the corresponding structure of JSON + * format for CloudEvents + * - This function applies toDestinationPayloadFormat() to the + * message data. It also sets the corresponding datacontenttype of + * the CloudEvent, as indicated by + * Pipeline.Destination.output_payload_format. If no + * output_payload_format is set it will use the existing + * datacontenttype on the CloudEvent if present, else leave + * datacontenttype absent. + * - This function expects that the content of the message will + * adhere to the standard CloudEvent format. If it doesn’t then this + * function will fail. + * - The result is a CEL map that corresponds to the JSON + * representation of the CloudEvent. To convert that data to a JSON + * string it can be chained with the toJsonString function. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The CEL expression template to apply to transform messages. + * The following CEL extension functions are provided for + * use in this CEL expression: + * - merge: + * map1.merge(map2) -> map3 + * - Merges the passed CEL map with the existing CEL map the + * function is applied to. + * - If the same key exists in both maps, if the key's value is type + * map both maps are merged else the value from the passed map is + * used. + * - denormalize: + * map.denormalize() -> map + * - Denormalizes a CEL map such that every value of type map or key + * in the map is expanded to return a single level map. + * - The resulting keys are "." separated indices of the map keys. + * - For example: + * { + * "a": 1, + * "b": { + * "c": 2, + * "d": 3 + * } + * "e": [4, 5] + * } + * .denormalize() + * -> { + * "a": 1, + * "b.c": 2, + * "b.d": 3, + * "e.0": 4, + * "e.1": 5 + * } + * - setField: + * map.setField(key, value) -> message + * - Sets the field of the message with the given key to the + * given value. + * - If the field is not present it will be added. + * - If the field is present it will be overwritten. + * - The key can be a dot separated path to set a field in a nested + * message. + * - Key must be of type string. + * - Value may be any valid type. + * - removeFields: + * map.removeFields([key1, key2, ...]) -> message + * - Removes the fields of the map with the given keys. + * - The keys can be a dot separated path to remove a field in a + * nested message. + * - If a key is not found it will be ignored. + * - Keys must be of type string. + * - toMap: + * [map1, map2, ...].toMap() -> map + * - Converts a CEL list of CEL maps to a single CEL map + * - toDestinationPayloadFormat(): + * message.data.toDestinationPayloadFormat() -> string or bytes + * - Converts the message data to the destination payload format + * specified in Pipeline.Destination.output_payload_format + * - This function is meant to be applied to the message.data field. + * - If the destination payload format is not set, the function will + * return the message data unchanged. + * - toCloudEventJsonWithPayloadFormat: + * message.toCloudEventJsonWithPayloadFormat() -> map + * - Converts a message to the corresponding structure of JSON + * format for CloudEvents + * - This function applies toDestinationPayloadFormat() to the + * message data. It also sets the corresponding datacontenttype of + * the CloudEvent, as indicated by + * Pipeline.Destination.output_payload_format. If no + * output_payload_format is set it will use the existing + * datacontenttype on the CloudEvent if present, else leave + * datacontenttype absent. + * - This function expects that the content of the message will + * adhere to the standard CloudEvent format. If it doesn’t then this + * function will fail. + * - The result is a CEL map that corresponds to the JSON + * representation of the CloudEvent. To convert that data to a JSON + * string it can be chained with the toJsonString function. + * + * Generated from protobuf field string transformation_template = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getTransformationTemplate() + { + return $this->transformation_template; + } + + /** + * Optional. The CEL expression template to apply to transform messages. + * The following CEL extension functions are provided for + * use in this CEL expression: + * - merge: + * map1.merge(map2) -> map3 + * - Merges the passed CEL map with the existing CEL map the + * function is applied to. + * - If the same key exists in both maps, if the key's value is type + * map both maps are merged else the value from the passed map is + * used. + * - denormalize: + * map.denormalize() -> map + * - Denormalizes a CEL map such that every value of type map or key + * in the map is expanded to return a single level map. + * - The resulting keys are "." separated indices of the map keys. + * - For example: + * { + * "a": 1, + * "b": { + * "c": 2, + * "d": 3 + * } + * "e": [4, 5] + * } + * .denormalize() + * -> { + * "a": 1, + * "b.c": 2, + * "b.d": 3, + * "e.0": 4, + * "e.1": 5 + * } + * - setField: + * map.setField(key, value) -> message + * - Sets the field of the message with the given key to the + * given value. + * - If the field is not present it will be added. + * - If the field is present it will be overwritten. + * - The key can be a dot separated path to set a field in a nested + * message. + * - Key must be of type string. + * - Value may be any valid type. + * - removeFields: + * map.removeFields([key1, key2, ...]) -> message + * - Removes the fields of the map with the given keys. + * - The keys can be a dot separated path to remove a field in a + * nested message. + * - If a key is not found it will be ignored. + * - Keys must be of type string. + * - toMap: + * [map1, map2, ...].toMap() -> map + * - Converts a CEL list of CEL maps to a single CEL map + * - toDestinationPayloadFormat(): + * message.data.toDestinationPayloadFormat() -> string or bytes + * - Converts the message data to the destination payload format + * specified in Pipeline.Destination.output_payload_format + * - This function is meant to be applied to the message.data field. + * - If the destination payload format is not set, the function will + * return the message data unchanged. + * - toCloudEventJsonWithPayloadFormat: + * message.toCloudEventJsonWithPayloadFormat() -> map + * - Converts a message to the corresponding structure of JSON + * format for CloudEvents + * - This function applies toDestinationPayloadFormat() to the + * message data. It also sets the corresponding datacontenttype of + * the CloudEvent, as indicated by + * Pipeline.Destination.output_payload_format. If no + * output_payload_format is set it will use the existing + * datacontenttype on the CloudEvent if present, else leave + * datacontenttype absent. + * - This function expects that the content of the message will + * adhere to the standard CloudEvent format. If it doesn’t then this + * function will fail. + * - The result is a CEL map that corresponds to the JSON + * representation of the CloudEvent. To convert that data to a JSON + * string it can be chained with the toJsonString function. + * + * Generated from protobuf field string transformation_template = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setTransformationTemplate($var) + { + GPBUtil::checkString($var, True); + $this->transformation_template = $var; + + return $this; + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/MessagePayloadFormat.php b/Eventarc/src/V1/Pipeline/MessagePayloadFormat.php new file mode 100644 index 000000000000..34a284ece569 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/MessagePayloadFormat.php @@ -0,0 +1,142 @@ +google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat + */ +class MessagePayloadFormat extends \Google\Protobuf\Internal\Message +{ + protected $kind; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\ProtobufFormat $protobuf + * Optional. Protobuf format. + * @type \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\AvroFormat $avro + * Optional. Avro format. + * @type \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\JsonFormat $json + * Optional. JSON format. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Protobuf format. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.ProtobufFormat protobuf = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\ProtobufFormat|null + */ + public function getProtobuf() + { + return $this->readOneof(1); + } + + public function hasProtobuf() + { + return $this->hasOneof(1); + } + + /** + * Optional. Protobuf format. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.ProtobufFormat protobuf = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\ProtobufFormat $var + * @return $this + */ + public function setProtobuf($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\ProtobufFormat::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * Optional. Avro format. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.AvroFormat avro = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\AvroFormat|null + */ + public function getAvro() + { + return $this->readOneof(2); + } + + public function hasAvro() + { + return $this->hasOneof(2); + } + + /** + * Optional. Avro format. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.AvroFormat avro = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\AvroFormat $var + * @return $this + */ + public function setAvro($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\AvroFormat::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Optional. JSON format. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.JsonFormat json = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\JsonFormat|null + */ + public function getJson() + { + return $this->readOneof(3); + } + + public function hasJson() + { + return $this->hasOneof(3); + } + + /** + * Optional. JSON format. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.JsonFormat json = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\JsonFormat $var + * @return $this + */ + public function setJson($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat\JsonFormat::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * @return string + */ + public function getKind() + { + return $this->whichOneof("kind"); + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/MessagePayloadFormat/AvroFormat.php b/Eventarc/src/V1/Pipeline/MessagePayloadFormat/AvroFormat.php new file mode 100644 index 000000000000..b992b9198ef6 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/MessagePayloadFormat/AvroFormat.php @@ -0,0 +1,68 @@ +google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.AvroFormat + */ +class AvroFormat extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The entire schema definition is stored in this field. + * + * Generated from protobuf field string schema_definition = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $schema_definition = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $schema_definition + * Optional. The entire schema definition is stored in this field. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The entire schema definition is stored in this field. + * + * Generated from protobuf field string schema_definition = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSchemaDefinition() + { + return $this->schema_definition; + } + + /** + * Optional. The entire schema definition is stored in this field. + * + * Generated from protobuf field string schema_definition = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSchemaDefinition($var) + { + GPBUtil::checkString($var, True); + $this->schema_definition = $var; + + return $this; + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/MessagePayloadFormat/JsonFormat.php b/Eventarc/src/V1/Pipeline/MessagePayloadFormat/JsonFormat.php new file mode 100644 index 000000000000..49534a82ce76 --- /dev/null +++ b/Eventarc/src/V1/Pipeline/MessagePayloadFormat/JsonFormat.php @@ -0,0 +1,34 @@ +google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.JsonFormat + */ +class JsonFormat extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/MessagePayloadFormat/ProtobufFormat.php b/Eventarc/src/V1/Pipeline/MessagePayloadFormat/ProtobufFormat.php new file mode 100644 index 000000000000..bdb6f706b7dc --- /dev/null +++ b/Eventarc/src/V1/Pipeline/MessagePayloadFormat/ProtobufFormat.php @@ -0,0 +1,68 @@ +google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat.ProtobufFormat + */ +class ProtobufFormat extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The entire schema definition is stored in this field. + * + * Generated from protobuf field string schema_definition = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $schema_definition = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $schema_definition + * Optional. The entire schema definition is stored in this field. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The entire schema definition is stored in this field. + * + * Generated from protobuf field string schema_definition = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSchemaDefinition() + { + return $this->schema_definition; + } + + /** + * Optional. The entire schema definition is stored in this field. + * + * Generated from protobuf field string schema_definition = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSchemaDefinition($var) + { + GPBUtil::checkString($var, True); + $this->schema_definition = $var; + + return $this; + } + +} + + diff --git a/Eventarc/src/V1/Pipeline/RetryPolicy.php b/Eventarc/src/V1/Pipeline/RetryPolicy.php new file mode 100644 index 000000000000..af44930dedca --- /dev/null +++ b/Eventarc/src/V1/Pipeline/RetryPolicy.php @@ -0,0 +1,183 @@ +google.cloud.eventarc.v1.Pipeline.RetryPolicy + */ +class RetryPolicy extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The maximum number of delivery attempts for any message. The + * value must be between 1 and 100. The default value for this field is 5. + * + * Generated from protobuf field int32 max_attempts = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $max_attempts = 0; + /** + * Optional. The minimum amount of seconds to wait between retry attempts. + * The value must be between 1 and 600. The default value for this field + * is 5. + * + * Generated from protobuf field .google.protobuf.Duration min_retry_delay = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $min_retry_delay = null; + /** + * Optional. The maximum amount of seconds to wait between retry attempts. + * The value must be between 1 and 600. The default value for this field + * is 60. + * + * Generated from protobuf field .google.protobuf.Duration max_retry_delay = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $max_retry_delay = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $max_attempts + * Optional. The maximum number of delivery attempts for any message. The + * value must be between 1 and 100. The default value for this field is 5. + * @type \Google\Protobuf\Duration $min_retry_delay + * Optional. The minimum amount of seconds to wait between retry attempts. + * The value must be between 1 and 600. The default value for this field + * is 5. + * @type \Google\Protobuf\Duration $max_retry_delay + * Optional. The maximum amount of seconds to wait between retry attempts. + * The value must be between 1 and 600. The default value for this field + * is 60. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Pipeline::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The maximum number of delivery attempts for any message. The + * value must be between 1 and 100. The default value for this field is 5. + * + * Generated from protobuf field int32 max_attempts = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getMaxAttempts() + { + return $this->max_attempts; + } + + /** + * Optional. The maximum number of delivery attempts for any message. The + * value must be between 1 and 100. The default value for this field is 5. + * + * Generated from protobuf field int32 max_attempts = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setMaxAttempts($var) + { + GPBUtil::checkInt32($var); + $this->max_attempts = $var; + + return $this; + } + + /** + * Optional. The minimum amount of seconds to wait between retry attempts. + * The value must be between 1 and 600. The default value for this field + * is 5. + * + * Generated from protobuf field .google.protobuf.Duration min_retry_delay = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Duration|null + */ + public function getMinRetryDelay() + { + return $this->min_retry_delay; + } + + public function hasMinRetryDelay() + { + return isset($this->min_retry_delay); + } + + public function clearMinRetryDelay() + { + unset($this->min_retry_delay); + } + + /** + * Optional. The minimum amount of seconds to wait between retry attempts. + * The value must be between 1 and 600. The default value for this field + * is 5. + * + * Generated from protobuf field .google.protobuf.Duration min_retry_delay = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setMinRetryDelay($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->min_retry_delay = $var; + + return $this; + } + + /** + * Optional. The maximum amount of seconds to wait between retry attempts. + * The value must be between 1 and 600. The default value for this field + * is 60. + * + * Generated from protobuf field .google.protobuf.Duration max_retry_delay = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Duration|null + */ + public function getMaxRetryDelay() + { + return $this->max_retry_delay; + } + + public function hasMaxRetryDelay() + { + return isset($this->max_retry_delay); + } + + public function clearMaxRetryDelay() + { + unset($this->max_retry_delay); + } + + /** + * Optional. The maximum amount of seconds to wait between retry attempts. + * The value must be between 1 and 600. The default value for this field + * is 60. + * + * Generated from protobuf field .google.protobuf.Duration max_retry_delay = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setMaxRetryDelay($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->max_retry_delay = $var; + + return $this; + } + +} + + diff --git a/Eventarc/src/V1/Provider.php b/Eventarc/src/V1/Provider.php index 2cab34dc5b9d..6afe5e7cb8af 100644 --- a/Eventarc/src/V1/Provider.php +++ b/Eventarc/src/V1/Provider.php @@ -16,14 +16,15 @@ class Provider extends \Google\Protobuf\Internal\Message { /** - * Output only. In `projects/{project}/locations/{location}/providers/{provider_id}` - * format. + * Output only. In + * `projects/{project}/locations/{location}/providers/{provider_id}` format. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $name = ''; /** - * Output only. Human friendly name for the Provider. For example "Cloud Storage". + * Output only. Human friendly name for the Provider. For example "Cloud + * Storage". * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -42,10 +43,11 @@ class Provider extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Output only. In `projects/{project}/locations/{location}/providers/{provider_id}` - * format. + * Output only. In + * `projects/{project}/locations/{location}/providers/{provider_id}` format. * @type string $display_name - * Output only. Human friendly name for the Provider. For example "Cloud Storage". + * Output only. Human friendly name for the Provider. For example "Cloud + * Storage". * @type array<\Google\Cloud\Eventarc\V1\EventType>|\Google\Protobuf\Internal\RepeatedField $event_types * Output only. Event types for this provider. * } @@ -56,8 +58,8 @@ public function __construct($data = NULL) { } /** - * Output only. In `projects/{project}/locations/{location}/providers/{provider_id}` - * format. + * Output only. In + * `projects/{project}/locations/{location}/providers/{provider_id}` format. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -68,8 +70,8 @@ public function getName() } /** - * Output only. In `projects/{project}/locations/{location}/providers/{provider_id}` - * format. + * Output only. In + * `projects/{project}/locations/{location}/providers/{provider_id}` format. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -84,7 +86,8 @@ public function setName($var) } /** - * Output only. Human friendly name for the Provider. For example "Cloud Storage". + * Output only. Human friendly name for the Provider. For example "Cloud + * Storage". * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -95,7 +98,8 @@ public function getDisplayName() } /** - * Output only. Human friendly name for the Provider. For example "Cloud Storage". + * Output only. Human friendly name for the Provider. For example "Cloud + * Storage". * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var diff --git a/Eventarc/src/V1/Pubsub.php b/Eventarc/src/V1/Pubsub.php index 438692870f62..651c38bc08f3 100644 --- a/Eventarc/src/V1/Pubsub.php +++ b/Eventarc/src/V1/Pubsub.php @@ -27,8 +27,8 @@ class Pubsub extends \Google\Protobuf\Internal\Message */ protected $topic = ''; /** - * Output only. The name of the Pub/Sub subscription created and managed by Eventarc - * as a transport for the event delivery. Format: + * Output only. The name of the Pub/Sub subscription created and managed by + * Eventarc as a transport for the event delivery. Format: * `projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}`. * * Generated from protobuf field string subscription = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -49,8 +49,8 @@ class Pubsub extends \Google\Protobuf\Internal\Message * `google.cloud.pubsub.topic.v1.messagePublished`. The topic you provide * here is not deleted by Eventarc at trigger deletion. * @type string $subscription - * Output only. The name of the Pub/Sub subscription created and managed by Eventarc - * as a transport for the event delivery. Format: + * Output only. The name of the Pub/Sub subscription created and managed by + * Eventarc as a transport for the event delivery. Format: * `projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}`. * } */ @@ -96,8 +96,8 @@ public function setTopic($var) } /** - * Output only. The name of the Pub/Sub subscription created and managed by Eventarc - * as a transport for the event delivery. Format: + * Output only. The name of the Pub/Sub subscription created and managed by + * Eventarc as a transport for the event delivery. Format: * `projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}`. * * Generated from protobuf field string subscription = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -109,8 +109,8 @@ public function getSubscription() } /** - * Output only. The name of the Pub/Sub subscription created and managed by Eventarc - * as a transport for the event delivery. Format: + * Output only. The name of the Pub/Sub subscription created and managed by + * Eventarc as a transport for the event delivery. Format: * `projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}`. * * Generated from protobuf field string subscription = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; diff --git a/Eventarc/src/V1/Trigger.php b/Eventarc/src/V1/Trigger.php index 144b812b9f05..9a7a92ad8544 100644 --- a/Eventarc/src/V1/Trigger.php +++ b/Eventarc/src/V1/Trigger.php @@ -16,16 +16,17 @@ class Trigger extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the trigger. Must be unique within the location of the - * project and must be in + * Required. The resource name of the trigger. Must be unique within the + * location of the project and must be in * `projects/{project}/locations/{location}/triggers/{trigger}` format. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $name = ''; /** - * Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 - * string and guaranteed to remain unchanged until the resource is deleted. + * Output only. Server-assigned unique identifier for the trigger. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -43,8 +44,9 @@ class Trigger extends \Google\Protobuf\Internal\Message */ protected $update_time = null; /** - * Required. Unordered list. The list of filters that applies to event attributes. Only events that - * match all the provided filters are sent to the destination. + * Required. Unordered list. The list of filters that applies to event + * attributes. Only events that match all the provided filters are sent to the + * destination. * * Generated from protobuf field repeated .google.cloud.eventarc.v1.EventFilter event_filters = 8 [(.google.api.field_behavior) = UNORDERED_LIST, (.google.api.field_behavior) = REQUIRED]; */ @@ -52,16 +54,11 @@ class Trigger extends \Google\Protobuf\Internal\Message /** * Optional. The IAM service account email associated with the trigger. The * service account represents the identity of the trigger. - * The principal who calls this API must have the `iam.serviceAccounts.actAs` - * permission in the service account. See - * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common - * for more information. - * For Cloud Run destinations, this service account is used to generate - * identity tokens when invoking the service. See - * https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account - * for information on how to invoke authenticated Cloud Run services. - * To create Audit Log triggers, the service account should also - * have the `roles/eventarc.eventReceiver` IAM role. + * The `iam.serviceAccounts.actAs` permission must be granted on the service + * account to allow a principal to impersonate the service account. For more + * information, see the + * [Roles and permissions](/eventarc/docs/all-roles-permissions) page specific + * to the trigger destination. * * Generated from protobuf field string service_account = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ @@ -73,7 +70,7 @@ class Trigger extends \Google\Protobuf\Internal\Message */ protected $destination = null; /** - * Optional. To deliver messages, Eventarc might use other GCP + * Optional. To deliver messages, Eventarc might use other Google Cloud * products as a transport intermediary. This field contains a reference to * that transport intermediary. This information can be used for debugging * purposes. @@ -82,7 +79,8 @@ class Trigger extends \Google\Protobuf\Internal\Message */ protected $transport = null; /** - * Optional. User labels attached to the triggers that can be used to group resources. + * Optional. User labels attached to the triggers that can be used to group + * resources. * * Generated from protobuf field map labels = 12 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -102,8 +100,23 @@ class Trigger extends \Google\Protobuf\Internal\Message */ private $conditions; /** - * Output only. This checksum is computed by the server based on the value of other - * fields, and might be sent only on create requests to ensure that the + * Optional. EventDataContentType specifies the type of payload in MIME + * format that is expected from the CloudEvent data field. This is set to + * `application/json` if the value is not defined. + * + * Generated from protobuf field string event_data_content_type = 16 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $event_data_content_type = ''; + /** + * Output only. Whether or not this Trigger satisfies the requirements of + * physical zone separation + * + * Generated from protobuf field bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $satisfies_pzs = false; + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on create requests to ensure that the * client has an up-to-date value before proceeding. * * Generated from protobuf field string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -117,50 +130,55 @@ class Trigger extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the trigger. Must be unique within the location of the - * project and must be in + * Required. The resource name of the trigger. Must be unique within the + * location of the project and must be in * `projects/{project}/locations/{location}/triggers/{trigger}` format. * @type string $uid - * Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 - * string and guaranteed to remain unchanged until the resource is deleted. + * Output only. Server-assigned unique identifier for the trigger. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. * @type \Google\Protobuf\Timestamp $create_time * Output only. The creation time. * @type \Google\Protobuf\Timestamp $update_time * Output only. The last-modified time. * @type array<\Google\Cloud\Eventarc\V1\EventFilter>|\Google\Protobuf\Internal\RepeatedField $event_filters - * Required. Unordered list. The list of filters that applies to event attributes. Only events that - * match all the provided filters are sent to the destination. + * Required. Unordered list. The list of filters that applies to event + * attributes. Only events that match all the provided filters are sent to the + * destination. * @type string $service_account * Optional. The IAM service account email associated with the trigger. The * service account represents the identity of the trigger. - * The principal who calls this API must have the `iam.serviceAccounts.actAs` - * permission in the service account. See - * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common - * for more information. - * For Cloud Run destinations, this service account is used to generate - * identity tokens when invoking the service. See - * https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account - * for information on how to invoke authenticated Cloud Run services. - * To create Audit Log triggers, the service account should also - * have the `roles/eventarc.eventReceiver` IAM role. + * The `iam.serviceAccounts.actAs` permission must be granted on the service + * account to allow a principal to impersonate the service account. For more + * information, see the + * [Roles and permissions](/eventarc/docs/all-roles-permissions) page specific + * to the trigger destination. * @type \Google\Cloud\Eventarc\V1\Destination $destination * Required. Destination specifies where the events should be sent to. * @type \Google\Cloud\Eventarc\V1\Transport $transport - * Optional. To deliver messages, Eventarc might use other GCP + * Optional. To deliver messages, Eventarc might use other Google Cloud * products as a transport intermediary. This field contains a reference to * that transport intermediary. This information can be used for debugging * purposes. * @type array|\Google\Protobuf\Internal\MapField $labels - * Optional. User labels attached to the triggers that can be used to group resources. + * Optional. User labels attached to the triggers that can be used to group + * resources. * @type string $channel * Optional. The name of the channel associated with the trigger in * `projects/{project}/locations/{location}/channels/{channel}` format. * You must provide a channel to receive events from Eventarc SaaS partners. * @type array|\Google\Protobuf\Internal\MapField $conditions * Output only. The reason(s) why a trigger is in FAILED state. + * @type string $event_data_content_type + * Optional. EventDataContentType specifies the type of payload in MIME + * format that is expected from the CloudEvent data field. This is set to + * `application/json` if the value is not defined. + * @type bool $satisfies_pzs + * Output only. Whether or not this Trigger satisfies the requirements of + * physical zone separation * @type string $etag - * Output only. This checksum is computed by the server based on the value of other - * fields, and might be sent only on create requests to ensure that the + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on create requests to ensure that the * client has an up-to-date value before proceeding. * } */ @@ -170,8 +188,8 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the trigger. Must be unique within the location of the - * project and must be in + * Required. The resource name of the trigger. Must be unique within the + * location of the project and must be in * `projects/{project}/locations/{location}/triggers/{trigger}` format. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -183,8 +201,8 @@ public function getName() } /** - * Required. The resource name of the trigger. Must be unique within the location of the - * project and must be in + * Required. The resource name of the trigger. Must be unique within the + * location of the project and must be in * `projects/{project}/locations/{location}/triggers/{trigger}` format. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -200,8 +218,9 @@ public function setName($var) } /** - * Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 - * string and guaranteed to remain unchanged until the resource is deleted. + * Output only. Server-assigned unique identifier for the trigger. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -212,8 +231,9 @@ public function getUid() } /** - * Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 - * string and guaranteed to remain unchanged until the resource is deleted. + * Output only. Server-assigned unique identifier for the trigger. The value + * is a UUID4 string and guaranteed to remain unchanged until the resource is + * deleted. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -300,8 +320,9 @@ public function setUpdateTime($var) } /** - * Required. Unordered list. The list of filters that applies to event attributes. Only events that - * match all the provided filters are sent to the destination. + * Required. Unordered list. The list of filters that applies to event + * attributes. Only events that match all the provided filters are sent to the + * destination. * * Generated from protobuf field repeated .google.cloud.eventarc.v1.EventFilter event_filters = 8 [(.google.api.field_behavior) = UNORDERED_LIST, (.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\Internal\RepeatedField @@ -312,8 +333,9 @@ public function getEventFilters() } /** - * Required. Unordered list. The list of filters that applies to event attributes. Only events that - * match all the provided filters are sent to the destination. + * Required. Unordered list. The list of filters that applies to event + * attributes. Only events that match all the provided filters are sent to the + * destination. * * Generated from protobuf field repeated .google.cloud.eventarc.v1.EventFilter event_filters = 8 [(.google.api.field_behavior) = UNORDERED_LIST, (.google.api.field_behavior) = REQUIRED]; * @param array<\Google\Cloud\Eventarc\V1\EventFilter>|\Google\Protobuf\Internal\RepeatedField $var @@ -330,16 +352,11 @@ public function setEventFilters($var) /** * Optional. The IAM service account email associated with the trigger. The * service account represents the identity of the trigger. - * The principal who calls this API must have the `iam.serviceAccounts.actAs` - * permission in the service account. See - * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common - * for more information. - * For Cloud Run destinations, this service account is used to generate - * identity tokens when invoking the service. See - * https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account - * for information on how to invoke authenticated Cloud Run services. - * To create Audit Log triggers, the service account should also - * have the `roles/eventarc.eventReceiver` IAM role. + * The `iam.serviceAccounts.actAs` permission must be granted on the service + * account to allow a principal to impersonate the service account. For more + * information, see the + * [Roles and permissions](/eventarc/docs/all-roles-permissions) page specific + * to the trigger destination. * * Generated from protobuf field string service_account = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string @@ -352,16 +369,11 @@ public function getServiceAccount() /** * Optional. The IAM service account email associated with the trigger. The * service account represents the identity of the trigger. - * The principal who calls this API must have the `iam.serviceAccounts.actAs` - * permission in the service account. See - * https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common - * for more information. - * For Cloud Run destinations, this service account is used to generate - * identity tokens when invoking the service. See - * https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account - * for information on how to invoke authenticated Cloud Run services. - * To create Audit Log triggers, the service account should also - * have the `roles/eventarc.eventReceiver` IAM role. + * The `iam.serviceAccounts.actAs` permission must be granted on the service + * account to allow a principal to impersonate the service account. For more + * information, see the + * [Roles and permissions](/eventarc/docs/all-roles-permissions) page specific + * to the trigger destination. * * Generated from protobuf field string service_account = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var @@ -412,7 +424,7 @@ public function setDestination($var) } /** - * Optional. To deliver messages, Eventarc might use other GCP + * Optional. To deliver messages, Eventarc might use other Google Cloud * products as a transport intermediary. This field contains a reference to * that transport intermediary. This information can be used for debugging * purposes. @@ -436,7 +448,7 @@ public function clearTransport() } /** - * Optional. To deliver messages, Eventarc might use other GCP + * Optional. To deliver messages, Eventarc might use other Google Cloud * products as a transport intermediary. This field contains a reference to * that transport intermediary. This information can be used for debugging * purposes. @@ -454,7 +466,8 @@ public function setTransport($var) } /** - * Optional. User labels attached to the triggers that can be used to group resources. + * Optional. User labels attached to the triggers that can be used to group + * resources. * * Generated from protobuf field map labels = 12 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField @@ -465,7 +478,8 @@ public function getLabels() } /** - * Optional. User labels attached to the triggers that can be used to group resources. + * Optional. User labels attached to the triggers that can be used to group + * resources. * * Generated from protobuf field map labels = 12 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var @@ -536,8 +550,66 @@ public function setConditions($var) } /** - * Output only. This checksum is computed by the server based on the value of other - * fields, and might be sent only on create requests to ensure that the + * Optional. EventDataContentType specifies the type of payload in MIME + * format that is expected from the CloudEvent data field. This is set to + * `application/json` if the value is not defined. + * + * Generated from protobuf field string event_data_content_type = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEventDataContentType() + { + return $this->event_data_content_type; + } + + /** + * Optional. EventDataContentType specifies the type of payload in MIME + * format that is expected from the CloudEvent data field. This is set to + * `application/json` if the value is not defined. + * + * Generated from protobuf field string event_data_content_type = 16 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEventDataContentType($var) + { + GPBUtil::checkString($var, True); + $this->event_data_content_type = $var; + + return $this; + } + + /** + * Output only. Whether or not this Trigger satisfies the requirements of + * physical zone separation + * + * Generated from protobuf field bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzs() + { + return $this->satisfies_pzs; + } + + /** + * Output only. Whether or not this Trigger satisfies the requirements of + * physical zone separation + * + * Generated from protobuf field bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + + /** + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on create requests to ensure that the * client has an up-to-date value before proceeding. * * Generated from protobuf field string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -549,8 +621,8 @@ public function getEtag() } /** - * Output only. This checksum is computed by the server based on the value of other - * fields, and might be sent only on create requests to ensure that the + * Output only. This checksum is computed by the server based on the value of + * other fields, and might be sent only on create requests to ensure that the * client has an up-to-date value before proceeding. * * Generated from protobuf field string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY]; diff --git a/Eventarc/src/V1/UpdateChannelRequest.php b/Eventarc/src/V1/UpdateChannelRequest.php index ebfe981eb675..3cee00e08c23 100644 --- a/Eventarc/src/V1/UpdateChannelRequest.php +++ b/Eventarc/src/V1/UpdateChannelRequest.php @@ -30,10 +30,10 @@ class UpdateChannelRequest extends \Google\Protobuf\Internal\Message */ protected $update_mask = null; /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; @@ -67,7 +67,7 @@ public static function build(\Google\Cloud\Eventarc\V1\Channel $channel, \Google * If no field mask is provided, all provided fields in the request are * updated. To update all fields, provide a field mask of "*". * @type bool $validate_only - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * } */ @@ -153,10 +153,10 @@ public function setUpdateMask($var) } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getValidateOnly() @@ -165,10 +165,10 @@ public function getValidateOnly() } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/Eventarc/src/V1/UpdateEnrollmentRequest.php b/Eventarc/src/V1/UpdateEnrollmentRequest.php new file mode 100644 index 000000000000..70255d125bfe --- /dev/null +++ b/Eventarc/src/V1/UpdateEnrollmentRequest.php @@ -0,0 +1,222 @@ +google.cloud.eventarc.v1.UpdateEnrollmentRequest + */ +class UpdateEnrollmentRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The Enrollment to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Enrollment enrollment = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $enrollment = null; + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $update_mask = null; + /** + * Optional. If set to true, and the Enrollment is not found, a new Enrollment + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param \Google\Cloud\Eventarc\V1\Enrollment $enrollment Required. The Enrollment to be updated. + * @param \Google\Protobuf\FieldMask $updateMask Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * @return \Google\Cloud\Eventarc\V1\UpdateEnrollmentRequest + * + * @experimental + */ + public static function build(\Google\Cloud\Eventarc\V1\Enrollment $enrollment, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setEnrollment($enrollment) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Eventarc\V1\Enrollment $enrollment + * Required. The Enrollment to be updated. + * @type \Google\Protobuf\FieldMask $update_mask + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * @type bool $allow_missing + * Optional. If set to true, and the Enrollment is not found, a new Enrollment + * will be created. In this situation, `update_mask` is ignored. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The Enrollment to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Enrollment enrollment = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Eventarc\V1\Enrollment|null + */ + public function getEnrollment() + { + return $this->enrollment; + } + + public function hasEnrollment() + { + return isset($this->enrollment); + } + + public function clearEnrollment() + { + unset($this->enrollment); + } + + /** + * Required. The Enrollment to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Enrollment enrollment = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Eventarc\V1\Enrollment $var + * @return $this + */ + public function setEnrollment($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Enrollment::class); + $this->enrollment = $var; + + return $this; + } + + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * Optional. If set to true, and the Enrollment is not found, a new Enrollment + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the Enrollment is not found, a new Enrollment + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/UpdateGoogleApiSourceRequest.php b/Eventarc/src/V1/UpdateGoogleApiSourceRequest.php new file mode 100644 index 000000000000..420c284a32ab --- /dev/null +++ b/Eventarc/src/V1/UpdateGoogleApiSourceRequest.php @@ -0,0 +1,226 @@ +google.cloud.eventarc.v1.UpdateGoogleApiSourceRequest + */ +class UpdateGoogleApiSourceRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The GoogleApiSource to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.GoogleApiSource google_api_source = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $google_api_source = null; + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $update_mask = null; + /** + * Optional. If set to true, and the GoogleApiSource is not found, a new + * GoogleApiSource will be created. In this situation, `update_mask` is + * ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param \Google\Cloud\Eventarc\V1\GoogleApiSource $googleApiSource Required. The GoogleApiSource to be updated. + * @param \Google\Protobuf\FieldMask $updateMask Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * @return \Google\Cloud\Eventarc\V1\UpdateGoogleApiSourceRequest + * + * @experimental + */ + public static function build(\Google\Cloud\Eventarc\V1\GoogleApiSource $googleApiSource, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setGoogleApiSource($googleApiSource) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Eventarc\V1\GoogleApiSource $google_api_source + * Required. The GoogleApiSource to be updated. + * @type \Google\Protobuf\FieldMask $update_mask + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * @type bool $allow_missing + * Optional. If set to true, and the GoogleApiSource is not found, a new + * GoogleApiSource will be created. In this situation, `update_mask` is + * ignored. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The GoogleApiSource to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.GoogleApiSource google_api_source = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Eventarc\V1\GoogleApiSource|null + */ + public function getGoogleApiSource() + { + return $this->google_api_source; + } + + public function hasGoogleApiSource() + { + return isset($this->google_api_source); + } + + public function clearGoogleApiSource() + { + unset($this->google_api_source); + } + + /** + * Required. The GoogleApiSource to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.GoogleApiSource google_api_source = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Eventarc\V1\GoogleApiSource $var + * @return $this + */ + public function setGoogleApiSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\GoogleApiSource::class); + $this->google_api_source = $var; + + return $this; + } + + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * Optional. If set to true, and the GoogleApiSource is not found, a new + * GoogleApiSource will be created. In this situation, `update_mask` is + * ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the GoogleApiSource is not found, a new + * GoogleApiSource will be created. In this situation, `update_mask` is + * ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/UpdateMessageBusRequest.php b/Eventarc/src/V1/UpdateMessageBusRequest.php new file mode 100644 index 000000000000..0699200ebaf8 --- /dev/null +++ b/Eventarc/src/V1/UpdateMessageBusRequest.php @@ -0,0 +1,222 @@ +google.cloud.eventarc.v1.UpdateMessageBusRequest + */ +class UpdateMessageBusRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The MessageBus to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.MessageBus message_bus = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $message_bus = null; + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $update_mask = null; + /** + * Optional. If set to true, and the MessageBus is not found, a new MessageBus + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param \Google\Cloud\Eventarc\V1\MessageBus $messageBus Required. The MessageBus to be updated. + * @param \Google\Protobuf\FieldMask $updateMask Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * @return \Google\Cloud\Eventarc\V1\UpdateMessageBusRequest + * + * @experimental + */ + public static function build(\Google\Cloud\Eventarc\V1\MessageBus $messageBus, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setMessageBus($messageBus) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Eventarc\V1\MessageBus $message_bus + * Required. The MessageBus to be updated. + * @type \Google\Protobuf\FieldMask $update_mask + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * @type bool $allow_missing + * Optional. If set to true, and the MessageBus is not found, a new MessageBus + * will be created. In this situation, `update_mask` is ignored. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The MessageBus to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.MessageBus message_bus = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Eventarc\V1\MessageBus|null + */ + public function getMessageBus() + { + return $this->message_bus; + } + + public function hasMessageBus() + { + return isset($this->message_bus); + } + + public function clearMessageBus() + { + unset($this->message_bus); + } + + /** + * Required. The MessageBus to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.MessageBus message_bus = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Eventarc\V1\MessageBus $var + * @return $this + */ + public function setMessageBus($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\MessageBus::class); + $this->message_bus = $var; + + return $this; + } + + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * Optional. If set to true, and the MessageBus is not found, a new MessageBus + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the MessageBus is not found, a new MessageBus + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/UpdatePipelineRequest.php b/Eventarc/src/V1/UpdatePipelineRequest.php new file mode 100644 index 000000000000..05d4848fe829 --- /dev/null +++ b/Eventarc/src/V1/UpdatePipelineRequest.php @@ -0,0 +1,222 @@ +google.cloud.eventarc.v1.UpdatePipelineRequest + */ +class UpdatePipelineRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The Pipeline to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $pipeline = null; + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $update_mask = null; + /** + * Optional. If set to true, and the Pipeline is not found, a new Pipeline + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $allow_missing = false; + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param \Google\Cloud\Eventarc\V1\Pipeline $pipeline Required. The Pipeline to be updated. + * @param \Google\Protobuf\FieldMask $updateMask Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * @return \Google\Cloud\Eventarc\V1\UpdatePipelineRequest + * + * @experimental + */ + public static function build(\Google\Cloud\Eventarc\V1\Pipeline $pipeline, \Google\Protobuf\FieldMask $updateMask): self + { + return (new self()) + ->setPipeline($pipeline) + ->setUpdateMask($updateMask); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Eventarc\V1\Pipeline $pipeline + * Required. The Pipeline to be updated. + * @type \Google\Protobuf\FieldMask $update_mask + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * @type bool $allow_missing + * Optional. If set to true, and the Pipeline is not found, a new Pipeline + * will be created. In this situation, `update_mask` is ignored. + * @type bool $validate_only + * Optional. If set, validate the request and preview the review, but do not + * post it. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\V1\Eventarc::initOnce(); + parent::__construct($data); + } + + /** + * Required. The Pipeline to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Eventarc\V1\Pipeline|null + */ + public function getPipeline() + { + return $this->pipeline; + } + + public function hasPipeline() + { + return isset($this->pipeline); + } + + public function clearPipeline() + { + unset($this->pipeline); + } + + /** + * Required. The Pipeline to be updated. + * + * Generated from protobuf field .google.cloud.eventarc.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Eventarc\V1\Pipeline $var + * @return $this + */ + public function setPipeline($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\V1\Pipeline::class); + $this->pipeline = $var; + + return $this; + } + + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * Optional. The fields to be updated; only fields explicitly provided are + * updated. If no field mask is provided, all provided fields in the request + * are updated. To update all fields, provide a field mask of "*". + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * Optional. If set to true, and the Pipeline is not found, a new Pipeline + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getAllowMissing() + { + return $this->allow_missing; + } + + /** + * Optional. If set to true, and the Pipeline is not found, a new Pipeline + * will be created. In this situation, `update_mask` is ignored. + * + * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setAllowMissing($var) + { + GPBUtil::checkBool($var); + $this->allow_missing = $var; + + return $this; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. If set, validate the request and preview the review, but do not + * post it. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Eventarc/src/V1/UpdateTriggerRequest.php b/Eventarc/src/V1/UpdateTriggerRequest.php index 0063f4cb5469..6091f1a892eb 100644 --- a/Eventarc/src/V1/UpdateTriggerRequest.php +++ b/Eventarc/src/V1/UpdateTriggerRequest.php @@ -37,10 +37,10 @@ class UpdateTriggerRequest extends \Google\Protobuf\Internal\Message */ protected $allow_missing = false; /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; @@ -80,7 +80,7 @@ public static function build(\Google\Cloud\Eventarc\V1\Trigger $trigger, \Google * If set to true, and the trigger is not found, a new trigger will be * created. In this situation, `update_mask` is ignored. * @type bool $validate_only - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * } */ @@ -194,10 +194,10 @@ public function setAllowMissing($var) } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getValidateOnly() @@ -206,10 +206,10 @@ public function getValidateOnly() } /** - * Required. If set, validate the request and preview the review, but do not + * Optional. If set, validate the request and preview the review, but do not * post it. * - * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/Eventarc/src/V1/gapic_metadata.json b/Eventarc/src/V1/gapic_metadata.json index ac94c299f66f..a6223f4e4409 100644 --- a/Eventarc/src/V1/gapic_metadata.json +++ b/Eventarc/src/V1/gapic_metadata.json @@ -20,6 +20,26 @@ "createChannelConnection" ] }, + "CreateEnrollment": { + "methods": [ + "createEnrollment" + ] + }, + "CreateGoogleApiSource": { + "methods": [ + "createGoogleApiSource" + ] + }, + "CreateMessageBus": { + "methods": [ + "createMessageBus" + ] + }, + "CreatePipeline": { + "methods": [ + "createPipeline" + ] + }, "CreateTrigger": { "methods": [ "createTrigger" @@ -35,6 +55,26 @@ "deleteChannelConnection" ] }, + "DeleteEnrollment": { + "methods": [ + "deleteEnrollment" + ] + }, + "DeleteGoogleApiSource": { + "methods": [ + "deleteGoogleApiSource" + ] + }, + "DeleteMessageBus": { + "methods": [ + "deleteMessageBus" + ] + }, + "DeletePipeline": { + "methods": [ + "deletePipeline" + ] + }, "DeleteTrigger": { "methods": [ "deleteTrigger" @@ -50,11 +90,31 @@ "getChannelConnection" ] }, + "GetEnrollment": { + "methods": [ + "getEnrollment" + ] + }, + "GetGoogleApiSource": { + "methods": [ + "getGoogleApiSource" + ] + }, "GetGoogleChannelConfig": { "methods": [ "getGoogleChannelConfig" ] }, + "GetMessageBus": { + "methods": [ + "getMessageBus" + ] + }, + "GetPipeline": { + "methods": [ + "getPipeline" + ] + }, "GetProvider": { "methods": [ "getProvider" @@ -75,6 +135,31 @@ "listChannels" ] }, + "ListEnrollments": { + "methods": [ + "listEnrollments" + ] + }, + "ListGoogleApiSources": { + "methods": [ + "listGoogleApiSources" + ] + }, + "ListMessageBusEnrollments": { + "methods": [ + "listMessageBusEnrollments" + ] + }, + "ListMessageBuses": { + "methods": [ + "listMessageBuses" + ] + }, + "ListPipelines": { + "methods": [ + "listPipelines" + ] + }, "ListProviders": { "methods": [ "listProviders" @@ -90,11 +175,31 @@ "updateChannel" ] }, + "UpdateEnrollment": { + "methods": [ + "updateEnrollment" + ] + }, + "UpdateGoogleApiSource": { + "methods": [ + "updateGoogleApiSource" + ] + }, "UpdateGoogleChannelConfig": { "methods": [ "updateGoogleChannelConfig" ] }, + "UpdateMessageBus": { + "methods": [ + "updateMessageBus" + ] + }, + "UpdatePipeline": { + "methods": [ + "updatePipeline" + ] + }, "UpdateTrigger": { "methods": [ "updateTrigger" diff --git a/Eventarc/src/V1/resources/eventarc_client_config.json b/Eventarc/src/V1/resources/eventarc_client_config.json index 31759d36a3b7..5203bf50f2ef 100644 --- a/Eventarc/src/V1/resources/eventarc_client_config.json +++ b/Eventarc/src/V1/resources/eventarc_client_config.json @@ -2,7 +2,12 @@ "interfaces": { "google.cloud.eventarc.v1.Eventarc": { "retry_codes": { - "no_retry_codes": [] + "no_retry_codes": [], + "retry_policy_1_codes": [ + "UNAVAILABLE", + "UNKNOWN" + ], + "no_retry_1_codes": [] }, "retry_params": { "no_retry_params": { @@ -13,98 +18,221 @@ "rpc_timeout_multiplier": 1.0, "max_rpc_timeout_millis": 0, "total_timeout_millis": 0 + }, + "retry_policy_1_params": { + "initial_retry_delay_millis": 1000, + "retry_delay_multiplier": 1.3, + "max_retry_delay_millis": 60000, + "initial_rpc_timeout_millis": 60000, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 60000, + "total_timeout_millis": 60000 + }, + "no_retry_1_params": { + "initial_retry_delay_millis": 0, + "retry_delay_multiplier": 0.0, + "max_retry_delay_millis": 0, + "initial_rpc_timeout_millis": 60000, + "rpc_timeout_multiplier": 1.0, + "max_rpc_timeout_millis": 60000, + "total_timeout_millis": 60000 } }, "methods": { "CreateChannel": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "CreateChannelConnection": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "CreateEnrollment": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "CreateGoogleApiSource": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "CreateMessageBus": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "CreatePipeline": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "CreateTrigger": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "DeleteChannel": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "DeleteChannelConnection": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "DeleteEnrollment": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "DeleteGoogleApiSource": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "DeleteMessageBus": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "DeletePipeline": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "DeleteTrigger": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "GetChannel": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "GetChannelConnection": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "GetEnrollment": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "GetGoogleApiSource": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "GetGoogleChannelConfig": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "GetMessageBus": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "GetPipeline": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "GetProvider": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "GetTrigger": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "ListChannelConnections": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "ListChannels": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "ListEnrollments": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "ListGoogleApiSources": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "ListMessageBusEnrollments": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "ListMessageBuses": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" + }, + "ListPipelines": { + "timeout_millis": 60000, + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "ListProviders": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "ListTriggers": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "retry_policy_1_codes", + "retry_params_name": "retry_policy_1_params" }, "UpdateChannel": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "UpdateEnrollment": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "UpdateGoogleApiSource": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "UpdateGoogleChannelConfig": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "UpdateMessageBus": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, + "UpdatePipeline": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "UpdateTrigger": { "timeout_millis": 60000, - "retry_codes_name": "no_retry_codes", - "retry_params_name": "no_retry_params" + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" }, "GetLocation": { "timeout_millis": 60000, diff --git a/Eventarc/src/V1/resources/eventarc_descriptor_config.php b/Eventarc/src/V1/resources/eventarc_descriptor_config.php index 54f8e9ee8eb1..062cd5f67467 100644 --- a/Eventarc/src/V1/resources/eventarc_descriptor_config.php +++ b/Eventarc/src/V1/resources/eventarc_descriptor_config.php @@ -61,6 +61,82 @@ ], ], ], + 'CreateEnrollment' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Enrollment', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'CreateGoogleApiSource' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\GoogleApiSource', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'CreateMessageBus' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\MessageBus', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'CreatePipeline' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Pipeline', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'CreateTrigger' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Trigger', @@ -118,6 +194,82 @@ ], ], ], + 'DeleteEnrollment' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Enrollment', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'DeleteGoogleApiSource' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\GoogleApiSource', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'DeleteMessageBus' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\MessageBus', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'DeletePipeline' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Pipeline', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'DeleteTrigger' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Trigger', @@ -157,6 +309,86 @@ ], ], ], + 'UpdateEnrollment' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Enrollment', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'enrollment.name', + 'fieldAccessors' => [ + 'getEnrollment', + 'getName', + ], + ], + ], + ], + 'UpdateGoogleApiSource' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\GoogleApiSource', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'google_api_source.name', + 'fieldAccessors' => [ + 'getGoogleApiSource', + 'getName', + ], + ], + ], + ], + 'UpdateMessageBus' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\MessageBus', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'message_bus.name', + 'fieldAccessors' => [ + 'getMessageBus', + 'getName', + ], + ], + ], + ], + 'UpdatePipeline' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Pipeline', + 'metadataReturnType' => '\Google\Cloud\Eventarc\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'pipeline.name', + 'fieldAccessors' => [ + 'getPipeline', + 'getName', + ], + ], + ], + ], 'UpdateTrigger' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\Eventarc\V1\Trigger', @@ -201,6 +433,30 @@ ], ], ], + 'GetEnrollment' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\Enrollment', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'GetGoogleApiSource' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\GoogleApiSource', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'GetGoogleChannelConfig' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\Eventarc\V1\GoogleChannelConfig', @@ -213,6 +469,30 @@ ], ], ], + 'GetMessageBus' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\MessageBus', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], + 'GetPipeline' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\Pipeline', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'GetProvider' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\Eventarc\V1\Provider', @@ -277,6 +557,106 @@ ], ], ], + 'ListEnrollments' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getEnrollments', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\ListEnrollmentsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListGoogleApiSources' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getGoogleApiSources', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\ListGoogleApiSourcesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListMessageBusEnrollments' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getEnrollments', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\ListMessageBusEnrollmentsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListMessageBuses' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getMessageBuses', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\ListMessageBusesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], + 'ListPipelines' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getPipelines', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Eventarc\V1\ListPipelinesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'ListProviders' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', @@ -408,10 +788,16 @@ 'channelConnection' => 'projects/{project}/locations/{location}/channelConnections/{channel_connection}', 'cloudFunction' => 'projects/{project}/locations/{location}/functions/{function}', 'cryptoKey' => 'projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}', + 'enrollment' => 'projects/{project}/locations/{location}/enrollments/{enrollment}', + 'googleApiSource' => 'projects/{project}/locations/{location}/googleApiSources/{google_api_source}', 'googleChannelConfig' => 'projects/{project}/locations/{location}/googleChannelConfig', 'location' => 'projects/{project}/locations/{location}', + 'messageBus' => 'projects/{project}/locations/{location}/messageBuses/{message_bus}', + 'networkAttachment' => 'projects/{project}/regions/{region}/networkAttachments/{networkattachment}', + 'pipeline' => 'projects/{project}/locations/{location}/pipelines/{pipeline}', 'provider' => 'projects/{project}/locations/{location}/providers/{provider}', 'serviceAccount' => 'projects/{project}/serviceAccounts/{service_account}', + 'topic' => 'projects/{project}/topics/{topic}', 'trigger' => 'projects/{project}/locations/{location}/triggers/{trigger}', 'workflow' => 'projects/{project}/locations/{location}/workflows/{workflow}', ], diff --git a/Eventarc/src/V1/resources/eventarc_rest_client_config.php b/Eventarc/src/V1/resources/eventarc_rest_client_config.php index 7a534674fed2..44f6aec3f1aa 100644 --- a/Eventarc/src/V1/resources/eventarc_rest_client_config.php +++ b/Eventarc/src/V1/resources/eventarc_rest_client_config.php @@ -36,7 +36,6 @@ ], 'queryParams' => [ 'channel_id', - 'validate_only', ], ], 'CreateChannelConnection' => [ @@ -54,6 +53,66 @@ 'channel_connection_id', ], ], + 'CreateEnrollment' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/enrollments', + 'body' => 'enrollment', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'enrollment_id', + ], + ], + 'CreateGoogleApiSource' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/googleApiSources', + 'body' => 'google_api_source', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'google_api_source_id', + ], + ], + 'CreateMessageBus' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/messageBuses', + 'body' => 'message_bus', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'message_bus_id', + ], + ], + 'CreatePipeline' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/pipelines', + 'body' => 'pipeline', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + 'queryParams' => [ + 'pipeline_id', + ], + ], 'CreateTrigger' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/triggers', @@ -67,7 +126,6 @@ ], 'queryParams' => [ 'trigger_id', - 'validate_only', ], ], 'DeleteChannel' => [ @@ -80,9 +138,6 @@ ], ], ], - 'queryParams' => [ - 'validate_only', - ], ], 'DeleteChannelConnection' => [ 'method' => 'delete', @@ -95,6 +150,50 @@ ], ], ], + 'DeleteEnrollment' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/enrollments/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'DeleteGoogleApiSource' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/googleApiSources/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'DeleteMessageBus' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/messageBuses/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'DeletePipeline' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/pipelines/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'DeleteTrigger' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/triggers/*}', @@ -105,9 +204,6 @@ ], ], ], - 'queryParams' => [ - 'validate_only', - ], ], 'GetChannel' => [ 'method' => 'get', @@ -131,6 +227,28 @@ ], ], ], + 'GetEnrollment' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/enrollments/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetGoogleApiSource' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/googleApiSources/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetGoogleChannelConfig' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/googleChannelConfig}', @@ -142,6 +260,28 @@ ], ], ], + 'GetMessageBus' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/messageBuses/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], + 'GetPipeline' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/pipelines/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetProvider' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/providers/*}', @@ -186,6 +326,61 @@ ], ], ], + 'ListEnrollments' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/enrollments', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListGoogleApiSources' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/googleApiSources', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListMessageBusEnrollments' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/messageBuses/*}:listEnrollments', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListMessageBuses' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/messageBuses', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], + 'ListPipelines' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/pipelines', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'ListProviders' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/providers', @@ -220,8 +415,31 @@ ], ], ], - 'queryParams' => [ - 'validate_only', + ], + 'UpdateEnrollment' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{enrollment.name=projects/*/locations/*/enrollments/*}', + 'body' => 'enrollment', + 'placeholders' => [ + 'enrollment.name' => [ + 'getters' => [ + 'getEnrollment', + 'getName', + ], + ], + ], + ], + 'UpdateGoogleApiSource' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{google_api_source.name=projects/*/locations/*/googleApiSources/*}', + 'body' => 'google_api_source', + 'placeholders' => [ + 'google_api_source.name' => [ + 'getters' => [ + 'getGoogleApiSource', + 'getName', + ], + ], ], ], 'UpdateGoogleChannelConfig' => [ @@ -237,6 +455,32 @@ ], ], ], + 'UpdateMessageBus' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{message_bus.name=projects/*/locations/*/messageBuses/*}', + 'body' => 'message_bus', + 'placeholders' => [ + 'message_bus.name' => [ + 'getters' => [ + 'getMessageBus', + 'getName', + ], + ], + ], + ], + 'UpdatePipeline' => [ + 'method' => 'patch', + 'uriTemplate' => '/v1/{pipeline.name=projects/*/locations/*/pipelines/*}', + 'body' => 'pipeline', + 'placeholders' => [ + 'pipeline.name' => [ + 'getters' => [ + 'getPipeline', + 'getName', + ], + ], + ], + ], 'UpdateTrigger' => [ 'method' => 'patch', 'uriTemplate' => '/v1/{trigger.name=projects/*/locations/*/triggers/*}', @@ -249,9 +493,6 @@ ], ], ], - 'queryParams' => [ - 'validate_only', - ], ], ], 'google.cloud.location.Locations' => [ @@ -291,6 +532,22 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/channelConnections/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/messageBuses/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/enrollments/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/pipelines/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/googleApiSources/*}:getIamPolicy', + ], ], 'placeholders' => [ 'resource' => [ @@ -315,6 +572,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/channelConnections/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/messageBuses/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/enrollments/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/pipelines/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/googleApiSources/*}:setIamPolicy', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -339,6 +616,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/channelConnections/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/messageBuses/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/enrollments/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/pipelines/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/googleApiSources/*}:testIamPermissions', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ diff --git a/Eventarc/tests/Unit/V1/Client/EventarcClientTest.php b/Eventarc/tests/Unit/V1/Client/EventarcClientTest.php index 78e8f4bee9df..8e425091a8bd 100644 --- a/Eventarc/tests/Unit/V1/Client/EventarcClientTest.php +++ b/Eventarc/tests/Unit/V1/Client/EventarcClientTest.php @@ -31,29 +31,59 @@ use Google\Cloud\Eventarc\V1\Client\EventarcClient; use Google\Cloud\Eventarc\V1\CreateChannelConnectionRequest; use Google\Cloud\Eventarc\V1\CreateChannelRequest; +use Google\Cloud\Eventarc\V1\CreateEnrollmentRequest; +use Google\Cloud\Eventarc\V1\CreateGoogleApiSourceRequest; +use Google\Cloud\Eventarc\V1\CreateMessageBusRequest; +use Google\Cloud\Eventarc\V1\CreatePipelineRequest; use Google\Cloud\Eventarc\V1\CreateTriggerRequest; use Google\Cloud\Eventarc\V1\DeleteChannelConnectionRequest; use Google\Cloud\Eventarc\V1\DeleteChannelRequest; +use Google\Cloud\Eventarc\V1\DeleteEnrollmentRequest; +use Google\Cloud\Eventarc\V1\DeleteGoogleApiSourceRequest; +use Google\Cloud\Eventarc\V1\DeleteMessageBusRequest; +use Google\Cloud\Eventarc\V1\DeletePipelineRequest; use Google\Cloud\Eventarc\V1\DeleteTriggerRequest; use Google\Cloud\Eventarc\V1\Destination; +use Google\Cloud\Eventarc\V1\Enrollment; use Google\Cloud\Eventarc\V1\GetChannelConnectionRequest; use Google\Cloud\Eventarc\V1\GetChannelRequest; +use Google\Cloud\Eventarc\V1\GetEnrollmentRequest; +use Google\Cloud\Eventarc\V1\GetGoogleApiSourceRequest; use Google\Cloud\Eventarc\V1\GetGoogleChannelConfigRequest; +use Google\Cloud\Eventarc\V1\GetMessageBusRequest; +use Google\Cloud\Eventarc\V1\GetPipelineRequest; use Google\Cloud\Eventarc\V1\GetProviderRequest; use Google\Cloud\Eventarc\V1\GetTriggerRequest; +use Google\Cloud\Eventarc\V1\GoogleApiSource; use Google\Cloud\Eventarc\V1\GoogleChannelConfig; use Google\Cloud\Eventarc\V1\ListChannelConnectionsRequest; use Google\Cloud\Eventarc\V1\ListChannelConnectionsResponse; use Google\Cloud\Eventarc\V1\ListChannelsRequest; use Google\Cloud\Eventarc\V1\ListChannelsResponse; +use Google\Cloud\Eventarc\V1\ListEnrollmentsRequest; +use Google\Cloud\Eventarc\V1\ListEnrollmentsResponse; +use Google\Cloud\Eventarc\V1\ListGoogleApiSourcesRequest; +use Google\Cloud\Eventarc\V1\ListGoogleApiSourcesResponse; +use Google\Cloud\Eventarc\V1\ListMessageBusEnrollmentsRequest; +use Google\Cloud\Eventarc\V1\ListMessageBusEnrollmentsResponse; +use Google\Cloud\Eventarc\V1\ListMessageBusesRequest; +use Google\Cloud\Eventarc\V1\ListMessageBusesResponse; +use Google\Cloud\Eventarc\V1\ListPipelinesRequest; +use Google\Cloud\Eventarc\V1\ListPipelinesResponse; use Google\Cloud\Eventarc\V1\ListProvidersRequest; use Google\Cloud\Eventarc\V1\ListProvidersResponse; use Google\Cloud\Eventarc\V1\ListTriggersRequest; use Google\Cloud\Eventarc\V1\ListTriggersResponse; +use Google\Cloud\Eventarc\V1\MessageBus; +use Google\Cloud\Eventarc\V1\Pipeline; use Google\Cloud\Eventarc\V1\Provider; use Google\Cloud\Eventarc\V1\Trigger; use Google\Cloud\Eventarc\V1\UpdateChannelRequest; +use Google\Cloud\Eventarc\V1\UpdateEnrollmentRequest; +use Google\Cloud\Eventarc\V1\UpdateGoogleApiSourceRequest; use Google\Cloud\Eventarc\V1\UpdateGoogleChannelConfigRequest; +use Google\Cloud\Eventarc\V1\UpdateMessageBusRequest; +use Google\Cloud\Eventarc\V1\UpdatePipelineRequest; use Google\Cloud\Eventarc\V1\UpdateTriggerRequest; use Google\Cloud\Iam\V1\GetIamPolicyRequest; use Google\Cloud\Iam\V1\Policy; @@ -128,6 +158,7 @@ public function createChannelTest() $pubsubTopic = 'pubsubTopic-338126829'; $activationToken = 'activationToken1250030992'; $cryptoKeyName = 'cryptoKeyName-184663511'; + $satisfiesPzs = false; $expectedResponse = new Channel(); $expectedResponse->setName($name); $expectedResponse->setUid($uid); @@ -135,6 +166,7 @@ public function createChannelTest() $expectedResponse->setPubsubTopic($pubsubTopic); $expectedResponse->setActivationToken($activationToken); $expectedResponse->setCryptoKeyName($cryptoKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -148,12 +180,10 @@ public function createChannelTest() $channelName = 'channelName273953326'; $channel->setName($channelName); $channelId = 'channelId-1930808873'; - $validateOnly = false; $request = (new CreateChannelRequest()) ->setParent($formattedParent) ->setChannel($channel) - ->setChannelId($channelId) - ->setValidateOnly($validateOnly); + ->setChannelId($channelId); $response = $gapicClient->createChannel($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -170,8 +200,6 @@ public function createChannelTest() $this->assertProtobufEquals($channel, $actualValue); $actualValue = $actualApiRequestObject->getChannelId(); $this->assertProtobufEquals($channelId, $actualValue); - $actualValue = $actualApiRequestObject->getValidateOnly(); - $this->assertProtobufEquals($validateOnly, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); $expectedOperationsRequestObject->setName('operations/createChannelTest'); $response->pollUntilComplete([ @@ -231,12 +259,10 @@ public function createChannelExceptionTest() $channelName = 'channelName273953326'; $channel->setName($channelName); $channelId = 'channelId-1930808873'; - $validateOnly = false; $request = (new CreateChannelRequest()) ->setParent($formattedParent) ->setChannel($channel) - ->setChannelId($channelId) - ->setValidateOnly($validateOnly); + ->setChannelId($channelId); $response = $gapicClient->createChannel($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -412,7 +438,7 @@ public function createChannelConnectionExceptionTest() } /** @test */ - public function createTriggerTest() + public function createEnrollmentTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -429,44 +455,46 @@ public function createTriggerTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/createTriggerTest'); + $incompleteOperation->setName('operations/createEnrollmentTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $name = 'name3373707'; $uid = 'uid115792'; - $serviceAccount = 'serviceAccount-1948028253'; - $channel = 'channel738950403'; $etag = 'etag3123477'; - $expectedResponse = new Trigger(); + $displayName = 'displayName1615086568'; + $celMatch = 'celMatch1270406544'; + $messageBus = 'messageBus-872787384'; + $destination = 'destination-1429847026'; + $expectedResponse = new Enrollment(); $expectedResponse->setName($name); $expectedResponse->setUid($uid); - $expectedResponse->setServiceAccount($serviceAccount); - $expectedResponse->setChannel($channel); $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCelMatch($celMatch); + $expectedResponse->setMessageBus($messageBus); + $expectedResponse->setDestination($destination); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/createTriggerTest'); + $completeOperation->setName('operations/createEnrollmentTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $trigger = new Trigger(); - $triggerName = 'triggerName-681138077'; - $trigger->setName($triggerName); - $triggerEventFilters = []; - $trigger->setEventFilters($triggerEventFilters); - $triggerDestination = new Destination(); - $trigger->setDestination($triggerDestination); - $triggerId = 'triggerId1363517698'; - $validateOnly = false; - $request = (new CreateTriggerRequest()) + $enrollment = new Enrollment(); + $enrollmentCelMatch = 'enrollmentCelMatch2137295551'; + $enrollment->setCelMatch($enrollmentCelMatch); + $enrollmentMessageBus = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $enrollment->setMessageBus($enrollmentMessageBus); + $enrollmentDestination = 'enrollmentDestination-400605590'; + $enrollment->setDestination($enrollmentDestination); + $enrollmentId = 'enrollmentId976814134'; + $request = (new CreateEnrollmentRequest()) ->setParent($formattedParent) - ->setTrigger($trigger) - ->setTriggerId($triggerId) - ->setValidateOnly($validateOnly); - $response = $gapicClient->createTrigger($request); + ->setEnrollment($enrollment) + ->setEnrollmentId($enrollmentId); + $response = $gapicClient->createEnrollment($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -475,17 +503,15 @@ public function createTriggerTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/CreateTrigger', $actualApiFuncCall); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/CreateEnrollment', $actualApiFuncCall); $actualValue = $actualApiRequestObject->getParent(); $this->assertProtobufEquals($formattedParent, $actualValue); - $actualValue = $actualApiRequestObject->getTrigger(); - $this->assertProtobufEquals($trigger, $actualValue); - $actualValue = $actualApiRequestObject->getTriggerId(); - $this->assertProtobufEquals($triggerId, $actualValue); - $actualValue = $actualApiRequestObject->getValidateOnly(); - $this->assertProtobufEquals($validateOnly, $actualValue); + $actualValue = $actualApiRequestObject->getEnrollment(); + $this->assertProtobufEquals($enrollment, $actualValue); + $actualValue = $actualApiRequestObject->getEnrollmentId(); + $this->assertProtobufEquals($enrollmentId, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/createTriggerTest'); + $expectedOperationsRequestObject->setName('operations/createEnrollmentTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); @@ -504,7 +530,7 @@ public function createTriggerTest() } /** @test */ - public function createTriggerExceptionTest() + public function createEnrollmentExceptionTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -521,7 +547,7 @@ public function createTriggerExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/createTriggerTest'); + $incompleteOperation->setName('operations/createEnrollmentTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $status = new stdClass(); @@ -539,25 +565,23 @@ public function createTriggerExceptionTest() $operationsTransport->addResponse(null, $status); // Mock request $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $trigger = new Trigger(); - $triggerName = 'triggerName-681138077'; - $trigger->setName($triggerName); - $triggerEventFilters = []; - $trigger->setEventFilters($triggerEventFilters); - $triggerDestination = new Destination(); - $trigger->setDestination($triggerDestination); - $triggerId = 'triggerId1363517698'; - $validateOnly = false; - $request = (new CreateTriggerRequest()) + $enrollment = new Enrollment(); + $enrollmentCelMatch = 'enrollmentCelMatch2137295551'; + $enrollment->setCelMatch($enrollmentCelMatch); + $enrollmentMessageBus = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $enrollment->setMessageBus($enrollmentMessageBus); + $enrollmentDestination = 'enrollmentDestination-400605590'; + $enrollment->setDestination($enrollmentDestination); + $enrollmentId = 'enrollmentId976814134'; + $request = (new CreateEnrollmentRequest()) ->setParent($formattedParent) - ->setTrigger($trigger) - ->setTriggerId($triggerId) - ->setValidateOnly($validateOnly); - $response = $gapicClient->createTrigger($request); + ->setEnrollment($enrollment) + ->setEnrollmentId($enrollmentId); + $response = $gapicClient->createEnrollment($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/createTriggerTest'); + $expectedOperationsRequestObject->setName('operations/createEnrollmentTest'); try { $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, @@ -576,7 +600,7 @@ public function createTriggerExceptionTest() } /** @test */ - public function deleteChannelTest() + public function createGoogleApiSourceTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -593,34 +617,40 @@ public function deleteChannelTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/deleteChannelTest'); + $incompleteOperation->setName('operations/createGoogleApiSourceTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); - $name2 = 'name2-1052831874'; + $name = 'name3373707'; $uid = 'uid115792'; - $provider = 'provider-987494927'; - $pubsubTopic = 'pubsubTopic-338126829'; - $activationToken = 'activationToken1250030992'; + $etag = 'etag3123477'; + $displayName = 'displayName1615086568'; + $destination = 'destination-1429847026'; $cryptoKeyName = 'cryptoKeyName-184663511'; - $expectedResponse = new Channel(); - $expectedResponse->setName($name2); + $expectedResponse = new GoogleApiSource(); + $expectedResponse->setName($name); $expectedResponse->setUid($uid); - $expectedResponse->setProvider($provider); - $expectedResponse->setPubsubTopic($pubsubTopic); - $expectedResponse->setActivationToken($activationToken); + $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDestination($destination); $expectedResponse->setCryptoKeyName($cryptoKeyName); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/deleteChannelTest'); + $completeOperation->setName('operations/createGoogleApiSourceTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $formattedName = $gapicClient->channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); - $validateOnly = false; - $request = (new DeleteChannelRequest())->setName($formattedName)->setValidateOnly($validateOnly); - $response = $gapicClient->deleteChannel($request); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $googleApiSource = new GoogleApiSource(); + $googleApiSourceDestination = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $googleApiSource->setDestination($googleApiSourceDestination); + $googleApiSourceId = 'googleApiSourceId-1909472172'; + $request = (new CreateGoogleApiSourceRequest()) + ->setParent($formattedParent) + ->setGoogleApiSource($googleApiSource) + ->setGoogleApiSourceId($googleApiSourceId); + $response = $gapicClient->createGoogleApiSource($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -629,13 +659,15 @@ public function deleteChannelTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteChannel', $actualApiFuncCall); - $actualValue = $actualApiRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); - $actualValue = $actualApiRequestObject->getValidateOnly(); - $this->assertProtobufEquals($validateOnly, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/CreateGoogleApiSource', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getGoogleApiSource(); + $this->assertProtobufEquals($googleApiSource, $actualValue); + $actualValue = $actualApiRequestObject->getGoogleApiSourceId(); + $this->assertProtobufEquals($googleApiSourceId, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteChannelTest'); + $expectedOperationsRequestObject->setName('operations/createGoogleApiSourceTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); @@ -654,7 +686,7 @@ public function deleteChannelTest() } /** @test */ - public function deleteChannelExceptionTest() + public function createGoogleApiSourceExceptionTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -671,7 +703,7 @@ public function deleteChannelExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/deleteChannelTest'); + $incompleteOperation->setName('operations/createGoogleApiSourceTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $status = new stdClass(); @@ -688,14 +720,20 @@ public function deleteChannelExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); - $validateOnly = false; - $request = (new DeleteChannelRequest())->setName($formattedName)->setValidateOnly($validateOnly); - $response = $gapicClient->deleteChannel($request); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $googleApiSource = new GoogleApiSource(); + $googleApiSourceDestination = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $googleApiSource->setDestination($googleApiSourceDestination); + $googleApiSourceId = 'googleApiSourceId-1909472172'; + $request = (new CreateGoogleApiSourceRequest()) + ->setParent($formattedParent) + ->setGoogleApiSource($googleApiSource) + ->setGoogleApiSourceId($googleApiSourceId); + $response = $gapicClient->createGoogleApiSource($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteChannelTest'); + $expectedOperationsRequestObject->setName('operations/createGoogleApiSourceTest'); try { $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, @@ -714,7 +752,7 @@ public function deleteChannelExceptionTest() } /** @test */ - public function deleteChannelConnectionTest() + public function createMessageBusTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -731,29 +769,36 @@ public function deleteChannelConnectionTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/deleteChannelConnectionTest'); + $incompleteOperation->setName('operations/createMessageBusTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); - $name2 = 'name2-1052831874'; + $name = 'name3373707'; $uid = 'uid115792'; - $channel = 'channel738950403'; - $activationToken = 'activationToken1250030992'; - $expectedResponse = new ChannelConnection(); - $expectedResponse->setName($name2); + $etag = 'etag3123477'; + $displayName = 'displayName1615086568'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $expectedResponse = new MessageBus(); + $expectedResponse->setName($name); $expectedResponse->setUid($uid); - $expectedResponse->setChannel($channel); - $expectedResponse->setActivationToken($activationToken); + $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCryptoKeyName($cryptoKeyName); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/deleteChannelConnectionTest'); + $completeOperation->setName('operations/createMessageBusTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $formattedName = $gapicClient->channelConnectionName('[PROJECT]', '[LOCATION]', '[CHANNEL_CONNECTION]'); - $request = (new DeleteChannelConnectionRequest())->setName($formattedName); - $response = $gapicClient->deleteChannelConnection($request); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $messageBus = new MessageBus(); + $messageBusId = 'messageBusId523147890'; + $request = (new CreateMessageBusRequest()) + ->setParent($formattedParent) + ->setMessageBus($messageBus) + ->setMessageBusId($messageBusId); + $response = $gapicClient->createMessageBus($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -762,11 +807,15 @@ public function deleteChannelConnectionTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteChannelConnection', $actualApiFuncCall); - $actualValue = $actualApiRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/CreateMessageBus', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getMessageBus(); + $this->assertProtobufEquals($messageBus, $actualValue); + $actualValue = $actualApiRequestObject->getMessageBusId(); + $this->assertProtobufEquals($messageBusId, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteChannelConnectionTest'); + $expectedOperationsRequestObject->setName('operations/createMessageBusTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); @@ -785,7 +834,7 @@ public function deleteChannelConnectionTest() } /** @test */ - public function deleteChannelConnectionExceptionTest() + public function createMessageBusExceptionTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -802,7 +851,7 @@ public function deleteChannelConnectionExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/deleteChannelConnectionTest'); + $incompleteOperation->setName('operations/createMessageBusTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $status = new stdClass(); @@ -819,13 +868,18 @@ public function deleteChannelConnectionExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->channelConnectionName('[PROJECT]', '[LOCATION]', '[CHANNEL_CONNECTION]'); - $request = (new DeleteChannelConnectionRequest())->setName($formattedName); - $response = $gapicClient->deleteChannelConnection($request); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $messageBus = new MessageBus(); + $messageBusId = 'messageBusId523147890'; + $request = (new CreateMessageBusRequest()) + ->setParent($formattedParent) + ->setMessageBus($messageBus) + ->setMessageBusId($messageBusId); + $response = $gapicClient->createMessageBus($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteChannelConnectionTest'); + $expectedOperationsRequestObject->setName('operations/createMessageBusTest'); try { $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, @@ -844,7 +898,7 @@ public function deleteChannelConnectionExceptionTest() } /** @test */ - public function deleteTriggerTest() + public function createPipelineTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -861,32 +915,38 @@ public function deleteTriggerTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/deleteTriggerTest'); + $incompleteOperation->setName('operations/createPipelineTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); - $name2 = 'name2-1052831874'; + $name = 'name3373707'; $uid = 'uid115792'; - $serviceAccount = 'serviceAccount-1948028253'; - $channel = 'channel738950403'; - $etag2 = 'etag2-1293302904'; - $expectedResponse = new Trigger(); - $expectedResponse->setName($name2); + $displayName = 'displayName1615086568'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $etag = 'etag3123477'; + $expectedResponse = new Pipeline(); + $expectedResponse->setName($name); $expectedResponse->setUid($uid); - $expectedResponse->setServiceAccount($serviceAccount); - $expectedResponse->setChannel($channel); - $expectedResponse->setEtag($etag2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $expectedResponse->setEtag($etag); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/deleteTriggerTest'); + $completeOperation->setName('operations/createPipelineTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $formattedName = $gapicClient->triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); - $validateOnly = false; - $request = (new DeleteTriggerRequest())->setName($formattedName)->setValidateOnly($validateOnly); - $response = $gapicClient->deleteTrigger($request); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $pipeline = new Pipeline(); + $pipelineDestinations = []; + $pipeline->setDestinations($pipelineDestinations); + $pipelineId = 'pipelineId981478360'; + $request = (new CreatePipelineRequest()) + ->setParent($formattedParent) + ->setPipeline($pipeline) + ->setPipelineId($pipelineId); + $response = $gapicClient->createPipeline($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -895,13 +955,15 @@ public function deleteTriggerTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteTrigger', $actualApiFuncCall); - $actualValue = $actualApiRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); - $actualValue = $actualApiRequestObject->getValidateOnly(); - $this->assertProtobufEquals($validateOnly, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/CreatePipeline', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getPipeline(); + $this->assertProtobufEquals($pipeline, $actualValue); + $actualValue = $actualApiRequestObject->getPipelineId(); + $this->assertProtobufEquals($pipelineId, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteTriggerTest'); + $expectedOperationsRequestObject->setName('operations/createPipelineTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); @@ -920,7 +982,7 @@ public function deleteTriggerTest() } /** @test */ - public function deleteTriggerExceptionTest() + public function createPipelineExceptionTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -937,7 +999,7 @@ public function deleteTriggerExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/deleteTriggerTest'); + $incompleteOperation->setName('operations/createPipelineTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $status = new stdClass(); @@ -954,14 +1016,20 @@ public function deleteTriggerExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); - $validateOnly = false; - $request = (new DeleteTriggerRequest())->setName($formattedName)->setValidateOnly($validateOnly); - $response = $gapicClient->deleteTrigger($request); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $pipeline = new Pipeline(); + $pipelineDestinations = []; + $pipeline->setDestinations($pipelineDestinations); + $pipelineId = 'pipelineId981478360'; + $request = (new CreatePipelineRequest()) + ->setParent($formattedParent) + ->setPipeline($pipeline) + ->setPipelineId($pipelineId); + $response = $gapicClient->createPipeline($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/deleteTriggerTest'); + $expectedOperationsRequestObject->setName('operations/createPipelineTest'); try { $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, @@ -980,45 +1048,1938 @@ public function deleteTriggerExceptionTest() } /** @test */ - public function getChannelTest() + public function createTriggerTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); // Mock response - $name2 = 'name2-1052831874'; + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createTriggerTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; $uid = 'uid115792'; - $provider = 'provider-987494927'; - $pubsubTopic = 'pubsubTopic-338126829'; - $activationToken = 'activationToken1250030992'; - $cryptoKeyName = 'cryptoKeyName-184663511'; - $expectedResponse = new Channel(); - $expectedResponse->setName($name2); + $serviceAccount = 'serviceAccount-1948028253'; + $channel = 'channel738950403'; + $eventDataContentType = 'eventDataContentType-440836272'; + $satisfiesPzs = false; + $etag = 'etag3123477'; + $expectedResponse = new Trigger(); + $expectedResponse->setName($name); $expectedResponse->setUid($uid); - $expectedResponse->setProvider($provider); - $expectedResponse->setPubsubTopic($pubsubTopic); - $expectedResponse->setActivationToken($activationToken); - $expectedResponse->setCryptoKeyName($cryptoKeyName); - $transport->addResponse($expectedResponse); + $expectedResponse->setServiceAccount($serviceAccount); + $expectedResponse->setChannel($channel); + $expectedResponse->setEventDataContentType($eventDataContentType); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setEtag($etag); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createTriggerTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); // Mock request - $formattedName = $gapicClient->channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); - $request = (new GetChannelRequest())->setName($formattedName); - $response = $gapicClient->getChannel($request); - $this->assertEquals($expectedResponse, $response); - $actualRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($actualRequests)); - $actualFuncCall = $actualRequests[0]->getFuncCall(); - $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetChannel', $actualFuncCall); - $actualValue = $actualRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $trigger = new Trigger(); + $triggerName = 'triggerName-681138077'; + $trigger->setName($triggerName); + $triggerEventFilters = []; + $trigger->setEventFilters($triggerEventFilters); + $triggerDestination = new Destination(); + $trigger->setDestination($triggerDestination); + $triggerId = 'triggerId1363517698'; + $request = (new CreateTriggerRequest()) + ->setParent($formattedParent) + ->setTrigger($trigger) + ->setTriggerId($triggerId); + $response = $gapicClient->createTrigger($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/CreateTrigger', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getTrigger(); + $this->assertProtobufEquals($trigger, $actualValue); + $actualValue = $actualApiRequestObject->getTriggerId(); + $this->assertProtobufEquals($triggerId, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createTriggerTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function getChannelExceptionTest() + public function createTriggerExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createTriggerTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $trigger = new Trigger(); + $triggerName = 'triggerName-681138077'; + $trigger->setName($triggerName); + $triggerEventFilters = []; + $trigger->setEventFilters($triggerEventFilters); + $triggerDestination = new Destination(); + $trigger->setDestination($triggerDestination); + $triggerId = 'triggerId1363517698'; + $request = (new CreateTriggerRequest()) + ->setParent($formattedParent) + ->setTrigger($trigger) + ->setTriggerId($triggerId); + $response = $gapicClient->createTrigger($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createTriggerTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteChannelTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteChannelTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $provider = 'provider-987494927'; + $pubsubTopic = 'pubsubTopic-338126829'; + $activationToken = 'activationToken1250030992'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $satisfiesPzs = false; + $expectedResponse = new Channel(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setProvider($provider); + $expectedResponse->setPubsubTopic($pubsubTopic); + $expectedResponse->setActivationToken($activationToken); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteChannelTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); + $request = (new DeleteChannelRequest())->setName($formattedName); + $response = $gapicClient->deleteChannel($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteChannel', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteChannelTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteChannelExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteChannelTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); + $request = (new DeleteChannelRequest())->setName($formattedName); + $response = $gapicClient->deleteChannel($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteChannelTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteChannelConnectionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteChannelConnectionTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $channel = 'channel738950403'; + $activationToken = 'activationToken1250030992'; + $expectedResponse = new ChannelConnection(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setChannel($channel); + $expectedResponse->setActivationToken($activationToken); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteChannelConnectionTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->channelConnectionName('[PROJECT]', '[LOCATION]', '[CHANNEL_CONNECTION]'); + $request = (new DeleteChannelConnectionRequest())->setName($formattedName); + $response = $gapicClient->deleteChannelConnection($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteChannelConnection', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteChannelConnectionTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteChannelConnectionExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteChannelConnectionTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->channelConnectionName('[PROJECT]', '[LOCATION]', '[CHANNEL_CONNECTION]'); + $request = (new DeleteChannelConnectionRequest())->setName($formattedName); + $response = $gapicClient->deleteChannelConnection($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteChannelConnectionTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteEnrollmentTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteEnrollmentTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $etag2 = 'etag2-1293302904'; + $displayName = 'displayName1615086568'; + $celMatch = 'celMatch1270406544'; + $messageBus = 'messageBus-872787384'; + $destination = 'destination-1429847026'; + $expectedResponse = new Enrollment(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCelMatch($celMatch); + $expectedResponse->setMessageBus($messageBus); + $expectedResponse->setDestination($destination); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteEnrollmentTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->enrollmentName('[PROJECT]', '[LOCATION]', '[ENROLLMENT]'); + $request = (new DeleteEnrollmentRequest())->setName($formattedName); + $response = $gapicClient->deleteEnrollment($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteEnrollment', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteEnrollmentTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteEnrollmentExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteEnrollmentTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->enrollmentName('[PROJECT]', '[LOCATION]', '[ENROLLMENT]'); + $request = (new DeleteEnrollmentRequest())->setName($formattedName); + $response = $gapicClient->deleteEnrollment($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteEnrollmentTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteGoogleApiSourceTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteGoogleApiSourceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $etag2 = 'etag2-1293302904'; + $displayName = 'displayName1615086568'; + $destination = 'destination-1429847026'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $expectedResponse = new GoogleApiSource(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDestination($destination); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteGoogleApiSourceTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->googleApiSourceName('[PROJECT]', '[LOCATION]', '[GOOGLE_API_SOURCE]'); + $request = (new DeleteGoogleApiSourceRequest())->setName($formattedName); + $response = $gapicClient->deleteGoogleApiSource($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteGoogleApiSource', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteGoogleApiSourceTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteGoogleApiSourceExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteGoogleApiSourceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->googleApiSourceName('[PROJECT]', '[LOCATION]', '[GOOGLE_API_SOURCE]'); + $request = (new DeleteGoogleApiSourceRequest())->setName($formattedName); + $response = $gapicClient->deleteGoogleApiSource($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteGoogleApiSourceTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteMessageBusTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteMessageBusTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $etag2 = 'etag2-1293302904'; + $displayName = 'displayName1615086568'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $expectedResponse = new MessageBus(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteMessageBusTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $request = (new DeleteMessageBusRequest())->setName($formattedName); + $response = $gapicClient->deleteMessageBus($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteMessageBus', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteMessageBusTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteMessageBusExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteMessageBusTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $request = (new DeleteMessageBusRequest())->setName($formattedName); + $response = $gapicClient->deleteMessageBus($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteMessageBusTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deletePipelineTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deletePipelineTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $displayName = 'displayName1615086568'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $etag2 = 'etag2-1293302904'; + $expectedResponse = new Pipeline(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $expectedResponse->setEtag($etag2); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deletePipelineTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->pipelineName('[PROJECT]', '[LOCATION]', '[PIPELINE]'); + $request = (new DeletePipelineRequest())->setName($formattedName); + $response = $gapicClient->deletePipeline($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeletePipeline', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deletePipelineTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deletePipelineExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deletePipelineTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->pipelineName('[PROJECT]', '[LOCATION]', '[PIPELINE]'); + $request = (new DeletePipelineRequest())->setName($formattedName); + $response = $gapicClient->deletePipeline($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deletePipelineTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteTriggerTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteTriggerTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $serviceAccount = 'serviceAccount-1948028253'; + $channel = 'channel738950403'; + $eventDataContentType = 'eventDataContentType-440836272'; + $satisfiesPzs = false; + $etag2 = 'etag2-1293302904'; + $expectedResponse = new Trigger(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setServiceAccount($serviceAccount); + $expectedResponse->setChannel($channel); + $expectedResponse->setEventDataContentType($eventDataContentType); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setEtag($etag2); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteTriggerTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); + $request = (new DeleteTriggerRequest())->setName($formattedName); + $response = $gapicClient->deleteTrigger($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/DeleteTrigger', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteTriggerTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteTriggerExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteTriggerTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); + $request = (new DeleteTriggerRequest())->setName($formattedName); + $response = $gapicClient->deleteTrigger($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteTriggerTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function getChannelTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $provider = 'provider-987494927'; + $pubsubTopic = 'pubsubTopic-338126829'; + $activationToken = 'activationToken1250030992'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $satisfiesPzs = false; + $expectedResponse = new Channel(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setProvider($provider); + $expectedResponse->setPubsubTopic($pubsubTopic); + $expectedResponse->setActivationToken($activationToken); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); + $request = (new GetChannelRequest())->setName($formattedName); + $response = $gapicClient->getChannel($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetChannel', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getChannelExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); + $request = (new GetChannelRequest())->setName($formattedName); + try { + $gapicClient->getChannel($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getChannelConnectionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $channel = 'channel738950403'; + $activationToken = 'activationToken1250030992'; + $expectedResponse = new ChannelConnection(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setChannel($channel); + $expectedResponse->setActivationToken($activationToken); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->channelConnectionName('[PROJECT]', '[LOCATION]', '[CHANNEL_CONNECTION]'); + $request = (new GetChannelConnectionRequest())->setName($formattedName); + $response = $gapicClient->getChannelConnection($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetChannelConnection', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getChannelConnectionExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->channelConnectionName('[PROJECT]', '[LOCATION]', '[CHANNEL_CONNECTION]'); + $request = (new GetChannelConnectionRequest())->setName($formattedName); + try { + $gapicClient->getChannelConnection($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getEnrollmentTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $etag = 'etag3123477'; + $displayName = 'displayName1615086568'; + $celMatch = 'celMatch1270406544'; + $messageBus = 'messageBus-872787384'; + $destination = 'destination-1429847026'; + $expectedResponse = new Enrollment(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCelMatch($celMatch); + $expectedResponse->setMessageBus($messageBus); + $expectedResponse->setDestination($destination); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->enrollmentName('[PROJECT]', '[LOCATION]', '[ENROLLMENT]'); + $request = (new GetEnrollmentRequest())->setName($formattedName); + $response = $gapicClient->getEnrollment($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetEnrollment', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getEnrollmentExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->enrollmentName('[PROJECT]', '[LOCATION]', '[ENROLLMENT]'); + $request = (new GetEnrollmentRequest())->setName($formattedName); + try { + $gapicClient->getEnrollment($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getGoogleApiSourceTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $etag = 'etag3123477'; + $displayName = 'displayName1615086568'; + $destination = 'destination-1429847026'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $expectedResponse = new GoogleApiSource(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDestination($destination); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->googleApiSourceName('[PROJECT]', '[LOCATION]', '[GOOGLE_API_SOURCE]'); + $request = (new GetGoogleApiSourceRequest())->setName($formattedName); + $response = $gapicClient->getGoogleApiSource($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetGoogleApiSource', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getGoogleApiSourceExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->googleApiSourceName('[PROJECT]', '[LOCATION]', '[GOOGLE_API_SOURCE]'); + $request = (new GetGoogleApiSourceRequest())->setName($formattedName); + try { + $gapicClient->getGoogleApiSource($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getGoogleChannelConfigTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $expectedResponse = new GoogleChannelConfig(); + $expectedResponse->setName($name2); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->googleChannelConfigName('[PROJECT]', '[LOCATION]'); + $request = (new GetGoogleChannelConfigRequest())->setName($formattedName); + $response = $gapicClient->getGoogleChannelConfig($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetGoogleChannelConfig', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getGoogleChannelConfigExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->googleChannelConfigName('[PROJECT]', '[LOCATION]'); + $request = (new GetGoogleChannelConfigRequest())->setName($formattedName); + try { + $gapicClient->getGoogleChannelConfig($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getMessageBusTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $etag = 'etag3123477'; + $displayName = 'displayName1615086568'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $expectedResponse = new MessageBus(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $request = (new GetMessageBusRequest())->setName($formattedName); + $response = $gapicClient->getMessageBus($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetMessageBus', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getMessageBusExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $request = (new GetMessageBusRequest())->setName($formattedName); + try { + $gapicClient->getMessageBus($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getPipelineTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $displayName = 'displayName1615086568'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $etag = 'etag3123477'; + $expectedResponse = new Pipeline(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $expectedResponse->setEtag($etag); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->pipelineName('[PROJECT]', '[LOCATION]', '[PIPELINE]'); + $request = (new GetPipelineRequest())->setName($formattedName); + $response = $gapicClient->getPipeline($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetPipeline', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getPipelineExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->pipelineName('[PROJECT]', '[LOCATION]', '[PIPELINE]'); + $request = (new GetPipelineRequest())->setName($formattedName); + try { + $gapicClient->getPipeline($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getProviderTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $displayName = 'displayName1615086568'; + $expectedResponse = new Provider(); + $expectedResponse->setName($name2); + $expectedResponse->setDisplayName($displayName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->providerName('[PROJECT]', '[LOCATION]', '[PROVIDER]'); + $request = (new GetProviderRequest())->setName($formattedName); + $response = $gapicClient->getProvider($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetProvider', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getProviderExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->providerName('[PROJECT]', '[LOCATION]', '[PROVIDER]'); + $request = (new GetProviderRequest())->setName($formattedName); + try { + $gapicClient->getProvider($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getTriggerTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $serviceAccount = 'serviceAccount-1948028253'; + $channel = 'channel738950403'; + $eventDataContentType = 'eventDataContentType-440836272'; + $satisfiesPzs = false; + $etag = 'etag3123477'; + $expectedResponse = new Trigger(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $expectedResponse->setServiceAccount($serviceAccount); + $expectedResponse->setChannel($channel); + $expectedResponse->setEventDataContentType($eventDataContentType); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setEtag($etag); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); + $request = (new GetTriggerRequest())->setName($formattedName); + $response = $gapicClient->getTrigger($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetTrigger', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getTriggerExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); + $request = (new GetTriggerRequest())->setName($formattedName); + try { + $gapicClient->getTrigger($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listChannelConnectionsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $channelConnectionsElement = new ChannelConnection(); + $channelConnections = [$channelConnectionsElement]; + $expectedResponse = new ListChannelConnectionsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setChannelConnections($channelConnections); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListChannelConnectionsRequest())->setParent($formattedParent); + $response = $gapicClient->listChannelConnections($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getChannelConnections()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListChannelConnections', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listChannelConnectionsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListChannelConnectionsRequest())->setParent($formattedParent); + try { + $gapicClient->listChannelConnections($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listChannelsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $channelsElement = new Channel(); + $channels = [$channelsElement]; + $expectedResponse = new ListChannelsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setChannels($channels); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListChannelsRequest())->setParent($formattedParent); + $response = $gapicClient->listChannels($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getChannels()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListChannels', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listChannelsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListChannelsRequest())->setParent($formattedParent); + try { + $gapicClient->listChannels($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listEnrollmentsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $enrollmentsElement = new Enrollment(); + $enrollments = [$enrollmentsElement]; + $expectedResponse = new ListEnrollmentsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setEnrollments($enrollments); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListEnrollmentsRequest())->setParent($formattedParent); + $response = $gapicClient->listEnrollments($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getEnrollments()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListEnrollments', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listEnrollmentsExceptionTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1039,10 +3000,10 @@ public function getChannelExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->channelName('[PROJECT]', '[LOCATION]', '[CHANNEL]'); - $request = (new GetChannelRequest())->setName($formattedName); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListEnrollmentsRequest())->setParent($formattedParent); try { - $gapicClient->getChannel($request); + $gapicClient->listEnrollments($request); // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { @@ -1055,7 +3016,7 @@ public function getChannelExceptionTest() } /** @test */ - public function getChannelConnectionTest() + public function listGoogleApiSourcesTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1063,33 +3024,33 @@ public function getChannelConnectionTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response - $name2 = 'name2-1052831874'; - $uid = 'uid115792'; - $channel = 'channel738950403'; - $activationToken = 'activationToken1250030992'; - $expectedResponse = new ChannelConnection(); - $expectedResponse->setName($name2); - $expectedResponse->setUid($uid); - $expectedResponse->setChannel($channel); - $expectedResponse->setActivationToken($activationToken); + $nextPageToken = ''; + $googleApiSourcesElement = new GoogleApiSource(); + $googleApiSources = [$googleApiSourcesElement]; + $expectedResponse = new ListGoogleApiSourcesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setGoogleApiSources($googleApiSources); $transport->addResponse($expectedResponse); // Mock request - $formattedName = $gapicClient->channelConnectionName('[PROJECT]', '[LOCATION]', '[CHANNEL_CONNECTION]'); - $request = (new GetChannelConnectionRequest())->setName($formattedName); - $response = $gapicClient->getChannelConnection($request); - $this->assertEquals($expectedResponse, $response); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListGoogleApiSourcesRequest())->setParent($formattedParent); + $response = $gapicClient->listGoogleApiSources($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getGoogleApiSources()[0], $resources[0]); $actualRequests = $transport->popReceivedCalls(); $this->assertSame(1, count($actualRequests)); $actualFuncCall = $actualRequests[0]->getFuncCall(); $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetChannelConnection', $actualFuncCall); - $actualValue = $actualRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListGoogleApiSources', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); $this->assertTrue($transport->isExhausted()); } /** @test */ - public function getChannelConnectionExceptionTest() + public function listGoogleApiSourcesExceptionTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1110,10 +3071,10 @@ public function getChannelConnectionExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->channelConnectionName('[PROJECT]', '[LOCATION]', '[CHANNEL_CONNECTION]'); - $request = (new GetChannelConnectionRequest())->setName($formattedName); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListGoogleApiSourcesRequest())->setParent($formattedParent); try { - $gapicClient->getChannelConnection($request); + $gapicClient->listGoogleApiSources($request); // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { @@ -1126,7 +3087,7 @@ public function getChannelConnectionExceptionTest() } /** @test */ - public function getGoogleChannelConfigTest() + public function listMessageBusEnrollmentsTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1134,29 +3095,33 @@ public function getGoogleChannelConfigTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response - $name2 = 'name2-1052831874'; - $cryptoKeyName = 'cryptoKeyName-184663511'; - $expectedResponse = new GoogleChannelConfig(); - $expectedResponse->setName($name2); - $expectedResponse->setCryptoKeyName($cryptoKeyName); + $nextPageToken = ''; + $enrollmentsElement = 'enrollmentsElement-1920310100'; + $enrollments = [$enrollmentsElement]; + $expectedResponse = new ListMessageBusEnrollmentsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setEnrollments($enrollments); $transport->addResponse($expectedResponse); // Mock request - $formattedName = $gapicClient->googleChannelConfigName('[PROJECT]', '[LOCATION]'); - $request = (new GetGoogleChannelConfigRequest())->setName($formattedName); - $response = $gapicClient->getGoogleChannelConfig($request); - $this->assertEquals($expectedResponse, $response); + $formattedParent = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $request = (new ListMessageBusEnrollmentsRequest())->setParent($formattedParent); + $response = $gapicClient->listMessageBusEnrollments($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getEnrollments()[0], $resources[0]); $actualRequests = $transport->popReceivedCalls(); $this->assertSame(1, count($actualRequests)); $actualFuncCall = $actualRequests[0]->getFuncCall(); $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetGoogleChannelConfig', $actualFuncCall); - $actualValue = $actualRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListMessageBusEnrollments', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); $this->assertTrue($transport->isExhausted()); } /** @test */ - public function getGoogleChannelConfigExceptionTest() + public function listMessageBusEnrollmentsExceptionTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1177,10 +3142,10 @@ public function getGoogleChannelConfigExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->googleChannelConfigName('[PROJECT]', '[LOCATION]'); - $request = (new GetGoogleChannelConfigRequest())->setName($formattedName); + $formattedParent = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $request = (new ListMessageBusEnrollmentsRequest())->setParent($formattedParent); try { - $gapicClient->getGoogleChannelConfig($request); + $gapicClient->listMessageBusEnrollments($request); // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { @@ -1193,7 +3158,7 @@ public function getGoogleChannelConfigExceptionTest() } /** @test */ - public function getProviderTest() + public function listMessageBusesTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1201,29 +3166,33 @@ public function getProviderTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response - $name2 = 'name2-1052831874'; - $displayName = 'displayName1615086568'; - $expectedResponse = new Provider(); - $expectedResponse->setName($name2); - $expectedResponse->setDisplayName($displayName); + $nextPageToken = ''; + $messageBusesElement = new MessageBus(); + $messageBuses = [$messageBusesElement]; + $expectedResponse = new ListMessageBusesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setMessageBuses($messageBuses); $transport->addResponse($expectedResponse); // Mock request - $formattedName = $gapicClient->providerName('[PROJECT]', '[LOCATION]', '[PROVIDER]'); - $request = (new GetProviderRequest())->setName($formattedName); - $response = $gapicClient->getProvider($request); - $this->assertEquals($expectedResponse, $response); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListMessageBusesRequest())->setParent($formattedParent); + $response = $gapicClient->listMessageBuses($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getMessageBuses()[0], $resources[0]); $actualRequests = $transport->popReceivedCalls(); $this->assertSame(1, count($actualRequests)); $actualFuncCall = $actualRequests[0]->getFuncCall(); $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetProvider', $actualFuncCall); - $actualValue = $actualRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListMessageBuses', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); $this->assertTrue($transport->isExhausted()); } /** @test */ - public function getProviderExceptionTest() + public function listMessageBusesExceptionTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1244,10 +3213,10 @@ public function getProviderExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->providerName('[PROJECT]', '[LOCATION]', '[PROVIDER]'); - $request = (new GetProviderRequest())->setName($formattedName); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListMessageBusesRequest())->setParent($formattedParent); try { - $gapicClient->getProvider($request); + $gapicClient->listMessageBuses($request); // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { @@ -1260,7 +3229,7 @@ public function getProviderExceptionTest() } /** @test */ - public function getTriggerTest() + public function listPipelinesTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1268,35 +3237,175 @@ public function getTriggerTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response - $name2 = 'name2-1052831874'; - $uid = 'uid115792'; - $serviceAccount = 'serviceAccount-1948028253'; - $channel = 'channel738950403'; - $etag = 'etag3123477'; - $expectedResponse = new Trigger(); - $expectedResponse->setName($name2); - $expectedResponse->setUid($uid); - $expectedResponse->setServiceAccount($serviceAccount); - $expectedResponse->setChannel($channel); - $expectedResponse->setEtag($etag); + $nextPageToken = ''; + $pipelinesElement = new Pipeline(); + $pipelines = [$pipelinesElement]; + $expectedResponse = new ListPipelinesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setPipelines($pipelines); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListPipelinesRequest())->setParent($formattedParent); + $response = $gapicClient->listPipelines($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getPipelines()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListPipelines', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listPipelinesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListPipelinesRequest())->setParent($formattedParent); + try { + $gapicClient->listPipelines($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listProvidersTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $providersElement = new Provider(); + $providers = [$providersElement]; + $expectedResponse = new ListProvidersResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setProviders($providers); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListProvidersRequest())->setParent($formattedParent); + $response = $gapicClient->listProviders($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getProviders()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListProviders', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listProvidersExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListProvidersRequest())->setParent($formattedParent); + try { + $gapicClient->listProviders($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listTriggersTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $triggersElement = new Trigger(); + $triggers = [$triggersElement]; + $expectedResponse = new ListTriggersResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setTriggers($triggers); $transport->addResponse($expectedResponse); // Mock request - $formattedName = $gapicClient->triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); - $request = (new GetTriggerRequest())->setName($formattedName); - $response = $gapicClient->getTrigger($request); - $this->assertEquals($expectedResponse, $response); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListTriggersRequest())->setParent($formattedParent); + $response = $gapicClient->listTriggers($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getTriggers()[0], $resources[0]); $actualRequests = $transport->popReceivedCalls(); $this->assertSame(1, count($actualRequests)); $actualFuncCall = $actualRequests[0]->getFuncCall(); $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/GetTrigger', $actualFuncCall); - $actualValue = $actualRequestObject->getName(); - $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListTriggers', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); $this->assertTrue($transport->isExhausted()); } /** @test */ - public function getTriggerExceptionTest() + public function listTriggersExceptionTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1317,10 +3426,10 @@ public function getTriggerExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $formattedName = $gapicClient->triggerName('[PROJECT]', '[LOCATION]', '[TRIGGER]'); - $request = (new GetTriggerRequest())->setName($formattedName); + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListTriggersRequest())->setParent($formattedParent); try { - $gapicClient->getTrigger($request); + $gapicClient->listTriggers($request); // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { @@ -1333,47 +3442,99 @@ public function getTriggerExceptionTest() } /** @test */ - public function listChannelConnectionsTest() + public function updateChannelTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); // Mock response - $nextPageToken = ''; - $channelConnectionsElement = new ChannelConnection(); - $channelConnections = [$channelConnectionsElement]; - $expectedResponse = new ListChannelConnectionsResponse(); - $expectedResponse->setNextPageToken($nextPageToken); - $expectedResponse->setChannelConnections($channelConnections); - $transport->addResponse($expectedResponse); - // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListChannelConnectionsRequest())->setParent($formattedParent); - $response = $gapicClient->listChannelConnections($request); - $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); - $resources = iterator_to_array($response->iterateAllElements()); - $this->assertSame(1, count($resources)); - $this->assertEquals($expectedResponse->getChannelConnections()[0], $resources[0]); - $actualRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($actualRequests)); - $actualFuncCall = $actualRequests[0]->getFuncCall(); - $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListChannelConnections', $actualFuncCall); - $actualValue = $actualRequestObject->getParent(); - $this->assertProtobufEquals($formattedParent, $actualValue); + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateChannelTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $uid = 'uid115792'; + $provider = 'provider-987494927'; + $pubsubTopic = 'pubsubTopic-338126829'; + $activationToken = 'activationToken1250030992'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $satisfiesPzs = false; + $expectedResponse = new Channel(); + $expectedResponse->setName($name); + $expectedResponse->setUid($uid); + $expectedResponse->setProvider($provider); + $expectedResponse->setPubsubTopic($pubsubTopic); + $expectedResponse->setActivationToken($activationToken); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/updateChannelTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + $request = new UpdateChannelRequest(); + $response = $gapicClient->updateChannel($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdateChannel', $actualApiFuncCall); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateChannelTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function listChannelConnectionsExceptionTest() + public function updateChannelExceptionTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateChannelTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); $status = new stdClass(); $status->code = Code::DATA_LOSS; $status->details = 'internal error'; @@ -1386,65 +3547,134 @@ public function listChannelConnectionsExceptionTest() ], JSON_PRETTY_PRINT ); - $transport->addResponse(null, $status); - // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListChannelConnectionsRequest())->setParent($formattedParent); + $operationsTransport->addResponse(null, $status); + $request = new UpdateChannelRequest(); + $response = $gapicClient->updateChannel($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateChannelTest'); try { - $gapicClient->listChannelConnections($request); - // If the $gapicClient method call did not throw, fail the test + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { $this->assertEquals($status->code, $ex->getCode()); $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); } - // Call popReceivedCalls to ensure the stub is exhausted + // Call popReceivedCalls to ensure the stubs are exhausted $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function listChannelsTest() + public function updateEnrollmentTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); // Mock response - $nextPageToken = ''; - $channelsElement = new Channel(); - $channels = [$channelsElement]; - $expectedResponse = new ListChannelsResponse(); - $expectedResponse->setNextPageToken($nextPageToken); - $expectedResponse->setChannels($channels); - $transport->addResponse($expectedResponse); + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateEnrollmentTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $uid = 'uid115792'; + $etag = 'etag3123477'; + $displayName = 'displayName1615086568'; + $celMatch = 'celMatch1270406544'; + $messageBus = 'messageBus-872787384'; + $destination = 'destination-1429847026'; + $expectedResponse = new Enrollment(); + $expectedResponse->setName($name); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setCelMatch($celMatch); + $expectedResponse->setMessageBus($messageBus); + $expectedResponse->setDestination($destination); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/updateEnrollmentTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListChannelsRequest())->setParent($formattedParent); - $response = $gapicClient->listChannels($request); - $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); - $resources = iterator_to_array($response->iterateAllElements()); - $this->assertSame(1, count($resources)); - $this->assertEquals($expectedResponse->getChannels()[0], $resources[0]); - $actualRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($actualRequests)); - $actualFuncCall = $actualRequests[0]->getFuncCall(); - $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListChannels', $actualFuncCall); - $actualValue = $actualRequestObject->getParent(); - $this->assertProtobufEquals($formattedParent, $actualValue); + $enrollment = new Enrollment(); + $enrollmentCelMatch = 'enrollmentCelMatch2137295551'; + $enrollment->setCelMatch($enrollmentCelMatch); + $enrollmentMessageBus = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $enrollment->setMessageBus($enrollmentMessageBus); + $enrollmentDestination = 'enrollmentDestination-400605590'; + $enrollment->setDestination($enrollmentDestination); + $request = (new UpdateEnrollmentRequest())->setEnrollment($enrollment); + $response = $gapicClient->updateEnrollment($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdateEnrollment', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getEnrollment(); + $this->assertProtobufEquals($enrollment, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateEnrollmentTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function listChannelsExceptionTest() + public function updateEnrollmentExceptionTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateEnrollmentTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); $status = new stdClass(); $status->code = Code::DATA_LOSS; $status->details = 'internal error'; @@ -1457,65 +3687,136 @@ public function listChannelsExceptionTest() ], JSON_PRETTY_PRINT ); - $transport->addResponse(null, $status); + $operationsTransport->addResponse(null, $status); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListChannelsRequest())->setParent($formattedParent); + $enrollment = new Enrollment(); + $enrollmentCelMatch = 'enrollmentCelMatch2137295551'; + $enrollment->setCelMatch($enrollmentCelMatch); + $enrollmentMessageBus = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $enrollment->setMessageBus($enrollmentMessageBus); + $enrollmentDestination = 'enrollmentDestination-400605590'; + $enrollment->setDestination($enrollmentDestination); + $request = (new UpdateEnrollmentRequest())->setEnrollment($enrollment); + $response = $gapicClient->updateEnrollment($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateEnrollmentTest'); try { - $gapicClient->listChannels($request); - // If the $gapicClient method call did not throw, fail the test + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { $this->assertEquals($status->code, $ex->getCode()); $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); } - // Call popReceivedCalls to ensure the stub is exhausted + // Call popReceivedCalls to ensure the stubs are exhausted $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function listProvidersTest() + public function updateGoogleApiSourceTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); // Mock response - $nextPageToken = ''; - $providersElement = new Provider(); - $providers = [$providersElement]; - $expectedResponse = new ListProvidersResponse(); - $expectedResponse->setNextPageToken($nextPageToken); - $expectedResponse->setProviders($providers); - $transport->addResponse($expectedResponse); + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateGoogleApiSourceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $uid = 'uid115792'; + $etag = 'etag3123477'; + $displayName = 'displayName1615086568'; + $destination = 'destination-1429847026'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $expectedResponse = new GoogleApiSource(); + $expectedResponse->setName($name); + $expectedResponse->setUid($uid); + $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setDestination($destination); + $expectedResponse->setCryptoKeyName($cryptoKeyName); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/updateGoogleApiSourceTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListProvidersRequest())->setParent($formattedParent); - $response = $gapicClient->listProviders($request); - $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); - $resources = iterator_to_array($response->iterateAllElements()); - $this->assertSame(1, count($resources)); - $this->assertEquals($expectedResponse->getProviders()[0], $resources[0]); - $actualRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($actualRequests)); - $actualFuncCall = $actualRequests[0]->getFuncCall(); - $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListProviders', $actualFuncCall); - $actualValue = $actualRequestObject->getParent(); - $this->assertProtobufEquals($formattedParent, $actualValue); + $googleApiSource = new GoogleApiSource(); + $googleApiSourceDestination = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $googleApiSource->setDestination($googleApiSourceDestination); + $request = (new UpdateGoogleApiSourceRequest())->setGoogleApiSource($googleApiSource); + $response = $gapicClient->updateGoogleApiSource($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdateGoogleApiSource', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getGoogleApiSource(); + $this->assertProtobufEquals($googleApiSource, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateGoogleApiSourceTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function listProvidersExceptionTest() + public function updateGoogleApiSourceExceptionTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updateGoogleApiSourceTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); $status = new stdClass(); $status->code = Code::DATA_LOSS; $status->details = 'internal error'; @@ -1528,25 +3829,36 @@ public function listProvidersExceptionTest() ], JSON_PRETTY_PRINT ); - $transport->addResponse(null, $status); + $operationsTransport->addResponse(null, $status); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListProvidersRequest())->setParent($formattedParent); + $googleApiSource = new GoogleApiSource(); + $googleApiSourceDestination = $gapicClient->messageBusName('[PROJECT]', '[LOCATION]', '[MESSAGE_BUS]'); + $googleApiSource->setDestination($googleApiSourceDestination); + $request = (new UpdateGoogleApiSourceRequest())->setGoogleApiSource($googleApiSource); + $response = $gapicClient->updateGoogleApiSource($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updateGoogleApiSourceTest'); try { - $gapicClient->listProviders($request); - // If the $gapicClient method call did not throw, fail the test + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { $this->assertEquals($status->code, $ex->getCode()); $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); } - // Call popReceivedCalls to ensure the stub is exhausted + // Call popReceivedCalls to ensure the stubs are exhausted $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function listTriggersTest() + public function updateGoogleChannelConfigTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1554,33 +3866,31 @@ public function listTriggersTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response - $nextPageToken = ''; - $triggersElement = new Trigger(); - $triggers = [$triggersElement]; - $expectedResponse = new ListTriggersResponse(); - $expectedResponse->setNextPageToken($nextPageToken); - $expectedResponse->setTriggers($triggers); + $name = 'name3373707'; + $cryptoKeyName = 'cryptoKeyName-184663511'; + $expectedResponse = new GoogleChannelConfig(); + $expectedResponse->setName($name); + $expectedResponse->setCryptoKeyName($cryptoKeyName); $transport->addResponse($expectedResponse); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListTriggersRequest())->setParent($formattedParent); - $response = $gapicClient->listTriggers($request); - $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); - $resources = iterator_to_array($response->iterateAllElements()); - $this->assertSame(1, count($resources)); - $this->assertEquals($expectedResponse->getTriggers()[0], $resources[0]); + $googleChannelConfig = new GoogleChannelConfig(); + $googleChannelConfigName = 'googleChannelConfigName-13357801'; + $googleChannelConfig->setName($googleChannelConfigName); + $request = (new UpdateGoogleChannelConfigRequest())->setGoogleChannelConfig($googleChannelConfig); + $response = $gapicClient->updateGoogleChannelConfig($request); + $this->assertEquals($expectedResponse, $response); $actualRequests = $transport->popReceivedCalls(); $this->assertSame(1, count($actualRequests)); $actualFuncCall = $actualRequests[0]->getFuncCall(); $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/ListTriggers', $actualFuncCall); - $actualValue = $actualRequestObject->getParent(); - $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdateGoogleChannelConfig', $actualFuncCall); + $actualValue = $actualRequestObject->getGoogleChannelConfig(); + $this->assertProtobufEquals($googleChannelConfig, $actualValue); $this->assertTrue($transport->isExhausted()); } /** @test */ - public function listTriggersExceptionTest() + public function updateGoogleChannelConfigExceptionTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -1601,10 +3911,12 @@ public function listTriggersExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $request = (new ListTriggersRequest())->setParent($formattedParent); + $googleChannelConfig = new GoogleChannelConfig(); + $googleChannelConfigName = 'googleChannelConfigName-13357801'; + $googleChannelConfig->setName($googleChannelConfigName); + $request = (new UpdateGoogleChannelConfigRequest())->setGoogleChannelConfig($googleChannelConfig); try { - $gapicClient->listTriggers($request); + $gapicClient->updateGoogleChannelConfig($request); // If the $gapicClient method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { @@ -1617,7 +3929,7 @@ public function listTriggersExceptionTest() } /** @test */ - public function updateChannelTest() + public function updateMessageBusTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -1634,33 +3946,31 @@ public function updateChannelTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/updateChannelTest'); + $incompleteOperation->setName('operations/updateMessageBusTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $name = 'name3373707'; $uid = 'uid115792'; - $provider = 'provider-987494927'; - $pubsubTopic = 'pubsubTopic-338126829'; - $activationToken = 'activationToken1250030992'; + $etag = 'etag3123477'; + $displayName = 'displayName1615086568'; $cryptoKeyName = 'cryptoKeyName-184663511'; - $expectedResponse = new Channel(); + $expectedResponse = new MessageBus(); $expectedResponse->setName($name); $expectedResponse->setUid($uid); - $expectedResponse->setProvider($provider); - $expectedResponse->setPubsubTopic($pubsubTopic); - $expectedResponse->setActivationToken($activationToken); + $expectedResponse->setEtag($etag); + $expectedResponse->setDisplayName($displayName); $expectedResponse->setCryptoKeyName($cryptoKeyName); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/updateChannelTest'); + $completeOperation->setName('operations/updateMessageBusTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request - $validateOnly = false; - $request = (new UpdateChannelRequest())->setValidateOnly($validateOnly); - $response = $gapicClient->updateChannel($request); + $messageBus = new MessageBus(); + $request = (new UpdateMessageBusRequest())->setMessageBus($messageBus); + $response = $gapicClient->updateMessageBus($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -1669,11 +3979,11 @@ public function updateChannelTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdateChannel', $actualApiFuncCall); - $actualValue = $actualApiRequestObject->getValidateOnly(); - $this->assertProtobufEquals($validateOnly, $actualValue); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdateMessageBus', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getMessageBus(); + $this->assertProtobufEquals($messageBus, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/updateChannelTest'); + $expectedOperationsRequestObject->setName('operations/updateMessageBusTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); @@ -1692,7 +4002,7 @@ public function updateChannelTest() } /** @test */ - public function updateChannelExceptionTest() + public function updateMessageBusExceptionTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -1709,7 +4019,7 @@ public function updateChannelExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/updateChannelTest'); + $incompleteOperation->setName('operations/updateMessageBusTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); $status = new stdClass(); @@ -1726,13 +4036,13 @@ public function updateChannelExceptionTest() ); $operationsTransport->addResponse(null, $status); // Mock request - $validateOnly = false; - $request = (new UpdateChannelRequest())->setValidateOnly($validateOnly); - $response = $gapicClient->updateChannel($request); + $messageBus = new MessageBus(); + $request = (new UpdateMessageBusRequest())->setMessageBus($messageBus); + $response = $gapicClient->updateMessageBus($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/updateChannelTest'); + $expectedOperationsRequestObject->setName('operations/updateMessageBusTest'); try { $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, @@ -1751,45 +4061,101 @@ public function updateChannelExceptionTest() } /** @test */ - public function updateGoogleChannelConfigTest() + public function updatePipelineTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updatePipelineTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); $name = 'name3373707'; + $uid = 'uid115792'; + $displayName = 'displayName1615086568'; $cryptoKeyName = 'cryptoKeyName-184663511'; - $expectedResponse = new GoogleChannelConfig(); + $etag = 'etag3123477'; + $expectedResponse = new Pipeline(); $expectedResponse->setName($name); + $expectedResponse->setUid($uid); + $expectedResponse->setDisplayName($displayName); $expectedResponse->setCryptoKeyName($cryptoKeyName); - $transport->addResponse($expectedResponse); + $expectedResponse->setEtag($etag); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/updatePipelineTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); // Mock request - $googleChannelConfig = new GoogleChannelConfig(); - $googleChannelConfigName = 'googleChannelConfigName-13357801'; - $googleChannelConfig->setName($googleChannelConfigName); - $request = (new UpdateGoogleChannelConfigRequest())->setGoogleChannelConfig($googleChannelConfig); - $response = $gapicClient->updateGoogleChannelConfig($request); - $this->assertEquals($expectedResponse, $response); - $actualRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($actualRequests)); - $actualFuncCall = $actualRequests[0]->getFuncCall(); - $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdateGoogleChannelConfig', $actualFuncCall); - $actualValue = $actualRequestObject->getGoogleChannelConfig(); - $this->assertProtobufEquals($googleChannelConfig, $actualValue); + $pipeline = new Pipeline(); + $pipelineDestinations = []; + $pipeline->setDestinations($pipelineDestinations); + $request = (new UpdatePipelineRequest())->setPipeline($pipeline); + $response = $gapicClient->updatePipeline($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdatePipeline', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getPipeline(); + $this->assertProtobufEquals($pipeline, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updatePipelineTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ - public function updateGoogleChannelConfigExceptionTest() + public function updatePipelineExceptionTest() { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, + 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/updatePipelineTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); $status = new stdClass(); $status->code = Code::DATA_LOSS; $status->details = 'internal error'; @@ -1802,23 +4168,32 @@ public function updateGoogleChannelConfigExceptionTest() ], JSON_PRETTY_PRINT ); - $transport->addResponse(null, $status); + $operationsTransport->addResponse(null, $status); // Mock request - $googleChannelConfig = new GoogleChannelConfig(); - $googleChannelConfigName = 'googleChannelConfigName-13357801'; - $googleChannelConfig->setName($googleChannelConfigName); - $request = (new UpdateGoogleChannelConfigRequest())->setGoogleChannelConfig($googleChannelConfig); + $pipeline = new Pipeline(); + $pipelineDestinations = []; + $pipeline->setDestinations($pipelineDestinations); + $request = (new UpdatePipelineRequest())->setPipeline($pipeline); + $response = $gapicClient->updatePipeline($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/updatePipelineTest'); try { - $gapicClient->updateGoogleChannelConfig($request); - // If the $gapicClient method call did not throw, fail the test + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test $this->fail('Expected an ApiException, but no exception was thrown.'); } catch (ApiException $ex) { $this->assertEquals($status->code, $ex->getCode()); $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); } - // Call popReceivedCalls to ensure the stub is exhausted + // Call popReceivedCalls to ensure the stubs are exhausted $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); } /** @test */ @@ -1846,12 +4221,16 @@ public function updateTriggerTest() $uid = 'uid115792'; $serviceAccount = 'serviceAccount-1948028253'; $channel = 'channel738950403'; + $eventDataContentType = 'eventDataContentType-440836272'; + $satisfiesPzs = false; $etag = 'etag3123477'; $expectedResponse = new Trigger(); $expectedResponse->setName($name); $expectedResponse->setUid($uid); $expectedResponse->setServiceAccount($serviceAccount); $expectedResponse->setChannel($channel); + $expectedResponse->setEventDataContentType($eventDataContentType); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $expectedResponse->setEtag($etag); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); @@ -1860,9 +4239,7 @@ public function updateTriggerTest() $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); - // Mock request - $validateOnly = false; - $request = (new UpdateTriggerRequest())->setValidateOnly($validateOnly); + $request = new UpdateTriggerRequest(); $response = $gapicClient->updateTrigger($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -1873,8 +4250,6 @@ public function updateTriggerTest() $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); $this->assertSame('/google.cloud.eventarc.v1.Eventarc/UpdateTrigger', $actualApiFuncCall); - $actualValue = $actualApiRequestObject->getValidateOnly(); - $this->assertProtobufEquals($validateOnly, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); $expectedOperationsRequestObject->setName('operations/updateTriggerTest'); $response->pollUntilComplete([ @@ -1928,9 +4303,7 @@ public function updateTriggerExceptionTest() JSON_PRETTY_PRINT ); $operationsTransport->addResponse(null, $status); - // Mock request - $validateOnly = false; - $request = (new UpdateTriggerRequest())->setValidateOnly($validateOnly); + $request = new UpdateTriggerRequest(); $response = $gapicClient->updateTrigger($request); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -2313,6 +4686,7 @@ public function createChannelAsyncTest() $pubsubTopic = 'pubsubTopic-338126829'; $activationToken = 'activationToken1250030992'; $cryptoKeyName = 'cryptoKeyName-184663511'; + $satisfiesPzs = false; $expectedResponse = new Channel(); $expectedResponse->setName($name); $expectedResponse->setUid($uid); @@ -2320,6 +4694,7 @@ public function createChannelAsyncTest() $expectedResponse->setPubsubTopic($pubsubTopic); $expectedResponse->setActivationToken($activationToken); $expectedResponse->setCryptoKeyName($cryptoKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -2333,12 +4708,10 @@ public function createChannelAsyncTest() $channelName = 'channelName273953326'; $channel->setName($channelName); $channelId = 'channelId-1930808873'; - $validateOnly = false; $request = (new CreateChannelRequest()) ->setParent($formattedParent) ->setChannel($channel) - ->setChannelId($channelId) - ->setValidateOnly($validateOnly); + ->setChannelId($channelId); $response = $gapicClient->createChannelAsync($request)->wait(); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); @@ -2355,8 +4728,6 @@ public function createChannelAsyncTest() $this->assertProtobufEquals($channel, $actualValue); $actualValue = $actualApiRequestObject->getChannelId(); $this->assertProtobufEquals($channelId, $actualValue); - $actualValue = $actualApiRequestObject->getValidateOnly(); - $this->assertProtobufEquals($validateOnly, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); $expectedOperationsRequestObject->setName('operations/createChannelTest'); $response->pollUntilComplete([ From 4d95d210ed316d1e3235e076ad5c71a1082d3164 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:20:22 -0400 Subject: [PATCH 053/157] feat: support for ListIpOverrides and RemoveIpOverride (#7777) feat: enable Akamai web application firewall docs: minor updates to reference documentation PiperOrigin-RevId: 691017365 Source-Link: https://github.com/googleapis/googleapis/commit/f28656a54e9b507dc244f9da70474fdb75ac5555 Source-Link: https://github.com/googleapis/googleapis-gen/commit/537296f5c3f781937ac6dfefc138a5a6f7aec2dc Copy-Tag: eyJwIjoiUmVjYXB0Y2hhRW50ZXJwcmlzZS8uT3dsQm90LnlhbWwiLCJoIjoiNTM3Mjk2ZjVjM2Y3ODE5MzdhYzZkZmVmYzEzOGE1YTZmN2FlYzJkYyJ9 --- .../metadata/V1/Recaptchaenterprise.php | Bin 23619 -> 24536 bytes .../annotate_assessment.php | 4 +- .../create_firewall_policy.php | 2 +- .../list_ip_overrides.php | 77 ++++++++ .../list_keys.php | 2 +- .../remove_ip_override.php | 95 ++++++++++ .../src/V1/AnnotateAssessmentRequest.php | 20 +-- .../RecaptchaEnterpriseServiceClient.php | 63 +++++++ .../src/V1/CreateFirewallPolicyRequest.php | 10 +- RecaptchaEnterprise/src/V1/Event.php | 16 +- RecaptchaEnterprise/src/V1/FirewallAction.php | 30 ++-- .../src/V1/FirewallAction/RedirectAction.php | 2 +- .../RecaptchaEnterpriseServiceGapicClient.php | 149 ++++++++++++++- RecaptchaEnterprise/src/V1/IOSKeySettings.php | 32 ++-- RecaptchaEnterprise/src/V1/Key.php | 6 +- .../src/V1/ListIpOverridesRequest.php | 170 ++++++++++++++++++ .../src/V1/ListIpOverridesResponse.php | 105 +++++++++++ .../src/V1/ListKeysRequest.php | 10 +- RecaptchaEnterprise/src/V1/Metrics.php | 8 +- .../src/V1/RemoveIpOverrideRequest.php | 132 ++++++++++++++ .../src/V1/RemoveIpOverrideResponse.php | 33 ++++ RecaptchaEnterprise/src/V1/TestingOptions.php | 24 +-- .../src/V1/WafSettings/WafService.php | 9 +- RecaptchaEnterprise/src/V1/WebKeySettings.php | 16 +- .../src/V1/gapic_metadata.json | 10 ++ ...tcha_enterprise_service_client_config.json | 10 ++ ...a_enterprise_service_descriptor_config.php | 32 ++++ ..._enterprise_service_rest_client_config.php | 23 +++ .../RecaptchaEnterpriseServiceClientTest.php | 152 ++++++++++++++++ .../RecaptchaEnterpriseServiceClientTest.php | 140 +++++++++++++++ 30 files changed, 1286 insertions(+), 96 deletions(-) create mode 100644 RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/list_ip_overrides.php create mode 100644 RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/remove_ip_override.php create mode 100644 RecaptchaEnterprise/src/V1/ListIpOverridesRequest.php create mode 100644 RecaptchaEnterprise/src/V1/ListIpOverridesResponse.php create mode 100644 RecaptchaEnterprise/src/V1/RemoveIpOverrideRequest.php create mode 100644 RecaptchaEnterprise/src/V1/RemoveIpOverrideResponse.php diff --git a/RecaptchaEnterprise/metadata/V1/Recaptchaenterprise.php b/RecaptchaEnterprise/metadata/V1/Recaptchaenterprise.php index 17b08e15de3384e1a3615a12f09ab860802baf0a..c7e9e4a574c14ed42143dc54e05fb36d13918590 100644 GIT binary patch delta 469 zcmX@SgYm|G#tqCYtj*gQxojtT+irGcF>&Nt&B!Gll$x7gmO6Ql%Mu4EE(r+Fv%tSB zwWugFB{e9uxFA2TI8~{WkxR@cv$zByRUDLBSejZ~B4o$KR*+bfnpZN}SJP~AfRm9% zEtfckT8KG9o?JYc1@S-|LB>zk)zP2qsetParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $recaptchaEnterpriseServiceClient->listIpOverrides($request); + + /** @var IpOverrideData $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedParent = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]'); + + list_ip_overrides_sample($formattedParent); +} +// [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListIpOverrides_sync] diff --git a/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/list_keys.php b/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/list_keys.php index a56138803722..5994d374f851 100644 --- a/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/list_keys.php +++ b/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/list_keys.php @@ -32,7 +32,7 @@ /** * Returns the list of all keys that belong to a project. * - * @param string $formattedParent The name of the project that contains the keys that are + * @param string $formattedParent The name of the project that contains the keys that is * listed, in the format `projects/{project}`. Please see * {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field. */ diff --git a/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/remove_ip_override.php b/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/remove_ip_override.php new file mode 100644 index 000000000000..bcd40ed3b151 --- /dev/null +++ b/RecaptchaEnterprise/samples/V1/RecaptchaEnterpriseServiceClient/remove_ip_override.php @@ -0,0 +1,95 @@ +setIp($ipOverrideDataIp) + ->setOverrideType($ipOverrideDataOverrideType); + $request = (new RemoveIpOverrideRequest()) + ->setName($formattedName) + ->setIpOverrideData($ipOverrideData); + + // Call the API and handle any network failures. + try { + /** @var RemoveIpOverrideResponse $response */ + $response = $recaptchaEnterpriseServiceClient->removeIpOverride($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $formattedName = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]'); + $ipOverrideDataIp = '[IP]'; + $ipOverrideDataOverrideType = OverrideType::OVERRIDE_TYPE_UNSPECIFIED; + + remove_ip_override_sample($formattedName, $ipOverrideDataIp, $ipOverrideDataOverrideType); +} +// [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RemoveIpOverride_sync] diff --git a/RecaptchaEnterprise/src/V1/AnnotateAssessmentRequest.php b/RecaptchaEnterprise/src/V1/AnnotateAssessmentRequest.php index 9fd92369df93..fb85125d5825 100644 --- a/RecaptchaEnterprise/src/V1/AnnotateAssessmentRequest.php +++ b/RecaptchaEnterprise/src/V1/AnnotateAssessmentRequest.php @@ -23,8 +23,8 @@ class AnnotateAssessmentRequest extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * Optional. The annotation that is assigned to the Event. This field can - * be left empty to provide reasons that apply to an event without concluding + * Optional. The annotation that is assigned to the Event. This field can be + * left empty to provide reasons that apply to an event without concluding * whether the event is legitimate or fraudulent. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -65,8 +65,8 @@ class AnnotateAssessmentRequest extends \Google\Protobuf\Internal\Message * @param string $name Required. The resource name of the Assessment, in the format * `projects/{project}/assessments/{assessment}`. Please see * {@see RecaptchaEnterpriseServiceClient::assessmentName()} for help formatting this field. - * @param int $annotation Optional. The annotation that is assigned to the Event. This field can - * be left empty to provide reasons that apply to an event without concluding + * @param int $annotation Optional. The annotation that is assigned to the Event. This field can be + * left empty to provide reasons that apply to an event without concluding * whether the event is legitimate or fraudulent. * For allowed values, use constants defined on {@see \Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest\Annotation} * @@ -91,8 +91,8 @@ public static function build(string $name, int $annotation): self * Required. The resource name of the Assessment, in the format * `projects/{project}/assessments/{assessment}`. * @type int $annotation - * Optional. The annotation that is assigned to the Event. This field can - * be left empty to provide reasons that apply to an event without concluding + * Optional. The annotation that is assigned to the Event. This field can be + * left empty to provide reasons that apply to an event without concluding * whether the event is legitimate or fraudulent. * @type array|\Google\Protobuf\Internal\RepeatedField $reasons * Optional. Reasons for the annotation that are assigned to the event. @@ -144,8 +144,8 @@ public function setName($var) } /** - * Optional. The annotation that is assigned to the Event. This field can - * be left empty to provide reasons that apply to an event without concluding + * Optional. The annotation that is assigned to the Event. This field can be + * left empty to provide reasons that apply to an event without concluding * whether the event is legitimate or fraudulent. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -157,8 +157,8 @@ public function getAnnotation() } /** - * Optional. The annotation that is assigned to the Event. This field can - * be left empty to provide reasons that apply to an event without concluding + * Optional. The annotation that is assigned to the Event. This field can be + * left empty to provide reasons that apply to an event without concluding * whether the event is legitimate or fraudulent. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/RecaptchaEnterprise/src/V1/Client/RecaptchaEnterpriseServiceClient.php b/RecaptchaEnterprise/src/V1/Client/RecaptchaEnterpriseServiceClient.php index f1c696dae386..4d8c34088512 100644 --- a/RecaptchaEnterprise/src/V1/Client/RecaptchaEnterpriseServiceClient.php +++ b/RecaptchaEnterprise/src/V1/Client/RecaptchaEnterpriseServiceClient.php @@ -49,11 +49,14 @@ use Google\Cloud\RecaptchaEnterprise\V1\GetMetricsRequest; use Google\Cloud\RecaptchaEnterprise\V1\Key; use Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesRequest; +use Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest; use Google\Cloud\RecaptchaEnterprise\V1\ListKeysRequest; use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsRequest; use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupsRequest; use Google\Cloud\RecaptchaEnterprise\V1\Metrics; use Google\Cloud\RecaptchaEnterprise\V1\MigrateKeyRequest; +use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideRequest; +use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse; use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesRequest; use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse; use Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyRequest; @@ -85,10 +88,12 @@ * @method PromiseInterface getKeyAsync(GetKeyRequest $request, array $optionalArgs = []) * @method PromiseInterface getMetricsAsync(GetMetricsRequest $request, array $optionalArgs = []) * @method PromiseInterface listFirewallPoliciesAsync(ListFirewallPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIpOverridesAsync(ListIpOverridesRequest $request, array $optionalArgs = []) * @method PromiseInterface listKeysAsync(ListKeysRequest $request, array $optionalArgs = []) * @method PromiseInterface listRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest $request, array $optionalArgs = []) * @method PromiseInterface listRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest $request, array $optionalArgs = []) * @method PromiseInterface migrateKeyAsync(MigrateKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeIpOverrideAsync(RemoveIpOverrideRequest $request, array $optionalArgs = []) * @method PromiseInterface reorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest $request, array $optionalArgs = []) * @method PromiseInterface retrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest $request, array $optionalArgs = []) * @method PromiseInterface searchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest $request, array $optionalArgs = []) @@ -640,6 +645,33 @@ public function listFirewallPolicies(ListFirewallPoliciesRequest $request, array return $this->startApiCall('ListFirewallPolicies', $request, $callOptions); } + /** + * Lists all IP overrides for a key. + * + * The async variant is + * {@see RecaptchaEnterpriseServiceClient::listIpOverridesAsync()} . + * + * @example samples/V1/RecaptchaEnterpriseServiceClient/list_ip_overrides.php + * + * @param ListIpOverridesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listIpOverrides(ListIpOverridesRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListIpOverrides', $request, $callOptions); + } + /** * Returns the list of all keys that belong to a project. * @@ -753,6 +785,37 @@ public function migrateKey(MigrateKeyRequest $request, array $callOptions = []): return $this->startApiCall('MigrateKey', $request, $callOptions)->wait(); } + /** + * Removes an IP override from a key. The following restrictions hold: + * * If the IP isn't found in an existing IP override, a `NOT_FOUND` error + * is returned. + * * If the IP is found in an existing IP override, but the + * override type does not match, a `NOT_FOUND` error is returned. + * + * The async variant is + * {@see RecaptchaEnterpriseServiceClient::removeIpOverrideAsync()} . + * + * @example samples/V1/RecaptchaEnterpriseServiceClient/remove_ip_override.php + * + * @param RemoveIpOverrideRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return RemoveIpOverrideResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function removeIpOverride(RemoveIpOverrideRequest $request, array $callOptions = []): RemoveIpOverrideResponse + { + return $this->startApiCall('RemoveIpOverride', $request, $callOptions)->wait(); + } + /** * Reorders all firewall policies. * diff --git a/RecaptchaEnterprise/src/V1/CreateFirewallPolicyRequest.php b/RecaptchaEnterprise/src/V1/CreateFirewallPolicyRequest.php index d74794853ef8..eaf40a09a08d 100644 --- a/RecaptchaEnterprise/src/V1/CreateFirewallPolicyRequest.php +++ b/RecaptchaEnterprise/src/V1/CreateFirewallPolicyRequest.php @@ -16,7 +16,7 @@ class CreateFirewallPolicyRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The name of the project this policy will apply to, in the format + * Required. The name of the project this policy applies to, in the format * `projects/{project}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -30,7 +30,7 @@ class CreateFirewallPolicyRequest extends \Google\Protobuf\Internal\Message private $firewall_policy = null; /** - * @param string $parent Required. The name of the project this policy will apply to, in the format + * @param string $parent Required. The name of the project this policy applies to, in the format * `projects/{project}`. Please see * {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field. * @param \Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy $firewallPolicy Required. Information to create the policy. @@ -53,7 +53,7 @@ public static function build(string $parent, \Google\Cloud\RecaptchaEnterprise\V * Optional. Data for populating the Message object. * * @type string $parent - * Required. The name of the project this policy will apply to, in the format + * Required. The name of the project this policy applies to, in the format * `projects/{project}`. * @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy $firewall_policy * Required. Information to create the policy. @@ -65,7 +65,7 @@ public function __construct($data = NULL) { } /** - * Required. The name of the project this policy will apply to, in the format + * Required. The name of the project this policy applies to, in the format * `projects/{project}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -77,7 +77,7 @@ public function getParent() } /** - * Required. The name of the project this policy will apply to, in the format + * Required. The name of the project this policy applies to, in the format * `projects/{project}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/RecaptchaEnterprise/src/V1/Event.php b/RecaptchaEnterprise/src/V1/Event.php index ca4fc33bb46f..95b5943cf5ad 100644 --- a/RecaptchaEnterprise/src/V1/Event.php +++ b/RecaptchaEnterprise/src/V1/Event.php @@ -62,7 +62,7 @@ class Event extends \Google\Protobuf\Internal\Message protected $hashed_account_id = ''; /** * Optional. Flag for a reCAPTCHA express request for an assessment without a - * token. If enabled, `site_key` must reference an express key. + * token. If enabled, `site_key` must reference an Express site key. * * Generated from protobuf field bool express = 14 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -103,7 +103,7 @@ class Event extends \Google\Protobuf\Internal\Message private $firewall_policy_evaluation = false; /** * Optional. Data describing a payment transaction to be assessed. Sending - * this data enables reCAPTCHA Fraud Prevention and the + * this data enables reCAPTCHA Enterprise Fraud Prevention and the * FraudPreventionAssessment component in the response. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL]; @@ -153,7 +153,7 @@ class Event extends \Google\Protobuf\Internal\Message * be hashed using hmac-sha256 with stable secret. * @type bool $express * Optional. Flag for a reCAPTCHA express request for an assessment without a - * token. If enabled, `site_key` must reference an express key. + * token. If enabled, `site_key` must reference an Express site key. * @type string $requested_uri * Optional. The URI resource the user requested that triggered an assessment. * @type bool $waf_token_assessment @@ -170,7 +170,7 @@ class Event extends \Google\Protobuf\Internal\Message * suggested firewall action is returned in the response. * @type \Google\Cloud\RecaptchaEnterprise\V1\TransactionData $transaction_data * Optional. Data describing a payment transaction to be assessed. Sending - * this data enables reCAPTCHA Fraud Prevention and the + * this data enables reCAPTCHA Enterprise Fraud Prevention and the * FraudPreventionAssessment component in the response. * @type \Google\Cloud\RecaptchaEnterprise\V1\UserInfo $user_info * Optional. Information about the user that generates this event, when they @@ -364,7 +364,7 @@ public function setHashedAccountId($var) /** * Optional. Flag for a reCAPTCHA express request for an assessment without a - * token. If enabled, `site_key` must reference an express key. + * token. If enabled, `site_key` must reference an Express site key. * * Generated from protobuf field bool express = 14 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -376,7 +376,7 @@ public function getExpress() /** * Optional. Flag for a reCAPTCHA express request for an assessment without a - * token. If enabled, `site_key` must reference an express key. + * token. If enabled, `site_key` must reference an Express site key. * * Generated from protobuf field bool express = 14 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var @@ -530,7 +530,7 @@ public function setFirewallPolicyEvaluation($var) /** * Optional. Data describing a payment transaction to be assessed. Sending - * this data enables reCAPTCHA Fraud Prevention and the + * this data enables reCAPTCHA Enterprise Fraud Prevention and the * FraudPreventionAssessment component in the response. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL]; @@ -553,7 +553,7 @@ public function clearTransactionData() /** * Optional. Data describing a payment transaction to be assessed. Sending - * this data enables reCAPTCHA Fraud Prevention and the + * this data enables reCAPTCHA Enterprise Fraud Prevention and the * FraudPreventionAssessment component in the response. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/RecaptchaEnterprise/src/V1/FirewallAction.php b/RecaptchaEnterprise/src/V1/FirewallAction.php index ee934704ec1c..b5be30f5734f 100644 --- a/RecaptchaEnterprise/src/V1/FirewallAction.php +++ b/RecaptchaEnterprise/src/V1/FirewallAction.php @@ -28,19 +28,19 @@ class FirewallAction extends \Google\Protobuf\Internal\Message * The user request did not match any policy and should be allowed * access to the requested resource. * @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\BlockAction $block - * This action will deny access to a given page. The user will get an HTTP + * This action denies access to a given page. The user gets an HTTP * error code. * @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\IncludeRecaptchaScriptAction $include_recaptcha_script - * This action will inject reCAPTCHA JavaScript code into the HTML page + * This action injects reCAPTCHA JavaScript code into the HTML page * returned by the site backend. * @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\RedirectAction $redirect - * This action will redirect the request to a ReCaptcha interstitial to + * This action redirects the request to a reCAPTCHA interstitial to * attach a token. * @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SubstituteAction $substitute - * This action will transparently serve a different page to an offending + * This action transparently serves a different page to an offending * user. * @type \Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SetHeaderAction $set_header - * This action will set a custom header but allow the request to continue + * This action sets a custom header but allow the request to continue * to the customer backend. * } */ @@ -83,7 +83,7 @@ public function setAllow($var) } /** - * This action will deny access to a given page. The user will get an HTTP + * This action denies access to a given page. The user gets an HTTP * error code. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2; @@ -100,7 +100,7 @@ public function hasBlock() } /** - * This action will deny access to a given page. The user will get an HTTP + * This action denies access to a given page. The user gets an HTTP * error code. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2; @@ -116,7 +116,7 @@ public function setBlock($var) } /** - * This action will inject reCAPTCHA JavaScript code into the HTML page + * This action injects reCAPTCHA JavaScript code into the HTML page * returned by the site backend. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6; @@ -133,7 +133,7 @@ public function hasIncludeRecaptchaScript() } /** - * This action will inject reCAPTCHA JavaScript code into the HTML page + * This action injects reCAPTCHA JavaScript code into the HTML page * returned by the site backend. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6; @@ -149,7 +149,7 @@ public function setIncludeRecaptchaScript($var) } /** - * This action will redirect the request to a ReCaptcha interstitial to + * This action redirects the request to a reCAPTCHA interstitial to * attach a token. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5; @@ -166,7 +166,7 @@ public function hasRedirect() } /** - * This action will redirect the request to a ReCaptcha interstitial to + * This action redirects the request to a reCAPTCHA interstitial to * attach a token. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5; @@ -182,7 +182,7 @@ public function setRedirect($var) } /** - * This action will transparently serve a different page to an offending + * This action transparently serves a different page to an offending * user. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3; @@ -199,7 +199,7 @@ public function hasSubstitute() } /** - * This action will transparently serve a different page to an offending + * This action transparently serves a different page to an offending * user. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3; @@ -215,7 +215,7 @@ public function setSubstitute($var) } /** - * This action will set a custom header but allow the request to continue + * This action sets a custom header but allow the request to continue * to the customer backend. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4; @@ -232,7 +232,7 @@ public function hasSetHeader() } /** - * This action will set a custom header but allow the request to continue + * This action sets a custom header but allow the request to continue * to the customer backend. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4; diff --git a/RecaptchaEnterprise/src/V1/FirewallAction/RedirectAction.php b/RecaptchaEnterprise/src/V1/FirewallAction/RedirectAction.php index 6151c5b27f83..308c3b4c9f5a 100644 --- a/RecaptchaEnterprise/src/V1/FirewallAction/RedirectAction.php +++ b/RecaptchaEnterprise/src/V1/FirewallAction/RedirectAction.php @@ -10,7 +10,7 @@ /** * A redirect action returns a 307 (temporary redirect) response, pointing - * the user to a ReCaptcha interstitial page to attach a token. + * the user to a reCAPTCHA interstitial page to attach a token. * * Generated from protobuf message google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction */ diff --git a/RecaptchaEnterprise/src/V1/Gapic/RecaptchaEnterpriseServiceGapicClient.php b/RecaptchaEnterprise/src/V1/Gapic/RecaptchaEnterpriseServiceGapicClient.php index 0d4ac148e3be..2a48c5f48c2d 100644 --- a/RecaptchaEnterprise/src/V1/Gapic/RecaptchaEnterpriseServiceGapicClient.php +++ b/RecaptchaEnterprise/src/V1/Gapic/RecaptchaEnterpriseServiceGapicClient.php @@ -52,6 +52,8 @@ use Google\Cloud\RecaptchaEnterprise\V1\Key; use Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesRequest; use Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesResponse; +use Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest; +use Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesResponse; use Google\Cloud\RecaptchaEnterprise\V1\ListKeysRequest; use Google\Cloud\RecaptchaEnterprise\V1\ListKeysResponse; use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsRequest; @@ -60,6 +62,8 @@ use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupsResponse; use Google\Cloud\RecaptchaEnterprise\V1\Metrics; use Google\Cloud\RecaptchaEnterprise\V1\MigrateKeyRequest; +use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideRequest; +use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse; use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesRequest; use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse; use Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyRequest; @@ -534,8 +538,8 @@ public function addIpOverride( * * @param string $name Required. The resource name of the Assessment, in the format * `projects/{project}/assessments/{assessment}`. - * @param int $annotation Optional. The annotation that is assigned to the Event. This field can - * be left empty to provide reasons that apply to an event without concluding + * @param int $annotation Optional. The annotation that is assigned to the Event. This field can be + * left empty to provide reasons that apply to an event without concluding * whether the event is legitimate or fraudulent. * For allowed values, use constants defined on {@see \Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest\Annotation} * @param array $optionalArgs { @@ -678,7 +682,7 @@ public function createAssessment( * } * ``` * - * @param string $parent Required. The name of the project this policy will apply to, in the format + * @param string $parent Required. The name of the project this policy applies to, in the format * `projects/{project}`. * @param FirewallPolicy $firewallPolicy Required. Information to create the policy. * @param array $optionalArgs { @@ -1090,6 +1094,84 @@ public function listFirewallPolicies($parent, array $optionalArgs = []) ); } + /** + * Lists all IP overrides for a key. + * + * Sample code: + * ``` + * $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient(); + * try { + * $formattedParent = $recaptchaEnterpriseServiceClient->keyName('[PROJECT]', '[KEY]'); + * // Iterate over pages of elements + * $pagedResponse = $recaptchaEnterpriseServiceClient->listIpOverrides($formattedParent); + * foreach ($pagedResponse->iteratePages() as $page) { + * foreach ($page as $element) { + * // doSomethingWith($element); + * } + * } + * // Alternatively: + * // Iterate through all elements + * $pagedResponse = $recaptchaEnterpriseServiceClient->listIpOverrides($formattedParent); + * foreach ($pagedResponse->iterateAllElements() as $element) { + * // doSomethingWith($element); + * } + * } finally { + * $recaptchaEnterpriseServiceClient->close(); + * } + * ``` + * + * @param string $parent Required. The parent key for which the IP overrides are listed, in the + * format `projects/{project}/keys/{key}`. + * @param array $optionalArgs { + * Optional. + * + * @type int $pageSize + * The maximum number of resources contained in the underlying API + * response. The API may return fewer values in a page, even if + * there are additional values to be retrieved. + * @type string $pageToken + * A page token is used to specify a page of values to be returned. + * If no page token is specified (the default), the first page + * of values will be returned. Any page token used here must have + * been generated by a previous call to the API. + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return \Google\ApiCore\PagedListResponse + * + * @throws ApiException if the remote call fails + */ + public function listIpOverrides($parent, array $optionalArgs = []) + { + $request = new ListIpOverridesRequest(); + $requestParamHeaders = []; + $request->setParent($parent); + $requestParamHeaders['parent'] = $parent; + if (isset($optionalArgs['pageSize'])) { + $request->setPageSize($optionalArgs['pageSize']); + } + + if (isset($optionalArgs['pageToken'])) { + $request->setPageToken($optionalArgs['pageToken']); + } + + $requestParams = new RequestParamsHeaderDescriptor( + $requestParamHeaders + ); + $optionalArgs['headers'] = isset($optionalArgs['headers']) + ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) + : $requestParams->getHeader(); + return $this->getPagedListResponse( + 'ListIpOverrides', + $optionalArgs, + ListIpOverridesResponse::class, + $request + ); + } + /** * Returns the list of all keys that belong to a project. * @@ -1116,7 +1198,7 @@ public function listFirewallPolicies($parent, array $optionalArgs = []) * } * ``` * - * @param string $parent Required. The name of the project that contains the keys that are + * @param string $parent Required. The name of the project that contains the keys that is * listed, in the format `projects/{project}`. * @param array $optionalArgs { * Optional. @@ -1393,6 +1475,65 @@ public function migrateKey($name, array $optionalArgs = []) )->wait(); } + /** + * Removes an IP override from a key. The following restrictions hold: + * * If the IP isn't found in an existing IP override, a `NOT_FOUND` error + * is returned. + * * If the IP is found in an existing IP override, but the + * override type does not match, a `NOT_FOUND` error is returned. + * + * Sample code: + * ``` + * $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient(); + * try { + * $formattedName = $recaptchaEnterpriseServiceClient->keyName('[PROJECT]', '[KEY]'); + * $ipOverrideData = new IpOverrideData(); + * $response = $recaptchaEnterpriseServiceClient->removeIpOverride($formattedName, $ipOverrideData); + * } finally { + * $recaptchaEnterpriseServiceClient->close(); + * } + * ``` + * + * @param string $name Required. The name of the key from which the IP override is removed, in the + * format `projects/{project}/keys/{key}`. + * @param IpOverrideData $ipOverrideData Required. IP override to be removed from the key. + * @param array $optionalArgs { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return \Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse + * + * @throws ApiException if the remote call fails + */ + public function removeIpOverride( + $name, + $ipOverrideData, + array $optionalArgs = [] + ) { + $request = new RemoveIpOverrideRequest(); + $requestParamHeaders = []; + $request->setName($name); + $request->setIpOverrideData($ipOverrideData); + $requestParamHeaders['name'] = $name; + $requestParams = new RequestParamsHeaderDescriptor( + $requestParamHeaders + ); + $optionalArgs['headers'] = isset($optionalArgs['headers']) + ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) + : $requestParams->getHeader(); + return $this->startCall( + 'RemoveIpOverride', + RemoveIpOverrideResponse::class, + $optionalArgs, + $request + )->wait(); + } + /** * Reorders all firewall policies. * diff --git a/RecaptchaEnterprise/src/V1/IOSKeySettings.php b/RecaptchaEnterprise/src/V1/IOSKeySettings.php index b682092cc240..a751a2c0049c 100644 --- a/RecaptchaEnterprise/src/V1/IOSKeySettings.php +++ b/RecaptchaEnterprise/src/V1/IOSKeySettings.php @@ -30,10 +30,10 @@ class IOSKeySettings extends \Google\Protobuf\Internal\Message private $allowed_bundle_ids; /** * Optional. Apple Developer account details for the app that is protected by - * the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks - * like Apple App Attest and Apple DeviceCheck to protect your app from abuse. - * Providing these fields allows reCAPTCHA Enterprise to get a better - * assessment of the integrity of your app. + * the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple + * App Attest and Apple DeviceCheck to protect your app from abuse. Providing + * these fields allows reCAPTCHA to get a better assessment of the integrity + * of your app. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -52,10 +52,10 @@ class IOSKeySettings extends \Google\Protobuf\Internal\Message * Example: 'com.companyname.productname.appname' * @type \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId $apple_developer_id * Optional. Apple Developer account details for the app that is protected by - * the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks - * like Apple App Attest and Apple DeviceCheck to protect your app from abuse. - * Providing these fields allows reCAPTCHA Enterprise to get a better - * assessment of the integrity of your app. + * the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple + * App Attest and Apple DeviceCheck to protect your app from abuse. Providing + * these fields allows reCAPTCHA to get a better assessment of the integrity + * of your app. * } */ public function __construct($data = NULL) { @@ -119,10 +119,10 @@ public function setAllowedBundleIds($var) /** * Optional. Apple Developer account details for the app that is protected by - * the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks - * like Apple App Attest and Apple DeviceCheck to protect your app from abuse. - * Providing these fields allows reCAPTCHA Enterprise to get a better - * assessment of the integrity of your app. + * the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple + * App Attest and Apple DeviceCheck to protect your app from abuse. Providing + * these fields allows reCAPTCHA to get a better assessment of the integrity + * of your app. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId|null @@ -144,10 +144,10 @@ public function clearAppleDeveloperId() /** * Optional. Apple Developer account details for the app that is protected by - * the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks - * like Apple App Attest and Apple DeviceCheck to protect your app from abuse. - * Providing these fields allows reCAPTCHA Enterprise to get a better - * assessment of the integrity of your app. + * the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple + * App Attest and Apple DeviceCheck to protect your app from abuse. Providing + * these fields allows reCAPTCHA to get a better assessment of the integrity + * of your app. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId $var diff --git a/RecaptchaEnterprise/src/V1/Key.php b/RecaptchaEnterprise/src/V1/Key.php index 4cc838118bf3..c329e908fd3f 100644 --- a/RecaptchaEnterprise/src/V1/Key.php +++ b/RecaptchaEnterprise/src/V1/Key.php @@ -74,7 +74,7 @@ class Key extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings $ios_settings * Settings for keys that can be used by iOS apps. * @type \Google\Cloud\RecaptchaEnterprise\V1\ExpressKeySettings $express_settings - * Settings specific to keys that can be used for reCAPTCHA Express. + * Settings for keys that can be used by reCAPTCHA Express. * @type array|\Google\Protobuf\Internal\MapField $labels * Optional. See [Creating and managing labels] * (https://cloud.google.com/recaptcha/docs/labels). @@ -239,7 +239,7 @@ public function setIosSettings($var) } /** - * Settings specific to keys that can be used for reCAPTCHA Express. + * Settings for keys that can be used by reCAPTCHA Express. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11; * @return \Google\Cloud\RecaptchaEnterprise\V1\ExpressKeySettings|null @@ -255,7 +255,7 @@ public function hasExpressSettings() } /** - * Settings specific to keys that can be used for reCAPTCHA Express. + * Settings for keys that can be used by reCAPTCHA Express. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11; * @param \Google\Cloud\RecaptchaEnterprise\V1\ExpressKeySettings $var diff --git a/RecaptchaEnterprise/src/V1/ListIpOverridesRequest.php b/RecaptchaEnterprise/src/V1/ListIpOverridesRequest.php new file mode 100644 index 000000000000..9411617a5f32 --- /dev/null +++ b/RecaptchaEnterprise/src/V1/ListIpOverridesRequest.php @@ -0,0 +1,170 @@ +google.cloud.recaptchaenterprise.v1.ListIpOverridesRequest + */ +class ListIpOverridesRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The parent key for which the IP overrides are listed, in the + * format `projects/{project}/keys/{key}`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + private $parent = ''; + /** + * Optional. The maximum number of overrides to return. Default is 10. Max + * limit is 100. If the number of overrides is less than the page_size, all + * overrides are returned. If the page size is more than 100, it is coerced to + * 100. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $page_size = 0; + /** + * Optional. The next_page_token value returned from a previous + * ListIpOverridesRequest, if any. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $page_token = ''; + + /** + * @param string $parent Required. The parent key for which the IP overrides are listed, in the + * format `projects/{project}/keys/{key}`. Please see + * {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field. + * + * @return \Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The parent key for which the IP overrides are listed, in the + * format `projects/{project}/keys/{key}`. + * @type int $page_size + * Optional. The maximum number of overrides to return. Default is 10. Max + * limit is 100. If the number of overrides is less than the page_size, all + * overrides are returned. If the page size is more than 100, it is coerced to + * 100. + * @type string $page_token + * Optional. The next_page_token value returned from a previous + * ListIpOverridesRequest, if any. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Required. The parent key for which the IP overrides are listed, in the + * format `projects/{project}/keys/{key}`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The parent key for which the IP overrides are listed, in the + * format `projects/{project}/keys/{key}`. + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of overrides to return. Default is 10. Max + * limit is 100. If the number of overrides is less than the page_size, all + * overrides are returned. If the page size is more than 100, it is coerced to + * 100. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of overrides to return. Default is 10. Max + * limit is 100. If the number of overrides is less than the page_size, all + * overrides are returned. If the page size is more than 100, it is coerced to + * 100. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The next_page_token value returned from a previous + * ListIpOverridesRequest, if any. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The next_page_token value returned from a previous + * ListIpOverridesRequest, if any. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + +} + diff --git a/RecaptchaEnterprise/src/V1/ListIpOverridesResponse.php b/RecaptchaEnterprise/src/V1/ListIpOverridesResponse.php new file mode 100644 index 000000000000..0904013bd50e --- /dev/null +++ b/RecaptchaEnterprise/src/V1/ListIpOverridesResponse.php @@ -0,0 +1,105 @@ +google.cloud.recaptchaenterprise.v1.ListIpOverridesResponse + */ +class ListIpOverridesResponse extends \Google\Protobuf\Internal\Message +{ + /** + * IP Overrides details. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.IpOverrideData ip_overrides = 1; + */ + private $ip_overrides; + /** + * Token to retrieve the next page of results. If this field is empty, no keys + * remain in the results. + * + * Generated from protobuf field string next_page_token = 2; + */ + private $next_page_token = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData>|\Google\Protobuf\Internal\RepeatedField $ip_overrides + * IP Overrides details. + * @type string $next_page_token + * Token to retrieve the next page of results. If this field is empty, no keys + * remain in the results. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * IP Overrides details. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.IpOverrideData ip_overrides = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getIpOverrides() + { + return $this->ip_overrides; + } + + /** + * IP Overrides details. + * + * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.IpOverrideData ip_overrides = 1; + * @param array<\Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setIpOverrides($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData::class); + $this->ip_overrides = $arr; + + return $this; + } + + /** + * Token to retrieve the next page of results. If this field is empty, no keys + * remain in the results. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * Token to retrieve the next page of results. If this field is empty, no keys + * remain in the results. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + +} + diff --git a/RecaptchaEnterprise/src/V1/ListKeysRequest.php b/RecaptchaEnterprise/src/V1/ListKeysRequest.php index b75c2d5d36bd..b2fa1187e61f 100644 --- a/RecaptchaEnterprise/src/V1/ListKeysRequest.php +++ b/RecaptchaEnterprise/src/V1/ListKeysRequest.php @@ -16,7 +16,7 @@ class ListKeysRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The name of the project that contains the keys that are + * Required. The name of the project that contains the keys that is * listed, in the format `projects/{project}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -38,7 +38,7 @@ class ListKeysRequest extends \Google\Protobuf\Internal\Message private $page_token = ''; /** - * @param string $parent Required. The name of the project that contains the keys that are + * @param string $parent Required. The name of the project that contains the keys that is * listed, in the format `projects/{project}`. Please see * {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field. * @@ -59,7 +59,7 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. The name of the project that contains the keys that are + * Required. The name of the project that contains the keys that is * listed, in the format `projects/{project}`. * @type int $page_size * Optional. The maximum number of keys to return. Default is 10. Max limit is @@ -75,7 +75,7 @@ public function __construct($data = NULL) { } /** - * Required. The name of the project that contains the keys that are + * Required. The name of the project that contains the keys that is * listed, in the format `projects/{project}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -87,7 +87,7 @@ public function getParent() } /** - * Required. The name of the project that contains the keys that are + * Required. The name of the project that contains the keys that is * listed, in the format `projects/{project}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/RecaptchaEnterprise/src/V1/Metrics.php b/RecaptchaEnterprise/src/V1/Metrics.php index e4b38840a77b..4dbaea7c4279 100644 --- a/RecaptchaEnterprise/src/V1/Metrics.php +++ b/RecaptchaEnterprise/src/V1/Metrics.php @@ -37,7 +37,7 @@ class Metrics extends \Google\Protobuf\Internal\Message private $score_metrics; /** * Metrics are continuous and in order by dates, and in the granularity - * of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have + * of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have * challenge-based data. * * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ChallengeMetrics challenge_metrics = 3; @@ -60,7 +60,7 @@ class Metrics extends \Google\Protobuf\Internal\Message * of day. All Key types should have score-based data. * @type array<\Google\Cloud\RecaptchaEnterprise\V1\ChallengeMetrics>|\Google\Protobuf\Internal\RepeatedField $challenge_metrics * Metrics are continuous and in order by dates, and in the granularity - * of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have + * of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have * challenge-based data. * } */ @@ -163,7 +163,7 @@ public function setScoreMetrics($var) /** * Metrics are continuous and in order by dates, and in the granularity - * of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have + * of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have * challenge-based data. * * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ChallengeMetrics challenge_metrics = 3; @@ -176,7 +176,7 @@ public function getChallengeMetrics() /** * Metrics are continuous and in order by dates, and in the granularity - * of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have + * of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have * challenge-based data. * * Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ChallengeMetrics challenge_metrics = 3; diff --git a/RecaptchaEnterprise/src/V1/RemoveIpOverrideRequest.php b/RecaptchaEnterprise/src/V1/RemoveIpOverrideRequest.php new file mode 100644 index 000000000000..c8a7dc776a8e --- /dev/null +++ b/RecaptchaEnterprise/src/V1/RemoveIpOverrideRequest.php @@ -0,0 +1,132 @@ +google.cloud.recaptchaenterprise.v1.RemoveIpOverrideRequest + */ +class RemoveIpOverrideRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the key from which the IP override is removed, in the + * format `projects/{project}/keys/{key}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + private $name = ''; + /** + * Required. IP override to be removed from the key. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.IpOverrideData ip_override_data = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + private $ip_override_data = null; + + /** + * @param string $name Required. The name of the key from which the IP override is removed, in the + * format `projects/{project}/keys/{key}`. Please see + * {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field. + * @param \Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData $ipOverrideData Required. IP override to be removed from the key. + * + * @return \Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideRequest + * + * @experimental + */ + public static function build(string $name, \Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData $ipOverrideData): self + { + return (new self()) + ->setName($name) + ->setIpOverrideData($ipOverrideData); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the key from which the IP override is removed, in the + * format `projects/{project}/keys/{key}`. + * @type \Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData $ip_override_data + * Required. IP override to be removed from the key. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the key from which the IP override is removed, in the + * format `projects/{project}/keys/{key}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the key from which the IP override is removed, in the + * format `projects/{project}/keys/{key}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Required. IP override to be removed from the key. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.IpOverrideData ip_override_data = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData|null + */ + public function getIpOverrideData() + { + return $this->ip_override_data; + } + + public function hasIpOverrideData() + { + return isset($this->ip_override_data); + } + + public function clearIpOverrideData() + { + unset($this->ip_override_data); + } + + /** + * Required. IP override to be removed from the key. + * + * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.IpOverrideData ip_override_data = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData $var + * @return $this + */ + public function setIpOverrideData($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData::class); + $this->ip_override_data = $var; + + return $this; + } + +} + diff --git a/RecaptchaEnterprise/src/V1/RemoveIpOverrideResponse.php b/RecaptchaEnterprise/src/V1/RemoveIpOverrideResponse.php new file mode 100644 index 000000000000..c6cb317ffd7b --- /dev/null +++ b/RecaptchaEnterprise/src/V1/RemoveIpOverrideResponse.php @@ -0,0 +1,33 @@ +google.cloud.recaptchaenterprise.v1.RemoveIpOverrideResponse + */ +class RemoveIpOverrideResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce(); + parent::__construct($data); + } + +} + diff --git a/RecaptchaEnterprise/src/V1/TestingOptions.php b/RecaptchaEnterprise/src/V1/TestingOptions.php index aeb1cae39c37..9089785eee65 100644 --- a/RecaptchaEnterprise/src/V1/TestingOptions.php +++ b/RecaptchaEnterprise/src/V1/TestingOptions.php @@ -16,15 +16,15 @@ class TestingOptions extends \Google\Protobuf\Internal\Message { /** - * Optional. All assessments for this Key will return this score. Must be - * between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key return this score. Must be between 0 + * (likely not legitimate) and 1 (likely legitimate) inclusive. * * Generated from protobuf field float testing_score = 1 [(.google.api.field_behavior) = OPTIONAL]; */ private $testing_score = 0.0; /** * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - * challenge requests for this site will return nocaptcha if NOCAPTCHA, or an + * challenge requests for this site return nocaptcha if NOCAPTCHA, or an * unsolvable challenge if CHALLENGE. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -38,11 +38,11 @@ class TestingOptions extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type float $testing_score - * Optional. All assessments for this Key will return this score. Must be - * between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key return this score. Must be between 0 + * (likely not legitimate) and 1 (likely legitimate) inclusive. * @type int $testing_challenge * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - * challenge requests for this site will return nocaptcha if NOCAPTCHA, or an + * challenge requests for this site return nocaptcha if NOCAPTCHA, or an * unsolvable challenge if CHALLENGE. * } */ @@ -52,8 +52,8 @@ public function __construct($data = NULL) { } /** - * Optional. All assessments for this Key will return this score. Must be - * between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key return this score. Must be between 0 + * (likely not legitimate) and 1 (likely legitimate) inclusive. * * Generated from protobuf field float testing_score = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return float @@ -64,8 +64,8 @@ public function getTestingScore() } /** - * Optional. All assessments for this Key will return this score. Must be - * between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key return this score. Must be between 0 + * (likely not legitimate) and 1 (likely legitimate) inclusive. * * Generated from protobuf field float testing_score = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param float $var @@ -81,7 +81,7 @@ public function setTestingScore($var) /** * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - * challenge requests for this site will return nocaptcha if NOCAPTCHA, or an + * challenge requests for this site return nocaptcha if NOCAPTCHA, or an * unsolvable challenge if CHALLENGE. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -94,7 +94,7 @@ public function getTestingChallenge() /** * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - * challenge requests for this site will return nocaptcha if NOCAPTCHA, or an + * challenge requests for this site return nocaptcha if NOCAPTCHA, or an * unsolvable challenge if CHALLENGE. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge testing_challenge = 2 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/RecaptchaEnterprise/src/V1/WafSettings/WafService.php b/RecaptchaEnterprise/src/V1/WafSettings/WafService.php index dce269321856..e56c885cea57 100644 --- a/RecaptchaEnterprise/src/V1/WafSettings/WafService.php +++ b/RecaptchaEnterprise/src/V1/WafSettings/WafService.php @@ -7,7 +7,7 @@ use UnexpectedValueException; /** - * Web Application Firewalls supported by reCAPTCHA Enterprise. + * Web Application Firewalls supported by reCAPTCHA. * * Protobuf type google.cloud.recaptchaenterprise.v1.WafSettings.WafService */ @@ -37,12 +37,19 @@ class WafService * Generated from protobuf enum CLOUDFLARE = 4; */ const CLOUDFLARE = 4; + /** + * Akamai + * + * Generated from protobuf enum AKAMAI = 5; + */ + const AKAMAI = 5; private static $valueToName = [ self::WAF_SERVICE_UNSPECIFIED => 'WAF_SERVICE_UNSPECIFIED', self::CA => 'CA', self::FASTLY => 'FASTLY', self::CLOUDFLARE => 'CLOUDFLARE', + self::AKAMAI => 'AKAMAI', ]; public static function name($value) diff --git a/RecaptchaEnterprise/src/V1/WebKeySettings.php b/RecaptchaEnterprise/src/V1/WebKeySettings.php index e2769bf8c85e..e7212e33013e 100644 --- a/RecaptchaEnterprise/src/V1/WebKeySettings.php +++ b/RecaptchaEnterprise/src/V1/WebKeySettings.php @@ -16,7 +16,7 @@ class WebKeySettings extends \Google\Protobuf\Internal\Message { /** - * Optional. If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains are not enforced. * * Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -46,7 +46,7 @@ class WebKeySettings extends \Google\Protobuf\Internal\Message /** * Optional. Settings for the frequency and difficulty at which this key * triggers captcha challenges. This should only be specified for - * IntegrationTypes CHECKBOX and INVISIBLE. + * IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -59,7 +59,7 @@ class WebKeySettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $allow_all_domains - * Optional. If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains are not enforced. * @type array|\Google\Protobuf\Internal\RepeatedField $allowed_domains * Optional. Domains or subdomains of websites allowed to use the key. All * subdomains of an allowed domain are automatically allowed. A valid domain @@ -73,7 +73,7 @@ class WebKeySettings extends \Google\Protobuf\Internal\Message * @type int $challenge_security_preference * Optional. Settings for the frequency and difficulty at which this key * triggers captcha challenges. This should only be specified for - * IntegrationTypes CHECKBOX and INVISIBLE. + * IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. * } */ public function __construct($data = NULL) { @@ -82,7 +82,7 @@ public function __construct($data = NULL) { } /** - * Optional. If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains are not enforced. * * Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -93,7 +93,7 @@ public function getAllowAllDomains() } /** - * Optional. If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains are not enforced. * * Generated from protobuf field bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var @@ -196,7 +196,7 @@ public function setIntegrationType($var) /** * Optional. Settings for the frequency and difficulty at which this key * triggers captcha challenges. This should only be specified for - * IntegrationTypes CHECKBOX and INVISIBLE. + * IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -209,7 +209,7 @@ public function getChallengeSecurityPreference() /** * Optional. Settings for the frequency and difficulty at which this key * triggers captcha challenges. This should only be specified for - * IntegrationTypes CHECKBOX and INVISIBLE. + * IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. * * Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var diff --git a/RecaptchaEnterprise/src/V1/gapic_metadata.json b/RecaptchaEnterprise/src/V1/gapic_metadata.json index 7a795f4739cf..43e4b3c3ad2c 100644 --- a/RecaptchaEnterprise/src/V1/gapic_metadata.json +++ b/RecaptchaEnterprise/src/V1/gapic_metadata.json @@ -65,6 +65,11 @@ "listFirewallPolicies" ] }, + "ListIpOverrides": { + "methods": [ + "listIpOverrides" + ] + }, "ListKeys": { "methods": [ "listKeys" @@ -85,6 +90,11 @@ "migrateKey" ] }, + "RemoveIpOverride": { + "methods": [ + "removeIpOverride" + ] + }, "ReorderFirewallPolicies": { "methods": [ "reorderFirewallPolicies" diff --git a/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_client_config.json b/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_client_config.json index 1fbdfbaa419d..8de76c7b19f3 100644 --- a/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_client_config.json +++ b/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_client_config.json @@ -81,6 +81,11 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "ListIpOverrides": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "ListKeys": { "timeout_millis": 600000, "retry_codes_name": "no_retry_1_codes", @@ -101,6 +106,11 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "RemoveIpOverride": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "ReorderFirewallPolicies": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", diff --git a/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_descriptor_config.php b/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_descriptor_config.php index 7161900dc029..676193e04bbf 100644 --- a/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_descriptor_config.php +++ b/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_descriptor_config.php @@ -163,6 +163,26 @@ ], ], ], + 'ListIpOverrides' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getIpOverrides', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'ListKeys' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', @@ -235,6 +255,18 @@ ], ], ], + 'RemoveIpOverride' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'ReorderFirewallPolicies' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse', diff --git a/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_rest_client_config.php b/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_rest_client_config.php index cf28799784f0..43261e80848d 100644 --- a/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_rest_client_config.php +++ b/RecaptchaEnterprise/src/V1/resources/recaptcha_enterprise_service_rest_client_config.php @@ -149,6 +149,17 @@ ], ], ], + 'ListIpOverrides' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/keys/*}:listIpOverrides', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'ListKeys' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*}/keys', @@ -194,6 +205,18 @@ ], ], ], + 'RemoveIpOverride' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/keys/*}:removeIpOverride', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'ReorderFirewallPolicies' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*}/firewallpolicies:reorder', diff --git a/RecaptchaEnterprise/tests/Unit/V1/Client/RecaptchaEnterpriseServiceClientTest.php b/RecaptchaEnterprise/tests/Unit/V1/Client/RecaptchaEnterpriseServiceClientTest.php index 2f8c44b17e8c..65f3cd7edf5b 100644 --- a/RecaptchaEnterprise/tests/Unit/V1/Client/RecaptchaEnterpriseServiceClientTest.php +++ b/RecaptchaEnterprise/tests/Unit/V1/Client/RecaptchaEnterpriseServiceClientTest.php @@ -47,6 +47,8 @@ use Google\Cloud\RecaptchaEnterprise\V1\Key; use Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesRequest; use Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesResponse; +use Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest; +use Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesResponse; use Google\Cloud\RecaptchaEnterprise\V1\ListKeysRequest; use Google\Cloud\RecaptchaEnterprise\V1\ListKeysResponse; use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsRequest; @@ -57,6 +59,8 @@ use Google\Cloud\RecaptchaEnterprise\V1\MigrateKeyRequest; use Google\Cloud\RecaptchaEnterprise\V1\RelatedAccountGroup; use Google\Cloud\RecaptchaEnterprise\V1\RelatedAccountGroupMembership; +use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideRequest; +use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse; use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesRequest; use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse; use Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyRequest; @@ -857,6 +861,78 @@ public function listFirewallPoliciesExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function listIpOverridesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $ipOverridesElement = new IpOverrideData(); + $ipOverrides = [ + $ipOverridesElement, + ]; + $expectedResponse = new ListIpOverridesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setIpOverrides($ipOverrides); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->keyName('[PROJECT]', '[KEY]'); + $request = (new ListIpOverridesRequest()) + ->setParent($formattedParent); + $response = $gapicClient->listIpOverrides($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getIpOverrides()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListIpOverrides', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listIpOverridesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode([ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], JSON_PRETTY_PRINT); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->keyName('[PROJECT]', '[KEY]'); + $request = (new ListIpOverridesRequest()) + ->setParent($formattedParent); + try { + $gapicClient->listIpOverrides($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function listKeysTest() { @@ -1139,6 +1215,82 @@ public function migrateKeyExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function removeIpOverrideTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new RemoveIpOverrideResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->keyName('[PROJECT]', '[KEY]'); + $ipOverrideData = new IpOverrideData(); + $ipOverrideDataIp = 'ipOverrideDataIp1421737572'; + $ipOverrideData->setIp($ipOverrideDataIp); + $ipOverrideDataOverrideType = OverrideType::OVERRIDE_TYPE_UNSPECIFIED; + $ipOverrideData->setOverrideType($ipOverrideDataOverrideType); + $request = (new RemoveIpOverrideRequest()) + ->setName($formattedName) + ->setIpOverrideData($ipOverrideData); + $response = $gapicClient->removeIpOverride($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/RemoveIpOverride', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $actualValue = $actualRequestObject->getIpOverrideData(); + $this->assertProtobufEquals($ipOverrideData, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function removeIpOverrideExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode([ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], JSON_PRETTY_PRINT); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->keyName('[PROJECT]', '[KEY]'); + $ipOverrideData = new IpOverrideData(); + $ipOverrideDataIp = 'ipOverrideDataIp1421737572'; + $ipOverrideData->setIp($ipOverrideDataIp); + $ipOverrideDataOverrideType = OverrideType::OVERRIDE_TYPE_UNSPECIFIED; + $ipOverrideData->setOverrideType($ipOverrideDataOverrideType); + $request = (new RemoveIpOverrideRequest()) + ->setName($formattedName) + ->setIpOverrideData($ipOverrideData); + try { + $gapicClient->removeIpOverride($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function reorderFirewallPoliciesTest() { diff --git a/RecaptchaEnterprise/tests/Unit/V1/RecaptchaEnterpriseServiceClientTest.php b/RecaptchaEnterprise/tests/Unit/V1/RecaptchaEnterpriseServiceClientTest.php index 089b4d878935..262d365dac89 100644 --- a/RecaptchaEnterprise/tests/Unit/V1/RecaptchaEnterpriseServiceClientTest.php +++ b/RecaptchaEnterprise/tests/Unit/V1/RecaptchaEnterpriseServiceClientTest.php @@ -35,6 +35,7 @@ use Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData\OverrideType; use Google\Cloud\RecaptchaEnterprise\V1\Key; use Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesResponse; +use Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesResponse; use Google\Cloud\RecaptchaEnterprise\V1\ListKeysResponse; use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsResponse; use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupsResponse; @@ -42,6 +43,7 @@ use Google\Cloud\RecaptchaEnterprise\V1\RecaptchaEnterpriseServiceClient; use Google\Cloud\RecaptchaEnterprise\V1\RelatedAccountGroup; use Google\Cloud\RecaptchaEnterprise\V1\RelatedAccountGroupMembership; +use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse; use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse; use Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyResponse; use Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsResponse; @@ -783,6 +785,74 @@ public function listFirewallPoliciesExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function listIpOverridesTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $ipOverridesElement = new IpOverrideData(); + $ipOverrides = [ + $ipOverridesElement, + ]; + $expectedResponse = new ListIpOverridesResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setIpOverrides($ipOverrides); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->keyName('[PROJECT]', '[KEY]'); + $response = $gapicClient->listIpOverrides($formattedParent); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getIpOverrides()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListIpOverrides', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listIpOverridesExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode([ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], JSON_PRETTY_PRINT); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->keyName('[PROJECT]', '[KEY]'); + try { + $gapicClient->listIpOverrides($formattedParent); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function listKeysTest() { @@ -1049,6 +1119,76 @@ public function migrateKeyExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function removeIpOverrideTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new RemoveIpOverrideResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->keyName('[PROJECT]', '[KEY]'); + $ipOverrideData = new IpOverrideData(); + $ipOverrideDataIp = 'ipOverrideDataIp1421737572'; + $ipOverrideData->setIp($ipOverrideDataIp); + $ipOverrideDataOverrideType = OverrideType::OVERRIDE_TYPE_UNSPECIFIED; + $ipOverrideData->setOverrideType($ipOverrideDataOverrideType); + $response = $gapicClient->removeIpOverride($formattedName, $ipOverrideData); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/RemoveIpOverride', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $actualValue = $actualRequestObject->getIpOverrideData(); + $this->assertProtobufEquals($ipOverrideData, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function removeIpOverrideExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode([ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], JSON_PRETTY_PRINT); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->keyName('[PROJECT]', '[KEY]'); + $ipOverrideData = new IpOverrideData(); + $ipOverrideDataIp = 'ipOverrideDataIp1421737572'; + $ipOverrideData->setIp($ipOverrideDataIp); + $ipOverrideDataOverrideType = OverrideType::OVERRIDE_TYPE_UNSPECIFIED; + $ipOverrideData->setOverrideType($ipOverrideDataOverrideType); + try { + $gapicClient->removeIpOverride($formattedName, $ipOverrideData); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function reorderFirewallPoliciesTest() { From ab36815118c7fea625e734ca3957fe4addd55c6e Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:41:17 -0400 Subject: [PATCH 054/157] feat: Add GroundedGenerationService API (#7781) feat: Add AdvancedCompleteQuery API feat: Add lite search API to allow public website search with API key feat: Add Sitemap APIs to preview channel feat: Support search personalization to preview channel feat: Support natural language understanding search feat: Add BillingEstimation in data store feat: Support Google Workspace search feat: Support advanced boost search feat: Add one_box_page_size on search feat: support query regex in control match rules docs: deprecate extractive_answers in answer generation docs: deprecate asynchronous mode in answer generation docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 691212731 Source-Link: https://github.com/googleapis/googleapis/commit/e6b6ff9b7b3659641488e772355cdc78aac488ff Source-Link: https://github.com/googleapis/googleapis-gen/commit/67144fd43c5a3e164410b3617e5752f2e066ec25 Copy-Tag: eyJwIjoiRXZlbnRhcmNQdWJsaXNoaW5nLy5Pd2xCb3QueWFtbCIsImgiOiI2NzE0NGZkNDNjNWEzZTE2NDQxMGIzNjE3ZTU3NTJmMmUwNjZlYzI1In0= --- EventarcPublishing/metadata/V1/CloudEvent.php | Bin 0 -> 1805 bytes EventarcPublishing/metadata/V1/Publisher.php | Bin 2032 -> 2735 bytes .../samples/V1/PublisherClient/publish.php | 71 ++++ .../src/V1/Client/PublisherClient.php | 29 ++ EventarcPublishing/src/V1/CloudEvent.php | 328 ++++++++++++++++++ .../CloudEvent/CloudEventAttributeValue.php | 274 +++++++++++++++ EventarcPublishing/src/V1/PublishRequest.php | 197 +++++++++++ EventarcPublishing/src/V1/PublishResponse.php | 33 ++ EventarcPublishing/src/V1/gapic_metadata.json | 5 + .../V1/resources/publisher_client_config.json | 5 + .../resources/publisher_descriptor_config.php | 12 + .../publisher_rest_client_config.php | 12 + .../Unit/V1/Client/PublisherClientTest.php | 82 ++++- 13 files changed, 1040 insertions(+), 8 deletions(-) create mode 100644 EventarcPublishing/metadata/V1/CloudEvent.php create mode 100644 EventarcPublishing/samples/V1/PublisherClient/publish.php create mode 100644 EventarcPublishing/src/V1/CloudEvent.php create mode 100644 EventarcPublishing/src/V1/CloudEvent/CloudEventAttributeValue.php create mode 100644 EventarcPublishing/src/V1/PublishRequest.php create mode 100644 EventarcPublishing/src/V1/PublishResponse.php diff --git a/EventarcPublishing/metadata/V1/CloudEvent.php b/EventarcPublishing/metadata/V1/CloudEvent.php new file mode 100644 index 0000000000000000000000000000000000000000..406503720aea215b68f9c84e521a5e22b53b598a GIT binary patch literal 1805 zcmbVM&2AG(5XMeol5(Uh1BZz(Gz2L|g0bw?N~;M0*_+^SfcOxF6&lHEkIPPLCq1K{ z9t#uYQFs9!g)1+>nO9&B^p9u8A^{%1-;-y_Spqwxj~oS+I3}Yxk!MH} z5z9D?BQnY+6BHzj&l47*@CZ3LCa;c9$l<|@lY8oD8fPLzpG@O;8euDp;%wZ)8FEQQ z*h;cd#L_dyr>$ArCWj{JnHvB&J;yYmA(H-}_Yx%?Q%Qrq0So@oV8P)6EEp7E!D)LB zAdG055>sSq-~x#HnL9(0N-9}M9vX~Qn;FyQl zd`K*&u6>ZiijaMhcQ?=+DSm<%T%zDK3Jx$01xsWs2CCHerzi_%b)@-lajk}96VkLj z`u>$B_lXo4F5gawK$!`?XZqFvm&I3b4R_sy1*Bvbe>+<<; zoH}7@rIMZ}*Pk^sK7Ps;q;<#Rf}`h3V$EVIJ>xFCUx&YbOIyy4J?0rndbuRMQj*@R z-Pm4W8#$_FwkV%lZ8q+HpOX1tw&4E%s{p0?oGqxbv0EXP=0oL&aLZPTPEKi*p>s#QVH}Rs%RtHvbL;938`b)lqA=90spxIkP_?Pzf=?}JD(Jwv z2AFGdG;5nG_6O8dEE7!8rB+b@s>o2_#7wHA9oSTL#ZFy4XT8(7GE5=oqZ_>%tm<_% zE?}z|B{ifvby)ci=XU+hYgn7<2~GF)&QT8fGbt`_>_?3G)xRsc3B9u3*9ru?%9wuz zyth?Cn&&;Jyy@F+axul{t!aF%bJK(=^Df^_GTK}I^P#%aH-2p=@N&QQ28CaHr|pk< zRj{!2($|-bT{-)gYOreoecyEL`#GfVmzchP+8))6=KkC*OyiL?&LyAyp~sp^>x7qZ G3GfX(FF_Ch literal 0 HcmV?d00001 diff --git a/EventarcPublishing/metadata/V1/Publisher.php b/EventarcPublishing/metadata/V1/Publisher.php index 026594dd2e33f1bdfc82cd64951bd834a6a3ca01..e9952863ea7780af482e83d278a08511657aea58 100644 GIT binary patch delta 464 zcmeyszg~2ME0dsOL1v6wW@=7~Q))(HS!RCGLU zbMi}5T+34PN?^j1U6}$|I{CPaCwd!CKFefpFQ1;DpPrMdpIDHop9V5IJ_%~JUO`cQ zNxqachJs9>HBd>@iQXz4$sk+eQ_D6pF?%z*DXnAV;tMEE%E>Iw2udw1O)V}FlHlUb zO)V}?OiztZDlL{^RAAKLbYgzs$Ry;!#S6A39x5-v1eD`8(x2SGqKf2v4+bGIE}pF7 z{5-fqW{@Ee@x-#Ce7HCZP@Knu!HI*5EiJz&H?c%Xkc%Jgp5lW1yy8@&$!wbgSbj3{ z2_0bMVuwl!83QfV;e@(b$^^s<3`&LQQ1WWJ{A4ndi;}&5nW26)l5cE*?$1h1E-BX6 i($C3HPAtg;+5lujl{l3arvkaPRt1nC+3d!)iV*-GESRGJ delta 46 zcmZ24`hkCgE7N2S=0KKSE-vHAd@L#x^Z6%FV7A}v!s5utY;=KTvk%)(#?2g@%NYSc CSPgIh diff --git a/EventarcPublishing/samples/V1/PublisherClient/publish.php b/EventarcPublishing/samples/V1/PublisherClient/publish.php new file mode 100644 index 000000000000..80fce160f988 --- /dev/null +++ b/EventarcPublishing/samples/V1/PublisherClient/publish.php @@ -0,0 +1,71 @@ +setMessageBus($messageBus); + + // Call the API and handle any network failures. + try { + /** @var PublishResponse $response */ + $response = $publisherClient->publish($request); + printf('Response data: %s' . PHP_EOL, $response->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 +{ + $messageBus = '[MESSAGE_BUS]'; + + publish_sample($messageBus); +} +// [END eventarcpublishing_v1_generated_Publisher_Publish_sync] diff --git a/EventarcPublishing/src/V1/Client/PublisherClient.php b/EventarcPublishing/src/V1/Client/PublisherClient.php index de480d4d2f4d..5598ecb5fb68 100644 --- a/EventarcPublishing/src/V1/Client/PublisherClient.php +++ b/EventarcPublishing/src/V1/Client/PublisherClient.php @@ -35,6 +35,8 @@ use Google\Cloud\Eventarc\Publishing\V1\PublishChannelConnectionEventsResponse; use Google\Cloud\Eventarc\Publishing\V1\PublishEventsRequest; use Google\Cloud\Eventarc\Publishing\V1\PublishEventsResponse; +use Google\Cloud\Eventarc\Publishing\V1\PublishRequest; +use Google\Cloud\Eventarc\Publishing\V1\PublishResponse; use Google\Protobuf\Any; use GuzzleHttp\Promise\PromiseInterface; @@ -67,6 +69,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * + * @method PromiseInterface publishAsync(PublishRequest $request, array $optionalArgs = []) * @method PromiseInterface publishChannelConnectionEventsAsync(PublishChannelConnectionEventsRequest $request, array $optionalArgs = []) * @method PromiseInterface publishEventsAsync(PublishEventsRequest $request, array $optionalArgs = []) */ @@ -186,6 +189,32 @@ public function __call($method, $args) return call_user_func_array([$this, 'startAsyncCall'], $args); } + /** + * Publish events to a message bus. + * + * The async variant is {@see PublisherClient::publishAsync()} . + * + * @example samples/V1/PublisherClient/publish.php + * + * @param PublishRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PublishResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function publish(PublishRequest $request, array $callOptions = []): PublishResponse + { + return $this->startApiCall('Publish', $request, $callOptions)->wait(); + } + /** * Publish events to a ChannelConnection in a partner's project. * diff --git a/EventarcPublishing/src/V1/CloudEvent.php b/EventarcPublishing/src/V1/CloudEvent.php new file mode 100644 index 000000000000..59178671d8c9 --- /dev/null +++ b/EventarcPublishing/src/V1/CloudEvent.php @@ -0,0 +1,328 @@ +google.cloud.eventarc.publishing.v1.CloudEvent + */ +class CloudEvent extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Identifies the event. Producers MUST ensure that source + id is + * unique for each distinct event. + * + * Generated from protobuf field string id = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $id = ''; + /** + * Required. Identifies the context in which an event happened. + * URI-reference + * + * Generated from protobuf field string source = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $source = ''; + /** + * Required. The version of the CloudEvents specification which the event + * uses. + * + * Generated from protobuf field string spec_version = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $spec_version = ''; + /** + * Required. This attribute contains a value describing the type of event + * related to the originating occurrence. + * + * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $type = ''; + /** + * Optional. Used for Optional & Extension Attributes + * + * Generated from protobuf field map attributes = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $attributes; + protected $data; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $id + * Required. Identifies the event. Producers MUST ensure that source + id is + * unique for each distinct event. + * @type string $source + * Required. Identifies the context in which an event happened. + * URI-reference + * @type string $spec_version + * Required. The version of the CloudEvents specification which the event + * uses. + * @type string $type + * Required. This attribute contains a value describing the type of event + * related to the originating occurrence. + * @type array|\Google\Protobuf\Internal\MapField $attributes + * Optional. Used for Optional & Extension Attributes + * @type string $binary_data + * Optional. Binary data. + * @type string $text_data + * Optional. Text data. + * @type \Google\Protobuf\Any $proto_data + * Optional. Proto data. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\Publishing\V1\CloudEvent::initOnce(); + parent::__construct($data); + } + + /** + * Required. Identifies the event. Producers MUST ensure that source + id is + * unique for each distinct event. + * + * Generated from protobuf field string id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getId() + { + return $this->id; + } + + /** + * Required. Identifies the event. Producers MUST ensure that source + id is + * unique for each distinct event. + * + * Generated from protobuf field string id = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setId($var) + { + GPBUtil::checkString($var, True); + $this->id = $var; + + return $this; + } + + /** + * Required. Identifies the context in which an event happened. + * URI-reference + * + * Generated from protobuf field string source = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getSource() + { + return $this->source; + } + + /** + * Required. Identifies the context in which an event happened. + * URI-reference + * + * Generated from protobuf field string source = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setSource($var) + { + GPBUtil::checkString($var, True); + $this->source = $var; + + return $this; + } + + /** + * Required. The version of the CloudEvents specification which the event + * uses. + * + * Generated from protobuf field string spec_version = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getSpecVersion() + { + return $this->spec_version; + } + + /** + * Required. The version of the CloudEvents specification which the event + * uses. + * + * Generated from protobuf field string spec_version = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setSpecVersion($var) + { + GPBUtil::checkString($var, True); + $this->spec_version = $var; + + return $this; + } + + /** + * Required. This attribute contains a value describing the type of event + * related to the originating occurrence. + * + * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * Required. This attribute contains a value describing the type of event + * related to the originating occurrence. + * + * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + + /** + * Optional. Used for Optional & Extension Attributes + * + * Generated from protobuf field map attributes = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAttributes() + { + return $this->attributes; + } + + /** + * Optional. Used for Optional & Extension Attributes + * + * Generated from protobuf field map attributes = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAttributes($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Eventarc\Publishing\V1\CloudEvent\CloudEventAttributeValue::class); + $this->attributes = $arr; + + return $this; + } + + /** + * Optional. Binary data. + * + * Generated from protobuf field bytes binary_data = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getBinaryData() + { + return $this->readOneof(6); + } + + public function hasBinaryData() + { + return $this->hasOneof(6); + } + + /** + * Optional. Binary data. + * + * Generated from protobuf field bytes binary_data = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setBinaryData($var) + { + GPBUtil::checkString($var, False); + $this->writeOneof(6, $var); + + return $this; + } + + /** + * Optional. Text data. + * + * Generated from protobuf field string text_data = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getTextData() + { + return $this->readOneof(7); + } + + public function hasTextData() + { + return $this->hasOneof(7); + } + + /** + * Optional. Text data. + * + * Generated from protobuf field string text_data = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setTextData($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(7, $var); + + return $this; + } + + /** + * Optional. Proto data. + * + * Generated from protobuf field .google.protobuf.Any proto_data = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Any|null + */ + public function getProtoData() + { + return $this->readOneof(8); + } + + public function hasProtoData() + { + return $this->hasOneof(8); + } + + /** + * Optional. Proto data. + * + * Generated from protobuf field .google.protobuf.Any proto_data = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Any $var + * @return $this + */ + public function setProtoData($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Any::class); + $this->writeOneof(8, $var); + + return $this; + } + + /** + * @return string + */ + public function getData() + { + return $this->whichOneof("data"); + } + +} + diff --git a/EventarcPublishing/src/V1/CloudEvent/CloudEventAttributeValue.php b/EventarcPublishing/src/V1/CloudEvent/CloudEventAttributeValue.php new file mode 100644 index 000000000000..226c118df6f1 --- /dev/null +++ b/EventarcPublishing/src/V1/CloudEvent/CloudEventAttributeValue.php @@ -0,0 +1,274 @@ +google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue + */ +class CloudEventAttributeValue extends \Google\Protobuf\Internal\Message +{ + protected $attr; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $ce_boolean + * Boolean value. + * @type int $ce_integer + * Integer value. + * @type string $ce_string + * String value. + * @type string $ce_bytes + * Bytes value. + * @type string $ce_uri + * URI value. + * @type string $ce_uri_ref + * URI-reference value. + * @type \Google\Protobuf\Timestamp $ce_timestamp + * Timestamp value. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\Publishing\V1\CloudEvent::initOnce(); + parent::__construct($data); + } + + /** + * Boolean value. + * + * Generated from protobuf field bool ce_boolean = 1; + * @return bool + */ + public function getCeBoolean() + { + return $this->readOneof(1); + } + + public function hasCeBoolean() + { + return $this->hasOneof(1); + } + + /** + * Boolean value. + * + * Generated from protobuf field bool ce_boolean = 1; + * @param bool $var + * @return $this + */ + public function setCeBoolean($var) + { + GPBUtil::checkBool($var); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * Integer value. + * + * Generated from protobuf field int32 ce_integer = 2; + * @return int + */ + public function getCeInteger() + { + return $this->readOneof(2); + } + + public function hasCeInteger() + { + return $this->hasOneof(2); + } + + /** + * Integer value. + * + * Generated from protobuf field int32 ce_integer = 2; + * @param int $var + * @return $this + */ + public function setCeInteger($var) + { + GPBUtil::checkInt32($var); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * String value. + * + * Generated from protobuf field string ce_string = 3; + * @return string + */ + public function getCeString() + { + return $this->readOneof(3); + } + + public function hasCeString() + { + return $this->hasOneof(3); + } + + /** + * String value. + * + * Generated from protobuf field string ce_string = 3; + * @param string $var + * @return $this + */ + public function setCeString($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Bytes value. + * + * Generated from protobuf field bytes ce_bytes = 4; + * @return string + */ + public function getCeBytes() + { + return $this->readOneof(4); + } + + public function hasCeBytes() + { + return $this->hasOneof(4); + } + + /** + * Bytes value. + * + * Generated from protobuf field bytes ce_bytes = 4; + * @param string $var + * @return $this + */ + public function setCeBytes($var) + { + GPBUtil::checkString($var, False); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * URI value. + * + * Generated from protobuf field string ce_uri = 5; + * @return string + */ + public function getCeUri() + { + return $this->readOneof(5); + } + + public function hasCeUri() + { + return $this->hasOneof(5); + } + + /** + * URI value. + * + * Generated from protobuf field string ce_uri = 5; + * @param string $var + * @return $this + */ + public function setCeUri($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(5, $var); + + return $this; + } + + /** + * URI-reference value. + * + * Generated from protobuf field string ce_uri_ref = 6; + * @return string + */ + public function getCeUriRef() + { + return $this->readOneof(6); + } + + public function hasCeUriRef() + { + return $this->hasOneof(6); + } + + /** + * URI-reference value. + * + * Generated from protobuf field string ce_uri_ref = 6; + * @param string $var + * @return $this + */ + public function setCeUriRef($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(6, $var); + + return $this; + } + + /** + * Timestamp value. + * + * Generated from protobuf field .google.protobuf.Timestamp ce_timestamp = 7; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCeTimestamp() + { + return $this->readOneof(7); + } + + public function hasCeTimestamp() + { + return $this->hasOneof(7); + } + + /** + * Timestamp value. + * + * Generated from protobuf field .google.protobuf.Timestamp ce_timestamp = 7; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCeTimestamp($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->writeOneof(7, $var); + + return $this; + } + + /** + * @return string + */ + public function getAttr() + { + return $this->whichOneof("attr"); + } + +} + + diff --git a/EventarcPublishing/src/V1/PublishRequest.php b/EventarcPublishing/src/V1/PublishRequest.php new file mode 100644 index 000000000000..ce20979caf11 --- /dev/null +++ b/EventarcPublishing/src/V1/PublishRequest.php @@ -0,0 +1,197 @@ +google.cloud.eventarc.publishing.v1.PublishRequest + */ +class PublishRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The full name of the message bus to publish events to. Format: + * `projects/{project}/locations/{location}/messageBuses/{messageBus}`. + * + * Generated from protobuf field string message_bus = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $message_bus = ''; + protected $format; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $message_bus + * Required. The full name of the message bus to publish events to. Format: + * `projects/{project}/locations/{location}/messageBuses/{messageBus}`. + * @type \Google\Cloud\Eventarc\Publishing\V1\CloudEvent $proto_message + * The Protobuf format of the CloudEvent being published. Specification can + * be found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/protobuf-format.md + * @type string $json_message + * The JSON format of the CloudEvent being published. Specification can be + * found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md + * @type string $avro_message + * The Avro format of the CloudEvent being published. Specification can + * be found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/avro-format.md + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\Publishing\V1\Publisher::initOnce(); + parent::__construct($data); + } + + /** + * Required. The full name of the message bus to publish events to. Format: + * `projects/{project}/locations/{location}/messageBuses/{messageBus}`. + * + * Generated from protobuf field string message_bus = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getMessageBus() + { + return $this->message_bus; + } + + /** + * Required. The full name of the message bus to publish events to. Format: + * `projects/{project}/locations/{location}/messageBuses/{messageBus}`. + * + * Generated from protobuf field string message_bus = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setMessageBus($var) + { + GPBUtil::checkString($var, True); + $this->message_bus = $var; + + return $this; + } + + /** + * The Protobuf format of the CloudEvent being published. Specification can + * be found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/protobuf-format.md + * + * Generated from protobuf field .google.cloud.eventarc.publishing.v1.CloudEvent proto_message = 2; + * @return \Google\Cloud\Eventarc\Publishing\V1\CloudEvent|null + */ + public function getProtoMessage() + { + return $this->readOneof(2); + } + + public function hasProtoMessage() + { + return $this->hasOneof(2); + } + + /** + * The Protobuf format of the CloudEvent being published. Specification can + * be found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/protobuf-format.md + * + * Generated from protobuf field .google.cloud.eventarc.publishing.v1.CloudEvent proto_message = 2; + * @param \Google\Cloud\Eventarc\Publishing\V1\CloudEvent $var + * @return $this + */ + public function setProtoMessage($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Eventarc\Publishing\V1\CloudEvent::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * The JSON format of the CloudEvent being published. Specification can be + * found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md + * + * Generated from protobuf field string json_message = 3; + * @return string + */ + public function getJsonMessage() + { + return $this->readOneof(3); + } + + public function hasJsonMessage() + { + return $this->hasOneof(3); + } + + /** + * The JSON format of the CloudEvent being published. Specification can be + * found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md + * + * Generated from protobuf field string json_message = 3; + * @param string $var + * @return $this + */ + public function setJsonMessage($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * The Avro format of the CloudEvent being published. Specification can + * be found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/avro-format.md + * + * Generated from protobuf field bytes avro_message = 4; + * @return string + */ + public function getAvroMessage() + { + return $this->readOneof(4); + } + + public function hasAvroMessage() + { + return $this->hasOneof(4); + } + + /** + * The Avro format of the CloudEvent being published. Specification can + * be found here: + * https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/avro-format.md + * + * Generated from protobuf field bytes avro_message = 4; + * @param string $var + * @return $this + */ + public function setAvroMessage($var) + { + GPBUtil::checkString($var, False); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * @return string + */ + public function getFormat() + { + return $this->whichOneof("format"); + } + +} + diff --git a/EventarcPublishing/src/V1/PublishResponse.php b/EventarcPublishing/src/V1/PublishResponse.php new file mode 100644 index 000000000000..76e083aea440 --- /dev/null +++ b/EventarcPublishing/src/V1/PublishResponse.php @@ -0,0 +1,33 @@ +google.cloud.eventarc.publishing.v1.PublishResponse + */ +class PublishResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Eventarc\Publishing\V1\Publisher::initOnce(); + parent::__construct($data); + } + +} + diff --git a/EventarcPublishing/src/V1/gapic_metadata.json b/EventarcPublishing/src/V1/gapic_metadata.json index ea1b74edc868..8c15efbe6be4 100644 --- a/EventarcPublishing/src/V1/gapic_metadata.json +++ b/EventarcPublishing/src/V1/gapic_metadata.json @@ -10,6 +10,11 @@ "grpc": { "libraryClient": "PublisherGapicClient", "rpcs": { + "Publish": { + "methods": [ + "publish" + ] + }, "PublishChannelConnectionEvents": { "methods": [ "publishChannelConnectionEvents" diff --git a/EventarcPublishing/src/V1/resources/publisher_client_config.json b/EventarcPublishing/src/V1/resources/publisher_client_config.json index 4eca798f5b16..8e360d5b8878 100644 --- a/EventarcPublishing/src/V1/resources/publisher_client_config.json +++ b/EventarcPublishing/src/V1/resources/publisher_client_config.json @@ -26,6 +26,11 @@ } }, "methods": { + "Publish": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_1_codes", + "retry_params_name": "no_retry_1_params" + }, "PublishChannelConnectionEvents": { "timeout_millis": 60000, "retry_codes_name": "no_retry_1_codes", diff --git a/EventarcPublishing/src/V1/resources/publisher_descriptor_config.php b/EventarcPublishing/src/V1/resources/publisher_descriptor_config.php index ebce97ea4ab1..bff99c08e674 100644 --- a/EventarcPublishing/src/V1/resources/publisher_descriptor_config.php +++ b/EventarcPublishing/src/V1/resources/publisher_descriptor_config.php @@ -23,6 +23,18 @@ return [ 'interfaces' => [ 'google.cloud.eventarc.publishing.v1.Publisher' => [ + 'Publish' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Eventarc\Publishing\V1\PublishResponse', + 'headerParams' => [ + [ + 'keyName' => 'message_bus', + 'fieldAccessors' => [ + 'getMessageBus', + ], + ], + ], + ], 'PublishChannelConnectionEvents' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\Eventarc\Publishing\V1\PublishChannelConnectionEventsResponse', diff --git a/EventarcPublishing/src/V1/resources/publisher_rest_client_config.php b/EventarcPublishing/src/V1/resources/publisher_rest_client_config.php index 8922a23ca60d..5730c0aa7b57 100644 --- a/EventarcPublishing/src/V1/resources/publisher_rest_client_config.php +++ b/EventarcPublishing/src/V1/resources/publisher_rest_client_config.php @@ -23,6 +23,18 @@ return [ 'interfaces' => [ 'google.cloud.eventarc.publishing.v1.Publisher' => [ + 'Publish' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{message_bus=projects/*/locations/*/messageBuses/*}:publish', + 'body' => '*', + 'placeholders' => [ + 'message_bus' => [ + 'getters' => [ + 'getMessageBus', + ], + ], + ], + ], 'PublishChannelConnectionEvents' => [ 'method' => 'post', 'uriTemplate' => '/v1/{channel_connection=projects/*/locations/*/channelConnections/*}:publishEvents', diff --git a/EventarcPublishing/tests/Unit/V1/Client/PublisherClientTest.php b/EventarcPublishing/tests/Unit/V1/Client/PublisherClientTest.php index e65da6bd5056..49c8165ab0d0 100644 --- a/EventarcPublishing/tests/Unit/V1/Client/PublisherClientTest.php +++ b/EventarcPublishing/tests/Unit/V1/Client/PublisherClientTest.php @@ -31,6 +31,8 @@ use Google\Cloud\Eventarc\Publishing\V1\PublishChannelConnectionEventsResponse; use Google\Cloud\Eventarc\Publishing\V1\PublishEventsRequest; use Google\Cloud\Eventarc\Publishing\V1\PublishEventsResponse; +use Google\Cloud\Eventarc\Publishing\V1\PublishRequest; +use Google\Cloud\Eventarc\Publishing\V1\PublishResponse; use Google\Rpc\Code; use stdClass; @@ -64,6 +66,69 @@ private function createClient(array $options = []) return new PublisherClient($options); } + /** @test */ + public function publishTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new PublishResponse(); + $transport->addResponse($expectedResponse); + // Mock request + $messageBus = 'messageBus-872787384'; + $request = (new PublishRequest())->setMessageBus($messageBus); + $response = $gapicClient->publish($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.eventarc.publishing.v1.Publisher/Publish', $actualFuncCall); + $actualValue = $actualRequestObject->getMessageBus(); + $this->assertProtobufEquals($messageBus, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function publishExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $messageBus = 'messageBus-872787384'; + $request = (new PublishRequest())->setMessageBus($messageBus); + try { + $gapicClient->publish($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function publishChannelConnectionEventsTest() { @@ -182,7 +247,7 @@ public function publishEventsExceptionTest() } /** @test */ - public function publishChannelConnectionEventsAsyncTest() + public function publishAsyncTest() { $transport = $this->createTransport(); $gapicClient = $this->createClient([ @@ -190,19 +255,20 @@ public function publishChannelConnectionEventsAsyncTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response - $expectedResponse = new PublishChannelConnectionEventsResponse(); + $expectedResponse = new PublishResponse(); $transport->addResponse($expectedResponse); - $request = new PublishChannelConnectionEventsRequest(); - $response = $gapicClient->publishChannelConnectionEventsAsync($request)->wait(); + // Mock request + $messageBus = 'messageBus-872787384'; + $request = (new PublishRequest())->setMessageBus($messageBus); + $response = $gapicClient->publishAsync($request)->wait(); $this->assertEquals($expectedResponse, $response); $actualRequests = $transport->popReceivedCalls(); $this->assertSame(1, count($actualRequests)); $actualFuncCall = $actualRequests[0]->getFuncCall(); $actualRequestObject = $actualRequests[0]->getRequestObject(); - $this->assertSame( - '/google.cloud.eventarc.publishing.v1.Publisher/PublishChannelConnectionEvents', - $actualFuncCall - ); + $this->assertSame('/google.cloud.eventarc.publishing.v1.Publisher/Publish', $actualFuncCall); + $actualValue = $actualRequestObject->getMessageBus(); + $this->assertProtobufEquals($messageBus, $actualValue); $this->assertTrue($transport->isExhausted()); } } From cb053e3bcb689eb10630380d9b843df437ef3a10 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:42:54 -0400 Subject: [PATCH 055/157] feat: Add GroundedGenerationService API (#7779) feat: Add AdvancedCompleteQuery API feat: Add lite search API to allow public website search with API key feat: Add Sitemap APIs to preview channel feat: Support search personalization to preview channel feat: Support natural language understanding search feat: Add BillingEstimation in data store feat: Support Google Workspace search feat: Support advanced boost search feat: Add one_box_page_size on search feat: support query regex in control match rules docs: deprecate extractive_answers in answer generation docs: deprecate asynchronous mode in answer generation docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 691212731 Source-Link: https://github.com/googleapis/googleapis/commit/e6b6ff9b7b3659641488e772355cdc78aac488ff Source-Link: https://github.com/googleapis/googleapis-gen/commit/67144fd43c5a3e164410b3617e5752f2e066ec25 Copy-Tag: eyJwIjoiU2VjdXJpdHlDZW50ZXJNYW5hZ2VtZW50Ly5Pd2xCb3QueWFtbCIsImgiOiI2NzE0NGZkNDNjNWEzZTE2NDQxMGIzNjE3ZTU3NTJmMmUwNjZlYzI1In0= --- ...e_event_threat_detection_custom_module.php | 16 +- ...ecurity_health_analytics_custom_module.php | 12 +- ...e_event_threat_detection_custom_module.php | 17 +- ...ecurity_health_analytics_custom_module.php | 20 +- ...e_event_threat_detection_custom_module.php | 30 +-- ...ecurity_health_analytics_custom_module.php | 9 +- ...t_event_threat_detection_custom_module.php | 13 +- .../get_security_center_service.php | 17 +- ...ecurity_health_analytics_custom_module.php | 8 +- ..._event_threat_detection_custom_modules.php | 15 +- ...curity_health_analytics_custom_modules.php | 8 +- ..._event_threat_detection_custom_modules.php | 11 +- ...curity_health_analytics_custom_modules.php | 17 +- ..._event_threat_detection_custom_modules.php | 17 +- .../list_security_center_services.php | 11 +- ...curity_health_analytics_custom_modules.php | 12 +- ...ecurity_health_analytics_custom_module.php | 13 +- ...ecurity_health_analytics_custom_module.php | 12 +- ...e_event_threat_detection_custom_module.php | 11 +- .../Client/SecurityCenterManagementClient.php | 101 ++++---- ...ventThreatDetectionCustomModuleRequest.php | 137 ++++++----- ...rityHealthAnalyticsCustomModuleRequest.php | 95 ++++---- .../src/V1/CustomConfig.php | 32 +-- .../src/V1/CustomConfig/CustomOutputSpec.php | 3 +- .../src/V1/CustomConfig/Severity.php | 2 +- ...ventThreatDetectionCustomModuleRequest.php | 124 +++++----- ...rityHealthAnalyticsCustomModuleRequest.php | 124 +++++----- ...ectiveEventThreatDetectionCustomModule.php | 86 +++---- .../EnablementState.php | 2 +- ...iveSecurityHealthAnalyticsCustomModule.php | 64 +++-- .../EnablementState.php | 2 +- .../V1/EventThreatDetectionCustomModule.php | 102 ++++---- .../EnablementState.php | 10 +- ...ventThreatDetectionCustomModuleRequest.php | 56 ++--- ...rityHealthAnalyticsCustomModuleRequest.php | 33 +-- ...ventThreatDetectionCustomModuleRequest.php | 56 ++--- .../V1/GetSecurityCenterServiceRequest.php | 124 +++++----- ...rityHealthAnalyticsCustomModuleRequest.php | 20 +- ...entThreatDetectionCustomModulesRequest.php | 75 +++--- ...ntThreatDetectionCustomModulesResponse.php | 24 +- ...ityHealthAnalyticsCustomModulesRequest.php | 34 ++- ...tyHealthAnalyticsCustomModulesResponse.php | 16 +- ...entThreatDetectionCustomModulesRequest.php | 75 +++--- ...ntThreatDetectionCustomModulesResponse.php | 24 +- ...ityHealthAnalyticsCustomModulesRequest.php | 60 ++--- ...tyHealthAnalyticsCustomModulesResponse.php | 24 +- ...entThreatDetectionCustomModulesRequest.php | 102 ++++---- ...ntThreatDetectionCustomModulesResponse.php | 23 +- .../V1/ListSecurityCenterServicesRequest.php | 90 +++---- .../V1/ListSecurityCenterServicesResponse.php | 15 +- ...ityHealthAnalyticsCustomModulesRequest.php | 43 ++-- ...tyHealthAnalyticsCustomModulesResponse.php | 23 +- .../src/V1/SecurityCenterService.php | 150 ++++++------ .../SecurityCenterService/EnablementState.php | 14 +- .../SecurityCenterService/ModuleSettings.php | 44 ++-- .../SecurityHealthAnalyticsCustomModule.php | 66 +++--- .../EnablementState.php | 14 +- ...rityHealthAnalyticsCustomModuleRequest.php | 40 ++-- .../SimulatedResource.php | 36 ++- ...ityHealthAnalyticsCustomModuleResponse.php | 4 +- .../SimulatedResult.php | 12 +- .../src/V1/SimulatedFinding.php | 220 +++++++++--------- .../src/V1/SimulatedFinding/FindingClass.php | 13 +- .../src/V1/SimulatedFinding/Severity.php | 80 +++---- .../src/V1/SimulatedFinding/State.php | 6 +- ...ventThreatDetectionCustomModuleRequest.php | 108 ++++----- .../V1/UpdateSecurityCenterServiceRequest.php | 107 +++++---- ...rityHealthAnalyticsCustomModuleRequest.php | 128 +++++----- ...ventThreatDetectionCustomModuleRequest.php | 35 +-- ...entThreatDetectionCustomModuleResponse.php | 3 +- .../CustomModuleValidationError.php | 70 +++--- .../Position.php | 16 +- 72 files changed, 1719 insertions(+), 1517 deletions(-) diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_event_threat_detection_custom_module.php index 50ecd584c107..81b5a3200e76 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_event_threat_detection_custom_module.php @@ -30,15 +30,15 @@ /** * Creates a resident Event Threat Detection custom module at the scope of the - * given Resource Manager parent, and also creates inherited custom modules - * for all descendants of the given parent. These modules are enabled by - * default. + * given organization, folder, or project, and creates inherited custom + * modules for all descendants of the given parent. These modules are enabled + * by default. * - * @param string $formattedParent Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $formattedParent Name of parent for the module, in one of the following formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function create_event_threat_detection_custom_module_sample(string $formattedParent): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_security_health_analytics_custom_module.php index b06b2f1af7cf..0ca1e4eab3a8 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/create_security_health_analytics_custom_module.php @@ -29,13 +29,15 @@ use Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule; /** - * Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the - * given CRM parent, and also creates inherited - * SecurityHealthAnalyticsCustomModules for all CRM descendants of the given - * parent. These modules are enabled by default. + * Creates a resident + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * at the scope of the given organization, folder, or project, and also + * creates inherited `SecurityHealthAnalyticsCustomModule` resources for all + * folders and projects that are descendants of the given parent. These + * modules are enabled by default. * * @param string $formattedParent Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_event_threat_detection_custom_module.php index e922d9c138b4..037bf5606d29 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_event_threat_detection_custom_module.php @@ -29,17 +29,16 @@ /** * Deletes the specified Event Threat Detection custom module and all of its - * descendants in the Resource Manager hierarchy. This method is only - * supported for resident custom modules. + * descendants in the resource hierarchy. This method is only supported for + * resident custom modules. * - * @param string $formattedName The resource name of the ETD custom module. + * @param string $formattedName The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. */ function delete_event_threat_detection_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_security_health_analytics_custom_module.php index 2a00edf4efa0..d091d37a37aa 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/delete_security_health_analytics_custom_module.php @@ -28,18 +28,18 @@ use Google\Cloud\SecurityCenterManagement\V1\DeleteSecurityHealthAnalyticsCustomModuleRequest; /** - * Deletes the specified SecurityHealthAnalyticsCustomModule and all of its - * descendants in the CRM hierarchy. This method is only supported for - * resident custom modules. + * Deletes the specified + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * and all of its descendants in the resource hierarchy. This method is only + * supported for resident custom modules. * - * @param string $formattedName The resource name of the SHA custom module. + * @param string $formattedName The resource name of the SHA custom module, in one of the + * following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. Please see - * {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. */ function delete_security_health_analytics_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_event_threat_detection_custom_module.php index fe58910a54e0..ea49eb73b255 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_event_threat_detection_custom_module.php @@ -29,22 +29,26 @@ use Google\Cloud\SecurityCenterManagement\V1\GetEffectiveEventThreatDetectionCustomModuleRequest; /** - * Gets an effective ETD custom module. Retrieves the effective module at the - * given level. The difference between an EffectiveCustomModule and a - * CustomModule is that the fields for an EffectiveCustomModule are computed - * from ancestors if needed. For example, the enablement_state for a - * CustomModule can be either ENABLED, DISABLED, or INHERITED. Where as the - * enablement_state for an EffectiveCustomModule is always computed to ENABLED - * or DISABLED (the effective enablement_state). + * Gets the effective Event Threat Detection custom module at the given level. * - * @param string $formattedName The resource name of the ETD custom module. + * The difference between an + * [EffectiveEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule] + * and an + * [EventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule] + * is that the fields for an `EffectiveEventThreatDetectionCustomModule` are + * computed from ancestors if needed. For example, the enablement state for an + * `EventThreatDetectionCustomModule` can be `ENABLED`, `DISABLED`, or + * `INHERITED`. In contrast, the enablement state for an + * `EffectiveEventThreatDetectionCustomModule` is always computed as `ENABLED` + * or `DISABLED`. * - * Its format is: + * @param string $formattedName The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::effectiveEventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::effectiveEventThreatDetectionCustomModuleName()} for help formatting this field. */ function get_effective_event_threat_detection_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_security_health_analytics_custom_module.php index 4fce6bdac6fd..a29efacadea5 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_effective_security_health_analytics_custom_module.php @@ -29,14 +29,15 @@ use Google\Cloud\SecurityCenterManagement\V1\GetEffectiveSecurityHealthAnalyticsCustomModuleRequest; /** - * Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule. + * Gets details of a single + * [EffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule]. * * @param string $formattedName The full resource name of the custom module, specified in one of * the following formats: * - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * Please see {@see SecurityCenterManagementClient::effectiveSecurityHealthAnalyticsCustomModuleName()} for help formatting this field. */ function get_effective_security_health_analytics_custom_module_sample(string $formattedName): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_event_threat_detection_custom_module.php index ed1a4f16a9b8..0cc5f41f724b 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_event_threat_detection_custom_module.php @@ -31,14 +31,13 @@ /** * Gets an Event Threat Detection custom module. * - * @param string $formattedName The resource name of the ETD custom module. + * @param string $formattedName The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. */ function get_event_threat_detection_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_center_service.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_center_service.php index a832f451e258..2c8de8e189b7 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_center_service.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_center_service.php @@ -31,21 +31,20 @@ /** * Gets service settings for the specified Security Command Center service. * - * @param string $formattedName The Security Command Center service to retrieve. - * - * Formats: + * @param string $formattedName The Security Command Center service to retrieve, in one of the + * following formats: * * * organizations/{organization}/locations/{location}/securityCenterServices/{service} * * folders/{folder}/locations/{location}/securityCenterServices/{service} * * projects/{project}/locations/{location}/securityCenterServices/{service} * - * The possible values for id {service} are: + * The following values are valid for `{service}`: * - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * Please see {@see SecurityCenterManagementClient::securityCenterServiceName()} for help formatting this field. */ function get_security_center_service_sample(string $formattedName): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_health_analytics_custom_module.php index 6043528b6c06..180a19f95dfd 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/get_security_health_analytics_custom_module.php @@ -29,10 +29,12 @@ use Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule; /** - * Retrieves a SecurityHealthAnalyticsCustomModule. + * Retrieves a + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule]. * - * @param string $formattedName Name of the resource - * Please see {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. + * @param string $formattedName Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. Please see + * {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. */ function get_security_health_analytics_custom_module_sample(string $formattedName): void { diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_event_threat_detection_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_event_threat_detection_custom_modules.php index 23c295c639b4..a8546c3f1a65 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_event_threat_detection_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_event_threat_detection_custom_modules.php @@ -30,14 +30,15 @@ use Google\Cloud\SecurityCenterManagement\V1\ListDescendantEventThreatDetectionCustomModulesRequest; /** - * Lists all resident Event Threat Detection custom modules under the - * given Resource Manager parent and its descendants. + * Lists all resident Event Threat Detection custom modules for the given + * organization, folder, or project and its descendants. * - * @param string $formattedParent Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $formattedParent Name of parent to list custom modules, in one of the following + * formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_descendant_event_threat_detection_custom_modules_sample( diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_security_health_analytics_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_security_health_analytics_custom_modules.php index 16b8fca809b1..4152fe5b66f7 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_security_health_analytics_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_descendant_security_health_analytics_custom_modules.php @@ -30,11 +30,13 @@ use Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule; /** - * Returns a list of all resident SecurityHealthAnalyticsCustomModules under - * the given CRM parent and all of the parent's CRM descendants. + * Returns a list of all resident + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * resources under the given organization, folder, or project and all of its + * descendants. * * @param string $formattedParent Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_event_threat_detection_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_event_threat_detection_custom_modules.php index 033056c3a15d..49a344eddaf8 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_event_threat_detection_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_event_threat_detection_custom_modules.php @@ -34,11 +34,12 @@ * given parent. This includes resident modules defined at the scope of the * parent along with modules inherited from its ancestors. * - * @param string $formattedParent Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $formattedParent Name of parent to list effective custom modules, in one of the + * following formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_effective_event_threat_detection_custom_modules_sample( diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_security_health_analytics_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_security_health_analytics_custom_modules.php index e752bde456c7..4cee92b3aea9 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_security_health_analytics_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_effective_security_health_analytics_custom_modules.php @@ -30,17 +30,18 @@ use Google\Cloud\SecurityCenterManagement\V1\ListEffectiveSecurityHealthAnalyticsCustomModulesRequest; /** - * Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the - * given parent. This includes resident modules defined at the scope of the - * parent, and inherited modules, inherited from CRM ancestors (no - * descendants). + * Returns a list of all + * [EffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule] + * resources for the given parent. This includes resident modules defined at + * the scope of the parent, and inherited modules, inherited from ancestor + * organizations, folders, and projects (no descendants). + * + * @param string $formattedParent Name of parent to list effective custom modules, in one of the + * following formats: * - * @param string $formattedParent Name of parent to list effective custom modules. specified in one - * of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_effective_security_health_analytics_custom_modules_sample( diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_event_threat_detection_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_event_threat_detection_custom_modules.php index 3d1de8512479..145383c1ef71 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_event_threat_detection_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_event_threat_detection_custom_modules.php @@ -30,15 +30,16 @@ use Google\Cloud\SecurityCenterManagement\V1\ListEventThreatDetectionCustomModulesRequest; /** - * Lists all Event Threat Detection custom modules for the given - * Resource Manager parent. This includes resident modules defined at the - * scope of the parent along with modules inherited from ancestors. + * Lists all Event Threat Detection custom modules for the given organization, + * folder, or project. This includes resident modules defined at the scope of + * the parent along with modules inherited from ancestors. * - * @param string $formattedParent Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $formattedParent Name of parent to list custom modules, in one of the following + * formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_event_threat_detection_custom_modules_sample(string $formattedParent): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_center_services.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_center_services.php index ead3764fc0b0..4e2688825d08 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_center_services.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_center_services.php @@ -33,13 +33,12 @@ * Returns a list of all Security Command Center services for the given * parent. * - * @param string $formattedParent The name of the parent to list Security Command Center services. + * @param string $formattedParent The name of the parent to list Security Command Center services, + * in one of the following formats: * - * Formats: - * - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. */ function list_security_center_services_sample(string $formattedParent): void diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_health_analytics_custom_modules.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_health_analytics_custom_modules.php index 345420db4ca7..741d1cc0e1d7 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_health_analytics_custom_modules.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/list_security_health_analytics_custom_modules.php @@ -30,12 +30,14 @@ use Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule; /** - * Returns a list of all SecurityHealthAnalyticsCustomModules for the given - * parent. This includes resident modules defined at the scope of the parent, - * and inherited modules, inherited from CRM ancestors (no descendants). + * Returns a list of all + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * resources for the given parent. This includes resident modules defined at + * the scope of the parent, and inherited modules, inherited from ancestor + * organizations, folders, and projects (no descendants). * - * @param string $formattedParent Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * @param string $formattedParent Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/simulate_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/simulate_security_health_analytics_custom_module.php index f5fd2a907173..67a0d4421b7d 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/simulate_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/simulate_security_health_analytics_custom_module.php @@ -31,14 +31,15 @@ use Google\Cloud\SecurityCenterManagement\V1\SimulateSecurityHealthAnalyticsCustomModuleResponse; /** - * Simulates a given SecurityHealthAnalyticsCustomModule and Resource. + * Simulates the result of using a + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * to check a resource. * * @param string $parent The relative resource name of the organization, project, or - * folder. For more information about relative resource names, see [Relative - * Resource - * Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * Example: `organizations/{organization_id}`. - * @param string $resourceResourceType The type of the resource, for example, + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. + * @param string $resourceResourceType The type of the resource. For example, * `compute.googleapis.com/Disk`. */ function simulate_security_health_analytics_custom_module_sample( diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/update_security_health_analytics_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/update_security_health_analytics_custom_module.php index 6a18083f0e89..481d217ab836 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/update_security_health_analytics_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/update_security_health_analytics_custom_module.php @@ -30,11 +30,13 @@ use Google\Protobuf\FieldMask; /** - * Updates the SecurityHealthAnalyticsCustomModule under the given name based - * on the given update mask. Updating the enablement state is supported on - * both resident and inherited modules (though resident modules cannot have an - * enablement state of "inherited"). Updating the display name and custom - * config of a module is supported on resident modules only. + * Updates the + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * under the given name based on the given update mask. Updating the + * enablement state is supported on both resident and inherited modules + * (though resident modules cannot have an enablement state of "inherited"). + * Updating the display name and custom configuration of a module is supported + * on resident modules only. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: diff --git a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/validate_event_threat_detection_custom_module.php b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/validate_event_threat_detection_custom_module.php index 651855f64a10..075782bbdab8 100644 --- a/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/validate_event_threat_detection_custom_module.php +++ b/SecurityCenterManagement/samples/V1/SecurityCenterManagementClient/validate_event_threat_detection_custom_module.php @@ -31,15 +31,14 @@ /** * Validates the given Event Threat Detection custom module. * - * @param string $formattedParent Resource name of the parent to validate the Custom Module under. + * @param string $formattedParent Resource name of the parent to validate the custom modules under, + * in one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}`. Please see - * {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}` + * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * @param string $rawText The raw text of the module's contents. Used to generate error * messages. - * @param string $type The type of the module (e.g. CONFIGURABLE_BAD_IP). + * @param string $type The type of the module. For example, `CONFIGURABLE_BAD_IP`. */ function validate_event_threat_detection_custom_module_sample( string $formattedParent, diff --git a/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php b/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php index 5de09763fb26..b750d3f4aa06 100644 --- a/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php +++ b/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php @@ -750,9 +750,9 @@ public function __call($method, $args) /** * Creates a resident Event Threat Detection custom module at the scope of the - * given Resource Manager parent, and also creates inherited custom modules - * for all descendants of the given parent. These modules are enabled by - * default. + * given organization, folder, or project, and creates inherited custom + * modules for all descendants of the given parent. These modules are enabled + * by default. * * The async variant is * {@see SecurityCenterManagementClient::createEventThreatDetectionCustomModuleAsync()} @@ -782,10 +782,12 @@ public function createEventThreatDetectionCustomModule( } /** - * Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the - * given CRM parent, and also creates inherited - * SecurityHealthAnalyticsCustomModules for all CRM descendants of the given - * parent. These modules are enabled by default. + * Creates a resident + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * at the scope of the given organization, folder, or project, and also + * creates inherited `SecurityHealthAnalyticsCustomModule` resources for all + * folders and projects that are descendants of the given parent. These + * modules are enabled by default. * * The async variant is * {@see SecurityCenterManagementClient::createSecurityHealthAnalyticsCustomModuleAsync()} @@ -816,8 +818,8 @@ public function createSecurityHealthAnalyticsCustomModule( /** * Deletes the specified Event Threat Detection custom module and all of its - * descendants in the Resource Manager hierarchy. This method is only - * supported for resident custom modules. + * descendants in the resource hierarchy. This method is only supported for + * resident custom modules. * * The async variant is * {@see SecurityCenterManagementClient::deleteEventThreatDetectionCustomModuleAsync()} @@ -845,9 +847,10 @@ public function deleteEventThreatDetectionCustomModule( } /** - * Deletes the specified SecurityHealthAnalyticsCustomModule and all of its - * descendants in the CRM hierarchy. This method is only supported for - * resident custom modules. + * Deletes the specified + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * and all of its descendants in the resource hierarchy. This method is only + * supported for resident custom modules. * * The async variant is * {@see SecurityCenterManagementClient::deleteSecurityHealthAnalyticsCustomModuleAsync()} @@ -875,13 +878,18 @@ public function deleteSecurityHealthAnalyticsCustomModule( } /** - * Gets an effective ETD custom module. Retrieves the effective module at the - * given level. The difference between an EffectiveCustomModule and a - * CustomModule is that the fields for an EffectiveCustomModule are computed - * from ancestors if needed. For example, the enablement_state for a - * CustomModule can be either ENABLED, DISABLED, or INHERITED. Where as the - * enablement_state for an EffectiveCustomModule is always computed to ENABLED - * or DISABLED (the effective enablement_state). + * Gets the effective Event Threat Detection custom module at the given level. + * + * The difference between an + * [EffectiveEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule] + * and an + * [EventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule] + * is that the fields for an `EffectiveEventThreatDetectionCustomModule` are + * computed from ancestors if needed. For example, the enablement state for an + * `EventThreatDetectionCustomModule` can be `ENABLED`, `DISABLED`, or + * `INHERITED`. In contrast, the enablement state for an + * `EffectiveEventThreatDetectionCustomModule` is always computed as `ENABLED` + * or `DISABLED`. * * The async variant is * {@see SecurityCenterManagementClient::getEffectiveEventThreatDetectionCustomModuleAsync()} @@ -911,7 +919,8 @@ public function getEffectiveEventThreatDetectionCustomModule( } /** - * Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule. + * Gets details of a single + * [EffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule]. * * The async variant is * {@see SecurityCenterManagementClient::getEffectiveSecurityHealthAnalyticsCustomModuleAsync()} @@ -1000,7 +1009,8 @@ public function getSecurityCenterService( } /** - * Retrieves a SecurityHealthAnalyticsCustomModule. + * Retrieves a + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule]. * * The async variant is * {@see SecurityCenterManagementClient::getSecurityHealthAnalyticsCustomModuleAsync()} @@ -1030,8 +1040,8 @@ public function getSecurityHealthAnalyticsCustomModule( } /** - * Lists all resident Event Threat Detection custom modules under the - * given Resource Manager parent and its descendants. + * Lists all resident Event Threat Detection custom modules for the given + * organization, folder, or project and its descendants. * * The async variant is * {@see SecurityCenterManagementClient::listDescendantEventThreatDetectionCustomModulesAsync()} @@ -1061,8 +1071,10 @@ public function listDescendantEventThreatDetectionCustomModules( } /** - * Returns a list of all resident SecurityHealthAnalyticsCustomModules under - * the given CRM parent and all of the parent's CRM descendants. + * Returns a list of all resident + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * resources under the given organization, folder, or project and all of its + * descendants. * * The async variant is * {@see SecurityCenterManagementClient::listDescendantSecurityHealthAnalyticsCustomModulesAsync()} @@ -1124,10 +1136,11 @@ public function listEffectiveEventThreatDetectionCustomModules( } /** - * Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the - * given parent. This includes resident modules defined at the scope of the - * parent, and inherited modules, inherited from CRM ancestors (no - * descendants). + * Returns a list of all + * [EffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule] + * resources for the given parent. This includes resident modules defined at + * the scope of the parent, and inherited modules, inherited from ancestor + * organizations, folders, and projects (no descendants). * * The async variant is * {@see SecurityCenterManagementClient::listEffectiveSecurityHealthAnalyticsCustomModulesAsync()} @@ -1157,9 +1170,9 @@ public function listEffectiveSecurityHealthAnalyticsCustomModules( } /** - * Lists all Event Threat Detection custom modules for the given - * Resource Manager parent. This includes resident modules defined at the - * scope of the parent along with modules inherited from ancestors. + * Lists all Event Threat Detection custom modules for the given organization, + * folder, or project. This includes resident modules defined at the scope of + * the parent along with modules inherited from ancestors. * * The async variant is * {@see SecurityCenterManagementClient::listEventThreatDetectionCustomModulesAsync()} @@ -1219,9 +1232,11 @@ public function listSecurityCenterServices( } /** - * Returns a list of all SecurityHealthAnalyticsCustomModules for the given - * parent. This includes resident modules defined at the scope of the parent, - * and inherited modules, inherited from CRM ancestors (no descendants). + * Returns a list of all + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * resources for the given parent. This includes resident modules defined at + * the scope of the parent, and inherited modules, inherited from ancestor + * organizations, folders, and projects (no descendants). * * The async variant is * {@see SecurityCenterManagementClient::listSecurityHealthAnalyticsCustomModulesAsync()} @@ -1251,7 +1266,9 @@ public function listSecurityHealthAnalyticsCustomModules( } /** - * Simulates a given SecurityHealthAnalyticsCustomModule and Resource. + * Simulates the result of using a + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * to check a resource. * * The async variant is * {@see SecurityCenterManagementClient::simulateSecurityHealthAnalyticsCustomModuleAsync()} @@ -1345,11 +1362,13 @@ public function updateSecurityCenterService( } /** - * Updates the SecurityHealthAnalyticsCustomModule under the given name based - * on the given update mask. Updating the enablement state is supported on - * both resident and inherited modules (though resident modules cannot have an - * enablement state of "inherited"). Updating the display name and custom - * config of a module is supported on resident modules only. + * Updates the + * [SecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule] + * under the given name based on the given update mask. Updating the + * enablement state is supported on both resident and inherited modules + * (though resident modules cannot have an enablement state of "inherited"). + * Updating the display name and custom configuration of a module is supported + * on resident modules only. * * The async variant is * {@see SecurityCenterManagementClient::updateSecurityHealthAnalyticsCustomModuleAsync()} diff --git a/SecurityCenterManagement/src/V1/CreateEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/CreateEventThreatDetectionCustomModuleRequest.php index f10cdbc65818..89fe34cb5e6e 100644 --- a/SecurityCenterManagement/src/V1/CreateEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/CreateEventThreatDetectionCustomModuleRequest.php @@ -9,53 +9,56 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for creating a EventThreatDetectionCustomModule + * Request message for + * [SecurityCenterManagement.CreateEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.CreateEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.CreateEventThreatDetectionCustomModuleRequest */ class CreateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent for the module, in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 3 [(.google.api.field_behavior) = REQUIRED]; */ protected $event_threat_detection_custom_module = null; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred during creation of the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param string $parent Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $parent Required. Name of parent for the module, in one of the following formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $eventThreatDetectionCustomModule Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * * @return \Google\Cloud\SecurityCenterManagement\V1\CreateEventThreatDetectionCustomModuleRequest * @@ -75,23 +78,25 @@ public static function build(string $parent, \Google\Cloud\SecurityCenterManagem * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent for the module, in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $event_threat_detection_custom_module * Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred during creation of the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -100,11 +105,10 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent for the module, in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -115,11 +119,10 @@ public function getParent() } /** - * Required. Name of parent for the module. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent for the module, in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -135,8 +138,8 @@ public function setParent($var) /** * Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 3 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule|null @@ -158,8 +161,8 @@ public function clearEventThreatDetectionCustomModule() /** * Required. The module to create. The - * event_threat_detection_custom_module.name will be ignored and server - * generated. + * [EventThreatDetectionCustomModule.name][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name] + * field is ignored; Security Command Center generates the name. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 3 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $var @@ -174,13 +177,16 @@ public function setEventThreatDetectionCustomModule($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred during creation of the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -191,13 +197,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred during creation of the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/CreateSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/CreateSecurityHealthAnalyticsCustomModuleRequest.php index 582fa03482dc..97b0a5189124 100644 --- a/SecurityCenterManagement/src/V1/CreateSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/CreateSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for creating a SecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.CreateSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.CreateSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.CreateSecurityHealthAnalyticsCustomModuleRequest */ @@ -17,7 +18,7 @@ class CreateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\ { /** * Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -26,20 +27,22 @@ class CreateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\ */ protected $parent = ''; /** - * Required. The resource being created + * Required. The resource being created. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $security_health_analytics_custom_module = null; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because: - * 1. the state could have changed (e.g. IAM permission lost) or - * 2. A failure occurred during creation of the module. - * Defaults to false. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -47,13 +50,13 @@ class CreateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\ /** * @param string $parent Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. - * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $securityHealthAnalyticsCustomModule Required. The resource being created + * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $securityHealthAnalyticsCustomModule Required. The resource being created. * * @return \Google\Cloud\SecurityCenterManagement\V1\CreateSecurityHealthAnalyticsCustomModuleRequest * @@ -74,21 +77,23 @@ public static function build(string $parent, \Google\Cloud\SecurityCenterManagem * * @type string $parent * Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` * @type \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $security_health_analytics_custom_module - * Required. The resource being created + * Required. The resource being created. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because: - * 1. the state could have changed (e.g. IAM permission lost) or - * 2. A failure occurred during creation of the module. - * Defaults to false. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -98,7 +103,7 @@ public function __construct($data = NULL) { /** * Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -113,7 +118,7 @@ public function getParent() /** * Required. Name of the parent organization, folder, or project of the - * module, specified in one of the following formats: + * module, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -131,7 +136,7 @@ public function setParent($var) } /** - * Required. The resource being created + * Required. The resource being created. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule|null @@ -152,7 +157,7 @@ public function clearSecurityHealthAnalyticsCustomModule() } /** - * Required. The resource being created + * Required. The resource being created. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $var @@ -167,14 +172,16 @@ public function setSecurityHealthAnalyticsCustomModule($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because: - * 1. the state could have changed (e.g. IAM permission lost) or - * 2. A failure occurred during creation of the module. - * Defaults to false. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -185,14 +192,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (no module will be created). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually create the module could - * still fail because: - * 1. the state could have changed (e.g. IAM permission lost) or - * 2. A failure occurred during creation of the module. - * Defaults to false. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be created. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to create the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/CustomConfig.php b/SecurityCenterManagement/src/V1/CustomConfig.php index 77cd3e176778..b753e6e848bc 100644 --- a/SecurityCenterManagement/src/V1/CustomConfig.php +++ b/SecurityCenterManagement/src/V1/CustomConfig.php @@ -18,8 +18,9 @@ class CustomConfig extends \Google\Protobuf\Internal\Message { /** - * Optional. The CEL expression to evaluate to produce findings. When the - * expression evaluates to true against a resource, a finding is generated. + * Optional. The Common Expression Language (CEL) expression to evaluate to + * produce findings. When the expression evaluates to `true` against a + * resource, a finding is generated. * * Generated from protobuf field .google.type.Expr predicate = 1 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -57,8 +58,7 @@ class CustomConfig extends \Google\Protobuf\Internal\Message /** * Optional. An explanation of the recommended steps that security teams can * take to resolve the detected issue. This explanation is returned with each - * finding generated by this module in the `nextSteps` property of the finding - * JSON. + * finding generated by this module. * * Generated from protobuf field string recommendation = 6 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -71,8 +71,9 @@ class CustomConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Type\Expr $predicate - * Optional. The CEL expression to evaluate to produce findings. When the - * expression evaluates to true against a resource, a finding is generated. + * Optional. The Common Expression Language (CEL) expression to evaluate to + * produce findings. When the expression evaluates to `true` against a + * resource, a finding is generated. * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig\CustomOutputSpec $custom_output * Optional. Custom output properties. * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig\ResourceSelector $resource_selector @@ -90,8 +91,7 @@ class CustomConfig extends \Google\Protobuf\Internal\Message * @type string $recommendation * Optional. An explanation of the recommended steps that security teams can * take to resolve the detected issue. This explanation is returned with each - * finding generated by this module in the `nextSteps` property of the finding - * JSON. + * finding generated by this module. * } */ public function __construct($data = NULL) { @@ -100,8 +100,9 @@ public function __construct($data = NULL) { } /** - * Optional. The CEL expression to evaluate to produce findings. When the - * expression evaluates to true against a resource, a finding is generated. + * Optional. The Common Expression Language (CEL) expression to evaluate to + * produce findings. When the expression evaluates to `true` against a + * resource, a finding is generated. * * Generated from protobuf field .google.type.Expr predicate = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Type\Expr|null @@ -122,8 +123,9 @@ public function clearPredicate() } /** - * Optional. The CEL expression to evaluate to produce findings. When the - * expression evaluates to true against a resource, a finding is generated. + * Optional. The Common Expression Language (CEL) expression to evaluate to + * produce findings. When the expression evaluates to `true` against a + * resource, a finding is generated. * * Generated from protobuf field .google.type.Expr predicate = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Type\Expr $var @@ -276,8 +278,7 @@ public function setDescription($var) /** * Optional. An explanation of the recommended steps that security teams can * take to resolve the detected issue. This explanation is returned with each - * finding generated by this module in the `nextSteps` property of the finding - * JSON. + * finding generated by this module. * * Generated from protobuf field string recommendation = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -290,8 +291,7 @@ public function getRecommendation() /** * Optional. An explanation of the recommended steps that security teams can * take to resolve the detected issue. This explanation is returned with each - * finding generated by this module in the `nextSteps` property of the finding - * JSON. + * finding generated by this module. * * Generated from protobuf field string recommendation = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/CustomConfig/CustomOutputSpec.php b/SecurityCenterManagement/src/V1/CustomConfig/CustomOutputSpec.php index c858f968d0c9..ef5a4a680637 100644 --- a/SecurityCenterManagement/src/V1/CustomConfig/CustomOutputSpec.php +++ b/SecurityCenterManagement/src/V1/CustomConfig/CustomOutputSpec.php @@ -11,8 +11,7 @@ /** * A set of optional name-value pairs that define custom source properties to * return with each finding that is generated by the custom module. The custom - * source properties that are defined here are included in the finding JSON - * under `sourceProperties`. + * source properties that are defined here are included in the finding. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.CustomConfig.CustomOutputSpec */ diff --git a/SecurityCenterManagement/src/V1/CustomConfig/Severity.php b/SecurityCenterManagement/src/V1/CustomConfig/Severity.php index 2d8f54a47882..60d277b2e838 100644 --- a/SecurityCenterManagement/src/V1/CustomConfig/Severity.php +++ b/SecurityCenterManagement/src/V1/CustomConfig/Severity.php @@ -14,7 +14,7 @@ class Severity { /** - * Unspecified severity. + * Default value. This value is unused. * * Generated from protobuf enum SEVERITY_UNSPECIFIED = 0; */ diff --git a/SecurityCenterManagement/src/V1/DeleteEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/DeleteEventThreatDetectionCustomModuleRequest.php index 4f08f7d5180f..45fb939bb727 100644 --- a/SecurityCenterManagement/src/V1/DeleteEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/DeleteEventThreatDetectionCustomModuleRequest.php @@ -9,44 +9,47 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for deleting a EventThreatDetectionCustomModule + * Request message for + * [SecurityCenterManagement.DeleteEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.DeleteEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.DeleteEventThreatDetectionCustomModuleRequest */ class DeleteEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param string $name Required. The resource name of the ETD custom module. + * @param string $name Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\DeleteEventThreatDetectionCustomModuleRequest * @@ -65,19 +68,22 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -86,11 +92,11 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -101,11 +107,11 @@ public function getName() } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -120,13 +126,16 @@ public function setName($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -137,13 +146,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/DeleteSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/DeleteSecurityHealthAnalyticsCustomModuleRequest.php index ccb2146822e6..bfafbf5b60d2 100644 --- a/SecurityCenterManagement/src/V1/DeleteSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/DeleteSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,44 +9,47 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for deleting a SecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.DeleteSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.DeleteSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.DeleteSecurityHealthAnalyticsCustomModuleRequest */ class DeleteSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the SHA custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. + * Required. The resource name of the SHA custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during deletion of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param string $name Required. The resource name of the SHA custom module. + * @param string $name Required. The resource name of the SHA custom module, in one of the + * following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. Please see - * {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\DeleteSecurityHealthAnalyticsCustomModuleRequest * @@ -65,19 +68,22 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the SHA custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. + * Required. The resource name of the SHA custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during deletion of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -86,11 +92,11 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the SHA custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. + * Required. The resource name of the SHA custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -101,11 +107,11 @@ public function getName() } /** - * Required. The resource name of the SHA custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`. + * Required. The resource name of the SHA custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -120,13 +126,16 @@ public function setName($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during deletion of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -137,13 +146,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be deleted). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually delete the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be deleted. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to delete the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during deletion of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule.php b/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule.php index 659b3cd6a15e..ea107de94721 100644 --- a/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule.php +++ b/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule.php @@ -9,30 +9,30 @@ use Google\Protobuf\Internal\GPBUtil; /** - * An EffectiveEventThreatDetectionCustomModule is the representation of - * EventThreatDetectionCustomModule at a given level taking hierarchy into - * account and resolving various fields accordingly. e.g. if the module is - * enabled at the ancestor level, effective modules at all descendant levels - * will have enablement_state set to ENABLED. Similarly, if module.inherited is - * set, then effective module's config will contain the ancestor's config - * details. EffectiveEventThreatDetectionCustomModule is read-only. + * The representation of an + * [EventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule] + * at a given level, taking hierarchy into account and resolving various fields + * accordingly. For example, if the module is enabled at the ancestor level, + * then effective modules at all descendant levels will have their enablement + * state set to `ENABLED`. Similarly, if `module.inherited` is set, then the + * effective module's configuration will reflect the ancestor's configuration. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule */ class EffectiveEventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message { /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * Output only. Config for the effective module. + * Output only. Configuration for the effective module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -45,19 +45,19 @@ class EffectiveEventThreatDetectionCustomModule extends \Google\Protobuf\Interna */ protected $enablement_state = 0; /** - * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Output only. Type for the module (for example, `CONFIGURABLE_BAD_IP`). * * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $type = ''; /** - * Output only. The human readable name to be displayed for the module. + * Output only. The human-readable name of the module. * * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $display_name = ''; /** - * Output only. The description for the module. + * Output only. A description of the module. * * Generated from protobuf field string description = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -70,22 +70,22 @@ class EffectiveEventThreatDetectionCustomModule extends \Google\Protobuf\Interna * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * @type \Google\Protobuf\Struct $config - * Output only. Config for the effective module. + * Output only. Configuration for the effective module. * @type int $enablement_state * Output only. The effective state of enablement for the module at the given * level of the hierarchy. * @type string $type - * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Output only. Type for the module (for example, `CONFIGURABLE_BAD_IP`). * @type string $display_name - * Output only. The human readable name to be displayed for the module. + * Output only. The human-readable name of the module. * @type string $description - * Output only. The description for the module. + * Output only. A description of the module. * } */ public function __construct($data = NULL) { @@ -94,11 +94,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -109,11 +109,11 @@ public function getName() } /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -128,7 +128,7 @@ public function setName($var) } /** - * Output only. Config for the effective module. + * Output only. Configuration for the effective module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Struct|null @@ -149,7 +149,7 @@ public function clearConfig() } /** - * Output only. Config for the effective module. + * Output only. Configuration for the effective module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Protobuf\Struct $var @@ -192,7 +192,7 @@ public function setEnablementState($var) } /** - * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Output only. Type for the module (for example, `CONFIGURABLE_BAD_IP`). * * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -203,7 +203,7 @@ public function getType() } /** - * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Output only. Type for the module (for example, `CONFIGURABLE_BAD_IP`). * * Generated from protobuf field string type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -218,7 +218,7 @@ public function setType($var) } /** - * Output only. The human readable name to be displayed for the module. + * Output only. The human-readable name of the module. * * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -229,7 +229,7 @@ public function getDisplayName() } /** - * Output only. The human readable name to be displayed for the module. + * Output only. The human-readable name of the module. * * Generated from protobuf field string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -244,7 +244,7 @@ public function setDisplayName($var) } /** - * Output only. The description for the module. + * Output only. A description of the module. * * Generated from protobuf field string description = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -255,7 +255,7 @@ public function getDescription() } /** - * Output only. The description for the module. + * Output only. A description of the module. * * Generated from protobuf field string description = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule/EnablementState.php b/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule/EnablementState.php index 752123fcee50..051267e926ec 100644 --- a/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule/EnablementState.php +++ b/SecurityCenterManagement/src/V1/EffectiveEventThreatDetectionCustomModule/EnablementState.php @@ -14,7 +14,7 @@ class EnablementState { /** - * Unspecified enablement state. + * Default value. This value is unused. * * Generated from protobuf enum ENABLEMENT_STATE_UNSPECIFIED = 0; */ diff --git a/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule.php b/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule.php index 1345238cbc2f..5172f9fffee4 100644 --- a/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule.php +++ b/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule.php @@ -9,26 +9,24 @@ use Google\Protobuf\Internal\GPBUtil; /** - * An EffectiveSecurityHealthAnalyticsCustomModule is the representation of - * a Security Health Analytics custom module at a specified level of the - * resource hierarchy: organization, folder, or project. If a custom module is - * inherited from a parent organization or folder, the value of the - * `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is - * set to the value that is effective in the parent, instead of `INHERITED`. - * For example, if the module is enabled in a parent organization or folder, the - * effective enablement_state for the module in all child folders or projects is - * also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. + * The representation of a Security Health Analytics custom module at a + * specified level of the resource hierarchy: organization, folder, or project. + * If a custom module is inherited from an ancestor organization or folder, then + * the enablement state is set to the value that is effective in the parent, not + * to `INHERITED`. For example, if the module is enabled in an organization or + * folder, then the effective enablement state for the module is `ENABLED` in + * all descendant folders or projects. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule */ class EffectiveSecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Message { /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ @@ -40,7 +38,7 @@ class EffectiveSecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Inte */ protected $custom_config = null; /** - * Output only. The effective state of enablement for the module at the given + * Output only. The effective enablement state for the module at the given * level of the hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -62,15 +60,15 @@ class EffectiveSecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Inte * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $custom_config * Output only. The user-specified configuration for the module. * @type int $enablement_state - * Output only. The effective state of enablement for the module at the given + * Output only. The effective enablement state for the module at the given * level of the hierarchy. * @type string $display_name * Output only. The display name for the custom module. The name must be @@ -84,11 +82,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -99,11 +97,11 @@ public function getName() } /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -154,7 +152,7 @@ public function setCustomConfig($var) } /** - * Output only. The effective state of enablement for the module at the given + * Output only. The effective enablement state for the module at the given * level of the hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -166,7 +164,7 @@ public function getEnablementState() } /** - * Output only. The effective state of enablement for the module at the given + * Output only. The effective enablement state for the module at the given * level of the hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; diff --git a/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule/EnablementState.php b/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule/EnablementState.php index 4368999573f8..2e61f01d8de3 100644 --- a/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule/EnablementState.php +++ b/SecurityCenterManagement/src/V1/EffectiveSecurityHealthAnalyticsCustomModule/EnablementState.php @@ -14,7 +14,7 @@ class EnablementState { /** - * Unspecified enablement state. + * Default value. This value is unused. * * Generated from protobuf enum ENABLEMENT_STATE_UNSPECIFIED = 0; */ diff --git a/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule.php b/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule.php index c6dc2492db74..4b5c0af7354a 100644 --- a/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule.php +++ b/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule.php @@ -9,28 +9,28 @@ use Google\Protobuf\Internal\GPBUtil; /** - * An event threat detection custom module is a Cloud SCC resource that contains - * the configuration and enablement state of a custom module, which enables ETD - * to write certain findings to Cloud SCC. + * A Security Command Center resource that contains the configuration and + * enablement state of a custom module, which enables Event Threat Detection to + * write certain findings to Security Command Center. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule */ class EventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message { /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * Optional. Config for the module. For the resident module, its config value - * is defined at this level. For the inherited module, its config value is - * inherited from the ancestor module. + * Optional. Configuration for the module. For the resident module, its + * configuration value is defined at this level. For the inherited module, its + * configuration value is inherited from the ancestor module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -39,7 +39,7 @@ class EventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message * Output only. The closest ancestor module that this module inherits the * enablement state from. If empty, indicates that the custom module was * created in the requesting parent organization, folder, or project. The - * format is the same as the EventThreatDetectionCustomModule resource name. + * format is the same as the custom module's resource name. * * Generated from protobuf field string ancestor_module = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { */ @@ -52,19 +52,19 @@ class EventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message */ protected $enablement_state = 0; /** - * Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $type = ''; /** - * Optional. The human readable name to be displayed for the module. + * Optional. The human-readable name of the module. * * Generated from protobuf field string display_name = 6 [(.google.api.field_behavior) = OPTIONAL]; */ protected $display_name = ''; /** - * Optional. The description for the module. + * Optional. A description of the module. * * Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -89,29 +89,29 @@ class EventThreatDetectionCustomModule extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * @type \Google\Protobuf\Struct $config - * Optional. Config for the module. For the resident module, its config value - * is defined at this level. For the inherited module, its config value is - * inherited from the ancestor module. + * Optional. Configuration for the module. For the resident module, its + * configuration value is defined at this level. For the inherited module, its + * configuration value is inherited from the ancestor module. * @type string $ancestor_module * Output only. The closest ancestor module that this module inherits the * enablement state from. If empty, indicates that the custom module was * created in the requesting parent organization, folder, or project. The - * format is the same as the EventThreatDetectionCustomModule resource name. + * format is the same as the custom module's resource name. * @type int $enablement_state * Optional. The state of enablement for the module at the given level of the * hierarchy. * @type string $type - * Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. * @type string $display_name - * Optional. The human readable name to be displayed for the module. + * Optional. The human-readable name of the module. * @type string $description - * Optional. The description for the module. + * Optional. A description of the module. * @type \Google\Protobuf\Timestamp $update_time * Output only. The time the module was last updated. * @type string $last_editor @@ -124,11 +124,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -139,11 +139,11 @@ public function getName() } /** - * Identifier. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Identifier. The resource name of the Event Threat Detection custom module, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -158,9 +158,9 @@ public function setName($var) } /** - * Optional. Config for the module. For the resident module, its config value - * is defined at this level. For the inherited module, its config value is - * inherited from the ancestor module. + * Optional. Configuration for the module. For the resident module, its + * configuration value is defined at this level. For the inherited module, its + * configuration value is inherited from the ancestor module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Struct|null @@ -181,9 +181,9 @@ public function clearConfig() } /** - * Optional. Config for the module. For the resident module, its config value - * is defined at this level. For the inherited module, its config value is - * inherited from the ancestor module. + * Optional. Configuration for the module. For the resident module, its + * configuration value is defined at this level. For the inherited module, its + * configuration value is inherited from the ancestor module. * * Generated from protobuf field .google.protobuf.Struct config = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Struct $var @@ -201,7 +201,7 @@ public function setConfig($var) * Output only. The closest ancestor module that this module inherits the * enablement state from. If empty, indicates that the custom module was * created in the requesting parent organization, folder, or project. The - * format is the same as the EventThreatDetectionCustomModule resource name. + * format is the same as the custom module's resource name. * * Generated from protobuf field string ancestor_module = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * @return string @@ -215,7 +215,7 @@ public function getAncestorModule() * Output only. The closest ancestor module that this module inherits the * enablement state from. If empty, indicates that the custom module was * created in the requesting parent organization, folder, or project. The - * format is the same as the EventThreatDetectionCustomModule resource name. + * format is the same as the custom module's resource name. * * Generated from protobuf field string ancestor_module = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * @param string $var @@ -258,7 +258,7 @@ public function setEnablementState($var) } /** - * Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -269,7 +269,7 @@ public function getType() } /** - * Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP. + * Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -284,7 +284,7 @@ public function setType($var) } /** - * Optional. The human readable name to be displayed for the module. + * Optional. The human-readable name of the module. * * Generated from protobuf field string display_name = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -295,7 +295,7 @@ public function getDisplayName() } /** - * Optional. The human readable name to be displayed for the module. + * Optional. The human-readable name of the module. * * Generated from protobuf field string display_name = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -310,7 +310,7 @@ public function setDisplayName($var) } /** - * Optional. The description for the module. + * Optional. A description of the module. * * Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -321,7 +321,7 @@ public function getDescription() } /** - * Optional. The description for the module. + * Optional. A description of the module. * * Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule/EnablementState.php b/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule/EnablementState.php index bfc3020182f3..8cff8c55d88a 100644 --- a/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule/EnablementState.php +++ b/SecurityCenterManagement/src/V1/EventThreatDetectionCustomModule/EnablementState.php @@ -32,11 +32,11 @@ class EnablementState */ const DISABLED = 2; /** - * State is inherited from an ancestor module. The module will either - * be effectively ENABLED or DISABLED based on its closest non-inherited - * ancestor module in the CRM hierarchy. Attempting to set a top level - * module (module with no parent) to the INHERITED state will result in an - * error. + * State is inherited from an ancestor module. The module will either be + * effectively `ENABLED` or `DISABLED` based on its closest non-inherited + * ancestor module in the CRM hierarchy. If you try to set a top-level + * module (a module with no parent) to the `INHERITED` state, you receive an + * `INVALID_ARGUMENT` error. * * Generated from protobuf enum INHERITED = 3; */ diff --git a/SecurityCenterManagement/src/V1/GetEffectiveEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/GetEffectiveEventThreatDetectionCustomModuleRequest.php index 34bdee84cc97..cccd53442b4d 100644 --- a/SecurityCenterManagement/src/V1/GetEffectiveEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/GetEffectiveEventThreatDetectionCustomModuleRequest.php @@ -9,32 +9,32 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for getting a EffectiveEventThreatDetectionCustomModule + * Request message for + * [SecurityCenterManagement.GetEffectiveEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetEffectiveEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetEffectiveEventThreatDetectionCustomModuleRequest */ class GetEffectiveEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * @param string $name Required. The resource name of the ETD custom module. + * @param string $name Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::effectiveEventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::effectiveEventThreatDetectionCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetEffectiveEventThreatDetectionCustomModuleRequest * @@ -53,11 +53,11 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * } */ public function __construct($data = NULL) { @@ -66,11 +66,11 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -81,11 +81,11 @@ public function getName() } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/SecurityCenterManagement/src/V1/GetEffectiveSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/GetEffectiveSecurityHealthAnalyticsCustomModuleRequest.php index e784437bc70f..be05181a1559 100644 --- a/SecurityCenterManagement/src/V1/GetEffectiveSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/GetEffectiveSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for getting a EffectiveSecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.GetEffectiveSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetEffectiveSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetEffectiveSecurityHealthAnalyticsCustomModuleRequest */ @@ -18,9 +19,9 @@ class GetEffectiveSecurityHealthAnalyticsCustomModuleRequest extends \Google\Pro /** * Required. The full resource name of the custom module, specified in one of * the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -30,9 +31,9 @@ class GetEffectiveSecurityHealthAnalyticsCustomModuleRequest extends \Google\Pro * @param string $name Required. The full resource name of the custom module, specified in one of * the following formats: * - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * Please see {@see SecurityCenterManagementClient::effectiveSecurityHealthAnalyticsCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetEffectiveSecurityHealthAnalyticsCustomModuleRequest @@ -54,9 +55,9 @@ public static function build(string $name): self * @type string $name * Required. The full resource name of the custom module, specified in one of * the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * } */ public function __construct($data = NULL) { @@ -67,9 +68,9 @@ public function __construct($data = NULL) { /** * Required. The full resource name of the custom module, specified in one of * the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -82,9 +83,9 @@ public function getName() /** * Required. The full resource name of the custom module, specified in one of * the following formats: - * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` - * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}` + * * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/SecurityCenterManagement/src/V1/GetEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/GetEventThreatDetectionCustomModuleRequest.php index e280d8f676fa..7a83d6b48561 100644 --- a/SecurityCenterManagement/src/V1/GetEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/GetEventThreatDetectionCustomModuleRequest.php @@ -9,32 +9,32 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for getting a EventThreatDetectionCustomModule + * Request message for + * [SecurityCenterManagement.GetEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetEventThreatDetectionCustomModuleRequest */ class GetEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * @param string $name Required. The resource name of the ETD custom module. + * @param string $name Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: * - * Its format is: - * - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. Please see - * {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * Please see {@see SecurityCenterManagementClient::eventThreatDetectionCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetEventThreatDetectionCustomModuleRequest * @@ -53,11 +53,11 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * } */ public function __construct($data = NULL) { @@ -66,11 +66,11 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -81,11 +81,11 @@ public function getName() } /** - * Required. The resource name of the ETD custom module. - * Its format is: - * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. - * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`. + * Required. The resource name of the Event Threat Detection custom module, in + * one of the following formats: + * * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/SecurityCenterManagement/src/V1/GetSecurityCenterServiceRequest.php b/SecurityCenterManagement/src/V1/GetSecurityCenterServiceRequest.php index aafec1171fef..5edd59857e95 100644 --- a/SecurityCenterManagement/src/V1/GetSecurityCenterServiceRequest.php +++ b/SecurityCenterManagement/src/V1/GetSecurityCenterServiceRequest.php @@ -9,52 +9,52 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for getting a Security Command Center service. + * Request message for + * [SecurityCenterManagement.GetSecurityCenterService][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetSecurityCenterService]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetSecurityCenterServiceRequest */ class GetSecurityCenterServiceRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The Security Command Center service to retrieve. - * Formats: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Required. The Security Command Center service to retrieve, in one of the + * following formats: + * * organizations/{organization}/locations/{location}/securityCenterServices/{service} + * * folders/{folder}/locations/{location}/securityCenterServices/{service} + * * projects/{project}/locations/{location}/securityCenterServices/{service} + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Set to `true` to show only modules that are in scope. By default, all + * modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 2; */ protected $show_eligible_modules_only = false; /** - * @param string $name Required. The Security Command Center service to retrieve. - * - * Formats: + * @param string $name Required. The Security Command Center service to retrieve, in one of the + * following formats: * * * organizations/{organization}/locations/{location}/securityCenterServices/{service} * * folders/{folder}/locations/{location}/securityCenterServices/{service} * * projects/{project}/locations/{location}/securityCenterServices/{service} * - * The possible values for id {service} are: + * The following values are valid for `{service}`: * - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * Please see {@see SecurityCenterManagementClient::securityCenterServiceName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetSecurityCenterServiceRequest @@ -74,20 +74,20 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The Security Command Center service to retrieve. - * Formats: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Required. The Security Command Center service to retrieve, in one of the + * following formats: + * * organizations/{organization}/locations/{location}/securityCenterServices/{service} + * * folders/{folder}/locations/{location}/securityCenterServices/{service} + * * projects/{project}/locations/{location}/securityCenterServices/{service} + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * @type bool $show_eligible_modules_only - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Set to `true` to show only modules that are in scope. By default, all + * modules are shown. * } */ public function __construct($data = NULL) { @@ -96,17 +96,17 @@ public function __construct($data = NULL) { } /** - * Required. The Security Command Center service to retrieve. - * Formats: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Required. The Security Command Center service to retrieve, in one of the + * following formats: + * * organizations/{organization}/locations/{location}/securityCenterServices/{service} + * * folders/{folder}/locations/{location}/securityCenterServices/{service} + * * projects/{project}/locations/{location}/securityCenterServices/{service} + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -117,17 +117,17 @@ public function getName() } /** - * Required. The Security Command Center service to retrieve. - * Formats: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Required. The Security Command Center service to retrieve, in one of the + * following formats: + * * organizations/{organization}/locations/{location}/securityCenterServices/{service} + * * folders/{folder}/locations/{location}/securityCenterServices/{service} + * * projects/{project}/locations/{location}/securityCenterServices/{service} + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -142,8 +142,8 @@ public function setName($var) } /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Set to `true` to show only modules that are in scope. By default, all + * modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 2; * @return bool @@ -154,8 +154,8 @@ public function getShowEligibleModulesOnly() } /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Set to `true` to show only modules that are in scope. By default, all + * modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 2; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/GetSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/GetSecurityHealthAnalyticsCustomModuleRequest.php index 5069157c7578..084370424dd4 100644 --- a/SecurityCenterManagement/src/V1/GetSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/GetSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,22 +9,25 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for getting a SecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.GetSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.GetSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.GetSecurityHealthAnalyticsCustomModuleRequest */ class GetSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of the resource + * Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** - * @param string $name Required. Name of the resource - * Please see {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. + * @param string $name Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. Please see + * {@see SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\GetSecurityHealthAnalyticsCustomModuleRequest * @@ -43,7 +46,8 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. Name of the resource + * Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. * } */ public function __construct($data = NULL) { @@ -52,7 +56,8 @@ public function __construct($data = NULL) { } /** - * Required. Name of the resource + * Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -63,7 +68,8 @@ public function getName() } /** - * Required. Name of the resource + * Required. Name of the resource, in the format + * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesRequest.php index 6ea98488fc72..08df9dd9338b 100644 --- a/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesRequest.php @@ -9,19 +9,19 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing descendant Event Threat Detection custom - * modules. + * Request message for + * [SecurityCenterManagement.ListDescendantEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListDescendantEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListDescendantEventThreatDetectionCustomModulesRequest */ class ListDescendantEventThreatDetectionCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -35,18 +35,22 @@ class ListDescendantEventThreatDetectionCustomModulesRequest extends \Google\Pro */ protected $page_size = 0; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $parent Required. Name of parent to list custom modules, in one of the following + * formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListDescendantEventThreatDetectionCustomModulesRequest @@ -66,17 +70,20 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of modules to return. The service may return * fewer than this value. If unspecified, at most 10 configs will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @type string $page_token - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -85,11 +92,11 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -100,11 +107,11 @@ public function getParent() } /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -149,7 +156,10 @@ public function setPageSize($var) } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -160,7 +170,10 @@ public function getPageToken() } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesResponse.php index 91e329e5f403..d3724d98999f 100644 --- a/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListDescendantEventThreatDetectionCustomModulesResponse.php @@ -9,21 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing descendant Event Threat Detection custom - * modules. + * Response message for + * [SecurityCenterManagement.ListDescendantEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListDescendantEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListDescendantEventThreatDetectionCustomModulesResponse */ class ListDescendantEventThreatDetectionCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; */ private $event_threat_detection_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -36,9 +37,10 @@ class ListDescendantEventThreatDetectionCustomModulesResponse extends \Google\Pr * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $event_threat_detection_custom_modules - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -47,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -58,7 +60,7 @@ public function getEventThreatDetectionCustomModules() } /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -73,7 +75,8 @@ public function setEventThreatDetectionCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -84,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesRequest.php index 4db8d6b92e86..04f451500490 100644 --- a/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesRequest.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing descendant Security Health Analytics custom - * modules. + * Request message for + * [SecurityCenterManagement.ListDescendantSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListDescendantSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListDescendantSecurityHealthAnalyticsCustomModulesRequest */ @@ -18,7 +18,7 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesRequest extends \Google\ { /** * Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -34,7 +34,10 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesRequest extends \Google\ */ protected $page_size = 0; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -42,7 +45,7 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesRequest extends \Google\ /** * @param string $parent Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` @@ -67,7 +70,7 @@ public static function build(string $parent): self * * @type string $parent * Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -75,7 +78,10 @@ public static function build(string $parent): self * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -85,7 +91,7 @@ public function __construct($data = NULL) { /** * Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -100,7 +106,7 @@ public function getParent() /** * Required. Name of the parent organization, folder, or project in which to - * list custom modules, specified in one of the following formats: + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -146,7 +152,10 @@ public function setPageSize($var) } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -157,7 +166,10 @@ public function getPageToken() } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesResponse.php index b28b46e3c747..478fa12d4ec0 100644 --- a/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListDescendantSecurityHealthAnalyticsCustomModulesResponse.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing descendant Security Health Analytics custom - * modules. + * Response message for + * [SecurityCenterManagement.ListDescendantSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListDescendantSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListDescendantSecurityHealthAnalyticsCustomModulesResponse */ @@ -23,7 +23,8 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesResponse extends \Google */ private $security_health_analytics_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -38,7 +39,8 @@ class ListDescendantSecurityHealthAnalyticsCustomModulesResponse extends \Google * @type array<\Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $security_health_analytics_custom_modules * The list of SecurityHealthAnalyticsCustomModules * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -73,7 +75,8 @@ public function setSecurityHealthAnalyticsCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -84,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesRequest.php index 40094fd46acf..e5bf147f21a0 100644 --- a/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesRequest.php @@ -9,19 +9,19 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing effective Event Threat Detection custom - * modules. + * Request message for + * [SecurityCenterManagement.ListEffectiveEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEffectiveEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEffectiveEventThreatDetectionCustomModulesRequest */ class ListEffectiveEventThreatDetectionCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -34,18 +34,22 @@ class ListEffectiveEventThreatDetectionCustomModulesRequest extends \Google\Prot */ protected $page_size = 0; /** - * Optional. The value returned by the last call indicating a continuation + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $parent Required. Name of parent to list effective custom modules, in one of the + * following formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListEffectiveEventThreatDetectionCustomModulesRequest @@ -65,16 +69,19 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. The value returned by the last call indicating a continuation + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -83,11 +90,11 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -98,11 +105,11 @@ public function getParent() } /** - * Required. Name of parent to list effective custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -145,7 +152,10 @@ public function setPageSize($var) } /** - * Optional. The value returned by the last call indicating a continuation + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -156,7 +166,10 @@ public function getPageToken() } /** - * Optional. The value returned by the last call indicating a continuation + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesResponse.php index 66317828ab95..e8bb16a7e9a4 100644 --- a/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListEffectiveEventThreatDetectionCustomModulesResponse.php @@ -9,21 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing effective Event Threat Detection custom - * modules. + * Response message for + * [SecurityCenterManagement.ListEffectiveEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEffectiveEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEffectiveEventThreatDetectionCustomModulesResponse */ class ListEffectiveEventThreatDetectionCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of EffectiveEventThreatDetectionCustomModules + * The list of effective Event Threat Detection custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule effective_event_threat_detection_custom_modules = 1; */ private $effective_event_threat_detection_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -36,9 +37,10 @@ class ListEffectiveEventThreatDetectionCustomModulesResponse extends \Google\Pro * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\EffectiveEventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $effective_event_threat_detection_custom_modules - * The list of EffectiveEventThreatDetectionCustomModules + * The list of effective Event Threat Detection custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -47,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of EffectiveEventThreatDetectionCustomModules + * The list of effective Event Threat Detection custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule effective_event_threat_detection_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -58,7 +60,7 @@ public function getEffectiveEventThreatDetectionCustomModules() } /** - * The list of EffectiveEventThreatDetectionCustomModules + * The list of effective Event Threat Detection custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule effective_event_threat_detection_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\EffectiveEventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -73,7 +75,8 @@ public function setEffectiveEventThreatDetectionCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -84,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesRequest.php index 4e8e3f4aceaf..f5b12a20bc52 100644 --- a/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesRequest.php @@ -9,20 +9,19 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing effective Security Health Analytics custom - * modules. + * Request message for + * [SecurityCenterManagement.ListEffectiveSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEffectiveSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEffectiveSecurityHealthAnalyticsCustomModulesRequest */ class ListEffectiveSecurityHealthAnalyticsCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * Required. Name of parent to list effective custom modules, in one of the + * following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -35,19 +34,22 @@ class ListEffectiveSecurityHealthAnalyticsCustomModulesRequest extends \Google\P */ protected $page_size = 0; /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * @param string $parent Required. Name of parent to list effective custom modules, in one of the + * following formats: + * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListEffectiveSecurityHealthAnalyticsCustomModulesRequest @@ -67,17 +69,19 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * Required. Name of parent to list effective custom modules, in one of the + * following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -86,12 +90,11 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * Required. Name of parent to list effective custom modules, in one of the + * following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -102,12 +105,11 @@ public function getParent() } /** - * Required. Name of parent to list effective custom modules. specified in one - * of the following formats: + * Required. Name of parent to list effective custom modules, in one of the + * following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` - * or - * `projects/{project}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -150,7 +152,10 @@ public function setPageSize($var) } /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -161,7 +166,10 @@ public function getPageToken() } /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesResponse.php index 7a21fad782a9..23b7e7dd9346 100644 --- a/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListEffectiveSecurityHealthAnalyticsCustomModulesResponse.php @@ -9,21 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing effective Security Health Analytics custom - * modules. + * Response message for + * [SecurityCenterManagement.ListEffectiveSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEffectiveSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEffectiveSecurityHealthAnalyticsCustomModulesResponse */ class ListEffectiveSecurityHealthAnalyticsCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of EffectiveSecurityHealthAnalyticsCustomModule + * The list of effective Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule effective_security_health_analytics_custom_modules = 1; */ private $effective_security_health_analytics_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -36,9 +37,10 @@ class ListEffectiveSecurityHealthAnalyticsCustomModulesResponse extends \Google\ * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\EffectiveSecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $effective_security_health_analytics_custom_modules - * The list of EffectiveSecurityHealthAnalyticsCustomModule + * The list of effective Security Health Analytics custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -47,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of EffectiveSecurityHealthAnalyticsCustomModule + * The list of effective Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule effective_security_health_analytics_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -58,7 +60,7 @@ public function getEffectiveSecurityHealthAnalyticsCustomModules() } /** - * The list of EffectiveSecurityHealthAnalyticsCustomModule + * The list of effective Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule effective_security_health_analytics_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\EffectiveSecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -73,7 +75,8 @@ public function setEffectiveSecurityHealthAnalyticsCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -84,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesRequest.php index 16e359448211..1156908e530f 100644 --- a/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesRequest.php @@ -9,48 +9,48 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing Event Threat Detection custom modules. + * Request message for + * [SecurityCenterManagement.ListEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEventThreatDetectionCustomModulesRequest */ class ListEventThreatDetectionCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Optional. The maximum number of modules to return. The service may return - * fewer than this value. If unspecified, at most 10 configs will be returned. + * fewer than this value. If unspecified, at most 10 modules will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_size = 0; /** - * Optional. A page token, received from a previous - * `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the - * subsequent page. - * When paginating, all other parameters provided to - * `ListEventThreatDetectionCustomModules` must match the call that provided - * the page token. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * @param string $parent Required. Name of parent to list custom modules, in one of the following + * formats: + * + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListEventThreatDetectionCustomModulesRequest @@ -70,22 +70,20 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of modules to return. The service may return - * fewer than this value. If unspecified, at most 10 configs will be returned. + * fewer than this value. If unspecified, at most 10 modules will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @type string $page_token - * Optional. A page token, received from a previous - * `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the - * subsequent page. - * When paginating, all other parameters provided to - * `ListEventThreatDetectionCustomModules` must match the call that provided - * the page token. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -94,11 +92,11 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -109,11 +107,11 @@ public function getParent() } /** - * Required. Name of parent to list custom modules. Its format is - * `organizations/{organization}/locations/{location}`, - * `folders/{folder}/locations/{location}`, - * or - * `projects/{project}/locations/{location}` + * Required. Name of parent to list custom modules, in one of the following + * formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -129,7 +127,7 @@ public function setParent($var) /** * Optional. The maximum number of modules to return. The service may return - * fewer than this value. If unspecified, at most 10 configs will be returned. + * fewer than this value. If unspecified, at most 10 modules will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -142,7 +140,7 @@ public function getPageSize() /** * Optional. The maximum number of modules to return. The service may return - * fewer than this value. If unspecified, at most 10 configs will be returned. + * fewer than this value. If unspecified, at most 10 modules will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -158,12 +156,10 @@ public function setPageSize($var) } /** - * Optional. A page token, received from a previous - * `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the - * subsequent page. - * When paginating, all other parameters provided to - * `ListEventThreatDetectionCustomModules` must match the call that provided - * the page token. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -174,12 +170,10 @@ public function getPageToken() } /** - * Optional. A page token, received from a previous - * `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the - * subsequent page. - * When paginating, all other parameters provided to - * `ListEventThreatDetectionCustomModules` must match the call that provided - * the page token. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesResponse.php index ee2dd6dd74e4..a538e84d65b8 100644 --- a/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListEventThreatDetectionCustomModulesResponse.php @@ -9,20 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing Event Threat Detection custom modules. + * Response message for + * [SecurityCenterManagement.ListEventThreatDetectionCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListEventThreatDetectionCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListEventThreatDetectionCustomModulesResponse */ class ListEventThreatDetectionCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; */ private $event_threat_detection_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -35,9 +37,10 @@ class ListEventThreatDetectionCustomModulesResponse extends \Google\Protobuf\Int * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $event_threat_detection_custom_modules - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -46,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -57,7 +60,7 @@ public function getEventThreatDetectionCustomModules() } /** - * The list of EventThreatDetectionCustomModules + * The list of custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -72,7 +75,8 @@ public function setEventThreatDetectionCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -83,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListSecurityCenterServicesRequest.php b/SecurityCenterManagement/src/V1/ListSecurityCenterServicesRequest.php index 19c23c940772..ddadcb066ea1 100644 --- a/SecurityCenterManagement/src/V1/ListSecurityCenterServicesRequest.php +++ b/SecurityCenterManagement/src/V1/ListSecurityCenterServicesRequest.php @@ -9,18 +9,19 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing Security Command Center services. + * Request message for + * [SecurityCenterManagement.ListSecurityCenterServices][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListSecurityCenterServices]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListSecurityCenterServicesRequest */ class ListSecurityCenterServicesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The name of the parent to list Security Command Center services. - * Formats: - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * Required. The name of the parent to list Security Command Center services, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,27 +34,29 @@ class ListSecurityCenterServicesRequest extends \Google\Protobuf\Internal\Messag */ protected $page_size = 0; /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Flag that, when set, is used to filter the module settings that are shown. + * The default setting is that all modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 4; */ protected $show_eligible_modules_only = false; /** - * @param string $parent Required. The name of the parent to list Security Command Center services. + * @param string $parent Required. The name of the parent to list Security Command Center services, + * in one of the following formats: * - * Formats: - * - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * Please see {@see SecurityCenterManagementClient::organizationLocationName()} for help formatting this field. * * @return \Google\Cloud\SecurityCenterManagement\V1\ListSecurityCenterServicesRequest @@ -73,19 +76,22 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. The name of the parent to list Security Command Center services. - * Formats: - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * Required. The name of the parent to list Security Command Center services, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * @type int $page_size * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * @type bool $show_eligible_modules_only - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Flag that, when set, is used to filter the module settings that are shown. + * The default setting is that all modules are shown. * } */ public function __construct($data = NULL) { @@ -94,11 +100,11 @@ public function __construct($data = NULL) { } /** - * Required. The name of the parent to list Security Command Center services. - * Formats: - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * Required. The name of the parent to list Security Command Center services, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -109,11 +115,11 @@ public function getParent() } /** - * Required. The name of the parent to list Security Command Center services. - * Formats: - * * organizations/{organization}/locations/{location} - * * folders/{folder}/locations/{location} - * * projects/{project}/locations/{location} + * Required. The name of the parent to list Security Command Center services, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` + * * `folders/{folder}/locations/{location}` + * * `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -156,7 +162,10 @@ public function setPageSize($var) } /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -167,7 +176,10 @@ public function getPageToken() } /** - * Optional. The value returned by the last call indicating a continuation. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -182,8 +194,8 @@ public function setPageToken($var) } /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Flag that, when set, is used to filter the module settings that are shown. + * The default setting is that all modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 4; * @return bool @@ -194,8 +206,8 @@ public function getShowEligibleModulesOnly() } /** - * Flag that, when set, will be used to filter the ModuleSettings that are - * in scope. The default setting is that all modules will be shown. + * Flag that, when set, is used to filter the module settings that are shown. + * The default setting is that all modules are shown. * * Generated from protobuf field bool show_eligible_modules_only = 4; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/ListSecurityCenterServicesResponse.php b/SecurityCenterManagement/src/V1/ListSecurityCenterServicesResponse.php index 772555d39002..d43ae1af6a2d 100644 --- a/SecurityCenterManagement/src/V1/ListSecurityCenterServicesResponse.php +++ b/SecurityCenterManagement/src/V1/ListSecurityCenterServicesResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing Security Command Center services. + * Response message for + * [SecurityCenterManagement.ListSecurityCenterServices][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListSecurityCenterServices]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListSecurityCenterServicesResponse */ @@ -22,7 +23,8 @@ class ListSecurityCenterServicesResponse extends \Google\Protobuf\Internal\Messa */ private $security_center_services; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -37,7 +39,8 @@ class ListSecurityCenterServicesResponse extends \Google\Protobuf\Internal\Messa * @type array<\Google\Cloud\SecurityCenterManagement\V1\SecurityCenterService>|\Google\Protobuf\Internal\RepeatedField $security_center_services * The list of services. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -72,7 +75,8 @@ public function setSecurityCenterServices($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -83,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesRequest.php b/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesRequest.php index 2e52af07903c..7cd5f1705a22 100644 --- a/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesRequest.php +++ b/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesRequest.php @@ -9,15 +9,16 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for listing Security Health Analytics custom modules. + * Request message for + * [SecurityCenterManagement.ListSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListSecurityHealthAnalyticsCustomModulesRequest */ class ListSecurityHealthAnalyticsCustomModulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -33,15 +34,18 @@ class ListSecurityHealthAnalyticsCustomModulesRequest extends \Google\Protobuf\I */ protected $page_size = 0; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * @param string $parent Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * @param string $parent Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` @@ -65,8 +69,8 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -74,7 +78,10 @@ public static function build(string $parent): self * Optional. The maximum number of results to return in a single response. * Default is 10, minimum is 1, maximum is 1000. * @type string $page_token - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * } */ public function __construct($data = NULL) { @@ -83,8 +90,8 @@ public function __construct($data = NULL) { } /** - * Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -98,8 +105,8 @@ public function getParent() } /** - * Required. Name of parent organization, folder, or project in which to list - * custom modules, specified in one of the following formats: + * Required. Name of the parent organization, folder, or project in which to + * list custom modules, in one of the following formats: * * `organizations/{organization}/locations/{location}` * * `folders/{folder}/locations/{location}` * * `projects/{project}/locations/{location}` @@ -145,7 +152,10 @@ public function setPageSize($var) } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -156,7 +166,10 @@ public function getPageToken() } /** - * Optional. A token identifying a page of results the server should return. + * Optional. A pagination token returned from a previous request. Provide this + * token to retrieve the next page of results. + * When paginating, the rest of the request must match the request that + * generated the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesResponse.php b/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesResponse.php index 4ed6c5ea9a78..837acd25dacc 100644 --- a/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesResponse.php +++ b/SecurityCenterManagement/src/V1/ListSecurityHealthAnalyticsCustomModulesResponse.php @@ -9,20 +9,22 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for listing Security Health Analytics custom modules. + * Response message for + * [SecurityCenterManagement.ListSecurityHealthAnalyticsCustomModules][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ListSecurityHealthAnalyticsCustomModules]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ListSecurityHealthAnalyticsCustomModulesResponse */ class ListSecurityHealthAnalyticsCustomModulesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of SecurityHealthAnalyticsCustomModules + * The list of Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_modules = 1; */ private $security_health_analytics_custom_modules; /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; */ @@ -35,9 +37,10 @@ class ListSecurityHealthAnalyticsCustomModulesResponse extends \Google\Protobuf\ * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $security_health_analytics_custom_modules - * The list of SecurityHealthAnalyticsCustomModules + * The list of Security Health Analytics custom modules. * @type string $next_page_token - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * } */ public function __construct($data = NULL) { @@ -46,7 +49,7 @@ public function __construct($data = NULL) { } /** - * The list of SecurityHealthAnalyticsCustomModules + * The list of Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_modules = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -57,7 +60,7 @@ public function getSecurityHealthAnalyticsCustomModules() } /** - * The list of SecurityHealthAnalyticsCustomModules + * The list of Security Health Analytics custom modules. * * Generated from protobuf field repeated .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_modules = 1; * @param array<\Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule>|\Google\Protobuf\Internal\RepeatedField $var @@ -72,7 +75,8 @@ public function setSecurityHealthAnalyticsCustomModules($var) } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -83,7 +87,8 @@ public function getNextPageToken() } /** - * A token identifying a page of results the server should return. + * A pagination token. To retrieve the next page of results, call the method + * again with this token. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/SecurityCenterManagement/src/V1/SecurityCenterService.php b/SecurityCenterManagement/src/V1/SecurityCenterService.php index 6482912da57a..8f6f0023b937 100644 --- a/SecurityCenterManagement/src/V1/SecurityCenterService.php +++ b/SecurityCenterManagement/src/V1/SecurityCenterService.php @@ -13,39 +13,38 @@ * settings information such as top-level enablement in addition to individual * module settings. Service settings can be configured at the organization, * folder, or project level. Service settings at the organization or folder - * level are inherited by those in child folders and projects. + * level are inherited by those in descendant folders and projects. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SecurityCenterService */ class SecurityCenterService extends \Google\Protobuf\Internal\Message { /** - * Identifier. The name of the service. - * Its format is: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Identifier. The name of the service, in one of the following formats: + * * `organizations/{organization}/locations/{location}/securityCenterServices/{service}` + * * `folders/{folder}/locations/{location}/securityCenterServices/{service}` + * * `projects/{project}/locations/{location}/securityCenterServices/{service}` + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * Optional. The intended state of enablement for the service at its level of - * the resource hierarchy. A DISABLED state will override all module - * enablement_states to DISABLED. + * Optional. The intended enablement state for the service at its level of the + * resource hierarchy. A `DISABLED` state will override all module enablement + * states to `DISABLED`. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $intended_enablement_state = 0; /** * Output only. The effective enablement state for the service at its level of - * the resource hierarchy. If the intended state is set to INHERITED, the + * the resource hierarchy. If the intended state is set to `INHERITED`, the * effective state will be inherited from the enablement state of an ancestor. * This state may differ from the intended enablement state due to billing * eligibility or onboarding status. @@ -54,8 +53,8 @@ class SecurityCenterService extends \Google\Protobuf\Internal\Message */ protected $effective_enablement_state = 0; /** - * Optional. The configurations including the state of enablement for the - * service's different modules. The absence of a module in the map implies its + * Optional. The module configurations, including the enablement state for the + * service's modules. The absence of a module in the map implies that its * configuration is inherited from its parents. * * Generated from protobuf field map modules = 4 [(.google.api.field_behavior) = OPTIONAL]; @@ -63,14 +62,14 @@ class SecurityCenterService extends \Google\Protobuf\Internal\Message private $modules; /** * Output only. The time the service was last updated. This could be due to an - * explicit user update or due to a side effect of another system change such + * explicit user update or due to a side effect of another system change, such * as billing subscription expiry. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $update_time = null; /** - * Optional. Additional service specific configuration. Not all services will + * Optional. Additional service-specific configuration. Not all services will * utilize this field. * * Generated from protobuf field .google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL]; @@ -84,37 +83,36 @@ class SecurityCenterService extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The name of the service. - * Its format is: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Identifier. The name of the service, in one of the following formats: + * * `organizations/{organization}/locations/{location}/securityCenterServices/{service}` + * * `folders/{folder}/locations/{location}/securityCenterServices/{service}` + * * `projects/{project}/locations/{location}/securityCenterServices/{service}` + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * @type int $intended_enablement_state - * Optional. The intended state of enablement for the service at its level of - * the resource hierarchy. A DISABLED state will override all module - * enablement_states to DISABLED. + * Optional. The intended enablement state for the service at its level of the + * resource hierarchy. A `DISABLED` state will override all module enablement + * states to `DISABLED`. * @type int $effective_enablement_state * Output only. The effective enablement state for the service at its level of - * the resource hierarchy. If the intended state is set to INHERITED, the + * the resource hierarchy. If the intended state is set to `INHERITED`, the * effective state will be inherited from the enablement state of an ancestor. * This state may differ from the intended enablement state due to billing * eligibility or onboarding status. * @type array|\Google\Protobuf\Internal\MapField $modules - * Optional. The configurations including the state of enablement for the - * service's different modules. The absence of a module in the map implies its + * Optional. The module configurations, including the enablement state for the + * service's modules. The absence of a module in the map implies that its * configuration is inherited from its parents. * @type \Google\Protobuf\Timestamp $update_time * Output only. The time the service was last updated. This could be due to an - * explicit user update or due to a side effect of another system change such + * explicit user update or due to a side effect of another system change, such * as billing subscription expiry. * @type \Google\Protobuf\Struct $service_config - * Optional. Additional service specific configuration. Not all services will + * Optional. Additional service-specific configuration. Not all services will * utilize this field. * } */ @@ -124,17 +122,16 @@ public function __construct($data = NULL) { } /** - * Identifier. The name of the service. - * Its format is: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Identifier. The name of the service, in one of the following formats: + * * `organizations/{organization}/locations/{location}/securityCenterServices/{service}` + * * `folders/{folder}/locations/{location}/securityCenterServices/{service}` + * * `projects/{project}/locations/{location}/securityCenterServices/{service}` + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -145,17 +142,16 @@ public function getName() } /** - * Identifier. The name of the service. - * Its format is: - * * organizations/{organization}/locations/{location}/securityCenterServices/{service} - * * folders/{folder}/locations/{location}/securityCenterServices/{service} - * * projects/{project}/locations/{location}/securityCenterServices/{service} - * The possible values for id {service} are: - * * container-threat-detection - * * event-threat-detection - * * security-health-analytics - * * vm-threat-detection - * * web-security-scanner + * Identifier. The name of the service, in one of the following formats: + * * `organizations/{organization}/locations/{location}/securityCenterServices/{service}` + * * `folders/{folder}/locations/{location}/securityCenterServices/{service}` + * * `projects/{project}/locations/{location}/securityCenterServices/{service}` + * The following values are valid for `{service}`: + * * `container-threat-detection` + * * `event-threat-detection` + * * `security-health-analytics` + * * `vm-threat-detection` + * * `web-security-scanner` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -170,9 +166,9 @@ public function setName($var) } /** - * Optional. The intended state of enablement for the service at its level of - * the resource hierarchy. A DISABLED state will override all module - * enablement_states to DISABLED. + * Optional. The intended enablement state for the service at its level of the + * resource hierarchy. A `DISABLED` state will override all module enablement + * states to `DISABLED`. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -183,9 +179,9 @@ public function getIntendedEnablementState() } /** - * Optional. The intended state of enablement for the service at its level of - * the resource hierarchy. A DISABLED state will override all module - * enablement_states to DISABLED. + * Optional. The intended enablement state for the service at its level of the + * resource hierarchy. A `DISABLED` state will override all module enablement + * states to `DISABLED`. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -201,7 +197,7 @@ public function setIntendedEnablementState($var) /** * Output only. The effective enablement state for the service at its level of - * the resource hierarchy. If the intended state is set to INHERITED, the + * the resource hierarchy. If the intended state is set to `INHERITED`, the * effective state will be inherited from the enablement state of an ancestor. * This state may differ from the intended enablement state due to billing * eligibility or onboarding status. @@ -216,7 +212,7 @@ public function getEffectiveEnablementState() /** * Output only. The effective enablement state for the service at its level of - * the resource hierarchy. If the intended state is set to INHERITED, the + * the resource hierarchy. If the intended state is set to `INHERITED`, the * effective state will be inherited from the enablement state of an ancestor. * This state may differ from the intended enablement state due to billing * eligibility or onboarding status. @@ -234,8 +230,8 @@ public function setEffectiveEnablementState($var) } /** - * Optional. The configurations including the state of enablement for the - * service's different modules. The absence of a module in the map implies its + * Optional. The module configurations, including the enablement state for the + * service's modules. The absence of a module in the map implies that its * configuration is inherited from its parents. * * Generated from protobuf field map modules = 4 [(.google.api.field_behavior) = OPTIONAL]; @@ -247,8 +243,8 @@ public function getModules() } /** - * Optional. The configurations including the state of enablement for the - * service's different modules. The absence of a module in the map implies its + * Optional. The module configurations, including the enablement state for the + * service's modules. The absence of a module in the map implies that its * configuration is inherited from its parents. * * Generated from protobuf field map modules = 4 [(.google.api.field_behavior) = OPTIONAL]; @@ -265,7 +261,7 @@ public function setModules($var) /** * Output only. The time the service was last updated. This could be due to an - * explicit user update or due to a side effect of another system change such + * explicit user update or due to a side effect of another system change, such * as billing subscription expiry. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -288,7 +284,7 @@ public function clearUpdateTime() /** * Output only. The time the service was last updated. This could be due to an - * explicit user update or due to a side effect of another system change such + * explicit user update or due to a side effect of another system change, such * as billing subscription expiry. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; @@ -304,7 +300,7 @@ public function setUpdateTime($var) } /** - * Optional. Additional service specific configuration. Not all services will + * Optional. Additional service-specific configuration. Not all services will * utilize this field. * * Generated from protobuf field .google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL]; @@ -326,7 +322,7 @@ public function clearServiceConfig() } /** - * Optional. Additional service specific configuration. Not all services will + * Optional. Additional service-specific configuration. Not all services will * utilize this field. * * Generated from protobuf field .google.protobuf.Struct service_config = 6 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/SecurityCenterManagement/src/V1/SecurityCenterService/EnablementState.php b/SecurityCenterManagement/src/V1/SecurityCenterService/EnablementState.php index ec0c84ff61e9..ad2a197f3909 100644 --- a/SecurityCenterManagement/src/V1/SecurityCenterService/EnablementState.php +++ b/SecurityCenterManagement/src/V1/SecurityCenterService/EnablementState.php @@ -7,8 +7,7 @@ use UnexpectedValueException; /** - * Represents the possible intended states of enablement for a service or - * module. + * Represents the possible enablement states for a service or module. * * Protobuf type google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState */ @@ -21,8 +20,8 @@ class EnablementState */ const ENABLEMENT_STATE_UNSPECIFIED = 0; /** - * State is inherited from the parent resource. Not a valid effective - * enablement state. + * State is inherited from the parent resource. Valid as an intended + * enablement state, but not as an effective enablement state. * * Generated from protobuf enum INHERITED = 1; */ @@ -40,9 +39,10 @@ class EnablementState */ const DISABLED = 3; /** - * SCC is configured to ingest findings from this service but not enable - * this service. Not a valid intended_enablement_state (that is, this is a - * readonly state). + * Security Command Center is configured to ingest findings from this + * service, but not to enable this service. This state indicates that + * Security Command Center is misconfigured. You can't set this state + * yourself. * * Generated from protobuf enum INGEST_ONLY = 4; */ diff --git a/SecurityCenterManagement/src/V1/SecurityCenterService/ModuleSettings.php b/SecurityCenterManagement/src/V1/SecurityCenterService/ModuleSettings.php index 7b603e767c13..dd54816b3a55 100644 --- a/SecurityCenterManagement/src/V1/SecurityCenterService/ModuleSettings.php +++ b/SecurityCenterManagement/src/V1/SecurityCenterService/ModuleSettings.php @@ -16,7 +16,7 @@ class ModuleSettings extends \Google\Protobuf\Internal\Message { /** - * Optional. The intended state of enablement for the module at its level of + * Optional. The intended enablement state for the module at its level of * the resource hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 1 [(.google.api.field_behavior) = OPTIONAL]; @@ -24,11 +24,10 @@ class ModuleSettings extends \Google\Protobuf\Internal\Message protected $intended_enablement_state = 0; /** * Output only. The effective enablement state for the module at its level - * of the resource hierarchy. If the intended state is set to INHERITED, the - * effective state will be inherited from the enablement state of an - * ancestor. This state may - * differ from the intended enablement state due to billing eligibility or - * onboarding status. + * of the resource hierarchy. If the intended state is set to `INHERITED`, + * the effective state will be inherited from the enablement state of an + * ancestor. This state may differ from the intended enablement state due to + * billing eligibility or onboarding status. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState effective_enablement_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -41,15 +40,14 @@ class ModuleSettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $intended_enablement_state - * Optional. The intended state of enablement for the module at its level of + * Optional. The intended enablement state for the module at its level of * the resource hierarchy. * @type int $effective_enablement_state * Output only. The effective enablement state for the module at its level - * of the resource hierarchy. If the intended state is set to INHERITED, the - * effective state will be inherited from the enablement state of an - * ancestor. This state may - * differ from the intended enablement state due to billing eligibility or - * onboarding status. + * of the resource hierarchy. If the intended state is set to `INHERITED`, + * the effective state will be inherited from the enablement state of an + * ancestor. This state may differ from the intended enablement state due to + * billing eligibility or onboarding status. * } */ public function __construct($data = NULL) { @@ -58,7 +56,7 @@ public function __construct($data = NULL) { } /** - * Optional. The intended state of enablement for the module at its level of + * Optional. The intended enablement state for the module at its level of * the resource hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 1 [(.google.api.field_behavior) = OPTIONAL]; @@ -70,7 +68,7 @@ public function getIntendedEnablementState() } /** - * Optional. The intended state of enablement for the module at its level of + * Optional. The intended enablement state for the module at its level of * the resource hierarchy. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState intended_enablement_state = 1 [(.google.api.field_behavior) = OPTIONAL]; @@ -87,11 +85,10 @@ public function setIntendedEnablementState($var) /** * Output only. The effective enablement state for the module at its level - * of the resource hierarchy. If the intended state is set to INHERITED, the - * effective state will be inherited from the enablement state of an - * ancestor. This state may - * differ from the intended enablement state due to billing eligibility or - * onboarding status. + * of the resource hierarchy. If the intended state is set to `INHERITED`, + * the effective state will be inherited from the enablement state of an + * ancestor. This state may differ from the intended enablement state due to + * billing eligibility or onboarding status. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState effective_enablement_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int @@ -103,11 +100,10 @@ public function getEffectiveEnablementState() /** * Output only. The effective enablement state for the module at its level - * of the resource hierarchy. If the intended state is set to INHERITED, the - * effective state will be inherited from the enablement state of an - * ancestor. This state may - * differ from the intended enablement state due to billing eligibility or - * onboarding status. + * of the resource hierarchy. If the intended state is set to `INHERITED`, + * the effective state will be inherited from the enablement state of an + * ancestor. This state may differ from the intended enablement state due to + * billing eligibility or onboarding status. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityCenterService.EnablementState effective_enablement_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int $var diff --git a/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule.php b/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule.php index db568064f325..540fd6a49456 100644 --- a/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule.php +++ b/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule.php @@ -13,18 +13,18 @@ * including its full module name, display name, enablement state, and last * updated time. You can create a custom module at the organization, folder, or * project level. Custom modules that you create at the organization or folder - * level are inherited by the child folders and projects. + * level are inherited by the descendant folders and projects. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule */ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Message { /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ @@ -32,8 +32,8 @@ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Mess /** * Optional. The display name of the Security Health Analytics custom module. * This display name becomes the finding category for all findings that are - * returned by this custom module. The display name must be between 1 and - * 128 characters, start with a lowercase letter, and contain alphanumeric + * returned by this custom module. The display name must be between 1 and 128 + * characters, start with a lowercase letter, and contain alphanumeric * characters or underscores only. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -67,7 +67,7 @@ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Mess */ protected $ancestor_module = ''; /** - * Optional. The user specified custom configuration for the module. + * Optional. The user-specified custom configuration for the module. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.CustomConfig custom_config = 7 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -80,16 +80,16 @@ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Mess * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * @type string $display_name * Optional. The display name of the Security Health Analytics custom module. * This display name becomes the finding category for all findings that are - * returned by this custom module. The display name must be between 1 and - * 128 characters, start with a lowercase letter, and contain alphanumeric + * returned by this custom module. The display name must be between 1 and 128 + * characters, start with a lowercase letter, and contain alphanumeric * characters or underscores only. * @type int $enablement_state * Optional. The enablement state of the custom module. @@ -103,7 +103,7 @@ class SecurityHealthAnalyticsCustomModule extends \Google\Protobuf\Internal\Mess * in the organization, folder, or project in which you are viewing the custom * module. * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $custom_config - * Optional. The user specified custom configuration for the module. + * Optional. The user-specified custom configuration for the module. * } */ public function __construct($data = NULL) { @@ -112,11 +112,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -127,11 +127,11 @@ public function getName() } /** - * Identifier. The full resource name of the custom module, specified in one - * of the following formats: - * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` - * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}` + * Identifier. The full resource name of the custom module, in one of the + * following formats: + * * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` + * * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -148,8 +148,8 @@ public function setName($var) /** * Optional. The display name of the Security Health Analytics custom module. * This display name becomes the finding category for all findings that are - * returned by this custom module. The display name must be between 1 and - * 128 characters, start with a lowercase letter, and contain alphanumeric + * returned by this custom module. The display name must be between 1 and 128 + * characters, start with a lowercase letter, and contain alphanumeric * characters or underscores only. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -163,8 +163,8 @@ public function getDisplayName() /** * Optional. The display name of the Security Health Analytics custom module. * This display name becomes the finding category for all findings that are - * returned by this custom module. The display name must be between 1 and - * 128 characters, start with a lowercase letter, and contain alphanumeric + * returned by this custom module. The display name must be between 1 and 128 + * characters, start with a lowercase letter, and contain alphanumeric * characters or underscores only. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -300,7 +300,7 @@ public function setAncestorModule($var) } /** - * Optional. The user specified custom configuration for the module. + * Optional. The user-specified custom configuration for the module. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.CustomConfig custom_config = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\SecurityCenterManagement\V1\CustomConfig|null @@ -321,7 +321,7 @@ public function clearCustomConfig() } /** - * Optional. The user specified custom configuration for the module. + * Optional. The user-specified custom configuration for the module. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.CustomConfig custom_config = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $var diff --git a/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule/EnablementState.php b/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule/EnablementState.php index 2933b0039b33..ccfeefae7cb0 100644 --- a/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule/EnablementState.php +++ b/SecurityCenterManagement/src/V1/SecurityHealthAnalyticsCustomModule/EnablementState.php @@ -14,29 +14,29 @@ class EnablementState { /** - * Unspecified enablement state. + * Default value. This value is unused. * * Generated from protobuf enum ENABLEMENT_STATE_UNSPECIFIED = 0; */ const ENABLEMENT_STATE_UNSPECIFIED = 0; /** - * The module is enabled at the given CRM resource. + * The module is enabled at the given organization, folder, or project. * * Generated from protobuf enum ENABLED = 1; */ const ENABLED = 1; /** - * The module is disabled at the given CRM resource. + * The module is disabled at the given organization, folder, or project. * * Generated from protobuf enum DISABLED = 2; */ const DISABLED = 2; /** * State is inherited from an ancestor module. The module will either - * be effectively ENABLED or DISABLED based on its closest non-inherited - * ancestor module in the CRM hierarchy. Attempting to set a top level - * module (module with no parent) to the INHERITED state will result in an - * INVALID_ARGUMENT error. + * be effectively `ENABLED` or `DISABLED` based on its closest non-inherited + * ancestor module in the resource hierarchy. If you try to set a top-level + * module (a module with no parent) to the `INHERITED` state, you receive an + * `INVALID_ARGUMENT` error. * * Generated from protobuf enum INHERITED = 3; */ diff --git a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest.php index b7c4bdddc09b..dafdb842b8d7 100644 --- a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,8 +9,9 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message to simulate a CustomConfig against a given test resource. - * Maximum size of the request is 4 MB by default. + * Request message for + * [SecurityCenterManagement.SimulateSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.SimulateSecurityHealthAnalyticsCustomModule]. + * The maximum size of the request is 4 MiB. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleRequest */ @@ -18,10 +19,9 @@ class SimulateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobu { /** * Required. The relative resource name of the organization, project, or - * folder. For more information about relative resource names, see [Relative - * Resource - * Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * Example: `organizations/{organization_id}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; */ @@ -41,10 +41,9 @@ class SimulateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobu /** * @param string $parent Required. The relative resource name of the organization, project, or - * folder. For more information about relative resource names, see [Relative - * Resource - * Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * Example: `organizations/{organization_id}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * @param \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $customConfig Required. The custom configuration that you need to test. * @param \Google\Cloud\SecurityCenterManagement\V1\SimulateSecurityHealthAnalyticsCustomModuleRequest\SimulatedResource $resource Required. Resource data to simulate custom module against. * @@ -68,10 +67,9 @@ public static function build(string $parent, \Google\Cloud\SecurityCenterManagem * * @type string $parent * Required. The relative resource name of the organization, project, or - * folder. For more information about relative resource names, see [Relative - * Resource - * Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * Example: `organizations/{organization_id}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * @type \Google\Cloud\SecurityCenterManagement\V1\CustomConfig $custom_config * Required. The custom configuration that you need to test. * @type \Google\Cloud\SecurityCenterManagement\V1\SimulateSecurityHealthAnalyticsCustomModuleRequest\SimulatedResource $resource @@ -85,10 +83,9 @@ public function __construct($data = NULL) { /** * Required. The relative resource name of the organization, project, or - * folder. For more information about relative resource names, see [Relative - * Resource - * Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * Example: `organizations/{organization_id}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -100,10 +97,9 @@ public function getParent() /** * Required. The relative resource name of the organization, project, or - * folder. For more information about relative resource names, see [Relative - * Resource - * Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * Example: `organizations/{organization_id}`. + * folder. For more information about relative resource names, see [AIP-122: + * Resource names](https://google.aip.dev/122). Example: + * `organizations/{organization_id}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php index bd1fe46f93fb..5abdfa461c91 100644 --- a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php +++ b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php @@ -9,16 +9,14 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Manually constructed resource name. If the custom module evaluates against - * only the resource data, you can omit the `iam_policy_data` field. If it - * evaluates only the `iam_policy_data` field, you can omit the resource data. + * Manually constructed information about a resource. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleRequest.SimulatedResource */ class SimulatedResource extends \Google\Protobuf\Internal\Message { /** - * Required. The type of the resource, for example, + * Required. The type of the resource. For example, * `compute.googleapis.com/Disk`. * * Generated from protobuf field string resource_type = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -27,12 +25,16 @@ class SimulatedResource extends \Google\Protobuf\Internal\Message /** * Optional. A representation of the Google Cloud resource. Should match the * Google Cloud resource JSON format. + * If the custom module evaluates only the IAM allow policy, then you can + * omit this field. * * Generated from protobuf field .google.protobuf.Struct resource_data = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $resource_data = null; /** - * Optional. A representation of the IAM policy. + * Optional. A representation of the IAM allow policy. + * If the custom module evaluates only the resource data, then you can omit + * this field. * * Generated from protobuf field .google.iam.v1.Policy iam_policy_data = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -45,13 +47,17 @@ class SimulatedResource extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $resource_type - * Required. The type of the resource, for example, + * Required. The type of the resource. For example, * `compute.googleapis.com/Disk`. * @type \Google\Protobuf\Struct $resource_data * Optional. A representation of the Google Cloud resource. Should match the * Google Cloud resource JSON format. + * If the custom module evaluates only the IAM allow policy, then you can + * omit this field. * @type \Google\Cloud\Iam\V1\Policy $iam_policy_data - * Optional. A representation of the IAM policy. + * Optional. A representation of the IAM allow policy. + * If the custom module evaluates only the resource data, then you can omit + * this field. * } */ public function __construct($data = NULL) { @@ -60,7 +66,7 @@ public function __construct($data = NULL) { } /** - * Required. The type of the resource, for example, + * Required. The type of the resource. For example, * `compute.googleapis.com/Disk`. * * Generated from protobuf field string resource_type = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -72,7 +78,7 @@ public function getResourceType() } /** - * Required. The type of the resource, for example, + * Required. The type of the resource. For example, * `compute.googleapis.com/Disk`. * * Generated from protobuf field string resource_type = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -90,6 +96,8 @@ public function setResourceType($var) /** * Optional. A representation of the Google Cloud resource. Should match the * Google Cloud resource JSON format. + * If the custom module evaluates only the IAM allow policy, then you can + * omit this field. * * Generated from protobuf field .google.protobuf.Struct resource_data = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Struct|null @@ -112,6 +120,8 @@ public function clearResourceData() /** * Optional. A representation of the Google Cloud resource. Should match the * Google Cloud resource JSON format. + * If the custom module evaluates only the IAM allow policy, then you can + * omit this field. * * Generated from protobuf field .google.protobuf.Struct resource_data = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Struct $var @@ -126,7 +136,9 @@ public function setResourceData($var) } /** - * Optional. A representation of the IAM policy. + * Optional. A representation of the IAM allow policy. + * If the custom module evaluates only the resource data, then you can omit + * this field. * * Generated from protobuf field .google.iam.v1.Policy iam_policy_data = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Iam\V1\Policy|null @@ -147,7 +159,9 @@ public function clearIamPolicyData() } /** - * Optional. A representation of the IAM policy. + * Optional. A representation of the IAM allow policy. + * If the custom module evaluates only the resource data, then you can omit + * this field. * * Generated from protobuf field .google.iam.v1.Policy iam_policy_data = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Iam\V1\Policy $var diff --git a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse.php b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse.php index 4e49642f855f..a9196e92dba8 100644 --- a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse.php +++ b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response message for simulating a `SecurityHealthAnalyticsCustomModule` - * against a given resource. + * Response message for + * [SecurityCenterManagement.SimulateSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.SimulateSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleResponse */ diff --git a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse/SimulatedResult.php b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse/SimulatedResult.php index 9b2130dc3d95..9c43df356593 100644 --- a/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse/SimulatedResult.php +++ b/SecurityCenterManagement/src/V1/SimulateSecurityHealthAnalyticsCustomModuleResponse/SimulatedResult.php @@ -24,8 +24,8 @@ class SimulatedResult extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\SecurityCenterManagement\V1\SimulatedFinding $finding - * Finding that would be published for the test case, - * if a violation is detected. + * Finding that would be published for the test case if a violation is + * detected. * @type \Google\Protobuf\GPBEmpty $no_violation * Indicates that the test case does not trigger any violation. * @type \Google\Rpc\Status $error @@ -38,8 +38,8 @@ public function __construct($data = NULL) { } /** - * Finding that would be published for the test case, - * if a violation is detected. + * Finding that would be published for the test case if a violation is + * detected. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SimulatedFinding finding = 1; * @return \Google\Cloud\SecurityCenterManagement\V1\SimulatedFinding|null @@ -55,8 +55,8 @@ public function hasFinding() } /** - * Finding that would be published for the test case, - * if a violation is detected. + * Finding that would be published for the test case if a violation is + * detected. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SimulatedFinding finding = 1; * @param \Google\Cloud\SecurityCenterManagement\V1\SimulatedFinding $var diff --git a/SecurityCenterManagement/src/V1/SimulatedFinding.php b/SecurityCenterManagement/src/V1/SimulatedFinding.php index 4ca02b40dcf3..50199d68d4fb 100644 --- a/SecurityCenterManagement/src/V1/SimulatedFinding.php +++ b/SecurityCenterManagement/src/V1/SimulatedFinding.php @@ -9,49 +9,46 @@ use Google\Protobuf\Internal\GPBUtil; /** - * A subset of the fields of the Security Center Finding proto. The minimum set - * of fields needed to represent a simulated finding from a SHA custom module. + * The minimum set of fields needed to represent a simulated finding from a + * Security Health Analytics custom module. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.SimulatedFinding */ class SimulatedFinding extends \Google\Protobuf\Internal\Message { /** - * Identifier. The [relative resource - * name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * of the finding. Example: - * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, - * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, - * `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. + * Identifier. The [relative resource name](https://google.aip.dev/122) of the + * finding, in one of the following formats: + * * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + * * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + * * `projects/{project_id}/sources/{source_id}/findings/{finding_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. - * For example: - * `organizations/{organization_id}/sources/{source_id}` + * The [relative resource name](https://google.aip.dev/122) of the source the + * finding belongs to. For example, + * `organizations/{organization_id}/sources/{source_id}`. This field is + * immutable after creation time. * * Generated from protobuf field string parent = 2; */ protected $parent = ''; /** - * For findings on Google Cloud resources, the full resource - * name of the Google Cloud resource this finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * When the finding is for a non-Google Cloud resource, the resourceName can - * be a customer or partner defined string. This field is immutable after - * creation time. + * For findings on Google Cloud resources, the + * [full resource name](https://google.aip.dev/122#full-resource-names) of the + * Google Cloud resource this finding is for. When the finding is for a + * non-Google Cloud resource, the value can be a customer or partner defined + * string. This field is immutable after creation time. * * Generated from protobuf field string resource_name = 3; */ protected $resource_name = ''; /** - * The additional taxonomy group within findings from a given source. - * This field is immutable after creation time. - * Example: "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. For + * example, `XSS_FLASH_INJECTION`. This field is immutable after creation + * time. * * Generated from protobuf field string category = 4; */ @@ -63,22 +60,23 @@ class SimulatedFinding extends \Google\Protobuf\Internal\Message */ protected $state = 0; /** - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must be - * between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source-specific properties. These properties are managed by the source + * that writes the finding. The key names must be between 1 and 255 + * characters; they must start with a letter and contain alphanumeric + * characters or underscores only. * * Generated from protobuf field map source_properties = 6; */ private $source_properties; /** * The time the finding was first detected. If an existing finding is updated, - * then this is the time the update occurred. + * then this is the time the update occurred. If the finding is later + * resolved, then this time reflects when the finding was resolved. * For example, if the finding represents an open firewall, this property * captures the time the detector believes the firewall became open. The - * accuracy is determined by the detector. If the finding is later resolved, - * then this time reflects when the finding was resolved. This must not - * be set to a value greater than the current timestamp. + * accuracy is determined by the detector. + * The event time must not be set to a value greater than the current + * timestamp. * * Generated from protobuf field .google.protobuf.Timestamp event_time = 7; */ @@ -104,44 +102,42 @@ class SimulatedFinding extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The [relative resource - * name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * of the finding. Example: - * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, - * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, - * `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. + * Identifier. The [relative resource name](https://google.aip.dev/122) of the + * finding, in one of the following formats: + * * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + * * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + * * `projects/{project_id}/sources/{source_id}/findings/{finding_id}` * @type string $parent - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. - * For example: - * `organizations/{organization_id}/sources/{source_id}` + * The [relative resource name](https://google.aip.dev/122) of the source the + * finding belongs to. For example, + * `organizations/{organization_id}/sources/{source_id}`. This field is + * immutable after creation time. * @type string $resource_name - * For findings on Google Cloud resources, the full resource - * name of the Google Cloud resource this finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * When the finding is for a non-Google Cloud resource, the resourceName can - * be a customer or partner defined string. This field is immutable after - * creation time. + * For findings on Google Cloud resources, the + * [full resource name](https://google.aip.dev/122#full-resource-names) of the + * Google Cloud resource this finding is for. When the finding is for a + * non-Google Cloud resource, the value can be a customer or partner defined + * string. This field is immutable after creation time. * @type string $category - * The additional taxonomy group within findings from a given source. - * This field is immutable after creation time. - * Example: "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. For + * example, `XSS_FLASH_INJECTION`. This field is immutable after creation + * time. * @type int $state * Output only. The state of the finding. * @type array|\Google\Protobuf\Internal\MapField $source_properties - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must be - * between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source-specific properties. These properties are managed by the source + * that writes the finding. The key names must be between 1 and 255 + * characters; they must start with a letter and contain alphanumeric + * characters or underscores only. * @type \Google\Protobuf\Timestamp $event_time * The time the finding was first detected. If an existing finding is updated, - * then this is the time the update occurred. + * then this is the time the update occurred. If the finding is later + * resolved, then this time reflects when the finding was resolved. * For example, if the finding represents an open firewall, this property * captures the time the detector believes the firewall became open. The - * accuracy is determined by the detector. If the finding is later resolved, - * then this time reflects when the finding was resolved. This must not - * be set to a value greater than the current timestamp. + * accuracy is determined by the detector. + * The event time must not be set to a value greater than the current + * timestamp. * @type int $severity * The severity of the finding. This field is managed by the source that * writes the finding. @@ -155,12 +151,11 @@ public function __construct($data = NULL) { } /** - * Identifier. The [relative resource - * name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * of the finding. Example: - * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, - * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, - * `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. + * Identifier. The [relative resource name](https://google.aip.dev/122) of the + * finding, in one of the following formats: + * * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + * * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + * * `projects/{project_id}/sources/{source_id}/findings/{finding_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -171,12 +166,11 @@ public function getName() } /** - * Identifier. The [relative resource - * name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) - * of the finding. Example: - * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, - * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, - * `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. + * Identifier. The [relative resource name](https://google.aip.dev/122) of the + * finding, in one of the following formats: + * * `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + * * `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + * * `projects/{project_id}/sources/{source_id}/findings/{finding_id}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -191,11 +185,10 @@ public function setName($var) } /** - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. - * For example: - * `organizations/{organization_id}/sources/{source_id}` + * The [relative resource name](https://google.aip.dev/122) of the source the + * finding belongs to. For example, + * `organizations/{organization_id}/sources/{source_id}`. This field is + * immutable after creation time. * * Generated from protobuf field string parent = 2; * @return string @@ -206,11 +199,10 @@ public function getParent() } /** - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. - * For example: - * `organizations/{organization_id}/sources/{source_id}` + * The [relative resource name](https://google.aip.dev/122) of the source the + * finding belongs to. For example, + * `organizations/{organization_id}/sources/{source_id}`. This field is + * immutable after creation time. * * Generated from protobuf field string parent = 2; * @param string $var @@ -225,12 +217,11 @@ public function setParent($var) } /** - * For findings on Google Cloud resources, the full resource - * name of the Google Cloud resource this finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * When the finding is for a non-Google Cloud resource, the resourceName can - * be a customer or partner defined string. This field is immutable after - * creation time. + * For findings on Google Cloud resources, the + * [full resource name](https://google.aip.dev/122#full-resource-names) of the + * Google Cloud resource this finding is for. When the finding is for a + * non-Google Cloud resource, the value can be a customer or partner defined + * string. This field is immutable after creation time. * * Generated from protobuf field string resource_name = 3; * @return string @@ -241,12 +232,11 @@ public function getResourceName() } /** - * For findings on Google Cloud resources, the full resource - * name of the Google Cloud resource this finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * When the finding is for a non-Google Cloud resource, the resourceName can - * be a customer or partner defined string. This field is immutable after - * creation time. + * For findings on Google Cloud resources, the + * [full resource name](https://google.aip.dev/122#full-resource-names) of the + * Google Cloud resource this finding is for. When the finding is for a + * non-Google Cloud resource, the value can be a customer or partner defined + * string. This field is immutable after creation time. * * Generated from protobuf field string resource_name = 3; * @param string $var @@ -261,9 +251,9 @@ public function setResourceName($var) } /** - * The additional taxonomy group within findings from a given source. - * This field is immutable after creation time. - * Example: "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. For + * example, `XSS_FLASH_INJECTION`. This field is immutable after creation + * time. * * Generated from protobuf field string category = 4; * @return string @@ -274,9 +264,9 @@ public function getCategory() } /** - * The additional taxonomy group within findings from a given source. - * This field is immutable after creation time. - * Example: "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. For + * example, `XSS_FLASH_INJECTION`. This field is immutable after creation + * time. * * Generated from protobuf field string category = 4; * @param string $var @@ -317,10 +307,10 @@ public function setState($var) } /** - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must be - * between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source-specific properties. These properties are managed by the source + * that writes the finding. The key names must be between 1 and 255 + * characters; they must start with a letter and contain alphanumeric + * characters or underscores only. * * Generated from protobuf field map source_properties = 6; * @return \Google\Protobuf\Internal\MapField @@ -331,10 +321,10 @@ public function getSourceProperties() } /** - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must be - * between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source-specific properties. These properties are managed by the source + * that writes the finding. The key names must be between 1 and 255 + * characters; they must start with a letter and contain alphanumeric + * characters or underscores only. * * Generated from protobuf field map source_properties = 6; * @param array|\Google\Protobuf\Internal\MapField $var @@ -350,12 +340,13 @@ public function setSourceProperties($var) /** * The time the finding was first detected. If an existing finding is updated, - * then this is the time the update occurred. + * then this is the time the update occurred. If the finding is later + * resolved, then this time reflects when the finding was resolved. * For example, if the finding represents an open firewall, this property * captures the time the detector believes the firewall became open. The - * accuracy is determined by the detector. If the finding is later resolved, - * then this time reflects when the finding was resolved. This must not - * be set to a value greater than the current timestamp. + * accuracy is determined by the detector. + * The event time must not be set to a value greater than the current + * timestamp. * * Generated from protobuf field .google.protobuf.Timestamp event_time = 7; * @return \Google\Protobuf\Timestamp|null @@ -377,12 +368,13 @@ public function clearEventTime() /** * The time the finding was first detected. If an existing finding is updated, - * then this is the time the update occurred. + * then this is the time the update occurred. If the finding is later + * resolved, then this time reflects when the finding was resolved. * For example, if the finding represents an open firewall, this property * captures the time the detector believes the firewall became open. The - * accuracy is determined by the detector. If the finding is later resolved, - * then this time reflects when the finding was resolved. This must not - * be set to a value greater than the current timestamp. + * accuracy is determined by the detector. + * The event time must not be set to a value greater than the current + * timestamp. * * Generated from protobuf field .google.protobuf.Timestamp event_time = 7; * @param \Google\Protobuf\Timestamp $var diff --git a/SecurityCenterManagement/src/V1/SimulatedFinding/FindingClass.php b/SecurityCenterManagement/src/V1/SimulatedFinding/FindingClass.php index bbbf233602ea..e3e3f84b1b7a 100644 --- a/SecurityCenterManagement/src/V1/SimulatedFinding/FindingClass.php +++ b/SecurityCenterManagement/src/V1/SimulatedFinding/FindingClass.php @@ -7,14 +7,14 @@ use UnexpectedValueException; /** - * Represents what kind of Finding it is. + * Represents what kind of finding it is. * * Protobuf type google.cloud.securitycentermanagement.v1.SimulatedFinding.FindingClass */ class FindingClass { /** - * Unspecified finding class. + * Default value. This value is unused. * * Generated from protobuf enum FINDING_CLASS_UNSPECIFIED = 0; */ @@ -27,14 +27,14 @@ class FindingClass const THREAT = 1; /** * Describes a potential weakness in software that increases risk to - * Confidentiality & Integrity & Availability. + * confidentiality, integrity, and availability. * * Generated from protobuf enum VULNERABILITY = 2; */ const VULNERABILITY = 2; /** - * Describes a potential weakness in cloud resource/asset configuration that - * increases risk. + * Describes a potential weakness in cloud resource or asset configuration + * that increases risk. * * Generated from protobuf enum MISCONFIGURATION = 3; */ @@ -46,7 +46,8 @@ class FindingClass */ const OBSERVATION = 4; /** - * Describes an error that prevents some SCC functionality. + * Describes an error that prevents Security Command Center from working + * correctly. * * Generated from protobuf enum SCC_ERROR = 5; */ diff --git a/SecurityCenterManagement/src/V1/SimulatedFinding/Severity.php b/SecurityCenterManagement/src/V1/SimulatedFinding/Severity.php index d2317ee7fcfb..31db2d89923b 100644 --- a/SecurityCenterManagement/src/V1/SimulatedFinding/Severity.php +++ b/SecurityCenterManagement/src/V1/SimulatedFinding/Severity.php @@ -14,69 +14,63 @@ class Severity { /** - * This value is used for findings when a source doesn't write a severity - * value. + * Default value. This value is unused. * * Generated from protobuf enum SEVERITY_UNSPECIFIED = 0; */ const SEVERITY_UNSPECIFIED = 0; /** - * Vulnerability: - * A critical vulnerability is easily discoverable by an external actor, - * exploitable, and results in the direct ability to execute arbitrary code, - * exfiltrate data, and otherwise gain additional access and privileges to - * cloud resources and workloads. Examples include publicly accessible - * unprotected user data and public SSH access with weak or no - * passwords. - * Threat: - * Indicates a threat that is able to access, modify, or delete data or - * execute unauthorized code within existing resources. + * For vulnerabilities: A critical vulnerability is easily discoverable by + * an external actor, exploitable, and results in the direct ability to + * execute arbitrary code, exfiltrate data, and otherwise gain additional + * access and privileges to cloud resources and workloads. Examples include + * publicly accessible unprotected user data and public SSH access with weak + * or no passwords. + * For threats: Indicates a threat that is able to access, modify, or delete + * data or execute unauthorized code within existing resources. * * Generated from protobuf enum CRITICAL = 1; */ const CRITICAL = 1; /** - * Vulnerability: - * A high risk vulnerability can be easily discovered and exploited in - * combination with other vulnerabilities in order to gain direct access and - * the ability to execute arbitrary code, exfiltrate data, and otherwise - * gain additional access and privileges to cloud resources and workloads. - * An example is a database with weak or no passwords that is only - * accessible internally. This database could easily be compromised by an - * actor that had access to the internal network. - * Threat: - * Indicates a threat that is able to create new computational resources in - * an environment but not able to access data or execute code in existing - * resources. + * For vulnerabilities: A high-risk vulnerability can be easily discovered + * and exploited in combination with other vulnerabilities in order to gain + * direct access and the ability to execute arbitrary code, exfiltrate data, + * and otherwise gain additional access and privileges to cloud resources + * and workloads. An example is a database with weak or no passwords that is + * only accessible internally. This database could easily be compromised by + * an actor that had access to the internal network. + * For threats: Indicates a threat that is able to create new computational + * resources in an environment but not able to access data or execute code + * in existing resources. * * Generated from protobuf enum HIGH = 2; */ const HIGH = 2; /** - * Vulnerability: - * A medium risk vulnerability could be used by an actor to gain access to - * resources or privileges that enable them to eventually (through multiple - * steps or a complex exploit) gain access and the ability to execute - * arbitrary code or exfiltrate data. An example is a service account with - * access to more projects than it should have. If an actor gains access to - * the service account, they could potentially use that access to manipulate - * a project the service account was not intended to. - * Threat: - * Indicates a threat that is able to cause operational impact but may not - * access data or execute unauthorized code. + * For vulnerabilities: A medium-risk vulnerability could be used by an + * actor to gain access to resources or privileges that enable them to + * eventually (through multiple steps or a complex exploit) gain access and + * the ability to execute arbitrary code or exfiltrate data. An example is a + * service account with access to more projects than it should have. If an + * actor gains access to the service account, they could potentially use + * that access to manipulate a project the service account was not intended + * to. + * For threats: Indicates a threat that is able to cause operational impact + * but may not access data or execute unauthorized code. * * Generated from protobuf enum MEDIUM = 3; */ const MEDIUM = 3; /** - * Vulnerability: - * A low risk vulnerability hampers a security organization's ability to - * detect vulnerabilities or active threats in their deployment, or prevents - * the root cause investigation of security issues. An example is monitoring - * and logs being disabled for resource configurations and access. - * Threat: - * Indicates a threat that has obtained minimal access to an environment but - * is not able to access data, execute code, or create resources. + * For vulnerabilities: A low-risk vulnerability hampers a security + * organization's ability to detect vulnerabilities or active threats in + * their deployment, or prevents the root cause investigation of security + * issues. An example is monitoring and logs being disabled for resource + * configurations and access. + * For threats: Indicates a threat that has obtained minimal access to an + * environment but is not able to access data, execute code, or create + * resources. * * Generated from protobuf enum LOW = 4; */ diff --git a/SecurityCenterManagement/src/V1/SimulatedFinding/State.php b/SecurityCenterManagement/src/V1/SimulatedFinding/State.php index 8928295de963..04a918430491 100644 --- a/SecurityCenterManagement/src/V1/SimulatedFinding/State.php +++ b/SecurityCenterManagement/src/V1/SimulatedFinding/State.php @@ -14,7 +14,7 @@ class State { /** - * Unspecified state. + * Default value. This value is unused. * * Generated from protobuf enum STATE_UNSPECIFIED = 0; */ @@ -26,8 +26,8 @@ class State */ const ACTIVE = 1; /** - * The finding has been fixed, triaged as a non-issue or otherwise addressed - * and is no longer active. + * The finding has been fixed, triaged as a non-issue, or otherwise + * addressed and is no longer active. * * Generated from protobuf enum INACTIVE = 2; */ diff --git a/SecurityCenterManagement/src/V1/UpdateEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/UpdateEventThreatDetectionCustomModuleRequest.php index 85584147f21c..58d66e3094cd 100644 --- a/SecurityCenterManagement/src/V1/UpdateEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/UpdateEventThreatDetectionCustomModuleRequest.php @@ -16,41 +16,36 @@ class UpdateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * Required. The fields to update. If omitted, then all fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $update_mask = null; /** - * Required. The module being updated + * Required. The module being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $event_threat_detection_custom_module = null; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $eventThreatDetectionCustomModule Required. The module being updated - * @param \Google\Protobuf\FieldMask $updateMask Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $eventThreatDetectionCustomModule Required. The module being updated. + * @param \Google\Protobuf\FieldMask $updateMask Required. The fields to update. If omitted, then all fields are updated. * * @return \Google\Cloud\SecurityCenterManagement\V1\UpdateEventThreatDetectionCustomModuleRequest * @@ -70,21 +65,20 @@ public static function build(\Google\Cloud\SecurityCenterManagement\V1\EventThre * Optional. Data for populating the Message object. * * @type \Google\Protobuf\FieldMask $update_mask - * Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * Required. The fields to update. If omitted, then all fields are updated. * @type \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $event_threat_detection_custom_module - * Required. The module being updated + * Required. The module being updated. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -93,11 +87,7 @@ public function __construct($data = NULL) { } /** - * Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * Required. The fields to update. If omitted, then all fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\FieldMask|null @@ -118,11 +108,7 @@ public function clearUpdateMask() } /** - * Required. Field mask is used to specify the fields to be overwritten in the - * EventThreatDetectionCustomModule resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten. + * Required. The fields to update. If omitted, then all fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\FieldMask $var @@ -137,7 +123,7 @@ public function setUpdateMask($var) } /** - * Required. The module being updated + * Required. The module being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule|null @@ -158,7 +144,7 @@ public function clearEventThreatDetectionCustomModule() } /** - * Required. The module being updated + * Required. The module being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule event_threat_detection_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\SecurityCenterManagement\V1\EventThreatDetectionCustomModule $var @@ -173,13 +159,16 @@ public function setEventThreatDetectionCustomModule($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -190,13 +179,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/UpdateSecurityCenterServiceRequest.php b/SecurityCenterManagement/src/V1/UpdateSecurityCenterServiceRequest.php index 9f8693b99a17..5ba8a72d9a40 100644 --- a/SecurityCenterManagement/src/V1/UpdateSecurityCenterServiceRequest.php +++ b/SecurityCenterManagement/src/V1/UpdateSecurityCenterServiceRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for updating a Security Command Center service. + * Request message for + * [SecurityCenterManagement.UpdateSecurityCenterService][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.UpdateSecurityCenterService]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.UpdateSecurityCenterServiceRequest */ @@ -22,21 +23,25 @@ class UpdateSecurityCenterServiceRequest extends \Google\Protobuf\Internal\Messa */ protected $security_center_service = null; /** - * Required. The list of fields to be updated. Possible values: - * * "intended_enablement_state" - * * "modules" + * Required. The fields to update. Accepts the following values: + * * `intended_enablement_state` + * * `modules` + * If omitted, then all eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $update_mask = null; /** - * Optional. When set to true, only validations (including IAM checks) will be - * done for the request (service will not be updated). An OK response - * indicates that the request is valid, while an error response indicates that - * the request is invalid. Note that a subsequent request to actually update - * the service could still fail for one of the following reasons: - * - The state could have changed (e.g. IAM permission lost). - * - A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no service will be updated. An `OK` response indicates that + * the request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the service could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during update of the service + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -44,10 +49,12 @@ class UpdateSecurityCenterServiceRequest extends \Google\Protobuf\Internal\Messa /** * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityCenterService $securityCenterService Required. The updated service. - * @param \Google\Protobuf\FieldMask $updateMask Required. The list of fields to be updated. Possible values: + * @param \Google\Protobuf\FieldMask $updateMask Required. The fields to update. Accepts the following values: * - * * "intended_enablement_state" - * * "modules" + * * `intended_enablement_state` + * * `modules` + * + * If omitted, then all eligible fields are updated. * * @return \Google\Cloud\SecurityCenterManagement\V1\UpdateSecurityCenterServiceRequest * @@ -69,17 +76,21 @@ public static function build(\Google\Cloud\SecurityCenterManagement\V1\SecurityC * @type \Google\Cloud\SecurityCenterManagement\V1\SecurityCenterService $security_center_service * Required. The updated service. * @type \Google\Protobuf\FieldMask $update_mask - * Required. The list of fields to be updated. Possible values: - * * "intended_enablement_state" - * * "modules" + * Required. The fields to update. Accepts the following values: + * * `intended_enablement_state` + * * `modules` + * If omitted, then all eligible fields are updated. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will be - * done for the request (service will not be updated). An OK response - * indicates that the request is valid, while an error response indicates that - * the request is invalid. Note that a subsequent request to actually update - * the service could still fail for one of the following reasons: - * - The state could have changed (e.g. IAM permission lost). - * - A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no service will be updated. An `OK` response indicates that + * the request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the service could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during update of the service + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -124,9 +135,10 @@ public function setSecurityCenterService($var) } /** - * Required. The list of fields to be updated. Possible values: - * * "intended_enablement_state" - * * "modules" + * Required. The fields to update. Accepts the following values: + * * `intended_enablement_state` + * * `modules` + * If omitted, then all eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\FieldMask|null @@ -147,9 +159,10 @@ public function clearUpdateMask() } /** - * Required. The list of fields to be updated. Possible values: - * * "intended_enablement_state" - * * "modules" + * Required. The fields to update. Accepts the following values: + * * `intended_enablement_state` + * * `modules` + * If omitted, then all eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\FieldMask $var @@ -164,13 +177,16 @@ public function setUpdateMask($var) } /** - * Optional. When set to true, only validations (including IAM checks) will be - * done for the request (service will not be updated). An OK response - * indicates that the request is valid, while an error response indicates that - * the request is invalid. Note that a subsequent request to actually update - * the service could still fail for one of the following reasons: - * - The state could have changed (e.g. IAM permission lost). - * - A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no service will be updated. An `OK` response indicates that + * the request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the service could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during update of the service + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -181,13 +197,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will be - * done for the request (service will not be updated). An OK response - * indicates that the request is valid, while an error response indicates that - * the request is invalid. Note that a subsequent request to actually update - * the service could still fail for one of the following reasons: - * - The state could have changed (e.g. IAM permission lost). - * - A failure occurred while trying to delete the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no service will be updated. An `OK` response indicates that + * the request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the service could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during update of the service + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/UpdateSecurityHealthAnalyticsCustomModuleRequest.php b/SecurityCenterManagement/src/V1/UpdateSecurityHealthAnalyticsCustomModuleRequest.php index 9fb49e8da926..f78f9396668e 100644 --- a/SecurityCenterManagement/src/V1/UpdateSecurityHealthAnalyticsCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/UpdateSecurityHealthAnalyticsCustomModuleRequest.php @@ -9,46 +9,54 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Message for updating a SecurityHealthAnalyticsCustomModule + * Request message for + * [SecurityCenterManagement.UpdateSecurityHealthAnalyticsCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.UpdateSecurityHealthAnalyticsCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.UpdateSecurityHealthAnalyticsCustomModuleRequest */ class UpdateSecurityHealthAnalyticsCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * Required. The fields to update. The following values are valid: + * * `custom_config` + * * `enablement_state` + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $update_mask = null; /** - * Required. The resource being updated + * Required. The resource being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $security_health_analytics_custom_module = null; /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $securityHealthAnalyticsCustomModule Required. The resource being updated - * @param \Google\Protobuf\FieldMask $updateMask Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $securityHealthAnalyticsCustomModule Required. The resource being updated. + * @param \Google\Protobuf\FieldMask $updateMask Required. The fields to update. The following values are valid: + * + * * `custom_config` + * * `enablement_state` + * + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * * @return \Google\Cloud\SecurityCenterManagement\V1\UpdateSecurityHealthAnalyticsCustomModuleRequest * @@ -68,20 +76,24 @@ public static function build(\Google\Cloud\SecurityCenterManagement\V1\SecurityH * Optional. Data for populating the Message object. * * @type \Google\Protobuf\FieldMask $update_mask - * Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * Required. The fields to update. The following values are valid: + * * `custom_config` + * * `enablement_state` + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * @type \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $security_health_analytics_custom_module - * Required. The resource being updated + * Required. The resource being updated. * @type bool $validate_only - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * } */ public function __construct($data = NULL) { @@ -90,10 +102,11 @@ public function __construct($data = NULL) { } /** - * Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * Required. The fields to update. The following values are valid: + * * `custom_config` + * * `enablement_state` + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\FieldMask|null @@ -114,10 +127,11 @@ public function clearUpdateMask() } /** - * Required. The list of fields to be updated. The only fields that can be - * updated are `enablement_state` and `custom_config`. If empty or set to the - * wildcard value `*`, both `enablement_state` and `custom_config` are - * updated. + * Required. The fields to update. The following values are valid: + * * `custom_config` + * * `enablement_state` + * If you omit this field or set it to the wildcard value `*`, then all + * eligible fields are updated. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\FieldMask $var @@ -132,7 +146,7 @@ public function setUpdateMask($var) } /** - * Required. The resource being updated + * Required. The resource being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule|null @@ -153,7 +167,7 @@ public function clearSecurityHealthAnalyticsCustomModule() } /** - * Required. The resource being updated + * Required. The resource being updated. * * Generated from protobuf field .google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule security_health_analytics_custom_module = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule $var @@ -168,13 +182,16 @@ public function setSecurityHealthAnalyticsCustomModule($var) } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -185,13 +202,16 @@ public function getValidateOnly() } /** - * Optional. When set to true, only validations (including IAM checks) will - * done for the request (module will not be updated). An OK response indicates - * the request is valid while an error response indicates the request is - * invalid. Note that a subsequent request to actually update the module could - * still fail because 1. the state could have changed (e.g. IAM permission - * lost) or - * 2. A failure occurred while trying to update the module. + * Optional. When set to `true`, the request will be validated (including IAM + * checks), but no module will be updated. An `OK` response indicates that the + * request is valid, while an error response indicates that the request is + * invalid. + * If the request is valid, a subsequent request to update the module could + * still fail for one of the following reasons: + * * The state of your cloud resources changed; for example, you lost a + * required IAM permission + * * An error occurred during creation of the module + * Defaults to `false`. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleRequest.php b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleRequest.php index 40ac0673ade5..eec986d1de88 100644 --- a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleRequest.php +++ b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleRequest.php @@ -9,16 +9,17 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request to validate an Event Threat Detection custom module. + * Request message for + * [SecurityCenterManagement.ValidateEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ValidateEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleRequest */ class ValidateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Resource name of the parent to validate the Custom Module under. - * Its format is: - * * `organizations/{organization}/locations/{location}`. + * Required. Resource name of the parent to validate the custom modules under, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -31,7 +32,7 @@ class ValidateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\I */ protected $raw_text = ''; /** - * Required. The type of the module (e.g. CONFIGURABLE_BAD_IP). + * Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 3 [(.google.api.field_behavior) = REQUIRED]; */ @@ -44,14 +45,14 @@ class ValidateEventThreatDetectionCustomModuleRequest extends \Google\Protobuf\I * Optional. Data for populating the Message object. * * @type string $parent - * Required. Resource name of the parent to validate the Custom Module under. - * Its format is: - * * `organizations/{organization}/locations/{location}`. + * Required. Resource name of the parent to validate the custom modules under, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` * @type string $raw_text * Required. The raw text of the module's contents. Used to generate error * messages. * @type string $type - * Required. The type of the module (e.g. CONFIGURABLE_BAD_IP). + * Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`. * } */ public function __construct($data = NULL) { @@ -60,9 +61,9 @@ public function __construct($data = NULL) { } /** - * Required. Resource name of the parent to validate the Custom Module under. - * Its format is: - * * `organizations/{organization}/locations/{location}`. + * Required. Resource name of the parent to validate the custom modules under, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,9 +74,9 @@ public function getParent() } /** - * Required. Resource name of the parent to validate the Custom Module under. - * Its format is: - * * `organizations/{organization}/locations/{location}`. + * Required. Resource name of the parent to validate the custom modules under, + * in one of the following formats: + * * `organizations/{organization}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -118,7 +119,7 @@ public function setRawText($var) } /** - * Required. The type of the module (e.g. CONFIGURABLE_BAD_IP). + * Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 3 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -129,7 +130,7 @@ public function getType() } /** - * Required. The type of the module (e.g. CONFIGURABLE_BAD_IP). + * Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`. * * Generated from protobuf field string type = 3 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse.php b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse.php index d5707cbe2e7c..5cb87b5f3fe9 100644 --- a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse.php +++ b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Response to validating an Event Threat Detection custom module. + * Response message for + * [SecurityCenterManagement.ValidateEventThreatDetectionCustomModule][google.cloud.securitycentermanagement.v1.SecurityCenterManagement.ValidateEventThreatDetectionCustomModule]. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse */ diff --git a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/CustomModuleValidationError.php b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/CustomModuleValidationError.php index 0a58f35ad461..6d7cb58e67e2 100644 --- a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/CustomModuleValidationError.php +++ b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/CustomModuleValidationError.php @@ -10,37 +10,38 @@ /** * An error encountered while validating the uploaded configuration of an - * Event Threat Detection Custom Module. + * Event Threat Detection custom module. * * Generated from protobuf message google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.CustomModuleValidationError */ class CustomModuleValidationError extends \Google\Protobuf\Internal\Message { /** - * A description of the error, suitable for human consumption. Required. + * A human-readable description of the error. * * Generated from protobuf field string description = 1; */ protected $description = ''; /** - * The path, in RFC 8901 JSON Pointer format, to the field that failed - * validation. This may be left empty if no specific field is affected. + * The path, in [RFC 6901: JSON + * Pointer](https://datatracker.ietf.org/doc/html/rfc6901) format, to the + * field that failed validation. Omitted if no specific field is affected. * * Generated from protobuf field string field_path = 2; */ protected $field_path = ''; /** * The initial position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed. + * module. Omitted if no specific position applies, or if the position could + * not be computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position start = 3; */ protected $start = null; /** - * The end position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed.. + * The end position of the error in the uploaded text version of the module. + * Omitted if no specific position applies, or if the position could not be + * computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position end = 4; */ @@ -53,18 +54,19 @@ class CustomModuleValidationError extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $description - * A description of the error, suitable for human consumption. Required. + * A human-readable description of the error. * @type string $field_path - * The path, in RFC 8901 JSON Pointer format, to the field that failed - * validation. This may be left empty if no specific field is affected. + * The path, in [RFC 6901: JSON + * Pointer](https://datatracker.ietf.org/doc/html/rfc6901) format, to the + * field that failed validation. Omitted if no specific field is affected. * @type \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position $start * The initial position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed. + * module. Omitted if no specific position applies, or if the position could + * not be computed. * @type \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position $end - * The end position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed.. + * The end position of the error in the uploaded text version of the module. + * Omitted if no specific position applies, or if the position could not be + * computed. * } */ public function __construct($data = NULL) { @@ -73,7 +75,7 @@ public function __construct($data = NULL) { } /** - * A description of the error, suitable for human consumption. Required. + * A human-readable description of the error. * * Generated from protobuf field string description = 1; * @return string @@ -84,7 +86,7 @@ public function getDescription() } /** - * A description of the error, suitable for human consumption. Required. + * A human-readable description of the error. * * Generated from protobuf field string description = 1; * @param string $var @@ -99,8 +101,9 @@ public function setDescription($var) } /** - * The path, in RFC 8901 JSON Pointer format, to the field that failed - * validation. This may be left empty if no specific field is affected. + * The path, in [RFC 6901: JSON + * Pointer](https://datatracker.ietf.org/doc/html/rfc6901) format, to the + * field that failed validation. Omitted if no specific field is affected. * * Generated from protobuf field string field_path = 2; * @return string @@ -111,8 +114,9 @@ public function getFieldPath() } /** - * The path, in RFC 8901 JSON Pointer format, to the field that failed - * validation. This may be left empty if no specific field is affected. + * The path, in [RFC 6901: JSON + * Pointer](https://datatracker.ietf.org/doc/html/rfc6901) format, to the + * field that failed validation. Omitted if no specific field is affected. * * Generated from protobuf field string field_path = 2; * @param string $var @@ -128,8 +132,8 @@ public function setFieldPath($var) /** * The initial position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed. + * module. Omitted if no specific position applies, or if the position could + * not be computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position start = 3; * @return \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position|null @@ -151,8 +155,8 @@ public function clearStart() /** * The initial position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed. + * module. Omitted if no specific position applies, or if the position could + * not be computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position start = 3; * @param \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position $var @@ -167,9 +171,9 @@ public function setStart($var) } /** - * The end position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed.. + * The end position of the error in the uploaded text version of the module. + * Omitted if no specific position applies, or if the position could not be + * computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position end = 4; * @return \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position|null @@ -190,9 +194,9 @@ public function clearEnd() } /** - * The end position of the error in the uploaded text version of the - * module. This field may be omitted if no specific position applies, or if - * one could not be computed.. + * The end position of the error in the uploaded text version of the module. + * Omitted if no specific position applies, or if the position could not be + * computed. * * Generated from protobuf field optional .google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse.Position end = 4; * @param \Google\Cloud\SecurityCenterManagement\V1\ValidateEventThreatDetectionCustomModuleResponse\Position $var diff --git a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/Position.php b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/Position.php index c037f7c08192..6286241981b9 100644 --- a/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/Position.php +++ b/SecurityCenterManagement/src/V1/ValidateEventThreatDetectionCustomModuleResponse/Position.php @@ -16,13 +16,13 @@ class Position extends \Google\Protobuf\Internal\Message { /** - * The line position in the text + * The line position in the text. * * Generated from protobuf field int32 line_number = 1; */ protected $line_number = 0; /** - * The column position in the line + * The column position in the line. * * Generated from protobuf field int32 column_number = 2; */ @@ -35,9 +35,9 @@ class Position extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $line_number - * The line position in the text + * The line position in the text. * @type int $column_number - * The column position in the line + * The column position in the line. * } */ public function __construct($data = NULL) { @@ -46,7 +46,7 @@ public function __construct($data = NULL) { } /** - * The line position in the text + * The line position in the text. * * Generated from protobuf field int32 line_number = 1; * @return int @@ -57,7 +57,7 @@ public function getLineNumber() } /** - * The line position in the text + * The line position in the text. * * Generated from protobuf field int32 line_number = 1; * @param int $var @@ -72,7 +72,7 @@ public function setLineNumber($var) } /** - * The column position in the line + * The column position in the line. * * Generated from protobuf field int32 column_number = 2; * @return int @@ -83,7 +83,7 @@ public function getColumnNumber() } /** - * The column position in the line + * The column position in the line. * * Generated from protobuf field int32 column_number = 2; * @param int $var From 5271d4e6d2d70cd385246ca2edd888eade9d8a58 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:46:46 -0400 Subject: [PATCH 056/157] feat: add StopNotebookRuntime method (#7782) PiperOrigin-RevId: 691235183 Source-Link: https://github.com/googleapis/googleapis/commit/41605271bd86ee6991609ca4f225a6f1ed0fc390 Source-Link: https://github.com/googleapis/googleapis-gen/commit/c63dc6d09c9ccab6b68820fb66adee3c3200bc9e Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiYzYzZGM2ZDA5YzljY2FiNmI2ODgyMGZiNjZhZGVlM2MzMjAwYmM5ZSJ9 --- AiPlatform/metadata/V1/NotebookService.php | Bin 9848 -> 10353 bytes .../stop_notebook_runtime.php | 90 +++++++++++++ .../src/V1/Client/NotebookServiceClient.php | 28 ++++ .../StopNotebookRuntimeOperationMetadata.php | 78 +++++++++++ .../src/V1/StopNotebookRuntimeRequest.php | 97 ++++++++++++++ .../src/V1/StopNotebookRuntimeResponse.php | 34 +++++ AiPlatform/src/V1/gapic_metadata.json | 5 + .../notebook_service_client_config.json | 5 + .../notebook_service_descriptor_config.php | 19 +++ .../notebook_service_rest_client_config.php | 12 ++ .../V1/Client/NotebookServiceClientTest.php | 124 ++++++++++++++++++ 11 files changed, 492 insertions(+) create mode 100644 AiPlatform/samples/V1/NotebookServiceClient/stop_notebook_runtime.php create mode 100644 AiPlatform/src/V1/StopNotebookRuntimeOperationMetadata.php create mode 100644 AiPlatform/src/V1/StopNotebookRuntimeRequest.php create mode 100644 AiPlatform/src/V1/StopNotebookRuntimeResponse.php diff --git a/AiPlatform/metadata/V1/NotebookService.php b/AiPlatform/metadata/V1/NotebookService.php index 2eebcbd6383a66e745576ca2e06003a794565231..6254bfce48da195fa25f04ad78919d98d8dc61dc 100644 GIT binary patch delta 201 zcmez2^D$sUCJW0>cP_)pf~+bN^LaPVV^QQ`kL8jIF3B&Lyq-&ZvOk|Adl{DsnBO3; zFjr3LR!UCCka{setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $notebookServiceClient->stopNotebookRuntime($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var StopNotebookRuntimeResponse $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 +{ + $formattedName = NotebookServiceClient::notebookRuntimeName( + '[PROJECT]', + '[LOCATION]', + '[NOTEBOOK_RUNTIME]' + ); + + stop_notebook_runtime_sample($formattedName); +} +// [END aiplatform_v1_generated_NotebookService_StopNotebookRuntime_sync] diff --git a/AiPlatform/src/V1/Client/NotebookServiceClient.php b/AiPlatform/src/V1/Client/NotebookServiceClient.php index d22d9652abcd..9d8cb349ac75 100644 --- a/AiPlatform/src/V1/Client/NotebookServiceClient.php +++ b/AiPlatform/src/V1/Client/NotebookServiceClient.php @@ -50,6 +50,7 @@ use Google\Cloud\AIPlatform\V1\NotebookRuntime; use Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate; use Google\Cloud\AIPlatform\V1\StartNotebookRuntimeRequest; +use Google\Cloud\AIPlatform\V1\StopNotebookRuntimeRequest; use Google\Cloud\AIPlatform\V1\UpdateNotebookRuntimeTemplateRequest; use Google\Cloud\AIPlatform\V1\UpgradeNotebookRuntimeRequest; use Google\Cloud\Iam\V1\GetIamPolicyRequest; @@ -88,6 +89,7 @@ * @method PromiseInterface listNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest $request, array $optionalArgs = []) * @method PromiseInterface listNotebookRuntimesAsync(ListNotebookRuntimesRequest $request, array $optionalArgs = []) * @method PromiseInterface startNotebookRuntimeAsync(StartNotebookRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopNotebookRuntimeAsync(StopNotebookRuntimeRequest $request, array $optionalArgs = []) * @method PromiseInterface updateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) * @method PromiseInterface upgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest $request, array $optionalArgs = []) * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) @@ -824,6 +826,32 @@ public function startNotebookRuntime( return $this->startApiCall('StartNotebookRuntime', $request, $callOptions)->wait(); } + /** + * Stops a NotebookRuntime. + * + * The async variant is {@see NotebookServiceClient::stopNotebookRuntimeAsync()} . + * + * @example samples/V1/NotebookServiceClient/stop_notebook_runtime.php + * + * @param StopNotebookRuntimeRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function stopNotebookRuntime(StopNotebookRuntimeRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('StopNotebookRuntime', $request, $callOptions)->wait(); + } + /** * Updates a NotebookRuntimeTemplate. * diff --git a/AiPlatform/src/V1/StopNotebookRuntimeOperationMetadata.php b/AiPlatform/src/V1/StopNotebookRuntimeOperationMetadata.php new file mode 100644 index 000000000000..bcbb986af40d --- /dev/null +++ b/AiPlatform/src/V1/StopNotebookRuntimeOperationMetadata.php @@ -0,0 +1,78 @@ +google.cloud.aiplatform.v1.StopNotebookRuntimeOperationMetadata + */ +class StopNotebookRuntimeOperationMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * The operation generic information. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GenericOperationMetadata generic_metadata = 1; + */ + protected $generic_metadata = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\AIPlatform\V1\GenericOperationMetadata $generic_metadata + * The operation generic information. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + + /** + * The operation generic information. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GenericOperationMetadata generic_metadata = 1; + * @return \Google\Cloud\AIPlatform\V1\GenericOperationMetadata|null + */ + public function getGenericMetadata() + { + return $this->generic_metadata; + } + + public function hasGenericMetadata() + { + return isset($this->generic_metadata); + } + + public function clearGenericMetadata() + { + unset($this->generic_metadata); + } + + /** + * The operation generic information. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GenericOperationMetadata generic_metadata = 1; + * @param \Google\Cloud\AIPlatform\V1\GenericOperationMetadata $var + * @return $this + */ + public function setGenericMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\GenericOperationMetadata::class); + $this->generic_metadata = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/StopNotebookRuntimeRequest.php b/AiPlatform/src/V1/StopNotebookRuntimeRequest.php new file mode 100644 index 000000000000..895f01386d29 --- /dev/null +++ b/AiPlatform/src/V1/StopNotebookRuntimeRequest.php @@ -0,0 +1,97 @@ +google.cloud.aiplatform.v1.StopNotebookRuntimeRequest + */ +class StopNotebookRuntimeRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the NotebookRuntime resource to be stopped. + * Instead of checking whether the name is in valid NotebookRuntime resource + * name format, directly throw NotFound exception if there is no such + * NotebookRuntime in spanner. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the NotebookRuntime resource to be stopped. + * Instead of checking whether the name is in valid NotebookRuntime resource + * name format, directly throw NotFound exception if there is no such + * NotebookRuntime in spanner. Please see + * {@see NotebookServiceClient::notebookRuntimeName()} for help formatting this field. + * + * @return \Google\Cloud\AIPlatform\V1\StopNotebookRuntimeRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the NotebookRuntime resource to be stopped. + * Instead of checking whether the name is in valid NotebookRuntime resource + * name format, directly throw NotFound exception if there is no such + * NotebookRuntime in spanner. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the NotebookRuntime resource to be stopped. + * Instead of checking whether the name is in valid NotebookRuntime resource + * name format, directly throw NotFound exception if there is no such + * NotebookRuntime in spanner. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the NotebookRuntime resource to be stopped. + * Instead of checking whether the name is in valid NotebookRuntime resource + * name format, directly throw NotFound exception if there is no such + * NotebookRuntime in spanner. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/StopNotebookRuntimeResponse.php b/AiPlatform/src/V1/StopNotebookRuntimeResponse.php new file mode 100644 index 000000000000..de0bab292a21 --- /dev/null +++ b/AiPlatform/src/V1/StopNotebookRuntimeResponse.php @@ -0,0 +1,34 @@ +google.cloud.aiplatform.v1.StopNotebookRuntimeResponse + */ +class StopNotebookRuntimeResponse extends \Google\Protobuf\Internal\Message +{ + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + +} + diff --git a/AiPlatform/src/V1/gapic_metadata.json b/AiPlatform/src/V1/gapic_metadata.json index 7cb6d4941f23..57e0a62d4c97 100644 --- a/AiPlatform/src/V1/gapic_metadata.json +++ b/AiPlatform/src/V1/gapic_metadata.json @@ -1795,6 +1795,11 @@ "startNotebookRuntime" ] }, + "StopNotebookRuntime": { + "methods": [ + "stopNotebookRuntime" + ] + }, "UpdateNotebookRuntimeTemplate": { "methods": [ "updateNotebookRuntimeTemplate" diff --git a/AiPlatform/src/V1/resources/notebook_service_client_config.json b/AiPlatform/src/V1/resources/notebook_service_client_config.json index ce76a76e2cec..5dc7f4e850b5 100644 --- a/AiPlatform/src/V1/resources/notebook_service_client_config.json +++ b/AiPlatform/src/V1/resources/notebook_service_client_config.json @@ -81,6 +81,11 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "StopNotebookRuntime": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "UpdateNotebookRuntimeTemplate": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", diff --git a/AiPlatform/src/V1/resources/notebook_service_descriptor_config.php b/AiPlatform/src/V1/resources/notebook_service_descriptor_config.php index 27061cadb5ad..0f9f582dc40f 100644 --- a/AiPlatform/src/V1/resources/notebook_service_descriptor_config.php +++ b/AiPlatform/src/V1/resources/notebook_service_descriptor_config.php @@ -156,6 +156,25 @@ ], ], ], + 'StopNotebookRuntime' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\AIPlatform\V1\StopNotebookRuntimeResponse', + 'metadataReturnType' => '\Google\Cloud\AIPlatform\V1\StopNotebookRuntimeOperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'UpgradeNotebookRuntime' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\AIPlatform\V1\UpgradeNotebookRuntimeResponse', diff --git a/AiPlatform/src/V1/resources/notebook_service_rest_client_config.php b/AiPlatform/src/V1/resources/notebook_service_rest_client_config.php index efbe1704725d..d5c9e3dcf765 100644 --- a/AiPlatform/src/V1/resources/notebook_service_rest_client_config.php +++ b/AiPlatform/src/V1/resources/notebook_service_rest_client_config.php @@ -170,6 +170,18 @@ ], ], ], + 'StopNotebookRuntime' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/notebookRuntimes/*}:stop', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'UpdateNotebookRuntimeTemplate' => [ 'method' => 'patch', 'uriTemplate' => '/v1/{notebook_runtime_template.name=projects/*/locations/*/notebookRuntimeTemplates/*}', diff --git a/AiPlatform/tests/Unit/V1/Client/NotebookServiceClientTest.php b/AiPlatform/tests/Unit/V1/Client/NotebookServiceClientTest.php index 0c4137816805..9a0beb35fe74 100644 --- a/AiPlatform/tests/Unit/V1/Client/NotebookServiceClientTest.php +++ b/AiPlatform/tests/Unit/V1/Client/NotebookServiceClientTest.php @@ -47,6 +47,8 @@ use Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate; use Google\Cloud\AIPlatform\V1\StartNotebookRuntimeRequest; use Google\Cloud\AIPlatform\V1\StartNotebookRuntimeResponse; +use Google\Cloud\AIPlatform\V1\StopNotebookRuntimeRequest; +use Google\Cloud\AIPlatform\V1\StopNotebookRuntimeResponse; use Google\Cloud\AIPlatform\V1\UpdateNotebookRuntimeTemplateRequest; use Google\Cloud\AIPlatform\V1\UpgradeNotebookRuntimeRequest; use Google\Cloud\AIPlatform\V1\UpgradeNotebookRuntimeResponse; @@ -1514,6 +1516,128 @@ public function startNotebookRuntimeExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function stopNotebookRuntimeTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/stopNotebookRuntimeTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new StopNotebookRuntimeResponse(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/stopNotebookRuntimeTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->notebookRuntimeName('[PROJECT]', '[LOCATION]', '[NOTEBOOK_RUNTIME]'); + $request = (new StopNotebookRuntimeRequest())->setName($formattedName); + $response = $gapicClient->stopNotebookRuntime($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.aiplatform.v1.NotebookService/StopNotebookRuntime', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/stopNotebookRuntimeTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function stopNotebookRuntimeExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/stopNotebookRuntimeTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->notebookRuntimeName('[PROJECT]', '[LOCATION]', '[NOTEBOOK_RUNTIME]'); + $request = (new StopNotebookRuntimeRequest())->setName($formattedName); + $response = $gapicClient->stopNotebookRuntime($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/stopNotebookRuntimeTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function updateNotebookRuntimeTemplateTest() { From 0bd701e40b44bc7485d06c2dd6e4c7722f34e14e Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:47:30 -0400 Subject: [PATCH 057/157] feat: add lite search API to allow public website search with API key (#7765) * try comparing from origin * feat: add lite search API to allow public website search with API key feat: add LOW_GROUNDED_ANSWER in answer skip reasons feat: support query regex in control match rules docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 689588291 Source-Link: https://github.com/googleapis/googleapis/commit/537fd482f6bb8afb3a146d9b21673a8eb27958bd Source-Link: https://github.com/googleapis/googleapis-gen/commit/186fcc4e20a2c06bb514a2ff8d94eb7f7d6470c3 Copy-Tag: eyJwIjoiRGlzY292ZXJ5RW5naW5lLy5Pd2xCb3QueWFtbCIsImgiOiIxODZmY2M0ZTIwYTJjMDZiYjUxNGEyZmY4ZDk0ZWI3ZjdkNjQ3MGMzIn0= Co-authored-by: Brent Shaffer Co-authored-by: Owl Bot --- .../backwards-compatibility-checks.yaml | 2 +- DiscoveryEngine/metadata/V1/Answer.php | Bin 5646 -> 5671 bytes DiscoveryEngine/metadata/V1/Control.php | Bin 2887 -> 2913 bytes DiscoveryEngine/metadata/V1/SearchService.php | Bin 10162 -> 10580 bytes .../V1/SearchServiceClient/search_lite.php | 98 ++++++++++++++++++ .../src/V1/Answer/AnswerSkippedReason.php | 9 ++ .../DocumentMetadata/MatcherValue.php | 6 +- .../src/V1/Client/SearchServiceClient.php | 39 +++++++ DiscoveryEngine/src/V1/Condition.php | 58 +++++++++++ DiscoveryEngine/src/V1/gapic_metadata.json | 5 + .../search_service_client_config.json | 5 + .../search_service_descriptor_config.php | 20 ++++ .../search_service_rest_client_config.php | 24 +++++ .../V1/Client/SearchServiceClientTest.php | 89 ++++++++++++++++ 14 files changed, 351 insertions(+), 4 deletions(-) create mode 100644 DiscoveryEngine/samples/V1/SearchServiceClient/search_lite.php diff --git a/.github/workflows/backwards-compatibility-checks.yaml b/.github/workflows/backwards-compatibility-checks.yaml index 284f12f30e9e..97bda5691608 100644 --- a/.github/workflows/backwards-compatibility-checks.yaml +++ b/.github/workflows/backwards-compatibility-checks.yaml @@ -69,7 +69,7 @@ jobs: # OwlBot PRs which are not labelled feat should not add new files or methods run: | ~/.composer/vendor/bin/roave-backward-compatibility-check \ - --from=${{ github.head_ref || github.ref_name }} \ + --from=origin/${{ github.head_ref || github.ref_name }} \ --to=origin/main --format=github-actions - name: "Print the action item" run: | diff --git a/DiscoveryEngine/metadata/V1/Answer.php b/DiscoveryEngine/metadata/V1/Answer.php index 35be0444f496955fd25ebed50f673099e021e8f4..693a36e0e65356aad5f7787876bcd7b1b35326f6 100644 GIT binary patch delta 59 zcmeCvS+29;G!s*w+T^oLs~B%?u3#?XW4ychy`USTq>wn5u#bOuynB#;sGp0gOT43B PaJXxb0Ow{?;hRhVce4{$ delta 33 pcmZ3k)2FlHG!xTT)yZd>RxuvfT)|w%$9QD(dqFqG&3?i+nE>qo4O9RC diff --git a/DiscoveryEngine/metadata/V1/Control.php b/DiscoveryEngine/metadata/V1/Control.php index 940ff56533a75c63d8991a5f4abc0f1f7a48b563..d25197698c34beb86d7d0f7efeb474a00ced0da1 100644 GIT binary patch delta 51 zcmX>u_E2oYT_(m|lkYL@VZ1YWHuDN8Aqg(-!qU{D%J`zx^wbIo76nEPPABFEj*Od~ HSyHuH+ju`Dd?0E*5D?*IS* diff --git a/DiscoveryEngine/metadata/V1/SearchService.php b/DiscoveryEngine/metadata/V1/SearchService.php index 84d04cc513f5e80902e7c79f85ba2a7f46902dcb..b4d18f931ad410c7beb91cd97513a673cc5bc7b6 100644 GIT binary patch delta 125 zcmdnweQmLiie8vO@64V!~<0;6?Do`ZgK;c K+-6O+PDTJEWh)T? delta 38 ucmcZ-w8?+Nb7rRBZkt~+S1B-kW!{{svXGHgD(IA>+~fu>xy`55I~f5(zYiJ! diff --git a/DiscoveryEngine/samples/V1/SearchServiceClient/search_lite.php b/DiscoveryEngine/samples/V1/SearchServiceClient/search_lite.php new file mode 100644 index 000000000000..241b97ea5a71 --- /dev/null +++ b/DiscoveryEngine/samples/V1/SearchServiceClient/search_lite.php @@ -0,0 +1,98 @@ +setServingConfig($formattedServingConfig); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $searchServiceClient->searchLite($request); + + /** @var SearchResult $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->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 +{ + $formattedServingConfig = SearchServiceClient::servingConfigName( + '[PROJECT]', + '[LOCATION]', + '[DATA_STORE]', + '[SERVING_CONFIG]' + ); + + search_lite_sample($formattedServingConfig); +} +// [END discoveryengine_v1_generated_SearchService_SearchLite_sync] diff --git a/DiscoveryEngine/src/V1/Answer/AnswerSkippedReason.php b/DiscoveryEngine/src/V1/Answer/AnswerSkippedReason.php index ef1da4f5f4bb..9f2365464bb2 100644 --- a/DiscoveryEngine/src/V1/Answer/AnswerSkippedReason.php +++ b/DiscoveryEngine/src/V1/Answer/AnswerSkippedReason.php @@ -79,6 +79,14 @@ class AnswerSkippedReason * Generated from protobuf enum NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8; */ const NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8; + /** + * The low-grounded answer case. + * Google skips the answer if a well grounded answer was unable to be + * generated. + * + * Generated from protobuf enum LOW_GROUNDED_ANSWER = 9; + */ + const LOW_GROUNDED_ANSWER = 9; private static $valueToName = [ self::ANSWER_SKIPPED_REASON_UNSPECIFIED => 'ANSWER_SKIPPED_REASON_UNSPECIFIED', @@ -90,6 +98,7 @@ class AnswerSkippedReason self::JAIL_BREAKING_QUERY_IGNORED => 'JAIL_BREAKING_QUERY_IGNORED', self::CUSTOMER_POLICY_VIOLATION => 'CUSTOMER_POLICY_VIOLATION', self::NON_ANSWER_SEEKING_QUERY_IGNORED_V2 => 'NON_ANSWER_SEEKING_QUERY_IGNORED_V2', + self::LOW_GROUNDED_ANSWER => 'LOW_GROUNDED_ANSWER', ]; public static function name($value) diff --git a/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataResponse/DocumentMetadata/MatcherValue.php b/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataResponse/DocumentMetadata/MatcherValue.php index 214dde886286..00319353ab3b 100644 --- a/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataResponse/DocumentMetadata/MatcherValue.php +++ b/DiscoveryEngine/src/V1/BatchGetDocumentsMetadataResponse/DocumentMetadata/MatcherValue.php @@ -28,7 +28,7 @@ class MatcherValue extends \Google\Protobuf\Internal\Message * If match by URI, the URI of the * [Document][google.cloud.discoveryengine.v1.Document]. * @type string $fhir_resource - * Required. Format: + * Format: * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} * } */ @@ -71,7 +71,7 @@ public function setUri($var) } /** - * Required. Format: + * Format: * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} * * Generated from protobuf field string fhir_resource = 2 [(.google.api.resource_reference) = { @@ -88,7 +88,7 @@ public function hasFhirResource() } /** - * Required. Format: + * Format: * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} * * Generated from protobuf field string fhir_resource = 2 [(.google.api.resource_reference) = { diff --git a/DiscoveryEngine/src/V1/Client/SearchServiceClient.php b/DiscoveryEngine/src/V1/Client/SearchServiceClient.php index d6dc62e8c140..e7c1a1e368e2 100644 --- a/DiscoveryEngine/src/V1/Client/SearchServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/SearchServiceClient.php @@ -48,6 +48,7 @@ * contained within formatted names that are returned by the API. * * @method PromiseInterface searchAsync(SearchRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchLiteAsync(SearchRequest $request, array $optionalArgs = []) */ final class SearchServiceClient { @@ -573,4 +574,42 @@ public function search(SearchRequest $request, array $callOptions = []): PagedLi { return $this->startApiCall('Search', $request, $callOptions); } + + /** + * Performs a search. Similar to the + * [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + * method, but a lite version that allows API key for authentication, where + * OAuth and IAM checks are not required. + * + * Only public website search is supported by this method. If data stores and + * engines not associated with public website search are specified, a + * `FAILED_PRECONDITION` error is returned. + * + * This method can be used for easy onboarding without having to implement an + * authentication backend. However, it is strongly recommended to use + * [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + * instead with required OAuth and IAM checks to provide better data security. + * + * The async variant is {@see SearchServiceClient::searchLiteAsync()} . + * + * @example samples/V1/SearchServiceClient/search_lite.php + * + * @param SearchRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function searchLite(SearchRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('SearchLite', $request, $callOptions); + } } diff --git a/DiscoveryEngine/src/V1/Condition.php b/DiscoveryEngine/src/V1/Condition.php index acaf131b3572..0a122300ada0 100644 --- a/DiscoveryEngine/src/V1/Condition.php +++ b/DiscoveryEngine/src/V1/Condition.php @@ -18,6 +18,9 @@ class Condition extends \Google\Protobuf\Internal\Message /** * Search only * A list of terms to match the query on. + * Cannot be set when + * [Condition.query_regex][google.cloud.discoveryengine.v1.Condition.query_regex] + * is set. * Maximum of 10 query terms. * * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.Condition.QueryTerm query_terms = 2; @@ -30,6 +33,15 @@ class Condition extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.Condition.TimeRange active_time_range = 3; */ private $active_time_range; + /** + * Optional. Query regex to match the whole search query. + * Cannot be set when + * [Condition.query_terms][google.cloud.discoveryengine.v1.Condition.query_terms] + * is set. This is currently supporting promotion use case. + * + * Generated from protobuf field string query_regex = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $query_regex = ''; /** * Constructor. @@ -40,10 +52,18 @@ class Condition extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\DiscoveryEngine\V1\Condition\QueryTerm>|\Google\Protobuf\Internal\RepeatedField $query_terms * Search only * A list of terms to match the query on. + * Cannot be set when + * [Condition.query_regex][google.cloud.discoveryengine.v1.Condition.query_regex] + * is set. * Maximum of 10 query terms. * @type array<\Google\Cloud\DiscoveryEngine\V1\Condition\TimeRange>|\Google\Protobuf\Internal\RepeatedField $active_time_range * Range of time(s) specifying when condition is active. * Maximum of 10 time ranges. + * @type string $query_regex + * Optional. Query regex to match the whole search query. + * Cannot be set when + * [Condition.query_terms][google.cloud.discoveryengine.v1.Condition.query_terms] + * is set. This is currently supporting promotion use case. * } */ public function __construct($data = NULL) { @@ -54,6 +74,9 @@ public function __construct($data = NULL) { /** * Search only * A list of terms to match the query on. + * Cannot be set when + * [Condition.query_regex][google.cloud.discoveryengine.v1.Condition.query_regex] + * is set. * Maximum of 10 query terms. * * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.Condition.QueryTerm query_terms = 2; @@ -67,6 +90,9 @@ public function getQueryTerms() /** * Search only * A list of terms to match the query on. + * Cannot be set when + * [Condition.query_regex][google.cloud.discoveryengine.v1.Condition.query_regex] + * is set. * Maximum of 10 query terms. * * Generated from protobuf field repeated .google.cloud.discoveryengine.v1.Condition.QueryTerm query_terms = 2; @@ -109,5 +135,37 @@ public function setActiveTimeRange($var) return $this; } + /** + * Optional. Query regex to match the whole search query. + * Cannot be set when + * [Condition.query_terms][google.cloud.discoveryengine.v1.Condition.query_terms] + * is set. This is currently supporting promotion use case. + * + * Generated from protobuf field string query_regex = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getQueryRegex() + { + return $this->query_regex; + } + + /** + * Optional. Query regex to match the whole search query. + * Cannot be set when + * [Condition.query_terms][google.cloud.discoveryengine.v1.Condition.query_terms] + * is set. This is currently supporting promotion use case. + * + * Generated from protobuf field string query_regex = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setQueryRegex($var) + { + GPBUtil::checkString($var, True); + $this->query_regex = $var; + + return $this; + } + } diff --git a/DiscoveryEngine/src/V1/gapic_metadata.json b/DiscoveryEngine/src/V1/gapic_metadata.json index b7befe39ec3f..22ca1b944631 100644 --- a/DiscoveryEngine/src/V1/gapic_metadata.json +++ b/DiscoveryEngine/src/V1/gapic_metadata.json @@ -82,6 +82,11 @@ "methods": [ "search" ] + }, + "SearchLite": { + "methods": [ + "searchLite" + ] } } } diff --git a/DiscoveryEngine/src/V1/resources/search_service_client_config.json b/DiscoveryEngine/src/V1/resources/search_service_client_config.json index 53151b5b8302..7b29799035ac 100644 --- a/DiscoveryEngine/src/V1/resources/search_service_client_config.json +++ b/DiscoveryEngine/src/V1/resources/search_service_client_config.json @@ -32,6 +32,11 @@ "timeout_millis": 30000, "retry_codes_name": "retry_policy_2_codes", "retry_params_name": "retry_policy_2_params" + }, + "SearchLite": { + "timeout_millis": 30000, + "retry_codes_name": "retry_policy_2_codes", + "retry_params_name": "retry_policy_2_params" } } } diff --git a/DiscoveryEngine/src/V1/resources/search_service_descriptor_config.php b/DiscoveryEngine/src/V1/resources/search_service_descriptor_config.php index 708f91e00e42..04927acc01a2 100644 --- a/DiscoveryEngine/src/V1/resources/search_service_descriptor_config.php +++ b/DiscoveryEngine/src/V1/resources/search_service_descriptor_config.php @@ -43,6 +43,26 @@ ], ], ], + 'SearchLite' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getResults', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\DiscoveryEngine\V1\SearchResponse', + 'headerParams' => [ + [ + 'keyName' => 'serving_config', + 'fieldAccessors' => [ + 'getServingConfig', + ], + ], + ], + ], 'templateMap' => [ 'branch' => 'projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}', 'dataStore' => 'projects/{project}/locations/{location}/dataStores/{data_store}', diff --git a/DiscoveryEngine/src/V1/resources/search_service_rest_client_config.php b/DiscoveryEngine/src/V1/resources/search_service_rest_client_config.php index 61ff8f48813e..57bb2e58e3ff 100644 --- a/DiscoveryEngine/src/V1/resources/search_service_rest_client_config.php +++ b/DiscoveryEngine/src/V1/resources/search_service_rest_client_config.php @@ -47,6 +47,30 @@ ], ], ], + 'SearchLite' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{serving_config=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite', + 'body' => '*', + 'additionalBindings' => [ + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{serving_config=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite', + 'body' => '*', + ], + ], + 'placeholders' => [ + 'serving_config' => [ + 'getters' => [ + 'getServingConfig', + ], + ], + ], + ], ], 'google.longrunning.Operations' => [ 'CancelOperation' => [ diff --git a/DiscoveryEngine/tests/Unit/V1/Client/SearchServiceClientTest.php b/DiscoveryEngine/tests/Unit/V1/Client/SearchServiceClientTest.php index 72e0b116236d..4b14e94f092b 100644 --- a/DiscoveryEngine/tests/Unit/V1/Client/SearchServiceClientTest.php +++ b/DiscoveryEngine/tests/Unit/V1/Client/SearchServiceClientTest.php @@ -152,6 +152,95 @@ public function searchExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function searchLiteTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $totalSize = 705419236; + $attributionToken = 'attributionToken-729411015'; + $redirectUri = 'redirectUri951230089'; + $nextPageToken = ''; + $correctedQuery = 'correctedQuery107869074'; + $resultsElement = new SearchResult(); + $results = [$resultsElement]; + $expectedResponse = new SearchResponse(); + $expectedResponse->setTotalSize($totalSize); + $expectedResponse->setAttributionToken($attributionToken); + $expectedResponse->setRedirectUri($redirectUri); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setCorrectedQuery($correctedQuery); + $expectedResponse->setResults($results); + $transport->addResponse($expectedResponse); + // Mock request + $formattedServingConfig = $gapicClient->servingConfigName( + '[PROJECT]', + '[LOCATION]', + '[DATA_STORE]', + '[SERVING_CONFIG]' + ); + $request = (new SearchRequest())->setServingConfig($formattedServingConfig); + $response = $gapicClient->searchLite($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getResults()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.discoveryengine.v1.SearchService/SearchLite', $actualFuncCall); + $actualValue = $actualRequestObject->getServingConfig(); + $this->assertProtobufEquals($formattedServingConfig, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function searchLiteExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedServingConfig = $gapicClient->servingConfigName( + '[PROJECT]', + '[LOCATION]', + '[DATA_STORE]', + '[SERVING_CONFIG]' + ); + $request = (new SearchRequest())->setServingConfig($formattedServingConfig); + try { + $gapicClient->searchLite($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function searchAsyncTest() { From d046eb41791571b2fc5976bdb9f32751e8598f67 Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Thu, 31 Oct 2024 11:51:39 -0700 Subject: [PATCH 058/157] chore(ci): fix conventional commit check (#7763) From 068f434c7b00645ed7ec817b9359b6c5f9d2d466 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 15:15:50 -0400 Subject: [PATCH 059/157] doc: Add GroundedGenerationService API (#7780) * feat: Add GroundedGenerationService API feat: Add AdvancedCompleteQuery API feat: Add lite search API to allow public website search with API key feat: Add Sitemap APIs to preview channel feat: Support search personalization to preview channel feat: Support natural language understanding search feat: Add BillingEstimation in data store feat: Support Google Workspace search feat: Support advanced boost search feat: Add one_box_page_size on search feat: support query regex in control match rules docs: deprecate extractive_answers in answer generation docs: deprecate asynchronous mode in answer generation docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 691212731 Source-Link: https://github.com/googleapis/googleapis/commit/e6b6ff9b7b3659641488e772355cdc78aac488ff Source-Link: https://github.com/googleapis/googleapis-gen/commit/67144fd43c5a3e164410b3617e5752f2e066ec25 Copy-Tag: eyJwIjoiS21zLy5Pd2xCb3QueWFtbCIsImgiOiI2NzE0NGZkNDNjNWEzZTE2NDQxMGIzNjE3ZTU3NTJmMmUwNjZlYzI1In0= Co-authored-by: Brent Shaffer --- Kms/src/V1/ListKeyHandlesRequest.php | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Kms/src/V1/ListKeyHandlesRequest.php b/Kms/src/V1/ListKeyHandlesRequest.php index 89269423a3f0..c294c8dedd23 100644 --- a/Kms/src/V1/ListKeyHandlesRequest.php +++ b/Kms/src/V1/ListKeyHandlesRequest.php @@ -31,8 +31,8 @@ class ListKeyHandlesRequest extends \Google\Protobuf\Internal\Message * [KeyHandles][google.cloud.kms.v1.KeyHandle] can subsequently be obtained by * including the * [ListKeyHandlesResponse.next_page_token][google.cloud.kms.v1.ListKeyHandlesResponse.next_page_token] - * in a subsequent request. If unspecified, at most - * 100 [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned. + * in a subsequent request. If unspecified, at most 100 + * [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -86,8 +86,8 @@ public static function build(string $parent): self * [KeyHandles][google.cloud.kms.v1.KeyHandle] can subsequently be obtained by * including the * [ListKeyHandlesResponse.next_page_token][google.cloud.kms.v1.ListKeyHandlesResponse.next_page_token] - * in a subsequent request. If unspecified, at most - * 100 [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned. + * in a subsequent request. If unspecified, at most 100 + * [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned. * @type string $page_token * Optional. Optional pagination token, returned earlier via * [ListKeyHandlesResponse.next_page_token][google.cloud.kms.v1.ListKeyHandlesResponse.next_page_token]. @@ -139,8 +139,8 @@ public function setParent($var) * [KeyHandles][google.cloud.kms.v1.KeyHandle] can subsequently be obtained by * including the * [ListKeyHandlesResponse.next_page_token][google.cloud.kms.v1.ListKeyHandlesResponse.next_page_token] - * in a subsequent request. If unspecified, at most - * 100 [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned. + * in a subsequent request. If unspecified, at most 100 + * [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -157,8 +157,8 @@ public function getPageSize() * [KeyHandles][google.cloud.kms.v1.KeyHandle] can subsequently be obtained by * including the * [ListKeyHandlesResponse.next_page_token][google.cloud.kms.v1.ListKeyHandlesResponse.next_page_token] - * in a subsequent request. If unspecified, at most - * 100 [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned. + * in a subsequent request. If unspecified, at most 100 + * [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var From b8821e337719c1c0421688589464d79181fc5115 Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Fri, 1 Nov 2024 11:09:04 -0700 Subject: [PATCH 060/157] chore: rename AdsMarketingplatformAdmin (#7776) --- .repo-metadata-full.json | 2 +- AdsMarketingPlatformAdmin/composer.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.repo-metadata-full.json b/.repo-metadata-full.json index 98e0ec780eb1..e6f2308fdc03 100644 --- a/.repo-metadata-full.json +++ b/.repo-metadata-full.json @@ -25,7 +25,7 @@ }, "AdsMarketingPlatformAdmin": { "language": "php", - "distribution_name": "google/ads-marketingplatform-admin", + "distribution_name": "googleads/marketingplatform-admin", "release_level": "preview", "client_documentation": "https://cloud.google.com/php/docs/reference/ads-marketingplatform-admin/latest", "library_type": "GAPIC_AUTO", diff --git a/AdsMarketingPlatformAdmin/composer.json b/AdsMarketingPlatformAdmin/composer.json index cc06dfa4c94a..2c3690e679d5 100644 --- a/AdsMarketingPlatformAdmin/composer.json +++ b/AdsMarketingPlatformAdmin/composer.json @@ -1,5 +1,5 @@ { - "name": "google/ads-marketingplatform-admin", + "name": "googleads/marketingplatform-admin", "description": "Google Ads Marketing Platform Admin Client for PHP", "license": "Apache-2.0", "minimum-stability": "stable", From a2eb865459782d36cc3d438eb8c4006d121f17bd Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 1 Nov 2024 14:21:25 -0400 Subject: [PATCH 061/157] feat: add response types for async magic methods (#7773) * feat!: added new fields for the Automation Repair rule feat: added route destination related fields to Gateway service mesh message PiperOrigin-RevId: 690680962 Source-Link: https://github.com/googleapis/googleapis/commit/80460eb1f855dd7e31f854f01ddaaa7df653f36a Source-Link: https://github.com/googleapis/googleapis-gen/commit/b09f28e59a4e72c6da50110384de20789f652df8 Copy-Tag: eyJwIjoiRGVwbG95Ly5Pd2xCb3QueWFtbCIsImgiOiJiMDlmMjhlNTlhNGU3MmM2ZGE1MDExMDM4NGRlMjA3ODlmNjUyZGY4In0= * docs: add response types for async magic methods PiperOrigin-RevId: 691866489 Source-Link: https://github.com/googleapis/googleapis/commit/cf0f35efca7e0d507af89e9ddc46cba2f41eb9f7 Source-Link: https://github.com/googleapis/googleapis-gen/commit/e556aaed2dc6f46b6ff8cc769fabadcfbe2504a4 Copy-Tag: eyJwIjoiRGVwbG95Ly5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= --- Deploy/metadata/V1/CloudDeploy.php | Bin 48994 -> 50152 bytes Deploy/src/V1/AssociatedEntities.php | 101 ++++++++++++++ Deploy/src/V1/Client/CloudDeployClient.php | 100 +++++++------- .../KubernetesConfig/GatewayServiceMesh.php | 60 ++++++++ .../GatewayServiceMesh/RouteDestinations.php | 130 ++++++++++++++++++ Deploy/src/V1/RepairPhaseConfig.php | 108 +++++++++++++++ Deploy/src/V1/RepairRolloutOperation.php | 34 +++++ Deploy/src/V1/RepairRolloutRule.php | 88 ++++++++++++ Deploy/src/V1/Rollback.php | 38 +++++ Deploy/src/V1/RollbackAttempt.php | 34 +++++ Deploy/src/V1/Rollout.php | 34 +++++ Deploy/src/V1/Target.php | 62 +++++++++ .../Unit/V1/Client/CloudDeployClientTest.php | 4 + 13 files changed, 743 insertions(+), 50 deletions(-) create mode 100644 Deploy/src/V1/AssociatedEntities.php create mode 100644 Deploy/src/V1/KubernetesConfig/GatewayServiceMesh/RouteDestinations.php create mode 100644 Deploy/src/V1/RepairPhaseConfig.php diff --git a/Deploy/metadata/V1/CloudDeploy.php b/Deploy/metadata/V1/CloudDeploy.php index a0e8102a4107e6df69d6e842de78be3cd6d0493f..e55a683f02bc7999cde6334d86447a37d2cd7d5b 100644 GIT binary patch delta 911 zcma)4!AlfT9QMuZ>hxP{+^6Cs>$I7cW@}&!53R_g4* zi)QgI5e0SW7{zq)7z9Cw=nv=+LewcbbxWFguC-u?PBZZPe&6?d-}mkADc?5Kms<(t z>#uM-@e`ESjbcN8ue?#kLd%|s9l*X@4X9;P9x#Ul%yqb-Wl>*h_?kEghB()f7P~s8 zgZUVDxehj^ex5{~^N>C?!5Pr&2rXuF17+2|Bk_uYO-Osb>ya{vggN!sSdkh^q^X5h z(+_AqW>Ev*Y1>mL$(UMDUL}9*5@g3bl%rDi5g7qZg>+ zW7j}Co(7#b!LrN$&Qzg~nc}>O!&kkJbBfTzxrO#b5AKHyDF$qfT0Zp%^DR;h+*KKa zVN;W(awqcw&aK$9-@i)Z=Hv6%UK zyf^JSC03RxbPE(ECq?T<_yQz-8W|Yn6?dR3-Zu^moo&FQp!sg4vP6n2h9V|YrpUfX zh^LPdBhvEOhN)xFTz^UTCW2%>ro`=_kszR}UJ%y-^{Mg@@nbXBitq$9$E0qlWUab3 zHB?d9&Ml(uLIJdVO)+jxeXrzGC6#Oz!b5P%W}GZlB0p<87AwjBsJ)g)9h*7j{jTj- zj+fRk^9CX=d#TeHxIJ_-SwlMj+GvuToA P0s)+p#FU-0la*C2`IIg6 diff --git a/Deploy/src/V1/AssociatedEntities.php b/Deploy/src/V1/AssociatedEntities.php new file mode 100644 index 000000000000..3a6e382e89e5 --- /dev/null +++ b/Deploy/src/V1/AssociatedEntities.php @@ -0,0 +1,101 @@ +google.cloud.deploy.v1.AssociatedEntities + */ +class AssociatedEntities extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Information specifying GKE clusters as associated entities. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.GkeCluster gke_clusters = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $gke_clusters; + /** + * Optional. Information specifying Anthos clusters as associated entities. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.AnthosCluster anthos_clusters = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $anthos_clusters; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Deploy\V1\GkeCluster>|\Google\Protobuf\Internal\RepeatedField $gke_clusters + * Optional. Information specifying GKE clusters as associated entities. + * @type array<\Google\Cloud\Deploy\V1\AnthosCluster>|\Google\Protobuf\Internal\RepeatedField $anthos_clusters + * Optional. Information specifying Anthos clusters as associated entities. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Deploy\V1\CloudDeploy::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Information specifying GKE clusters as associated entities. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.GkeCluster gke_clusters = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGkeClusters() + { + return $this->gke_clusters; + } + + /** + * Optional. Information specifying GKE clusters as associated entities. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.GkeCluster gke_clusters = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Deploy\V1\GkeCluster>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGkeClusters($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Deploy\V1\GkeCluster::class); + $this->gke_clusters = $arr; + + return $this; + } + + /** + * Optional. Information specifying Anthos clusters as associated entities. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.AnthosCluster anthos_clusters = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAnthosClusters() + { + return $this->anthos_clusters; + } + + /** + * Optional. Information specifying Anthos clusters as associated entities. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.AnthosCluster anthos_clusters = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Deploy\V1\AnthosCluster>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAnthosClusters($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Deploy\V1\AnthosCluster::class); + $this->anthos_clusters = $arr; + + return $this; + } + +} + diff --git a/Deploy/src/V1/Client/CloudDeployClient.php b/Deploy/src/V1/Client/CloudDeployClient.php index 48adb7913db0..4bfac1aa9005 100644 --- a/Deploy/src/V1/Client/CloudDeployClient.php +++ b/Deploy/src/V1/Client/CloudDeployClient.php @@ -122,56 +122,56 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface abandonReleaseAsync(AbandonReleaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface advanceRolloutAsync(AdvanceRolloutRequest $request, array $optionalArgs = []) - * @method PromiseInterface approveRolloutAsync(ApproveRolloutRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelAutomationRunAsync(CancelAutomationRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelRolloutAsync(CancelRolloutRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAutomationAsync(CreateAutomationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomTargetTypeAsync(CreateCustomTargetTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDeliveryPipelineAsync(CreateDeliveryPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDeployPolicyAsync(CreateDeployPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReleaseAsync(CreateReleaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRolloutAsync(CreateRolloutRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTargetAsync(CreateTargetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAutomationAsync(DeleteAutomationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCustomTargetTypeAsync(DeleteCustomTargetTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDeployPolicyAsync(DeleteDeployPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTargetAsync(DeleteTargetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAutomationAsync(GetAutomationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAutomationRunAsync(GetAutomationRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConfigAsync(GetConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomTargetTypeAsync(GetCustomTargetTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDeliveryPipelineAsync(GetDeliveryPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDeployPolicyAsync(GetDeployPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobRunAsync(GetJobRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReleaseAsync(GetReleaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRolloutAsync(GetRolloutRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTargetAsync(GetTargetRequest $request, array $optionalArgs = []) - * @method PromiseInterface ignoreJobAsync(IgnoreJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAutomationRunsAsync(ListAutomationRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAutomationsAsync(ListAutomationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomTargetTypesAsync(ListCustomTargetTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeliveryPipelinesAsync(ListDeliveryPipelinesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeployPoliciesAsync(ListDeployPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobRunsAsync(ListJobRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReleasesAsync(ListReleasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRolloutsAsync(ListRolloutsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTargetsAsync(ListTargetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface retryJobAsync(RetryJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackTargetAsync(RollbackTargetRequest $request, array $optionalArgs = []) - * @method PromiseInterface terminateJobRunAsync(TerminateJobRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAutomationAsync(UpdateAutomationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomTargetTypeAsync(UpdateCustomTargetTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDeliveryPipelineAsync(UpdateDeliveryPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDeployPolicyAsync(UpdateDeployPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTargetAsync(UpdateTargetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface abandonReleaseAsync(AbandonReleaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface advanceRolloutAsync(AdvanceRolloutRequest $request, array $optionalArgs = []) + * @method PromiseInterface approveRolloutAsync(ApproveRolloutRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelAutomationRunAsync(CancelAutomationRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelRolloutAsync(CancelRolloutRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAutomationAsync(CreateAutomationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomTargetTypeAsync(CreateCustomTargetTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeliveryPipelineAsync(CreateDeliveryPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeployPolicyAsync(CreateDeployPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReleaseAsync(CreateReleaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRolloutAsync(CreateRolloutRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTargetAsync(CreateTargetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAutomationAsync(DeleteAutomationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCustomTargetTypeAsync(DeleteCustomTargetTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDeployPolicyAsync(DeleteDeployPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTargetAsync(DeleteTargetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAutomationAsync(GetAutomationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAutomationRunAsync(GetAutomationRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConfigAsync(GetConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomTargetTypeAsync(GetCustomTargetTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeliveryPipelineAsync(GetDeliveryPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeployPolicyAsync(GetDeployPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobRunAsync(GetJobRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReleaseAsync(GetReleaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRolloutAsync(GetRolloutRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTargetAsync(GetTargetRequest $request, array $optionalArgs = []) + * @method PromiseInterface ignoreJobAsync(IgnoreJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAutomationRunsAsync(ListAutomationRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAutomationsAsync(ListAutomationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomTargetTypesAsync(ListCustomTargetTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeliveryPipelinesAsync(ListDeliveryPipelinesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeployPoliciesAsync(ListDeployPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobRunsAsync(ListJobRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReleasesAsync(ListReleasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRolloutsAsync(ListRolloutsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTargetsAsync(ListTargetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface retryJobAsync(RetryJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackTargetAsync(RollbackTargetRequest $request, array $optionalArgs = []) + * @method PromiseInterface terminateJobRunAsync(TerminateJobRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAutomationAsync(UpdateAutomationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomTargetTypeAsync(UpdateCustomTargetTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDeliveryPipelineAsync(UpdateDeliveryPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDeployPolicyAsync(UpdateDeployPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTargetAsync(UpdateTargetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class CloudDeployClient { diff --git a/Deploy/src/V1/KubernetesConfig/GatewayServiceMesh.php b/Deploy/src/V1/KubernetesConfig/GatewayServiceMesh.php index 0f84cf1fe5f5..9543fd18a7eb 100644 --- a/Deploy/src/V1/KubernetesConfig/GatewayServiceMesh.php +++ b/Deploy/src/V1/KubernetesConfig/GatewayServiceMesh.php @@ -58,6 +58,16 @@ class GatewayServiceMesh extends \Google\Protobuf\Internal\Message * Generated from protobuf field string pod_selector_label = 6 [(.google.api.field_behavior) = OPTIONAL]; */ protected $pod_selector_label = ''; + /** + * Optional. Route destinations allow configuring the Gateway API HTTPRoute + * to be deployed to additional clusters. This option is available for + * multi-cluster service mesh set ups that require the route to exist in the + * clusters that call the service. If unspecified, the HTTPRoute will only + * be deployed to the Target cluster. + * + * Generated from protobuf field .google.cloud.deploy.v1.KubernetesConfig.GatewayServiceMesh.RouteDestinations route_destinations = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $route_destinations = null; /** * Constructor. @@ -84,6 +94,12 @@ class GatewayServiceMesh extends \Google\Protobuf\Internal\Message * @type string $pod_selector_label * Optional. The label to use when selecting Pods for the Deployment and * Service resources. This label must already be present in both resources. + * @type \Google\Cloud\Deploy\V1\KubernetesConfig\GatewayServiceMesh\RouteDestinations $route_destinations + * Optional. Route destinations allow configuring the Gateway API HTTPRoute + * to be deployed to additional clusters. This option is available for + * multi-cluster service mesh set ups that require the route to exist in the + * clusters that call the service. If unspecified, the HTTPRoute will only + * be deployed to the Target cluster. * } */ public function __construct($data = NULL) { @@ -281,6 +297,50 @@ public function setPodSelectorLabel($var) return $this; } + /** + * Optional. Route destinations allow configuring the Gateway API HTTPRoute + * to be deployed to additional clusters. This option is available for + * multi-cluster service mesh set ups that require the route to exist in the + * clusters that call the service. If unspecified, the HTTPRoute will only + * be deployed to the Target cluster. + * + * Generated from protobuf field .google.cloud.deploy.v1.KubernetesConfig.GatewayServiceMesh.RouteDestinations route_destinations = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Deploy\V1\KubernetesConfig\GatewayServiceMesh\RouteDestinations|null + */ + public function getRouteDestinations() + { + return $this->route_destinations; + } + + public function hasRouteDestinations() + { + return isset($this->route_destinations); + } + + public function clearRouteDestinations() + { + unset($this->route_destinations); + } + + /** + * Optional. Route destinations allow configuring the Gateway API HTTPRoute + * to be deployed to additional clusters. This option is available for + * multi-cluster service mesh set ups that require the route to exist in the + * clusters that call the service. If unspecified, the HTTPRoute will only + * be deployed to the Target cluster. + * + * Generated from protobuf field .google.cloud.deploy.v1.KubernetesConfig.GatewayServiceMesh.RouteDestinations route_destinations = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Deploy\V1\KubernetesConfig\GatewayServiceMesh\RouteDestinations $var + * @return $this + */ + public function setRouteDestinations($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Deploy\V1\KubernetesConfig\GatewayServiceMesh\RouteDestinations::class); + $this->route_destinations = $var; + + return $this; + } + } diff --git a/Deploy/src/V1/KubernetesConfig/GatewayServiceMesh/RouteDestinations.php b/Deploy/src/V1/KubernetesConfig/GatewayServiceMesh/RouteDestinations.php new file mode 100644 index 000000000000..d0cb3f721d2d --- /dev/null +++ b/Deploy/src/V1/KubernetesConfig/GatewayServiceMesh/RouteDestinations.php @@ -0,0 +1,130 @@ +google.cloud.deploy.v1.KubernetesConfig.GatewayServiceMesh.RouteDestinations + */ +class RouteDestinations extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The clusters where the Gateway API HTTPRoute resource will be + * deployed to. Valid entries include the associated entities IDs + * configured in the Target resource and "@self" to include the Target + * cluster. + * + * Generated from protobuf field repeated string destination_ids = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + private $destination_ids; + /** + * Optional. Whether to propagate the Kubernetes Service to the route + * destination clusters. The Service will always be deployed to the Target + * cluster even if the HTTPRoute is not. This option may be used to + * facilitiate successful DNS lookup in the route destination clusters. + * Can only be set to true if destinations are specified. + * + * Generated from protobuf field bool propagate_service = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $propagate_service = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $destination_ids + * Required. The clusters where the Gateway API HTTPRoute resource will be + * deployed to. Valid entries include the associated entities IDs + * configured in the Target resource and "@self" to include the Target + * cluster. + * @type bool $propagate_service + * Optional. Whether to propagate the Kubernetes Service to the route + * destination clusters. The Service will always be deployed to the Target + * cluster even if the HTTPRoute is not. This option may be used to + * facilitiate successful DNS lookup in the route destination clusters. + * Can only be set to true if destinations are specified. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Deploy\V1\CloudDeploy::initOnce(); + parent::__construct($data); + } + + /** + * Required. The clusters where the Gateway API HTTPRoute resource will be + * deployed to. Valid entries include the associated entities IDs + * configured in the Target resource and "@self" to include the Target + * cluster. + * + * Generated from protobuf field repeated string destination_ids = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getDestinationIds() + { + return $this->destination_ids; + } + + /** + * Required. The clusters where the Gateway API HTTPRoute resource will be + * deployed to. Valid entries include the associated entities IDs + * configured in the Target resource and "@self" to include the Target + * cluster. + * + * Generated from protobuf field repeated string destination_ids = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setDestinationIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->destination_ids = $arr; + + return $this; + } + + /** + * Optional. Whether to propagate the Kubernetes Service to the route + * destination clusters. The Service will always be deployed to the Target + * cluster even if the HTTPRoute is not. This option may be used to + * facilitiate successful DNS lookup in the route destination clusters. + * Can only be set to true if destinations are specified. + * + * Generated from protobuf field bool propagate_service = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getPropagateService() + { + return $this->propagate_service; + } + + /** + * Optional. Whether to propagate the Kubernetes Service to the route + * destination clusters. The Service will always be deployed to the Target + * cluster even if the HTTPRoute is not. This option may be used to + * facilitiate successful DNS lookup in the route destination clusters. + * Can only be set to true if destinations are specified. + * + * Generated from protobuf field bool propagate_service = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setPropagateService($var) + { + GPBUtil::checkBool($var); + $this->propagate_service = $var; + + return $this; + } + +} + + diff --git a/Deploy/src/V1/RepairPhaseConfig.php b/Deploy/src/V1/RepairPhaseConfig.php new file mode 100644 index 000000000000..073057c13470 --- /dev/null +++ b/Deploy/src/V1/RepairPhaseConfig.php @@ -0,0 +1,108 @@ +google.cloud.deploy.v1.RepairPhaseConfig + */ +class RepairPhaseConfig extends \Google\Protobuf\Internal\Message +{ + protected $repair_phase; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Deploy\V1\Retry $retry + * Optional. Retries a failed job. + * @type \Google\Cloud\Deploy\V1\Rollback $rollback + * Optional. Rolls back a `Rollout`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Deploy\V1\CloudDeploy::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Retries a failed job. + * + * Generated from protobuf field .google.cloud.deploy.v1.Retry retry = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Deploy\V1\Retry|null + */ + public function getRetry() + { + return $this->readOneof(1); + } + + public function hasRetry() + { + return $this->hasOneof(1); + } + + /** + * Optional. Retries a failed job. + * + * Generated from protobuf field .google.cloud.deploy.v1.Retry retry = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Deploy\V1\Retry $var + * @return $this + */ + public function setRetry($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Deploy\V1\Retry::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * Optional. Rolls back a `Rollout`. + * + * Generated from protobuf field .google.cloud.deploy.v1.Rollback rollback = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Deploy\V1\Rollback|null + */ + public function getRollback() + { + return $this->readOneof(2); + } + + public function hasRollback() + { + return $this->hasOneof(2); + } + + /** + * Optional. Rolls back a `Rollout`. + * + * Generated from protobuf field .google.cloud.deploy.v1.Rollback rollback = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Deploy\V1\Rollback $var + * @return $this + */ + public function setRollback($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Deploy\V1\Rollback::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * @return string + */ + public function getRepairPhase() + { + return $this->whichOneof("repair_phase"); + } + +} + diff --git a/Deploy/src/V1/RepairRolloutOperation.php b/Deploy/src/V1/RepairRolloutOperation.php index 8db984466a7f..070ec32be411 100644 --- a/Deploy/src/V1/RepairRolloutOperation.php +++ b/Deploy/src/V1/RepairRolloutOperation.php @@ -21,6 +21,12 @@ class RepairRolloutOperation extends \Google\Protobuf\Internal\Message * Generated from protobuf field string rollout = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $rollout = ''; + /** + * Output only. The index of the current repair action in the repair sequence. + * + * Generated from protobuf field int64 current_repair_phase_index = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $current_repair_phase_index = 0; /** * Output only. Records of the repair attempts. Each repair phase may have * multiple retry attempts or single rollback attempt. @@ -50,6 +56,8 @@ class RepairRolloutOperation extends \Google\Protobuf\Internal\Message * * @type string $rollout * Output only. The name of the rollout that initiates the `AutomationRun`. + * @type int|string $current_repair_phase_index + * Output only. The index of the current repair action in the repair sequence. * @type array<\Google\Cloud\Deploy\V1\RepairPhase>|\Google\Protobuf\Internal\RepeatedField $repair_phases * Output only. Records of the repair attempts. Each repair phase may have * multiple retry attempts or single rollback attempt. @@ -91,6 +99,32 @@ public function setRollout($var) return $this; } + /** + * Output only. The index of the current repair action in the repair sequence. + * + * Generated from protobuf field int64 current_repair_phase_index = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getCurrentRepairPhaseIndex() + { + return $this->current_repair_phase_index; + } + + /** + * Output only. The index of the current repair action in the repair sequence. + * + * Generated from protobuf field int64 current_repair_phase_index = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setCurrentRepairPhaseIndex($var) + { + GPBUtil::checkInt64($var); + $this->current_repair_phase_index = $var; + + return $this; + } + /** * Output only. Records of the repair attempts. Each repair phase may have * multiple retry attempts or single rollback attempt. diff --git a/Deploy/src/V1/RepairRolloutRule.php b/Deploy/src/V1/RepairRolloutRule.php index e562296f3300..86ab43ecfc5d 100644 --- a/Deploy/src/V1/RepairRolloutRule.php +++ b/Deploy/src/V1/RepairRolloutRule.php @@ -24,6 +24,17 @@ class RepairRolloutRule extends \Google\Protobuf\Internal\Message * Generated from protobuf field string id = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $id = ''; + /** + * Optional. Phases within which jobs are subject to automatic repair actions + * on failure. Proceeds only after phase name matched any one in the list, or + * for all phases if unspecified. This value must consist of lower-case + * letters, numbers, and hyphens, start with a letter and end with a letter or + * a number, and have a max length of 63 characters. In other words, it must + * match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + * + * Generated from protobuf field repeated string phases = 7 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $phases; /** * Optional. Jobs to repair. Proceeds only after job name matched any one in * the list, or for all jobs if unspecified or empty. The phase that includes @@ -42,6 +53,12 @@ class RepairRolloutRule extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.deploy.v1.AutomationRuleCondition condition = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $condition = null; + /** + * Required. Defines the types of automatic repair phases for failed jobs. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.RepairPhaseConfig repair_phases = 8 [(.google.api.field_behavior) = REQUIRED]; + */ + private $repair_phases; /** * Constructor. @@ -53,6 +70,13 @@ class RepairRolloutRule extends \Google\Protobuf\Internal\Message * Required. ID of the rule. This id must be unique in the `Automation` * resource to which this rule belongs. The format is * `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. + * @type array|\Google\Protobuf\Internal\RepeatedField $phases + * Optional. Phases within which jobs are subject to automatic repair actions + * on failure. Proceeds only after phase name matched any one in the list, or + * for all phases if unspecified. This value must consist of lower-case + * letters, numbers, and hyphens, start with a letter and end with a letter or + * a number, and have a max length of 63 characters. In other words, it must + * match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. * @type array|\Google\Protobuf\Internal\RepeatedField $jobs * Optional. Jobs to repair. Proceeds only after job name matched any one in * the list, or for all jobs if unspecified or empty. The phase that includes @@ -63,6 +87,8 @@ class RepairRolloutRule extends \Google\Protobuf\Internal\Message * `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. * @type \Google\Cloud\Deploy\V1\AutomationRuleCondition $condition * Output only. Information around the state of the 'Automation' rule. + * @type array<\Google\Cloud\Deploy\V1\RepairPhaseConfig>|\Google\Protobuf\Internal\RepeatedField $repair_phases + * Required. Defines the types of automatic repair phases for failed jobs. * } */ public function __construct($data = NULL) { @@ -100,6 +126,42 @@ public function setId($var) return $this; } + /** + * Optional. Phases within which jobs are subject to automatic repair actions + * on failure. Proceeds only after phase name matched any one in the list, or + * for all phases if unspecified. This value must consist of lower-case + * letters, numbers, and hyphens, start with a letter and end with a letter or + * a number, and have a max length of 63 characters. In other words, it must + * match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + * + * Generated from protobuf field repeated string phases = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPhases() + { + return $this->phases; + } + + /** + * Optional. Phases within which jobs are subject to automatic repair actions + * on failure. Proceeds only after phase name matched any one in the list, or + * for all phases if unspecified. This value must consist of lower-case + * letters, numbers, and hyphens, start with a letter and end with a letter or + * a number, and have a max length of 63 characters. In other words, it must + * match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + * + * Generated from protobuf field repeated string phases = 7 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPhases($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->phases = $arr; + + return $this; + } + /** * Optional. Jobs to repair. Proceeds only after job name matched any one in * the list, or for all jobs if unspecified or empty. The phase that includes @@ -174,5 +236,31 @@ public function setCondition($var) return $this; } + /** + * Required. Defines the types of automatic repair phases for failed jobs. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.RepairPhaseConfig repair_phases = 8 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getRepairPhases() + { + return $this->repair_phases; + } + + /** + * Required. Defines the types of automatic repair phases for failed jobs. + * + * Generated from protobuf field repeated .google.cloud.deploy.v1.RepairPhaseConfig repair_phases = 8 [(.google.api.field_behavior) = REQUIRED]; + * @param array<\Google\Cloud\Deploy\V1\RepairPhaseConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setRepairPhases($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Deploy\V1\RepairPhaseConfig::class); + $this->repair_phases = $arr; + + return $this; + } + } diff --git a/Deploy/src/V1/Rollback.php b/Deploy/src/V1/Rollback.php index 62a577b8775e..6d1360a23bcd 100644 --- a/Deploy/src/V1/Rollback.php +++ b/Deploy/src/V1/Rollback.php @@ -22,6 +22,13 @@ class Rollback extends \Google\Protobuf\Internal\Message * Generated from protobuf field string destination_phase = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $destination_phase = ''; + /** + * Optional. If pending rollout exists on the target, the rollback operation + * will be aborted. + * + * Generated from protobuf field bool disable_rollback_if_rollout_pending = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disable_rollback_if_rollout_pending = false; /** * Constructor. @@ -32,6 +39,9 @@ class Rollback extends \Google\Protobuf\Internal\Message * @type string $destination_phase * Optional. The starting phase ID for the `Rollout`. If unspecified, the * `Rollout` will start in the stable phase. + * @type bool $disable_rollback_if_rollout_pending + * Optional. If pending rollout exists on the target, the rollback operation + * will be aborted. * } */ public function __construct($data = NULL) { @@ -67,5 +77,33 @@ public function setDestinationPhase($var) return $this; } + /** + * Optional. If pending rollout exists on the target, the rollback operation + * will be aborted. + * + * Generated from protobuf field bool disable_rollback_if_rollout_pending = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getDisableRollbackIfRolloutPending() + { + return $this->disable_rollback_if_rollout_pending; + } + + /** + * Optional. If pending rollout exists on the target, the rollback operation + * will be aborted. + * + * Generated from protobuf field bool disable_rollback_if_rollout_pending = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setDisableRollbackIfRolloutPending($var) + { + GPBUtil::checkBool($var); + $this->disable_rollback_if_rollout_pending = $var; + + return $this; + } + } diff --git a/Deploy/src/V1/RollbackAttempt.php b/Deploy/src/V1/RollbackAttempt.php index 6cf2b0dae8d7..06b230ee7b7f 100644 --- a/Deploy/src/V1/RollbackAttempt.php +++ b/Deploy/src/V1/RollbackAttempt.php @@ -39,6 +39,12 @@ class RollbackAttempt extends \Google\Protobuf\Internal\Message * Generated from protobuf field string state_desc = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $state_desc = ''; + /** + * Output only. If active rollout exists on the target, abort this rollback. + * + * Generated from protobuf field bool disable_rollback_if_rollout_pending = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $disable_rollback_if_rollout_pending = false; /** * Constructor. @@ -54,6 +60,8 @@ class RollbackAttempt extends \Google\Protobuf\Internal\Message * Output only. Valid state of this rollback action. * @type string $state_desc * Output only. Description of the state of the Rollback. + * @type bool $disable_rollback_if_rollout_pending + * Output only. If active rollout exists on the target, abort this rollback. * } */ public function __construct($data = NULL) { @@ -165,5 +173,31 @@ public function setStateDesc($var) return $this; } + /** + * Output only. If active rollout exists on the target, abort this rollback. + * + * Generated from protobuf field bool disable_rollback_if_rollout_pending = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getDisableRollbackIfRolloutPending() + { + return $this->disable_rollback_if_rollout_pending; + } + + /** + * Output only. If active rollout exists on the target, abort this rollback. + * + * Generated from protobuf field bool disable_rollback_if_rollout_pending = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setDisableRollbackIfRolloutPending($var) + { + GPBUtil::checkBool($var); + $this->disable_rollback_if_rollout_pending = $var; + + return $this; + } + } diff --git a/Deploy/src/V1/Rollout.php b/Deploy/src/V1/Rollout.php index 4a50ee1c678b..889163f01844 100644 --- a/Deploy/src/V1/Rollout.php +++ b/Deploy/src/V1/Rollout.php @@ -169,6 +169,12 @@ class Rollout extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $rolled_back_by_rollouts; + /** + * Output only. The AutomationRun actively repairing the rollout. + * + * Generated from protobuf field string active_repair_automation_run = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $active_repair_automation_run = ''; /** * Constructor. @@ -241,6 +247,8 @@ class Rollout extends \Google\Protobuf\Internal\Message * Empty if this `Rollout` wasn't created as a rollback. * @type array|\Google\Protobuf\Internal\RepeatedField $rolled_back_by_rollouts * Output only. Names of `Rollouts` that rolled back this `Rollout`. + * @type string $active_repair_automation_run + * Output only. The AutomationRun actively repairing the rollout. * } */ public function __construct($data = NULL) { @@ -922,5 +930,31 @@ public function setRolledBackByRollouts($var) return $this; } + /** + * Output only. The AutomationRun actively repairing the rollout. + * + * Generated from protobuf field string active_repair_automation_run = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getActiveRepairAutomationRun() + { + return $this->active_repair_automation_run; + } + + /** + * Output only. The AutomationRun actively repairing the rollout. + * + * Generated from protobuf field string active_repair_automation_run = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setActiveRepairAutomationRun($var) + { + GPBUtil::checkString($var, True); + $this->active_repair_automation_run = $var; + + return $this; + } + } diff --git a/Deploy/src/V1/Target.php b/Deploy/src/V1/Target.php index 8e17d8f3b811..70f1b0a03e49 100644 --- a/Deploy/src/V1/Target.php +++ b/Deploy/src/V1/Target.php @@ -84,6 +84,19 @@ class Target extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $update_time = null; + /** + * Optional. Map of entity IDs to their associated entities. Associated + * entities allows specifying places other than the deployment target for + * specific features. For example, the Gateway API canary can be configured to + * deploy the HTTPRoute to a different cluster(s) than the deployment cluster + * using associated entities. An entity ID must consist of lower-case letters, + * numbers, and hyphens, start with a letter and end with a letter or a + * number, and have a max length of 63 characters. In other words, it must + * match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + * + * Generated from protobuf field map associated_entities = 23 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $associated_entities; /** * Optional. This checksum is computed by the server based on the value of * other fields, and may be sent on update and delete requests to ensure the @@ -159,6 +172,15 @@ class Target extends \Google\Protobuf\Internal\Message * Optional. Information specifying a multiTarget. * @type \Google\Cloud\Deploy\V1\CustomTarget $custom_target * Optional. Information specifying a Custom Target. + * @type array|\Google\Protobuf\Internal\MapField $associated_entities + * Optional. Map of entity IDs to their associated entities. Associated + * entities allows specifying places other than the deployment target for + * specific features. For example, the Gateway API canary can be configured to + * deploy the HTTPRoute to a different cluster(s) than the deployment cluster + * using associated entities. An entity ID must consist of lower-case letters, + * numbers, and hyphens, start with a letter and end with a letter or a + * number, and have a max length of 63 characters. In other words, it must + * match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. * @type string $etag * Optional. This checksum is computed by the server based on the value of * other fields, and may be sent on update and delete requests to ensure the @@ -615,6 +637,46 @@ public function setCustomTarget($var) return $this; } + /** + * Optional. Map of entity IDs to their associated entities. Associated + * entities allows specifying places other than the deployment target for + * specific features. For example, the Gateway API canary can be configured to + * deploy the HTTPRoute to a different cluster(s) than the deployment cluster + * using associated entities. An entity ID must consist of lower-case letters, + * numbers, and hyphens, start with a letter and end with a letter or a + * number, and have a max length of 63 characters. In other words, it must + * match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + * + * Generated from protobuf field map associated_entities = 23 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getAssociatedEntities() + { + return $this->associated_entities; + } + + /** + * Optional. Map of entity IDs to their associated entities. Associated + * entities allows specifying places other than the deployment target for + * specific features. For example, the Gateway API canary can be configured to + * deploy the HTTPRoute to a different cluster(s) than the deployment cluster + * using associated entities. An entity ID must consist of lower-case letters, + * numbers, and hyphens, start with a letter and end with a letter or a + * number, and have a max length of 63 characters. In other words, it must + * match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + * + * Generated from protobuf field map associated_entities = 23 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setAssociatedEntities($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Deploy\V1\AssociatedEntities::class); + $this->associated_entities = $arr; + + return $this; + } + /** * Optional. This checksum is computed by the server based on the value of * other fields, and may be sent on update and delete requests to ensure the diff --git a/Deploy/tests/Unit/V1/Client/CloudDeployClientTest.php b/Deploy/tests/Unit/V1/Client/CloudDeployClientTest.php index afb8c134eed8..9229e8618074 100644 --- a/Deploy/tests/Unit/V1/Client/CloudDeployClientTest.php +++ b/Deploy/tests/Unit/V1/Client/CloudDeployClientTest.php @@ -1306,6 +1306,7 @@ public function createRolloutTest() $etag = 'etag3123477'; $controllerRollout = 'controllerRollout-146558962'; $rollbackOfRollout = 'rollbackOfRollout-1880699004'; + $activeRepairAutomationRun = 'activeRepairAutomationRun-2089265700'; $expectedResponse = new Rollout(); $expectedResponse->setName($name); $expectedResponse->setUid($uid); @@ -1316,6 +1317,7 @@ public function createRolloutTest() $expectedResponse->setEtag($etag); $expectedResponse->setControllerRollout($controllerRollout); $expectedResponse->setRollbackOfRollout($rollbackOfRollout); + $expectedResponse->setActiveRepairAutomationRun($activeRepairAutomationRun); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -2824,6 +2826,7 @@ public function getRolloutTest() $etag = 'etag3123477'; $controllerRollout = 'controllerRollout-146558962'; $rollbackOfRollout = 'rollbackOfRollout-1880699004'; + $activeRepairAutomationRun = 'activeRepairAutomationRun-2089265700'; $expectedResponse = new Rollout(); $expectedResponse->setName($name2); $expectedResponse->setUid($uid); @@ -2834,6 +2837,7 @@ public function getRolloutTest() $expectedResponse->setEtag($etag); $expectedResponse->setControllerRollout($controllerRollout); $expectedResponse->setRollbackOfRollout($rollbackOfRollout); + $expectedResponse->setActiveRepairAutomationRun($activeRepairAutomationRun); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->rolloutName( From c05937252134d063c790ec8a1b4ab62e24d5a2e2 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 1 Nov 2024 14:21:53 -0400 Subject: [PATCH 062/157] docs: publishing v1beta version of Memorystore API (#7787) * feat: publishing v1beta version of Memorystore API PiperOrigin-RevId: 691872215 Source-Link: https://github.com/googleapis/googleapis/commit/0a0f55aa7a758961a57e8fd9ef1b7f3df677a942 Source-Link: https://github.com/googleapis/googleapis-gen/commit/0439389bd3aa34cbb5461a6e4530cfdc6947d3b3 Copy-Tag: eyJwIjoiRGlhbG9nZmxvd0N4Ly5Pd2xCb3QueWFtbCIsImgiOiIwNDM5Mzg5YmQzYWEzNGNiYjU0NjFhNmU0NTMwY2ZkYzY5NDdkM2IzIn0= --- DialogflowCx/src/V3/Client/AgentsClient.php | 26 ++++++++--------- .../src/V3/Client/ChangelogsClient.php | 8 +++--- .../src/V3/Client/DeploymentsClient.php | 8 +++--- .../src/V3/Client/EntityTypesClient.php | 18 ++++++------ .../src/V3/Client/EnvironmentsClient.php | 22 +++++++-------- .../src/V3/Client/ExperimentsClient.php | 18 ++++++------ DialogflowCx/src/V3/Client/FlowsClient.php | 24 ++++++++-------- .../src/V3/Client/GeneratorsClient.php | 14 +++++----- DialogflowCx/src/V3/Client/IntentsClient.php | 18 ++++++------ DialogflowCx/src/V3/Client/PagesClient.php | 14 +++++----- .../Client/SecuritySettingsServiceClient.php | 14 +++++----- .../V3/Client/SessionEntityTypesClient.php | 14 +++++----- DialogflowCx/src/V3/Client/SessionsClient.php | 12 ++++---- .../src/V3/Client/TestCasesClient.php | 28 +++++++++---------- .../V3/Client/TransitionRouteGroupsClient.php | 14 +++++----- DialogflowCx/src/V3/Client/VersionsClient.php | 18 ++++++------ DialogflowCx/src/V3/Client/WebhooksClient.php | 14 +++++----- 17 files changed, 142 insertions(+), 142 deletions(-) diff --git a/DialogflowCx/src/V3/Client/AgentsClient.php b/DialogflowCx/src/V3/Client/AgentsClient.php index e0d1a4da8944..449ba5083be5 100644 --- a/DialogflowCx/src/V3/Client/AgentsClient.php +++ b/DialogflowCx/src/V3/Client/AgentsClient.php @@ -68,19 +68,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAgentAsync(CreateAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAgentAsync(DeleteAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportAgentAsync(ExportAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAgentAsync(GetAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAgentValidationResultAsync(GetAgentValidationResultRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGenerativeSettingsAsync(GetGenerativeSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAgentsAsync(ListAgentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreAgentAsync(RestoreAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAgentAsync(UpdateAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGenerativeSettingsAsync(UpdateGenerativeSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateAgentAsync(ValidateAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAgentAsync(CreateAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAgentAsync(DeleteAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportAgentAsync(ExportAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAgentAsync(GetAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAgentValidationResultAsync(GetAgentValidationResultRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGenerativeSettingsAsync(GetGenerativeSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAgentsAsync(ListAgentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreAgentAsync(RestoreAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAgentAsync(UpdateAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGenerativeSettingsAsync(UpdateGenerativeSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateAgentAsync(ValidateAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class AgentsClient { diff --git a/DialogflowCx/src/V3/Client/ChangelogsClient.php b/DialogflowCx/src/V3/Client/ChangelogsClient.php index b7111e93a19c..e252d971a9e3 100644 --- a/DialogflowCx/src/V3/Client/ChangelogsClient.php +++ b/DialogflowCx/src/V3/Client/ChangelogsClient.php @@ -52,10 +52,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getChangelogAsync(GetChangelogRequest $request, array $optionalArgs = []) - * @method PromiseInterface listChangelogsAsync(ListChangelogsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getChangelogAsync(GetChangelogRequest $request, array $optionalArgs = []) + * @method PromiseInterface listChangelogsAsync(ListChangelogsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ChangelogsClient { diff --git a/DialogflowCx/src/V3/Client/DeploymentsClient.php b/DialogflowCx/src/V3/Client/DeploymentsClient.php index 7f3af796b52a..9237c4881c7b 100644 --- a/DialogflowCx/src/V3/Client/DeploymentsClient.php +++ b/DialogflowCx/src/V3/Client/DeploymentsClient.php @@ -52,10 +52,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DeploymentsClient { diff --git a/DialogflowCx/src/V3/Client/EntityTypesClient.php b/DialogflowCx/src/V3/Client/EntityTypesClient.php index 57afbb660299..ba63e97b9da9 100644 --- a/DialogflowCx/src/V3/Client/EntityTypesClient.php +++ b/DialogflowCx/src/V3/Client/EntityTypesClient.php @@ -60,15 +60,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEntityTypeAsync(CreateEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntityTypeAsync(DeleteEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportEntityTypesAsync(ExportEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntityTypeAsync(GetEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface importEntityTypesAsync(ImportEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntityTypesAsync(ListEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntityTypeAsync(UpdateEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntityTypeAsync(CreateEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntityTypeAsync(DeleteEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportEntityTypesAsync(ExportEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntityTypeAsync(GetEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface importEntityTypesAsync(ImportEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntityTypesAsync(ListEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntityTypeAsync(UpdateEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class EntityTypesClient { diff --git a/DialogflowCx/src/V3/Client/EnvironmentsClient.php b/DialogflowCx/src/V3/Client/EnvironmentsClient.php index e8ead5abb135..9ffa36d36cf8 100644 --- a/DialogflowCx/src/V3/Client/EnvironmentsClient.php +++ b/DialogflowCx/src/V3/Client/EnvironmentsClient.php @@ -68,17 +68,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deployFlowAsync(DeployFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listContinuousTestResultsAsync(ListContinuousTestResultsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface runContinuousTestAsync(RunContinuousTestRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEnvironmentAsync(UpdateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deployFlowAsync(DeployFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listContinuousTestResultsAsync(ListContinuousTestResultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupEnvironmentHistoryAsync(LookupEnvironmentHistoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface runContinuousTestAsync(RunContinuousTestRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEnvironmentAsync(UpdateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class EnvironmentsClient { diff --git a/DialogflowCx/src/V3/Client/ExperimentsClient.php b/DialogflowCx/src/V3/Client/ExperimentsClient.php index e8693b42c482..6a5e36b9c148 100644 --- a/DialogflowCx/src/V3/Client/ExperimentsClient.php +++ b/DialogflowCx/src/V3/Client/ExperimentsClient.php @@ -57,15 +57,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createExperimentAsync(CreateExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteExperimentAsync(DeleteExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExperimentAsync(GetExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExperimentsAsync(ListExperimentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface startExperimentAsync(StartExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopExperimentAsync(StopExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExperimentAsync(UpdateExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExperimentAsync(CreateExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteExperimentAsync(DeleteExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExperimentAsync(GetExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExperimentsAsync(ListExperimentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface startExperimentAsync(StartExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopExperimentAsync(StopExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExperimentAsync(UpdateExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ExperimentsClient { diff --git a/DialogflowCx/src/V3/Client/FlowsClient.php b/DialogflowCx/src/V3/Client/FlowsClient.php index f6d1974f7d3a..23d1e6a27e76 100644 --- a/DialogflowCx/src/V3/Client/FlowsClient.php +++ b/DialogflowCx/src/V3/Client/FlowsClient.php @@ -67,18 +67,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createFlowAsync(CreateFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFlowAsync(DeleteFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportFlowAsync(ExportFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFlowAsync(GetFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFlowValidationResultAsync(GetFlowValidationResultRequest $request, array $optionalArgs = []) - * @method PromiseInterface importFlowAsync(ImportFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFlowsAsync(ListFlowsRequest $request, array $optionalArgs = []) - * @method PromiseInterface trainFlowAsync(TrainFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFlowAsync(UpdateFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateFlowAsync(ValidateFlowRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFlowAsync(CreateFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFlowAsync(DeleteFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportFlowAsync(ExportFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFlowAsync(GetFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFlowValidationResultAsync(GetFlowValidationResultRequest $request, array $optionalArgs = []) + * @method PromiseInterface importFlowAsync(ImportFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFlowsAsync(ListFlowsRequest $request, array $optionalArgs = []) + * @method PromiseInterface trainFlowAsync(TrainFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFlowAsync(UpdateFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateFlowAsync(ValidateFlowRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class FlowsClient { diff --git a/DialogflowCx/src/V3/Client/GeneratorsClient.php b/DialogflowCx/src/V3/Client/GeneratorsClient.php index b4811d5e107c..06a029f98367 100644 --- a/DialogflowCx/src/V3/Client/GeneratorsClient.php +++ b/DialogflowCx/src/V3/Client/GeneratorsClient.php @@ -55,13 +55,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createGeneratorAsync(CreateGeneratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGeneratorAsync(DeleteGeneratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGeneratorAsync(GetGeneratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGeneratorsAsync(ListGeneratorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGeneratorAsync(UpdateGeneratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGeneratorAsync(CreateGeneratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGeneratorAsync(DeleteGeneratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGeneratorAsync(GetGeneratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGeneratorsAsync(ListGeneratorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGeneratorAsync(UpdateGeneratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class GeneratorsClient { diff --git a/DialogflowCx/src/V3/Client/IntentsClient.php b/DialogflowCx/src/V3/Client/IntentsClient.php index b3878433f39a..1e0221c62be3 100644 --- a/DialogflowCx/src/V3/Client/IntentsClient.php +++ b/DialogflowCx/src/V3/Client/IntentsClient.php @@ -64,15 +64,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createIntentAsync(CreateIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIntentAsync(DeleteIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportIntentsAsync(ExportIntentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIntentAsync(GetIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface importIntentsAsync(ImportIntentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIntentsAsync(ListIntentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateIntentAsync(UpdateIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIntentAsync(CreateIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIntentAsync(DeleteIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportIntentsAsync(ExportIntentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIntentAsync(GetIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface importIntentsAsync(ImportIntentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIntentsAsync(ListIntentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateIntentAsync(UpdateIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class IntentsClient { diff --git a/DialogflowCx/src/V3/Client/PagesClient.php b/DialogflowCx/src/V3/Client/PagesClient.php index 010c5a819fbe..192df1258a9a 100644 --- a/DialogflowCx/src/V3/Client/PagesClient.php +++ b/DialogflowCx/src/V3/Client/PagesClient.php @@ -55,13 +55,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createPageAsync(CreatePageRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePageAsync(DeletePageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPageAsync(GetPageRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPagesAsync(ListPagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePageAsync(UpdatePageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPageAsync(CreatePageRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePageAsync(DeletePageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPageAsync(GetPageRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPagesAsync(ListPagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePageAsync(UpdatePageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class PagesClient { diff --git a/DialogflowCx/src/V3/Client/SecuritySettingsServiceClient.php b/DialogflowCx/src/V3/Client/SecuritySettingsServiceClient.php index bfb249c70ebf..5fcd183ed17b 100644 --- a/DialogflowCx/src/V3/Client/SecuritySettingsServiceClient.php +++ b/DialogflowCx/src/V3/Client/SecuritySettingsServiceClient.php @@ -55,13 +55,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSecuritySettingsAsync(CreateSecuritySettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSecuritySettingsAsync(DeleteSecuritySettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSecuritySettingsAsync(GetSecuritySettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSecuritySettingsAsync(ListSecuritySettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSecuritySettingsAsync(UpdateSecuritySettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSecuritySettingsAsync(CreateSecuritySettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSecuritySettingsAsync(DeleteSecuritySettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSecuritySettingsAsync(GetSecuritySettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSecuritySettingsAsync(ListSecuritySettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSecuritySettingsAsync(UpdateSecuritySettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SecuritySettingsServiceClient { diff --git a/DialogflowCx/src/V3/Client/SessionEntityTypesClient.php b/DialogflowCx/src/V3/Client/SessionEntityTypesClient.php index 0b94fa6a15b3..701660c4326c 100644 --- a/DialogflowCx/src/V3/Client/SessionEntityTypesClient.php +++ b/DialogflowCx/src/V3/Client/SessionEntityTypesClient.php @@ -56,13 +56,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSessionEntityTypeAsync(CreateSessionEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSessionEntityTypeAsync(DeleteSessionEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSessionEntityTypeAsync(GetSessionEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSessionEntityTypesAsync(ListSessionEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSessionEntityTypeAsync(UpdateSessionEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSessionEntityTypeAsync(CreateSessionEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSessionEntityTypeAsync(DeleteSessionEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSessionEntityTypeAsync(GetSessionEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSessionEntityTypesAsync(ListSessionEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSessionEntityTypeAsync(UpdateSessionEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SessionEntityTypesClient { diff --git a/DialogflowCx/src/V3/Client/SessionsClient.php b/DialogflowCx/src/V3/Client/SessionsClient.php index 40e0ccbb2cfc..2de267a63af4 100644 --- a/DialogflowCx/src/V3/Client/SessionsClient.php +++ b/DialogflowCx/src/V3/Client/SessionsClient.php @@ -62,12 +62,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface detectIntentAsync(DetectIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface fulfillIntentAsync(FulfillIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface matchIntentAsync(MatchIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface submitAnswerFeedbackAsync(SubmitAnswerFeedbackRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface detectIntentAsync(DetectIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface fulfillIntentAsync(FulfillIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface matchIntentAsync(MatchIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface submitAnswerFeedbackAsync(SubmitAnswerFeedbackRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SessionsClient { diff --git a/DialogflowCx/src/V3/Client/TestCasesClient.php b/DialogflowCx/src/V3/Client/TestCasesClient.php index 08dfcf67129a..e0815be9629c 100644 --- a/DialogflowCx/src/V3/Client/TestCasesClient.php +++ b/DialogflowCx/src/V3/Client/TestCasesClient.php @@ -76,20 +76,20 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchDeleteTestCasesAsync(BatchDeleteTestCasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchRunTestCasesAsync(BatchRunTestCasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface calculateCoverageAsync(CalculateCoverageRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTestCaseAsync(CreateTestCaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportTestCasesAsync(ExportTestCasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTestCaseAsync(GetTestCaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTestCaseResultAsync(GetTestCaseResultRequest $request, array $optionalArgs = []) - * @method PromiseInterface importTestCasesAsync(ImportTestCasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTestCaseResultsAsync(ListTestCaseResultsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTestCasesAsync(ListTestCasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface runTestCaseAsync(RunTestCaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTestCaseAsync(UpdateTestCaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeleteTestCasesAsync(BatchDeleteTestCasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchRunTestCasesAsync(BatchRunTestCasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface calculateCoverageAsync(CalculateCoverageRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTestCaseAsync(CreateTestCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportTestCasesAsync(ExportTestCasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTestCaseAsync(GetTestCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTestCaseResultAsync(GetTestCaseResultRequest $request, array $optionalArgs = []) + * @method PromiseInterface importTestCasesAsync(ImportTestCasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTestCaseResultsAsync(ListTestCaseResultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTestCasesAsync(ListTestCasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface runTestCaseAsync(RunTestCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTestCaseAsync(UpdateTestCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class TestCasesClient { diff --git a/DialogflowCx/src/V3/Client/TransitionRouteGroupsClient.php b/DialogflowCx/src/V3/Client/TransitionRouteGroupsClient.php index 5d467d41cfd3..19e56d3e659c 100644 --- a/DialogflowCx/src/V3/Client/TransitionRouteGroupsClient.php +++ b/DialogflowCx/src/V3/Client/TransitionRouteGroupsClient.php @@ -56,13 +56,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTransitionRouteGroupAsync(CreateTransitionRouteGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTransitionRouteGroupAsync(DeleteTransitionRouteGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTransitionRouteGroupAsync(GetTransitionRouteGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTransitionRouteGroupsAsync(ListTransitionRouteGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTransitionRouteGroupAsync(UpdateTransitionRouteGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTransitionRouteGroupAsync(CreateTransitionRouteGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTransitionRouteGroupAsync(DeleteTransitionRouteGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTransitionRouteGroupAsync(GetTransitionRouteGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTransitionRouteGroupsAsync(ListTransitionRouteGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTransitionRouteGroupAsync(UpdateTransitionRouteGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class TransitionRouteGroupsClient { diff --git a/DialogflowCx/src/V3/Client/VersionsClient.php b/DialogflowCx/src/V3/Client/VersionsClient.php index 799b5072c5b5..9fa9e7aaa275 100644 --- a/DialogflowCx/src/V3/Client/VersionsClient.php +++ b/DialogflowCx/src/V3/Client/VersionsClient.php @@ -63,15 +63,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface compareVersionsAsync(CompareVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createVersionAsync(CreateVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface loadVersionAsync(LoadVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface compareVersionsAsync(CompareVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVersionAsync(CreateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface loadVersionAsync(LoadVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class VersionsClient { diff --git a/DialogflowCx/src/V3/Client/WebhooksClient.php b/DialogflowCx/src/V3/Client/WebhooksClient.php index ef05bd419f50..e222e070527c 100644 --- a/DialogflowCx/src/V3/Client/WebhooksClient.php +++ b/DialogflowCx/src/V3/Client/WebhooksClient.php @@ -55,13 +55,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createWebhookAsync(CreateWebhookRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWebhookAsync(DeleteWebhookRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWebhookAsync(GetWebhookRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWebhooksAsync(ListWebhooksRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateWebhookAsync(UpdateWebhookRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWebhookAsync(CreateWebhookRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWebhookAsync(DeleteWebhookRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWebhookAsync(GetWebhookRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWebhooksAsync(ListWebhooksRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateWebhookAsync(UpdateWebhookRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class WebhooksClient { From 880808c36024e72b5142cf85fb02b9fe708cd178 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 1 Nov 2024 14:24:29 -0400 Subject: [PATCH 063/157] docs: add response types for async magic methods (#7784) PiperOrigin-RevId: 691866489 Source-Link: https://github.com/googleapis/googleapis/commit/cf0f35efca7e0d507af89e9ddc46cba2f41eb9f7 Source-Link: https://github.com/googleapis/googleapis-gen/commit/e556aaed2dc6f46b6ff8cc769fabadcfbe2504a4 Copy-Tag: eyJwIjoiQWNjZXNzQXBwcm92YWwvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQWRzQWRNYW5hZ2VyLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQWR2aXNvcnlOb3RpZmljYXRpb25zLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQWxsb3lEYi8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQW5hbHl0aWNzQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQW5hbHl0aWNzRGF0YS8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQXBpR2F0ZXdheS8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQXBpSHViLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQXBpS2V5cy8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQXBpZ2VlQ29ubmVjdC8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQXBpZ2VlUmVnaXN0cnkvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQXBwRW5naW5lQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQXBwSHViLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQXBwc0NoYXQvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQXBwc0V2ZW50c1N1YnNjcmlwdGlvbnMvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQXBwc01lZXQvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQXNzZXQvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQXNzdXJlZFdvcmtsb2Fkcy8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQXV0b01sLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQmFja3VwRHIvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== --- .../src/V1/Client/AccessApprovalClient.php | 18 +- AdsAdManager/metadata/V1/AdUnitEnums.php | Bin 1115 -> 1144 bytes AdsAdManager/metadata/V1/AdUnitMessages.php | Bin 3739 -> 3768 bytes AdsAdManager/metadata/V1/AdUnitService.php | 6 +- AdsAdManager/metadata/V1/AdmanagerError.php | 6 +- AdsAdManager/metadata/V1/AppliedLabel.php | 6 +- .../metadata/V1/CompanyCreditStatusEnum.php | Bin 1005 -> 1034 bytes AdsAdManager/metadata/V1/CompanyMessages.php | Bin 2216 -> 2245 bytes AdsAdManager/metadata/V1/CompanyService.php | 6 +- AdsAdManager/metadata/V1/CompanyTypeEnum.php | Bin 968 -> 997 bytes AdsAdManager/metadata/V1/ContactMessages.php | 6 +- AdsAdManager/metadata/V1/CustomFieldEnums.php | Bin 1388 -> 1417 bytes .../metadata/V1/CustomFieldMessages.php | 6 +- .../metadata/V1/CustomFieldService.php | 6 +- AdsAdManager/metadata/V1/CustomFieldValue.php | Bin 1252 -> 1281 bytes .../metadata/V1/CustomTargetingKeyEnums.php | Bin 1285 -> 1314 bytes .../V1/CustomTargetingKeyMessages.php | 6 +- .../metadata/V1/CustomTargetingKeyService.php | 6 +- .../metadata/V1/CustomTargetingValueEnums.php | Bin 1200 -> 1229 bytes .../V1/CustomTargetingValueMessages.php | 6 +- .../V1/CustomTargetingValueService.php | 7 +- .../V1/EntitySignalsMappingMessages.php | Bin 1411 -> 1440 bytes .../V1/EntitySignalsMappingService.php | 6 +- .../metadata/V1/EnvironmentTypeEnum.php | Bin 942 -> 971 bytes AdsAdManager/metadata/V1/FrequencyCap.php | Bin 1071 -> 1100 bytes AdsAdManager/metadata/V1/LabelMessages.php | 6 +- AdsAdManager/metadata/V1/NetworkMessages.php | 6 +- AdsAdManager/metadata/V1/NetworkService.php | 6 +- AdsAdManager/metadata/V1/OrderEnums.php | Bin 966 -> 995 bytes AdsAdManager/metadata/V1/OrderMessages.php | 6 +- AdsAdManager/metadata/V1/OrderService.php | 6 +- AdsAdManager/metadata/V1/PlacementEnums.php | Bin 929 -> 958 bytes .../metadata/V1/PlacementMessages.php | 6 +- AdsAdManager/metadata/V1/PlacementService.php | 6 +- AdsAdManager/metadata/V1/ReportService.php | Bin 35098 -> 35127 bytes AdsAdManager/metadata/V1/RoleEnums.php | Bin 880 -> 909 bytes AdsAdManager/metadata/V1/RoleMessages.php | 6 +- AdsAdManager/metadata/V1/RoleService.php | 6 +- AdsAdManager/metadata/V1/Size.php | 6 +- AdsAdManager/metadata/V1/SizeTypeEnum.php | Bin 958 -> 987 bytes .../metadata/V1/TaxonomyCategoryMessages.php | 6 +- .../metadata/V1/TaxonomyCategoryService.php | 7 +- AdsAdManager/metadata/V1/TaxonomyTypeEnum.php | Bin 1055 -> 1084 bytes AdsAdManager/metadata/V1/TeamMessages.php | 6 +- AdsAdManager/metadata/V1/TimeUnitEnum.php | Bin 950 -> 979 bytes AdsAdManager/metadata/V1/UserMessages.php | 6 +- AdsAdManager/metadata/V1/UserService.php | 6 +- .../src/V1/Client/AdUnitServiceClient.php | 6 +- .../src/V1/Client/CompanyServiceClient.php | 4 +- .../V1/Client/CustomFieldServiceClient.php | 4 +- .../CustomTargetingKeyServiceClient.php | 4 +- .../CustomTargetingValueServiceClient.php | 4 +- .../EntitySignalsMappingServiceClient.php | 12 +- .../src/V1/Client/NetworkServiceClient.php | 4 +- .../src/V1/Client/OrderServiceClient.php | 4 +- .../src/V1/Client/PlacementServiceClient.php | 4 +- .../src/V1/Client/ReportServiceClient.php | 12 +- .../src/V1/Client/RoleServiceClient.php | 4 +- .../Client/TaxonomyCategoryServiceClient.php | 4 +- .../src/V1/Client/UserServiceClient.php | 2 +- .../AdvisoryNotificationsServiceClient.php | 8 +- AlloyDb/src/V1/Client/AlloyDBAdminClient.php | 72 ++--- .../Client/AnalyticsAdminServiceClient.php | 300 +++++++++--------- .../Client/AnalyticsAdminServiceClient.php | 108 +++---- .../Client/AlphaAnalyticsDataClient.php | 28 +- .../V1beta/Client/BetaAnalyticsDataClient.php | 22 +- .../src/V1/Client/ApiGatewayServiceClient.php | 30 +- ApiHub/src/V1/Client/ApiHubClient.php | 74 ++--- .../V1/Client/ApiHubDependenciesClient.php | 14 +- ApiHub/src/V1/Client/ApiHubPluginClient.php | 10 +- .../HostProjectRegistrationServiceClient.php | 10 +- ApiHub/src/V1/Client/LintingServiceClient.php | 12 +- ApiHub/src/V1/Client/ProvisioningClient.php | 10 +- .../RuntimeProjectAttachmentServiceClient.php | 14 +- ApiKeys/src/V2/Client/ApiKeysClient.php | 16 +- .../src/V1/Client/ConnectionServiceClient.php | 2 +- .../src/V1/Client/ProvisioningClient.php | 16 +- .../src/V1/Client/RegistryClient.php | 80 ++--- .../src/V1/Client/ApplicationsClient.php | 8 +- .../Client/AuthorizedCertificatesClient.php | 10 +- .../src/V1/Client/AuthorizedDomainsClient.php | 2 +- .../src/V1/Client/DomainMappingsClient.php | 10 +- .../src/V1/Client/FirewallClient.php | 12 +- .../src/V1/Client/InstancesClient.php | 8 +- .../src/V1/Client/ServicesClient.php | 8 +- .../src/V1/Client/VersionsClient.php | 10 +- AppHub/src/V1/Client/AppHubClient.php | 64 ++-- .../src/Chat/V1/Client/ChatServiceClient.php | 58 ++-- .../V1/Client/SubscriptionsServiceClient.php | 12 +- .../Client/ConferenceRecordsServiceClient.php | 24 +- .../src/V2/Client/SpacesServiceClient.php | 8 +- .../Client/ConferenceRecordsServiceClient.php | 24 +- .../src/V2beta/Client/SpacesServiceClient.php | 8 +- Asset/src/V1/Client/AssetServiceClient.php | 46 +-- .../Client/AssuredWorkloadsServiceClient.php | 18 +- .../Client/AssuredWorkloadsServiceClient.php | 14 +- AutoMl/src/V1/Client/AutoMlClient.php | 36 +-- .../src/V1/Client/PredictionServiceClient.php | 4 +- BackupDr/src/V1/Client/BackupDRClient.php | 64 ++-- 99 files changed, 762 insertions(+), 762 deletions(-) diff --git a/AccessApproval/src/V1/Client/AccessApprovalClient.php b/AccessApproval/src/V1/Client/AccessApprovalClient.php index 49b9332329d6..626d76c7bb23 100644 --- a/AccessApproval/src/V1/Client/AccessApprovalClient.php +++ b/AccessApproval/src/V1/Client/AccessApprovalClient.php @@ -90,15 +90,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface approveApprovalRequestAsync(ApproveApprovalRequestMessage $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccessApprovalSettingsAsync(DeleteAccessApprovalSettingsMessage $request, array $optionalArgs = []) - * @method PromiseInterface dismissApprovalRequestAsync(DismissApprovalRequestMessage $request, array $optionalArgs = []) - * @method PromiseInterface getAccessApprovalServiceAccountAsync(GetAccessApprovalServiceAccountMessage $request, array $optionalArgs = []) - * @method PromiseInterface getAccessApprovalSettingsAsync(GetAccessApprovalSettingsMessage $request, array $optionalArgs = []) - * @method PromiseInterface getApprovalRequestAsync(GetApprovalRequestMessage $request, array $optionalArgs = []) - * @method PromiseInterface invalidateApprovalRequestAsync(InvalidateApprovalRequestMessage $request, array $optionalArgs = []) - * @method PromiseInterface listApprovalRequestsAsync(ListApprovalRequestsMessage $request, array $optionalArgs = []) - * @method PromiseInterface updateAccessApprovalSettingsAsync(UpdateAccessApprovalSettingsMessage $request, array $optionalArgs = []) + * @method PromiseInterface approveApprovalRequestAsync(ApproveApprovalRequestMessage $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccessApprovalSettingsAsync(DeleteAccessApprovalSettingsMessage $request, array $optionalArgs = []) + * @method PromiseInterface dismissApprovalRequestAsync(DismissApprovalRequestMessage $request, array $optionalArgs = []) + * @method PromiseInterface getAccessApprovalServiceAccountAsync(GetAccessApprovalServiceAccountMessage $request, array $optionalArgs = []) + * @method PromiseInterface getAccessApprovalSettingsAsync(GetAccessApprovalSettingsMessage $request, array $optionalArgs = []) + * @method PromiseInterface getApprovalRequestAsync(GetApprovalRequestMessage $request, array $optionalArgs = []) + * @method PromiseInterface invalidateApprovalRequestAsync(InvalidateApprovalRequestMessage $request, array $optionalArgs = []) + * @method PromiseInterface listApprovalRequestsAsync(ListApprovalRequestsMessage $request, array $optionalArgs = []) + * @method PromiseInterface updateAccessApprovalSettingsAsync(UpdateAccessApprovalSettingsMessage $request, array $optionalArgs = []) */ final class AccessApprovalClient { diff --git a/AdsAdManager/metadata/V1/AdUnitEnums.php b/AdsAdManager/metadata/V1/AdUnitEnums.php index 25564e2ab81ea80be3ee8d322809208f757197eb..ae0af4b8f3e281456f79fec6ad1b9cba3b23558c 100644 GIT binary patch delta 58 zcmcc3@q=T-Lq?XfEL_?Xy|p(BFax0Sn`T&4w&_oQ$g`FW_A_Ih)TH0BGL`WB>pF diff --git a/AdsAdManager/metadata/V1/AdUnitService.php b/AdsAdManager/metadata/V1/AdUnitService.php index b5bac945497d..65811309fe0c 100644 --- a/AdsAdManager/metadata/V1/AdUnitService.php +++ b/AdsAdManager/metadata/V1/AdUnitService.php @@ -21,7 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -¿ +Ü -google/ads/admanager/v1/ad_unit_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"I GetAdUnitRequest5 name ( B\'àAúA! @@ -57,8 +57,8 @@ public static function initOnce() { AdUnitService‡ GetAdUnit).google.ads.admanager.v1.GetAdUnitRequest.google.ads.admanager.v1.AdUnit".ÚAname‚Óä“!/v1/{name=networks/*/adUnits/*}š ListAdUnits+.google.ads.admanager.v1.ListAdUnitsRequest,.google.ads.admanager.v1.ListAdUnitsResponse"0ÚAparent‚Óä“!/v1/{parent=networks/*}/adUnitsª -ListAdUnitSizes/.google.ads.admanager.v1.ListAdUnitSizesRequest0.google.ads.admanager.v1.ListAdUnitSizesResponse"4ÚAparent‚Óä“%#/v1/{parent=networks/*}/adUnitSizesÊAadmanager.googleapis.comB© -com.google.ads.admanager.v1BAdUnitServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +ListAdUnitSizes/.google.ads.admanager.v1.ListAdUnitSizesRequest0.google.ads.admanager.v1.ListAdUnitSizesResponse"4ÚAparent‚Óä“%#/v1/{parent=networks/*}/adUnitSizesÊAadmanager.googleapis.comBÆ +com.google.ads.admanager.v1BAdUnitServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/AdmanagerError.php b/AdsAdManager/metadata/V1/AdmanagerError.php index 8fc32636626a..a49f1ebb2779 100644 --- a/AdsAdManager/metadata/V1/AdmanagerError.php +++ b/AdsAdManager/metadata/V1/AdmanagerError.php @@ -17,7 +17,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Any::initOnce(); $pool->internalAddGeneratedFile( ' -– +³ -google/ads/admanager/v1/admanager_error.protogoogle.ads.admanager.v1"– AdManagerError @@ -27,8 +27,8 @@ public static function initOnce() { field_path (  trigger (  stack_trace ( % -details ( 2.google.protobuf.AnyBª -com.google.ads.admanager.v1BAdManagerErrorProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +details ( 2.google.protobuf.AnyBÇ +com.google.ads.admanager.v1BAdManagerErrorProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/AppliedLabel.php b/AdsAdManager/metadata/V1/AppliedLabel.php index ccf44e94926e..e23e5d79d3f6 100644 --- a/AdsAdManager/metadata/V1/AppliedLabel.php +++ b/AdsAdManager/metadata/V1/AppliedLabel.php @@ -18,13 +18,13 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -ì +‰ +google/ads/admanager/v1/applied_label.protogoogle.ads.admanager.v1google/api/resource.proto"V AppliedLabel5 label ( B&àAúA admanager.googleapis.com/Label -negated (B¨ -com.google.ads.admanager.v1BAppliedLabelProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +negated (BÅ +com.google.ads.admanager.v1BAppliedLabelProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/CompanyCreditStatusEnum.php b/AdsAdManager/metadata/V1/CompanyCreditStatusEnum.php index da04aa2a013a71883c545d76bcf1d64ff1c9f7c5..0966edc17e86850faa0330ff83d71c120f5aa5e1 100644 GIT binary patch delta 51 zcmaFM-o>%u7bD}b$-f!jGG3Vcl4-m2D<&!T{QUHsR4XgTlwuI!o0ylFo?2vOHF+Mh FKL9$U6i@&F delta 23 fcmeC;c+0-w7bD}!$-f!jGH#yyl4<+oz0AGcvNsh1v5)C7nk1T|I7-T=P>iLFrJvahJC&CD<&!T{QUHsR4XgTlwuI!o0ylF No?2vOH93;Q9{^ih6Y&55 delta 31 ncmX>qxI%D41vAStPAinternalAddGeneratedFile( ' -ß +ü -google/ads/admanager/v1/company_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"K GetCompanyRequest6 name ( B(àAúA" @@ -43,8 +43,8 @@ public static function initOnce() { CompanyServiceŒ GetCompany*.google.ads.admanager.v1.GetCompanyRequest .google.ads.admanager.v1.Company"0ÚAname‚Óä“#!/v1/{name=networks/*/companies/*}¢ - ListCompanies-.google.ads.admanager.v1.ListCompaniesRequest..google.ads.admanager.v1.ListCompaniesResponse"2ÚAparent‚Óä“#!/v1/{parent=networks/*}/companiesÊAadmanager.googleapis.comBª -com.google.ads.admanager.v1BCompanyServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + ListCompanies-.google.ads.admanager.v1.ListCompaniesRequest..google.ads.admanager.v1.ListCompaniesResponse"2ÚAparent‚Óä“#!/v1/{parent=networks/*}/companiesÊAadmanager.googleapis.comBÇ +com.google.ads.admanager.v1BCompanyServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/CompanyTypeEnum.php b/AdsAdManager/metadata/V1/CompanyTypeEnum.php index b212272e79bdb310cf674b2b5515e836552396a7..59881231d8665bf75ddb94614d7aa2f6bf74cb5c 100644 GIT binary patch delta 51 zcmX@X{*-;gOGd^`lV34DWIQqX4AXk)S4>jw`T6NNsa95wDa9bdH!&|UJ+;WnYH}sB FKL9fG6Y&55 delta 23 fcmaFLeu90&OGd`2lV34DWL!P@4Ac6_Gnjn=finternalAddGeneratedFile( ' -¸ +Õ .google/ads/admanager/v1/contact_messages.protogoogle.ads.admanager.v1google/api/resource.proto"› Contact name ( BàA contact_id (BàA:dêAa - admanager.googleapis.com/Contact*networks/{network_code}/contacts/{contact}*contacts2contactB« -com.google.ads.admanager.v1BContactMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + admanager.googleapis.com/Contact*networks/{network_code}/contacts/{contact}*contacts2contactBÈ +com.google.ads.admanager.v1BContactMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/CustomFieldEnums.php b/AdsAdManager/metadata/V1/CustomFieldEnums.php index 8ea7ee7cff7c1fe1f4092de4a6a1d6a92713b505..81c470c90343e32ecca3fb1141e4f57d7d1b500e 100644 GIT binary patch delta 52 zcmaFE)yci#H6!EY&2Jc+m>5q^&S%*m{fbG-JwHD^C)LWzF{Kzp_$KBhrl%HJSxuH@ G^#=eT2NLxF delta 24 gcmeC=e#5olH6!D;&2Jc+m>Abg&S%*$*@o2@0Dtibh5!Hn diff --git a/AdsAdManager/metadata/V1/CustomFieldMessages.php b/AdsAdManager/metadata/V1/CustomFieldMessages.php index 6e2776c20d37..aadb94caf293 100644 --- a/AdsAdManager/metadata/V1/CustomFieldMessages.php +++ b/AdsAdManager/metadata/V1/CustomFieldMessages.php @@ -19,7 +19,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -È +å 3google/ads/admanager/v1/custom_field_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"¬ CustomField name ( BàA @@ -36,8 +36,8 @@ public static function initOnce() { $admanager.googleapis.com/CustomField3networks/{network_code}/customFields/{custom_field}* customFields2 customField"S CustomFieldOption# custom_field_option_id (BàA - display_name ( BàAB¯ -com.google.ads.admanager.v1BCustomFieldMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + display_name ( BàABÌ +com.google.ads.admanager.v1BCustomFieldMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/CustomFieldService.php b/AdsAdManager/metadata/V1/CustomFieldService.php index 6960a5365982..dfd14cb20de3 100644 --- a/AdsAdManager/metadata/V1/CustomFieldService.php +++ b/AdsAdManager/metadata/V1/CustomFieldService.php @@ -21,7 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -ž +» 2google/ads/admanager/v1/custom_field_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"S GetCustomFieldRequest: name ( B,àAúA& @@ -42,8 +42,8 @@ public static function initOnce() { total_size (2€ CustomFieldService› GetCustomField..google.ads.admanager.v1.GetCustomFieldRequest$.google.ads.admanager.v1.CustomField"3ÚAname‚Óä“&$/v1/{name=networks/*/customFields/*}® -ListCustomFields0.google.ads.admanager.v1.ListCustomFieldsRequest1.google.ads.admanager.v1.ListCustomFieldsResponse"5ÚAparent‚Óä“&$/v1/{parent=networks/*}/customFieldsÊAadmanager.googleapis.comB® -com.google.ads.admanager.v1BCustomFieldServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +ListCustomFields0.google.ads.admanager.v1.ListCustomFieldsRequest1.google.ads.admanager.v1.ListCustomFieldsResponse"5ÚAparent‚Óä“&$/v1/{parent=networks/*}/customFieldsÊAadmanager.googleapis.comBË +com.google.ads.admanager.v1BCustomFieldServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/CustomFieldValue.php b/AdsAdManager/metadata/V1/CustomFieldValue.php index 6111d1bcb16167ba6a319594a129860857036bc1..303f1617d72f3c76dfdd1ee631c8f4d7e87ea82d 100644 GIT binary patch delta 62 zcmaFD*~qmahKcd^=2)gqM)s48T++$;xs&ynB_^}7Op<=ZB;}r;pPrLyW#yPs3?h6J Q^Agiji>$0BPi6530CX%A3jhEB delta 34 qcmZqVdcwIOhKX_C=2)gqM)oy~T++$;xs&ynB_^}7Oq#rf#TNj;ZVH?L diff --git a/AdsAdManager/metadata/V1/CustomTargetingKeyEnums.php b/AdsAdManager/metadata/V1/CustomTargetingKeyEnums.php index 72d02dc8913892de3f81a3694276cbaecfb706db..d23e53e3e6f9873f547d41a51c715aa12cb2c663 100644 GIT binary patch delta 52 zcmZqWTEw;C7bD}{&A%C0nHVojW@One{fbG-JwHD^C)LWzF{Kzp_$KBhrl%HJSxw%? G;tv4#%@TinternalAddGeneratedFile( ' -» +Ø ;google/ads/admanager/v1/custom_targeting_key_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"å CustomTargetingKey name ( BàA$ @@ -29,8 +29,8 @@ public static function initOnce() { type (2J.google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyTypeBàAc status (2N.google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatusBàA| reportable_type (2^.google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableTypeBàA:žêAš -+admanager.googleapis.com/CustomTargetingKeyBnetworks/{network_code}/customTargetingKeys/{custom_targeting_key}*customTargetingKeys2customTargetingKeyB¶ -com.google.ads.admanager.v1BCustomTargetingKeyMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' ++admanager.googleapis.com/CustomTargetingKeyBnetworks/{network_code}/customTargetingKeys/{custom_targeting_key}*customTargetingKeys2customTargetingKeyBÓ +com.google.ads.admanager.v1BCustomTargetingKeyMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/CustomTargetingKeyService.php b/AdsAdManager/metadata/V1/CustomTargetingKeyService.php index c8b81f388c75..0bce5ecf47e8 100644 --- a/AdsAdManager/metadata/V1/CustomTargetingKeyService.php +++ b/AdsAdManager/metadata/V1/CustomTargetingKeyService.php @@ -21,7 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -— +´ :google/ads/admanager/v1/custom_targeting_key_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"a GetCustomTargetingKeyRequestA @@ -43,8 +43,8 @@ public static function initOnce() { total_size (2¿ CustomTargetingKeyService· GetCustomTargetingKey5.google.ads.admanager.v1.GetCustomTargetingKeyRequest+.google.ads.admanager.v1.CustomTargetingKey":ÚAname‚Óä“-+/v1/{name=networks/*/customTargetingKeys/*}Ê -ListCustomTargetingKeys7.google.ads.admanager.v1.ListCustomTargetingKeysRequest8.google.ads.admanager.v1.ListCustomTargetingKeysResponse"<ÚAparent‚Óä“-+/v1/{parent=networks/*}/customTargetingKeysÊAadmanager.googleapis.comBµ -com.google.ads.admanager.v1BCustomTargetingKeyServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +ListCustomTargetingKeys7.google.ads.admanager.v1.ListCustomTargetingKeysRequest8.google.ads.admanager.v1.ListCustomTargetingKeysResponse"<ÚAparent‚Óä“-+/v1/{parent=networks/*}/customTargetingKeysÊAadmanager.googleapis.comBÒ +com.google.ads.admanager.v1BCustomTargetingKeyServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/CustomTargetingValueEnums.php b/AdsAdManager/metadata/V1/CustomTargetingValueEnums.php index 5eabde725644136cca0119b8d889cfdf1ed613d0..3679500cb898f8f3e71827abc96ba9fbba5e777b 100644 GIT binary patch delta 52 zcmdnMd6sj-KSrij)=f++85u84Ud6mq`W2Iudwza;PO6oaV@ffI@J-B1OiwMcvYMR8 G;tv1;R}zi@ delta 24 gcmX@hxq)-TKSrh(ESs2CGBR$Ryo!0}internalAddGeneratedFile( ' -í +Š =google/ads/admanager/v1/custom_targeting_value_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"“ CustomTargetingValue name ( BàA @@ -28,8 +28,8 @@ public static function initOnce() { match_type (2X.google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchTypeBàAàAg status (2R.google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatusBàA:ÓêAÏ --admanager.googleapis.com/CustomTargetingValueqnetworks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}*customTargetingValues2customTargetingValueB¸ -com.google.ads.admanager.v1B!CustomTargetingValueMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +-admanager.googleapis.com/CustomTargetingValueqnetworks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}*customTargetingValues2customTargetingValueBÕ +com.google.ads.admanager.v1B!CustomTargetingValueMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/CustomTargetingValueService.php b/AdsAdManager/metadata/V1/CustomTargetingValueService.php index 8de715a70ffa..298a449dba63 100644 --- a/AdsAdManager/metadata/V1/CustomTargetingValueService.php +++ b/AdsAdManager/metadata/V1/CustomTargetingValueService.php @@ -21,8 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -ð - + Hq)$ delta 30 mcmZ3$-ORnAl!@gCE0^s=Z`;k=m<}^C?wDM~vS)HIt1keaiVAxG diff --git a/AdsAdManager/metadata/V1/EntitySignalsMappingService.php b/AdsAdManager/metadata/V1/EntitySignalsMappingService.php index 6bfe888da928..e0291ff084ab 100644 --- a/AdsAdManager/metadata/V1/EntitySignalsMappingService.php +++ b/AdsAdManager/metadata/V1/EntitySignalsMappingService.php @@ -22,7 +22,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\FieldMask::initOnce(); $pool->internalAddGeneratedFile( ' -ã +€ "9/v1/{parent=networks/*}/entitySignalsMappings:batchCreate:*ÿ - BatchUpdateEntitySignalsMappings@.google.ads.admanager.v1.BatchUpdateEntitySignalsMappingsRequestA.google.ads.admanager.v1.BatchUpdateEntitySignalsMappingsResponse"VÚAparent,requests‚Óä“>"9/v1/{parent=networks/*}/entitySignalsMappings:batchUpdate:*ÊAadmanager.googleapis.comB· -com.google.ads.admanager.v1B EntitySignalsMappingServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + BatchUpdateEntitySignalsMappings@.google.ads.admanager.v1.BatchUpdateEntitySignalsMappingsRequestA.google.ads.admanager.v1.BatchUpdateEntitySignalsMappingsResponse"VÚAparent,requests‚Óä“>"9/v1/{parent=networks/*}/entitySignalsMappings:batchUpdate:*ÊAadmanager.googleapis.comBÔ +com.google.ads.admanager.v1B EntitySignalsMappingServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/EnvironmentTypeEnum.php b/AdsAdManager/metadata/V1/EnvironmentTypeEnum.php index 629c52c2bd780fefe81a5114bbe24805aaf1923a..8ad405f1742b63e5b1416dbf58013d3cf761693b 100644 GIT binary patch delta 57 zcmZ3-ewuy5M@E(j%v{D3y^SYpFtswCnY@l^v-B$_Dfj&R^qf>HE60>#5aFAcmzbVf LWMwrup4lG&MZpuO delta 29 lcmX@jzK(svM@E*internalAddGeneratedFile( ' -Ž +« ,google/ads/admanager/v1/label_messages.protogoogle.ads.admanager.v1google/api/resource.proto"v Label name ( BàA:ZêAW -admanager.googleapis.com/Label&networks/{network_code}/labels/{label}*labels2labelB© -com.google.ads.admanager.v1BLabelMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +admanager.googleapis.com/Label&networks/{network_code}/labels/{label}*labels2labelBÆ +com.google.ads.admanager.v1BLabelMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/NetworkMessages.php b/AdsAdManager/metadata/V1/NetworkMessages.php index a56a18beed04..b1077ac9a1e9 100644 --- a/AdsAdManager/metadata/V1/NetworkMessages.php +++ b/AdsAdManager/metadata/V1/NetworkMessages.php @@ -18,7 +18,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -¶ +Ó .google/ads/admanager/v1/network_messages.protogoogle.ads.admanager.v1google/api/resource.proto"™ Network name ( BàA @@ -34,8 +34,8 @@ public static function initOnce() { (BàA network_id (BàA:QêAN - admanager.googleapis.com/Networknetworks/{network_code}*networks2networkB« -com.google.ads.admanager.v1BNetworkMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + admanager.googleapis.com/Networknetworks/{network_code}*networks2networkBÈ +com.google.ads.admanager.v1BNetworkMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/NetworkService.php b/AdsAdManager/metadata/V1/NetworkService.php index a78ae63f7332..e0016c7a91a0 100644 --- a/AdsAdManager/metadata/V1/NetworkService.php +++ b/AdsAdManager/metadata/V1/NetworkService.php @@ -21,7 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -× +ô -google/ads/admanager/v1/network_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"K GetNetworkRequest6 name ( B(àAúA" @@ -32,8 +32,8 @@ public static function initOnce() { NetworkService€ GetNetwork*.google.ads.admanager.v1.GetNetworkRequest .google.ads.admanager.v1.Network"$ÚAname‚Óä“/v1/{name=networks/*} - ListNetworks,.google.ads.admanager.v1.ListNetworksRequest-.google.ads.admanager.v1.ListNetworksResponse"‚Óä“ /v1/networksÊAadmanager.googleapis.comBª -com.google.ads.admanager.v1BNetworkServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + ListNetworks,.google.ads.admanager.v1.ListNetworksRequest-.google.ads.admanager.v1.ListNetworksResponse"‚Óä“ /v1/networksÊAadmanager.googleapis.comBÇ +com.google.ads.admanager.v1BNetworkServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/OrderEnums.php b/AdsAdManager/metadata/V1/OrderEnums.php index 50e78befe4b07a118820051a08f1a50b66146ea9..cf531acbdb7dea67b076dc892c0e1ce6dfe85ad7 100644 GIT binary patch delta 51 zcmX@c{+NBkJx0delkYRWXFNRlJku)aS4>jw`T6NNsa95wDa9bdH!&|UJ+;WnYH~TV FKL9Zp6XgH^ delta 23 fcmaFNevEy?Jx0cPlkYRWXIwVg diff --git a/AdsAdManager/metadata/V1/OrderMessages.php b/AdsAdManager/metadata/V1/OrderMessages.php index fd26aa927f01..ecf66e125c8f 100644 --- a/AdsAdManager/metadata/V1/OrderMessages.php +++ b/AdsAdManager/metadata/V1/OrderMessages.php @@ -22,7 +22,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -Ç +ä ,google/ads/admanager/v1/order_messages.protogoogle.ads.admanager.v10google/ads/admanager/v1/custom_field_value.proto)google/ads/admanager/v1/order_enums.protogoogle/api/field_behavior.protogoogle/api/resource.protogoogle/protobuf/timestamp.proto" Order name ( BàA @@ -69,8 +69,8 @@ public static function initOnce() { applied_labels ( 2%.google.ads.admanager.v1.AppliedLabelBàAL effective_applied_labels ( 2%.google.ads.admanager.v1.AppliedLabelBàAK custom_field_values& ( 2).google.ads.admanager.v1.CustomFieldValueBàA:ZêAW -admanager.googleapis.com/Order&networks/{network_code}/orders/{order}*orders2orderB© -com.google.ads.admanager.v1BOrderMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +admanager.googleapis.com/Order&networks/{network_code}/orders/{order}*orders2orderBÆ +com.google.ads.admanager.v1BOrderMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/OrderService.php b/AdsAdManager/metadata/V1/OrderService.php index 71b9f7757efc..669e34b78ab6 100644 --- a/AdsAdManager/metadata/V1/OrderService.php +++ b/AdsAdManager/metadata/V1/OrderService.php @@ -21,7 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -µ +Ò +google/ads/admanager/v1/order_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"G GetOrderRequest4 name ( B&àAúA @@ -43,8 +43,8 @@ public static function initOnce() { OrderServiceƒ GetOrder(.google.ads.admanager.v1.GetOrderRequest.google.ads.admanager.v1.Order"-ÚAname‚Óä“ /v1/{name=networks/*/orders/*}– -ListOrders*.google.ads.admanager.v1.ListOrdersRequest+.google.ads.admanager.v1.ListOrdersResponse"/ÚAparent‚Óä“ /v1/{parent=networks/*}/ordersÊAadmanager.googleapis.comB¨ -com.google.ads.admanager.v1BOrderServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +ListOrders*.google.ads.admanager.v1.ListOrdersRequest+.google.ads.admanager.v1.ListOrdersResponse"/ÚAparent‚Óä“ /v1/{parent=networks/*}/ordersÊAadmanager.googleapis.comBÅ +com.google.ads.admanager.v1BOrderServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/PlacementEnums.php b/AdsAdManager/metadata/V1/PlacementEnums.php index 8eccdd7c4121bbd8c6e6e7a286ec98e2a528961e..f4f8dbe8af72054a98f26037f38304c87021099f 100644 GIT binary patch delta 57 zcmZ3;zK?ywGe(v^W-i@{-nx^;nfe%yPhQ5fPWly-lzV=DdQPg9m19aVi11C!OH5BK Lva*^S#Ox0MH)az~ delta 29 lcmdnTzL0&xGe(w=OkBDXy>%yxGxag9n!Jo@-Q+@MUjUu~3SIyJ diff --git a/AdsAdManager/metadata/V1/PlacementMessages.php b/AdsAdManager/metadata/V1/PlacementMessages.php index 79247877a5fd..8125e821161b 100644 --- a/AdsAdManager/metadata/V1/PlacementMessages.php +++ b/AdsAdManager/metadata/V1/PlacementMessages.php @@ -20,7 +20,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -« +È 0google/ads/admanager/v1/placement_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.protogoogle/protobuf/timestamp.proto"È Placement name ( BàA @@ -33,8 +33,8 @@ public static function initOnce() { admanager.googleapis.com/AdUnit4 update_time ( 2.google.protobuf.TimestampBàA:nêAk "admanager.googleapis.com/Placement.networks/{network_code}/placements/{placement}* -placements2 placementB­ -com.google.ads.admanager.v1BPlacementMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +placements2 placementBÊ +com.google.ads.admanager.v1BPlacementMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/PlacementService.php b/AdsAdManager/metadata/V1/PlacementService.php index 2512b3925512..df9341ed0666 100644 --- a/AdsAdManager/metadata/V1/PlacementService.php +++ b/AdsAdManager/metadata/V1/PlacementService.php @@ -21,7 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -ù +– /google/ads/admanager/v1/placement_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"O GetPlacementRequest8 name ( B*àAúA$ @@ -43,8 +43,8 @@ public static function initOnce() { total_size (2î PlacementService“ GetPlacement,.google.ads.admanager.v1.GetPlacementRequest".google.ads.admanager.v1.Placement"1ÚAname‚Óä“$"/v1/{name=networks/*/placements/*}¦ -ListPlacements..google.ads.admanager.v1.ListPlacementsRequest/.google.ads.admanager.v1.ListPlacementsResponse"3ÚAparent‚Óä“$"/v1/{parent=networks/*}/placementsÊAadmanager.googleapis.comB¬ -com.google.ads.admanager.v1BPlacementServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +ListPlacements..google.ads.admanager.v1.ListPlacementsRequest/.google.ads.admanager.v1.ListPlacementsResponse"3ÚAparent‚Óä“$"/v1/{parent=networks/*}/placementsÊAadmanager.googleapis.comBÉ +com.google.ads.admanager.v1BPlacementServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/ReportService.php b/AdsAdManager/metadata/V1/ReportService.php index 128aacca11e6462f885a65908f34f2bc0d33cb3f..a2e593f7314c9093b9262d182a87467df7fc43bb 100644 GIT binary patch delta 54 zcmbO=iD~;JrVX+zOue0pEetvpRs+E;vN->D=P0UM7Pc5>tnykp| F4*(VT65s#; delta 23 fcmeBW|G>844kP2K$#)s&FfN^3#k6v=1G6sxc!LRX diff --git a/AdsAdManager/metadata/V1/RoleMessages.php b/AdsAdManager/metadata/V1/RoleMessages.php index be6641a6d1b4..c93340745892 100644 --- a/AdsAdManager/metadata/V1/RoleMessages.php +++ b/AdsAdManager/metadata/V1/RoleMessages.php @@ -19,7 +19,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -Ó +ð +google/ads/admanager/v1/role_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"› Role name ( BàA @@ -28,8 +28,8 @@ public static function initOnce() { description ( BàA built_in (BàAG status (22.google.ads.admanager.v1.RoleStatusEnum.RoleStatusBàA:UêAR -admanager.googleapis.com/Role$networks/{network_code}/roles/{role}*roles2roleB¨ -com.google.ads.admanager.v1BRoleMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +admanager.googleapis.com/Role$networks/{network_code}/roles/{role}*roles2roleBÅ +com.google.ads.admanager.v1BRoleMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/RoleService.php b/AdsAdManager/metadata/V1/RoleService.php index d3021bd5ff87..60fc57879f0a 100644 --- a/AdsAdManager/metadata/V1/RoleService.php +++ b/AdsAdManager/metadata/V1/RoleService.php @@ -21,7 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -£ +À *google/ads/admanager/v1/role_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"E GetRoleRequest3 name ( B%àAúA @@ -42,8 +42,8 @@ public static function initOnce() { total_size (2À RoleService GetRole\'.google.ads.admanager.v1.GetRoleRequest.google.ads.admanager.v1.Role",ÚAname‚Óä“/v1/{name=networks/*/roles/*}’ - ListRoles).google.ads.admanager.v1.ListRolesRequest*.google.ads.admanager.v1.ListRolesResponse".ÚAparent‚Óä“/v1/{parent=networks/*}/rolesÊAadmanager.googleapis.comB§ -com.google.ads.admanager.v1BRoleServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + ListRoles).google.ads.admanager.v1.ListRolesRequest*.google.ads.admanager.v1.ListRolesResponse".ÚAparent‚Óä“/v1/{parent=networks/*}/rolesÊAadmanager.googleapis.comBÄ +com.google.ads.admanager.v1BRoleServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/Size.php b/AdsAdManager/metadata/V1/Size.php index f1880c9571c6..7a1dbd7371ad 100644 --- a/AdsAdManager/metadata/V1/Size.php +++ b/AdsAdManager/metadata/V1/Size.php @@ -18,13 +18,13 @@ public static function initOnce() { \GPBMetadata\Google\Api\FieldBehavior::initOnce(); $pool->internalAddGeneratedFile( ' -‚ +Ÿ "google/ads/admanager/v1/size.protogoogle.ads.admanager.v1google/api/field_behavior.proto"w Size width (BàA height (BàAF - size_type (2..google.ads.admanager.v1.SizeTypeEnum.SizeTypeBàAB  -com.google.ads.admanager.v1B SizeProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' + size_type (2..google.ads.admanager.v1.SizeTypeEnum.SizeTypeBàAB½ +com.google.ads.admanager.v1B SizeProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/SizeTypeEnum.php b/AdsAdManager/metadata/V1/SizeTypeEnum.php index 3e89b84e3c031ce0a57e9d8f442a5f480c0b028f..5d1476b3ca03b1ad527ec76b2f973df4fa98b95f 100644 GIT binary patch delta 57 zcmdnTew%&6V@8&B%v?GXy>%uFGi_u%I{7Hm8tGR|QttWr={c!ZR*osfAi_5>FEKr} L$jWMRKC?dnQTh}5 delta 29 lcmcc3zK?ywV@8&V%v?GXy>%uFGi_vCG5ILdn#q04z5t$u3X1>$ diff --git a/AdsAdManager/metadata/V1/TaxonomyCategoryMessages.php b/AdsAdManager/metadata/V1/TaxonomyCategoryMessages.php index 10a791d6c682..cf1430b9cbfe 100644 --- a/AdsAdManager/metadata/V1/TaxonomyCategoryMessages.php +++ b/AdsAdManager/metadata/V1/TaxonomyCategoryMessages.php @@ -19,7 +19,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -° +Í 8google/ads/admanager/v1/taxonomy_category_messages.protogoogle.ads.admanager.v1google/api/field_behavior.protogoogle/api/resource.proto"ß TaxonomyCategory name ( BàA! @@ -30,8 +30,8 @@ public static function initOnce() { taxonomy_type (26.google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyTypeBàA ancestor_names ( BàA+ ancestor_taxonomy_category_ids (BàA:•êA‘ -)admanager.googleapis.com/TaxonomyCategory>networks/{network_code}/taxonomyCategories/{taxonomy_category}*taxonomyCategories2taxonomyCategoryB´ -com.google.ads.admanager.v1BTaxonomyCategoryMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +)admanager.googleapis.com/TaxonomyCategory>networks/{network_code}/taxonomyCategories/{taxonomy_category}*taxonomyCategories2taxonomyCategoryBÑ +com.google.ads.admanager.v1BTaxonomyCategoryMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/TaxonomyCategoryService.php b/AdsAdManager/metadata/V1/TaxonomyCategoryService.php index e0d958fa9808..a66abbdece9d 100644 --- a/AdsAdManager/metadata/V1/TaxonomyCategoryService.php +++ b/AdsAdManager/metadata/V1/TaxonomyCategoryService.php @@ -21,7 +21,8 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -û +˜ + 7google/ads/admanager/v1/taxonomy_category_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"] GetTaxonomyCategoryRequest? name ( B1àAúA+ @@ -42,8 +43,8 @@ public static function initOnce() { total_size (2² TaxonomyCategoryService° GetTaxonomyCategory3.google.ads.admanager.v1.GetTaxonomyCategoryRequest).google.ads.admanager.v1.TaxonomyCategory"9ÚAname‚Óä“,*/v1/{name=networks/*/taxonomyCategories/*}Æ -ListTaxonomyCategories6.google.ads.admanager.v1.ListTaxonomyCategoriesRequest7.google.ads.admanager.v1.ListTaxonomyCategoriesResponse";ÚAparent‚Óä“,*/v1/{parent=networks/*}/taxonomyCategoriesÊAadmanager.googleapis.comB³ -com.google.ads.admanager.v1BTaxonomyCategoryServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +ListTaxonomyCategories6.google.ads.admanager.v1.ListTaxonomyCategoriesRequest7.google.ads.admanager.v1.ListTaxonomyCategoriesResponse";ÚAparent‚Óä“,*/v1/{parent=networks/*}/taxonomyCategoriesÊAadmanager.googleapis.comBÐ +com.google.ads.admanager.v1BTaxonomyCategoryServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/TaxonomyTypeEnum.php b/AdsAdManager/metadata/V1/TaxonomyTypeEnum.php index 7e0f028bad09eb63fb5d2931fd46b7d5be41f059..21b4cabf0e9c978976301c6c5ae8ac871e7378af 100644 GIT binary patch delta 64 zcmbQwv4>;BYeuGamd$S&O&B>&GIB{L=jZB8R%8;N?7%!p`W2Iudwza;PO6oaV@ffI S@J-B1OiwMcvYLE>*&hI<7!?Zu delta 36 scmdnPF`r|@YeuG5%$wgbnlN&#VdRod&d=4GtjHuj*@1b|internalAddGeneratedFile( ' - +º +google/ads/admanager/v1/team_messages.protogoogle.ads.admanager.v1google/api/resource.proto"† Team name ( BàA team_id (BàA:UêAR -admanager.googleapis.com/Team$networks/{network_code}/teams/{team}*teams2teamB¨ -com.google.ads.admanager.v1BTeamMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +admanager.googleapis.com/Team$networks/{network_code}/teams/{team}*teams2teamBÅ +com.google.ads.admanager.v1BTeamMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/TimeUnitEnum.php b/AdsAdManager/metadata/V1/TimeUnitEnum.php index e19c07fce545fbe6f9f6488b0c6d800d83206875..d30188fe4251059fbae3bfdb11a9585e9161c57e 100644 GIT binary patch delta 57 zcmdnSewls4V@8%`%v?GXy>%uFGp%GiI(aYC8tGR|QttWr={c!ZR*osfAi_5>FEKr} L$jWMRIinternalAddGeneratedFile( ' -ö +“ +google/ads/admanager/v1/user_messages.protogoogle.ads.admanager.v1google/api/resource.proto"ß User name ( BàA @@ -32,8 +32,8 @@ public static function initOnce() { external_id ( BàA service_account (BàA& orders_ui_local_time_zone ( BàA:UêAR -admanager.googleapis.com/User$networks/{network_code}/users/{user}*users2userB¨ -com.google.ads.admanager.v1BUserMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +admanager.googleapis.com/User$networks/{network_code}/users/{user}*users2userBÅ +com.google.ads.admanager.v1BUserMessagesProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/metadata/V1/UserService.php b/AdsAdManager/metadata/V1/UserService.php index 9bd35f41953e..e1289e617df4 100644 --- a/AdsAdManager/metadata/V1/UserService.php +++ b/AdsAdManager/metadata/V1/UserService.php @@ -21,14 +21,14 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -ß +ü *google/ads/admanager/v1/user_service.protogoogle.ads.admanager.v1google/api/annotations.protogoogle/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto"E GetUserRequest3 name ( B%àAúA admanager.googleapis.com/User2« UserService -GetUser\'.google.ads.admanager.v1.GetUserRequest.google.ads.admanager.v1.User",ÚAname‚Óä“/v1/{name=networks/*/users/*}ÊAadmanager.googleapis.comB§ -com.google.ads.admanager.v1BUserServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1bproto3' +GetUser\'.google.ads.admanager.v1.GetUserRequest.google.ads.admanager.v1.User",ÚAname‚Óä“/v1/{name=networks/*/users/*}ÊAadmanager.googleapis.comBÄ +com.google.ads.admanager.v1BUserServiceProtoPZ@google.golang.org/genproto/googleapis/ads/admanager/v1;admanagerªGoogle.Ads.AdManager.V1ÊGoogle\\Ads\\AdManager\\V1êGoogle::Ads::AdManager::V1bproto3' , true); static::$is_initialized = true; diff --git a/AdsAdManager/src/V1/Client/AdUnitServiceClient.php b/AdsAdManager/src/V1/Client/AdUnitServiceClient.php index 238d03d40c37..fc5cfa027abb 100644 --- a/AdsAdManager/src/V1/Client/AdUnitServiceClient.php +++ b/AdsAdManager/src/V1/Client/AdUnitServiceClient.php @@ -50,9 +50,9 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getAdUnitAsync(GetAdUnitRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAdUnitSizesAsync(ListAdUnitSizesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAdUnitsAsync(ListAdUnitsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAdUnitAsync(GetAdUnitRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAdUnitSizesAsync(ListAdUnitSizesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAdUnitsAsync(ListAdUnitsRequest $request, array $optionalArgs = []) */ final class AdUnitServiceClient { diff --git a/AdsAdManager/src/V1/Client/CompanyServiceClient.php b/AdsAdManager/src/V1/Client/CompanyServiceClient.php index 03298df70dd2..8d281f97dba6 100644 --- a/AdsAdManager/src/V1/Client/CompanyServiceClient.php +++ b/AdsAdManager/src/V1/Client/CompanyServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getCompanyAsync(GetCompanyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCompaniesAsync(ListCompaniesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCompanyAsync(GetCompanyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCompaniesAsync(ListCompaniesRequest $request, array $optionalArgs = []) */ final class CompanyServiceClient { diff --git a/AdsAdManager/src/V1/Client/CustomFieldServiceClient.php b/AdsAdManager/src/V1/Client/CustomFieldServiceClient.php index 930c38b922c3..29264b0255f6 100644 --- a/AdsAdManager/src/V1/Client/CustomFieldServiceClient.php +++ b/AdsAdManager/src/V1/Client/CustomFieldServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getCustomFieldAsync(GetCustomFieldRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomFieldsAsync(ListCustomFieldsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomFieldAsync(GetCustomFieldRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomFieldsAsync(ListCustomFieldsRequest $request, array $optionalArgs = []) */ final class CustomFieldServiceClient { diff --git a/AdsAdManager/src/V1/Client/CustomTargetingKeyServiceClient.php b/AdsAdManager/src/V1/Client/CustomTargetingKeyServiceClient.php index c3b0bc912b1d..11ecadbaa0cb 100644 --- a/AdsAdManager/src/V1/Client/CustomTargetingKeyServiceClient.php +++ b/AdsAdManager/src/V1/Client/CustomTargetingKeyServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getCustomTargetingKeyAsync(GetCustomTargetingKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomTargetingKeysAsync(ListCustomTargetingKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomTargetingKeyAsync(GetCustomTargetingKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomTargetingKeysAsync(ListCustomTargetingKeysRequest $request, array $optionalArgs = []) */ final class CustomTargetingKeyServiceClient { diff --git a/AdsAdManager/src/V1/Client/CustomTargetingValueServiceClient.php b/AdsAdManager/src/V1/Client/CustomTargetingValueServiceClient.php index 1ce9aabf61d2..26598bb9b8c3 100644 --- a/AdsAdManager/src/V1/Client/CustomTargetingValueServiceClient.php +++ b/AdsAdManager/src/V1/Client/CustomTargetingValueServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getCustomTargetingValueAsync(GetCustomTargetingValueRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomTargetingValuesAsync(ListCustomTargetingValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomTargetingValueAsync(GetCustomTargetingValueRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomTargetingValuesAsync(ListCustomTargetingValuesRequest $request, array $optionalArgs = []) */ final class CustomTargetingValueServiceClient { diff --git a/AdsAdManager/src/V1/Client/EntitySignalsMappingServiceClient.php b/AdsAdManager/src/V1/Client/EntitySignalsMappingServiceClient.php index 0c1e933d9a92..e7b483b3c61d 100644 --- a/AdsAdManager/src/V1/Client/EntitySignalsMappingServiceClient.php +++ b/AdsAdManager/src/V1/Client/EntitySignalsMappingServiceClient.php @@ -55,12 +55,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateEntitySignalsMappingsAsync(BatchCreateEntitySignalsMappingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchUpdateEntitySignalsMappingsAsync(BatchUpdateEntitySignalsMappingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntitySignalsMappingAsync(CreateEntitySignalsMappingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntitySignalsMappingAsync(GetEntitySignalsMappingRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntitySignalsMappingsAsync(ListEntitySignalsMappingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntitySignalsMappingAsync(UpdateEntitySignalsMappingRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateEntitySignalsMappingsAsync(BatchCreateEntitySignalsMappingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateEntitySignalsMappingsAsync(BatchUpdateEntitySignalsMappingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntitySignalsMappingAsync(CreateEntitySignalsMappingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntitySignalsMappingAsync(GetEntitySignalsMappingRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntitySignalsMappingsAsync(ListEntitySignalsMappingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntitySignalsMappingAsync(UpdateEntitySignalsMappingRequest $request, array $optionalArgs = []) */ final class EntitySignalsMappingServiceClient { diff --git a/AdsAdManager/src/V1/Client/NetworkServiceClient.php b/AdsAdManager/src/V1/Client/NetworkServiceClient.php index 2e3ae01eb097..24fb7b390b0d 100644 --- a/AdsAdManager/src/V1/Client/NetworkServiceClient.php +++ b/AdsAdManager/src/V1/Client/NetworkServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getNetworkAsync(GetNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworksAsync(ListNetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNetworkAsync(GetNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworksAsync(ListNetworksRequest $request, array $optionalArgs = []) */ final class NetworkServiceClient { diff --git a/AdsAdManager/src/V1/Client/OrderServiceClient.php b/AdsAdManager/src/V1/Client/OrderServiceClient.php index 6976c12ade0f..5a22c70f7139 100644 --- a/AdsAdManager/src/V1/Client/OrderServiceClient.php +++ b/AdsAdManager/src/V1/Client/OrderServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getOrderAsync(GetOrderRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOrdersAsync(ListOrdersRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOrderAsync(GetOrderRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOrdersAsync(ListOrdersRequest $request, array $optionalArgs = []) */ final class OrderServiceClient { diff --git a/AdsAdManager/src/V1/Client/PlacementServiceClient.php b/AdsAdManager/src/V1/Client/PlacementServiceClient.php index f81de1283b7a..d1b9406f2169 100644 --- a/AdsAdManager/src/V1/Client/PlacementServiceClient.php +++ b/AdsAdManager/src/V1/Client/PlacementServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getPlacementAsync(GetPlacementRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPlacementsAsync(ListPlacementsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPlacementAsync(GetPlacementRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPlacementsAsync(ListPlacementsRequest $request, array $optionalArgs = []) */ final class PlacementServiceClient { diff --git a/AdsAdManager/src/V1/Client/ReportServiceClient.php b/AdsAdManager/src/V1/Client/ReportServiceClient.php index 20addfcadaea..f843675c8466 100644 --- a/AdsAdManager/src/V1/Client/ReportServiceClient.php +++ b/AdsAdManager/src/V1/Client/ReportServiceClient.php @@ -58,12 +58,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createReportAsync(CreateReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchReportResultRowsAsync(FetchReportResultRowsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReportAsync(GetReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReportsAsync(ListReportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface runReportAsync(RunReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateReportAsync(UpdateReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReportAsync(CreateReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchReportResultRowsAsync(FetchReportResultRowsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReportAsync(GetReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReportsAsync(ListReportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface runReportAsync(RunReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateReportAsync(UpdateReportRequest $request, array $optionalArgs = []) */ final class ReportServiceClient { diff --git a/AdsAdManager/src/V1/Client/RoleServiceClient.php b/AdsAdManager/src/V1/Client/RoleServiceClient.php index ed5f846b6849..4c755d66f546 100644 --- a/AdsAdManager/src/V1/Client/RoleServiceClient.php +++ b/AdsAdManager/src/V1/Client/RoleServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getRoleAsync(GetRoleRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRolesAsync(ListRolesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRoleAsync(GetRoleRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRolesAsync(ListRolesRequest $request, array $optionalArgs = []) */ final class RoleServiceClient { diff --git a/AdsAdManager/src/V1/Client/TaxonomyCategoryServiceClient.php b/AdsAdManager/src/V1/Client/TaxonomyCategoryServiceClient.php index 35abfd31fdef..6c15b463075c 100644 --- a/AdsAdManager/src/V1/Client/TaxonomyCategoryServiceClient.php +++ b/AdsAdManager/src/V1/Client/TaxonomyCategoryServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getTaxonomyCategoryAsync(GetTaxonomyCategoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTaxonomyCategoriesAsync(ListTaxonomyCategoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTaxonomyCategoryAsync(GetTaxonomyCategoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTaxonomyCategoriesAsync(ListTaxonomyCategoriesRequest $request, array $optionalArgs = []) */ final class TaxonomyCategoryServiceClient { diff --git a/AdsAdManager/src/V1/Client/UserServiceClient.php b/AdsAdManager/src/V1/Client/UserServiceClient.php index e068fd03184d..375bf90d4c0a 100644 --- a/AdsAdManager/src/V1/Client/UserServiceClient.php +++ b/AdsAdManager/src/V1/Client/UserServiceClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getUserAsync(GetUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface getUserAsync(GetUserRequest $request, array $optionalArgs = []) */ final class UserServiceClient { diff --git a/AdvisoryNotifications/src/V1/Client/AdvisoryNotificationsServiceClient.php b/AdvisoryNotifications/src/V1/Client/AdvisoryNotificationsServiceClient.php index 96b4cca11f70..6f667be90d91 100644 --- a/AdvisoryNotifications/src/V1/Client/AdvisoryNotificationsServiceClient.php +++ b/AdvisoryNotifications/src/V1/Client/AdvisoryNotificationsServiceClient.php @@ -52,10 +52,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getNotificationAsync(GetNotificationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotificationsAsync(ListNotificationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSettingsAsync(UpdateSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotificationAsync(GetNotificationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotificationsAsync(ListNotificationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSettingsAsync(UpdateSettingsRequest $request, array $optionalArgs = []) */ final class AdvisoryNotificationsServiceClient { diff --git a/AlloyDb/src/V1/Client/AlloyDBAdminClient.php b/AlloyDb/src/V1/Client/AlloyDBAdminClient.php index dabcddfb3eb2..b6b68ad9a61d 100644 --- a/AlloyDb/src/V1/Client/AlloyDBAdminClient.php +++ b/AlloyDb/src/V1/Client/AlloyDBAdminClient.php @@ -93,42 +93,42 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateInstancesAsync(BatchCreateInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSecondaryClusterAsync(CreateSecondaryClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSecondaryInstanceAsync(CreateSecondaryInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createUserAsync(CreateUserRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteUserAsync(DeleteUserRequest $request, array $optionalArgs = []) - * @method PromiseInterface executeSqlAsync(ExecuteSqlRequest $request, array $optionalArgs = []) - * @method PromiseInterface failoverInstanceAsync(FailoverInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateClientCertificateAsync(GenerateClientCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectionInfoAsync(GetConnectionInfoRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getUserAsync(GetUserRequest $request, array $optionalArgs = []) - * @method PromiseInterface injectFaultAsync(InjectFaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatabasesAsync(ListDatabasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUsersAsync(ListUsersRequest $request, array $optionalArgs = []) - * @method PromiseInterface promoteClusterAsync(PromoteClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface restartInstanceAsync(RestartInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreClusterAsync(RestoreClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface switchoverClusterAsync(SwitchoverClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateUserAsync(UpdateUserRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateInstancesAsync(BatchCreateInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSecondaryClusterAsync(CreateSecondaryClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSecondaryInstanceAsync(CreateSecondaryInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createUserAsync(CreateUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteUserAsync(DeleteUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface executeSqlAsync(ExecuteSqlRequest $request, array $optionalArgs = []) + * @method PromiseInterface failoverInstanceAsync(FailoverInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateClientCertificateAsync(GenerateClientCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectionInfoAsync(GetConnectionInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getUserAsync(GetUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface injectFaultAsync(InjectFaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatabasesAsync(ListDatabasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUsersAsync(ListUsersRequest $request, array $optionalArgs = []) + * @method PromiseInterface promoteClusterAsync(PromoteClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface restartInstanceAsync(RestartInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreClusterAsync(RestoreClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface switchoverClusterAsync(SwitchoverClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateUserAsync(UpdateUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class AlloyDBAdminClient { diff --git a/AnalyticsAdmin/src/V1alpha/Client/AnalyticsAdminServiceClient.php b/AnalyticsAdmin/src/V1alpha/Client/AnalyticsAdminServiceClient.php index 7482a74083d7..4f11b65504ce 100644 --- a/AnalyticsAdmin/src/V1alpha/Client/AnalyticsAdminServiceClient.php +++ b/AnalyticsAdmin/src/V1alpha/Client/AnalyticsAdminServiceClient.php @@ -246,156 +246,156 @@ * * @experimental * - * @method PromiseInterface acknowledgeUserDataCollectionAsync(AcknowledgeUserDataCollectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface approveDisplayVideo360AdvertiserLinkProposalAsync(ApproveDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) - * @method PromiseInterface archiveAudienceAsync(ArchiveAudienceRequest $request, array $optionalArgs = []) - * @method PromiseInterface archiveCustomDimensionAsync(ArchiveCustomDimensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface archiveCustomMetricAsync(ArchiveCustomMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchCreateAccessBindingsAsync(BatchCreateAccessBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchDeleteAccessBindingsAsync(BatchDeleteAccessBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchGetAccessBindingsAsync(BatchGetAccessBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchUpdateAccessBindingsAsync(BatchUpdateAccessBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelDisplayVideo360AdvertiserLinkProposalAsync(CancelDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAccessBindingAsync(CreateAccessBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAdSenseLinkAsync(CreateAdSenseLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAudienceAsync(CreateAudienceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBigQueryLinkAsync(CreateBigQueryLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCalculatedMetricAsync(CreateCalculatedMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface createChannelGroupAsync(CreateChannelGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConnectedSiteTagAsync(CreateConnectedSiteTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConversionEventAsync(CreateConversionEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomDimensionAsync(CreateCustomDimensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomMetricAsync(CreateCustomMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDataStreamAsync(CreateDataStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDisplayVideo360AdvertiserLinkAsync(CreateDisplayVideo360AdvertiserLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDisplayVideo360AdvertiserLinkProposalAsync(CreateDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEventCreateRuleAsync(CreateEventCreateRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEventEditRuleAsync(CreateEventEditRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createExpandedDataSetAsync(CreateExpandedDataSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFirebaseLinkAsync(CreateFirebaseLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGoogleAdsLinkAsync(CreateGoogleAdsLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createKeyEventAsync(CreateKeyEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMeasurementProtocolSecretAsync(CreateMeasurementProtocolSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPropertyAsync(CreatePropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRollupPropertyAsync(CreateRollupPropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRollupPropertySourceLinkAsync(CreateRollupPropertySourceLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSKAdNetworkConversionValueSchemaAsync(CreateSKAdNetworkConversionValueSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSearchAds360LinkAsync(CreateSearchAds360LinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSubpropertyEventFilterAsync(CreateSubpropertyEventFilterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccessBindingAsync(DeleteAccessBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccountAsync(DeleteAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAdSenseLinkAsync(DeleteAdSenseLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBigQueryLinkAsync(DeleteBigQueryLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCalculatedMetricAsync(DeleteCalculatedMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteChannelGroupAsync(DeleteChannelGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectedSiteTagAsync(DeleteConnectedSiteTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversionEventAsync(DeleteConversionEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataStreamAsync(DeleteDataStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDisplayVideo360AdvertiserLinkAsync(DeleteDisplayVideo360AdvertiserLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDisplayVideo360AdvertiserLinkProposalAsync(DeleteDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEventCreateRuleAsync(DeleteEventCreateRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEventEditRuleAsync(DeleteEventEditRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteExpandedDataSetAsync(DeleteExpandedDataSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFirebaseLinkAsync(DeleteFirebaseLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGoogleAdsLinkAsync(DeleteGoogleAdsLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteKeyEventAsync(DeleteKeyEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMeasurementProtocolSecretAsync(DeleteMeasurementProtocolSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePropertyAsync(DeletePropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRollupPropertySourceLinkAsync(DeleteRollupPropertySourceLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSKAdNetworkConversionValueSchemaAsync(DeleteSKAdNetworkConversionValueSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSearchAds360LinkAsync(DeleteSearchAds360LinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSubpropertyEventFilterAsync(DeleteSubpropertyEventFilterRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchAutomatedGa4ConfigurationOptOutAsync(FetchAutomatedGa4ConfigurationOptOutRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchConnectedGa4PropertyAsync(FetchConnectedGa4PropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAccessBindingAsync(GetAccessBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAccountAsync(GetAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAdSenseLinkAsync(GetAdSenseLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAttributionSettingsAsync(GetAttributionSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAudienceAsync(GetAudienceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBigQueryLinkAsync(GetBigQueryLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCalculatedMetricAsync(GetCalculatedMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface getChannelGroupAsync(GetChannelGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversionEventAsync(GetConversionEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomDimensionAsync(GetCustomDimensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomMetricAsync(GetCustomMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataRedactionSettingsAsync(GetDataRedactionSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataRetentionSettingsAsync(GetDataRetentionSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataSharingSettingsAsync(GetDataSharingSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataStreamAsync(GetDataStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDisplayVideo360AdvertiserLinkAsync(GetDisplayVideo360AdvertiserLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDisplayVideo360AdvertiserLinkProposalAsync(GetDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnhancedMeasurementSettingsAsync(GetEnhancedMeasurementSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEventCreateRuleAsync(GetEventCreateRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEventEditRuleAsync(GetEventEditRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExpandedDataSetAsync(GetExpandedDataSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGlobalSiteTagAsync(GetGlobalSiteTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGoogleSignalsSettingsAsync(GetGoogleSignalsSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKeyEventAsync(GetKeyEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMeasurementProtocolSecretAsync(GetMeasurementProtocolSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPropertyAsync(GetPropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRollupPropertySourceLinkAsync(GetRollupPropertySourceLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSKAdNetworkConversionValueSchemaAsync(GetSKAdNetworkConversionValueSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSearchAds360LinkAsync(GetSearchAds360LinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSubpropertyEventFilterAsync(GetSubpropertyEventFilterRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccessBindingsAsync(ListAccessBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccountSummariesAsync(ListAccountSummariesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccountsAsync(ListAccountsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAdSenseLinksAsync(ListAdSenseLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAudiencesAsync(ListAudiencesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBigQueryLinksAsync(ListBigQueryLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCalculatedMetricsAsync(ListCalculatedMetricsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listChannelGroupsAsync(ListChannelGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectedSiteTagsAsync(ListConnectedSiteTagsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversionEventsAsync(ListConversionEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomDimensionsAsync(ListCustomDimensionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomMetricsAsync(ListCustomMetricsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataStreamsAsync(ListDataStreamsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDisplayVideo360AdvertiserLinkProposalsAsync(ListDisplayVideo360AdvertiserLinkProposalsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDisplayVideo360AdvertiserLinksAsync(ListDisplayVideo360AdvertiserLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEventCreateRulesAsync(ListEventCreateRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEventEditRulesAsync(ListEventEditRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExpandedDataSetsAsync(ListExpandedDataSetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFirebaseLinksAsync(ListFirebaseLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGoogleAdsLinksAsync(ListGoogleAdsLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listKeyEventsAsync(ListKeyEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMeasurementProtocolSecretsAsync(ListMeasurementProtocolSecretsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPropertiesAsync(ListPropertiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRollupPropertySourceLinksAsync(ListRollupPropertySourceLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSKAdNetworkConversionValueSchemasAsync(ListSKAdNetworkConversionValueSchemasRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSearchAds360LinksAsync(ListSearchAds360LinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSubpropertyEventFiltersAsync(ListSubpropertyEventFiltersRequest $request, array $optionalArgs = []) - * @method PromiseInterface provisionAccountTicketAsync(ProvisionAccountTicketRequest $request, array $optionalArgs = []) - * @method PromiseInterface provisionSubpropertyAsync(ProvisionSubpropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface reorderEventEditRulesAsync(ReorderEventEditRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface runAccessReportAsync(RunAccessReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchChangeHistoryEventsAsync(SearchChangeHistoryEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setAutomatedGa4ConfigurationOptOutAsync(SetAutomatedGa4ConfigurationOptOutRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccessBindingAsync(UpdateAccessBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccountAsync(UpdateAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAttributionSettingsAsync(UpdateAttributionSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAudienceAsync(UpdateAudienceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBigQueryLinkAsync(UpdateBigQueryLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCalculatedMetricAsync(UpdateCalculatedMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateChannelGroupAsync(UpdateChannelGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConversionEventAsync(UpdateConversionEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomDimensionAsync(UpdateCustomDimensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomMetricAsync(UpdateCustomMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataRedactionSettingsAsync(UpdateDataRedactionSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataRetentionSettingsAsync(UpdateDataRetentionSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataStreamAsync(UpdateDataStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDisplayVideo360AdvertiserLinkAsync(UpdateDisplayVideo360AdvertiserLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEnhancedMeasurementSettingsAsync(UpdateEnhancedMeasurementSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEventCreateRuleAsync(UpdateEventCreateRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEventEditRuleAsync(UpdateEventEditRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExpandedDataSetAsync(UpdateExpandedDataSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGoogleAdsLinkAsync(UpdateGoogleAdsLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGoogleSignalsSettingsAsync(UpdateGoogleSignalsSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateKeyEventAsync(UpdateKeyEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMeasurementProtocolSecretAsync(UpdateMeasurementProtocolSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePropertyAsync(UpdatePropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSKAdNetworkConversionValueSchemaAsync(UpdateSKAdNetworkConversionValueSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSearchAds360LinkAsync(UpdateSearchAds360LinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSubpropertyEventFilterAsync(UpdateSubpropertyEventFilterRequest $request, array $optionalArgs = []) + * @method PromiseInterface acknowledgeUserDataCollectionAsync(AcknowledgeUserDataCollectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface approveDisplayVideo360AdvertiserLinkProposalAsync(ApproveDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) + * @method PromiseInterface archiveAudienceAsync(ArchiveAudienceRequest $request, array $optionalArgs = []) + * @method PromiseInterface archiveCustomDimensionAsync(ArchiveCustomDimensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface archiveCustomMetricAsync(ArchiveCustomMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateAccessBindingsAsync(BatchCreateAccessBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeleteAccessBindingsAsync(BatchDeleteAccessBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchGetAccessBindingsAsync(BatchGetAccessBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateAccessBindingsAsync(BatchUpdateAccessBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelDisplayVideo360AdvertiserLinkProposalAsync(CancelDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAccessBindingAsync(CreateAccessBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAdSenseLinkAsync(CreateAdSenseLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAudienceAsync(CreateAudienceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBigQueryLinkAsync(CreateBigQueryLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCalculatedMetricAsync(CreateCalculatedMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface createChannelGroupAsync(CreateChannelGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectedSiteTagAsync(CreateConnectedSiteTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversionEventAsync(CreateConversionEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomDimensionAsync(CreateCustomDimensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomMetricAsync(CreateCustomMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataStreamAsync(CreateDataStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDisplayVideo360AdvertiserLinkAsync(CreateDisplayVideo360AdvertiserLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDisplayVideo360AdvertiserLinkProposalAsync(CreateDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEventCreateRuleAsync(CreateEventCreateRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEventEditRuleAsync(CreateEventEditRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExpandedDataSetAsync(CreateExpandedDataSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFirebaseLinkAsync(CreateFirebaseLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGoogleAdsLinkAsync(CreateGoogleAdsLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createKeyEventAsync(CreateKeyEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMeasurementProtocolSecretAsync(CreateMeasurementProtocolSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPropertyAsync(CreatePropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRollupPropertyAsync(CreateRollupPropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRollupPropertySourceLinkAsync(CreateRollupPropertySourceLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSKAdNetworkConversionValueSchemaAsync(CreateSKAdNetworkConversionValueSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSearchAds360LinkAsync(CreateSearchAds360LinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSubpropertyEventFilterAsync(CreateSubpropertyEventFilterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccessBindingAsync(DeleteAccessBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccountAsync(DeleteAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAdSenseLinkAsync(DeleteAdSenseLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBigQueryLinkAsync(DeleteBigQueryLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCalculatedMetricAsync(DeleteCalculatedMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteChannelGroupAsync(DeleteChannelGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectedSiteTagAsync(DeleteConnectedSiteTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversionEventAsync(DeleteConversionEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataStreamAsync(DeleteDataStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDisplayVideo360AdvertiserLinkAsync(DeleteDisplayVideo360AdvertiserLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDisplayVideo360AdvertiserLinkProposalAsync(DeleteDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEventCreateRuleAsync(DeleteEventCreateRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEventEditRuleAsync(DeleteEventEditRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteExpandedDataSetAsync(DeleteExpandedDataSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFirebaseLinkAsync(DeleteFirebaseLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGoogleAdsLinkAsync(DeleteGoogleAdsLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteKeyEventAsync(DeleteKeyEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMeasurementProtocolSecretAsync(DeleteMeasurementProtocolSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePropertyAsync(DeletePropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRollupPropertySourceLinkAsync(DeleteRollupPropertySourceLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSKAdNetworkConversionValueSchemaAsync(DeleteSKAdNetworkConversionValueSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSearchAds360LinkAsync(DeleteSearchAds360LinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSubpropertyEventFilterAsync(DeleteSubpropertyEventFilterRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchAutomatedGa4ConfigurationOptOutAsync(FetchAutomatedGa4ConfigurationOptOutRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchConnectedGa4PropertyAsync(FetchConnectedGa4PropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAccessBindingAsync(GetAccessBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAccountAsync(GetAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAdSenseLinkAsync(GetAdSenseLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttributionSettingsAsync(GetAttributionSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAudienceAsync(GetAudienceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBigQueryLinkAsync(GetBigQueryLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCalculatedMetricAsync(GetCalculatedMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface getChannelGroupAsync(GetChannelGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversionEventAsync(GetConversionEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomDimensionAsync(GetCustomDimensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomMetricAsync(GetCustomMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataRedactionSettingsAsync(GetDataRedactionSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataRetentionSettingsAsync(GetDataRetentionSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataSharingSettingsAsync(GetDataSharingSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataStreamAsync(GetDataStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDisplayVideo360AdvertiserLinkAsync(GetDisplayVideo360AdvertiserLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDisplayVideo360AdvertiserLinkProposalAsync(GetDisplayVideo360AdvertiserLinkProposalRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnhancedMeasurementSettingsAsync(GetEnhancedMeasurementSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEventCreateRuleAsync(GetEventCreateRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEventEditRuleAsync(GetEventEditRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExpandedDataSetAsync(GetExpandedDataSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGlobalSiteTagAsync(GetGlobalSiteTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGoogleSignalsSettingsAsync(GetGoogleSignalsSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKeyEventAsync(GetKeyEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMeasurementProtocolSecretAsync(GetMeasurementProtocolSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPropertyAsync(GetPropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRollupPropertySourceLinkAsync(GetRollupPropertySourceLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSKAdNetworkConversionValueSchemaAsync(GetSKAdNetworkConversionValueSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSearchAds360LinkAsync(GetSearchAds360LinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSubpropertyEventFilterAsync(GetSubpropertyEventFilterRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccessBindingsAsync(ListAccessBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccountSummariesAsync(ListAccountSummariesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccountsAsync(ListAccountsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAdSenseLinksAsync(ListAdSenseLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAudiencesAsync(ListAudiencesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBigQueryLinksAsync(ListBigQueryLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCalculatedMetricsAsync(ListCalculatedMetricsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listChannelGroupsAsync(ListChannelGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectedSiteTagsAsync(ListConnectedSiteTagsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversionEventsAsync(ListConversionEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomDimensionsAsync(ListCustomDimensionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomMetricsAsync(ListCustomMetricsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataStreamsAsync(ListDataStreamsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDisplayVideo360AdvertiserLinkProposalsAsync(ListDisplayVideo360AdvertiserLinkProposalsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDisplayVideo360AdvertiserLinksAsync(ListDisplayVideo360AdvertiserLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEventCreateRulesAsync(ListEventCreateRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEventEditRulesAsync(ListEventEditRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExpandedDataSetsAsync(ListExpandedDataSetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFirebaseLinksAsync(ListFirebaseLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGoogleAdsLinksAsync(ListGoogleAdsLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listKeyEventsAsync(ListKeyEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMeasurementProtocolSecretsAsync(ListMeasurementProtocolSecretsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPropertiesAsync(ListPropertiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRollupPropertySourceLinksAsync(ListRollupPropertySourceLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSKAdNetworkConversionValueSchemasAsync(ListSKAdNetworkConversionValueSchemasRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSearchAds360LinksAsync(ListSearchAds360LinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSubpropertyEventFiltersAsync(ListSubpropertyEventFiltersRequest $request, array $optionalArgs = []) + * @method PromiseInterface provisionAccountTicketAsync(ProvisionAccountTicketRequest $request, array $optionalArgs = []) + * @method PromiseInterface provisionSubpropertyAsync(ProvisionSubpropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface reorderEventEditRulesAsync(ReorderEventEditRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface runAccessReportAsync(RunAccessReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchChangeHistoryEventsAsync(SearchChangeHistoryEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setAutomatedGa4ConfigurationOptOutAsync(SetAutomatedGa4ConfigurationOptOutRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccessBindingAsync(UpdateAccessBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccountAsync(UpdateAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAttributionSettingsAsync(UpdateAttributionSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAudienceAsync(UpdateAudienceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBigQueryLinkAsync(UpdateBigQueryLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCalculatedMetricAsync(UpdateCalculatedMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateChannelGroupAsync(UpdateChannelGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConversionEventAsync(UpdateConversionEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomDimensionAsync(UpdateCustomDimensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomMetricAsync(UpdateCustomMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataRedactionSettingsAsync(UpdateDataRedactionSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataRetentionSettingsAsync(UpdateDataRetentionSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataStreamAsync(UpdateDataStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDisplayVideo360AdvertiserLinkAsync(UpdateDisplayVideo360AdvertiserLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEnhancedMeasurementSettingsAsync(UpdateEnhancedMeasurementSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEventCreateRuleAsync(UpdateEventCreateRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEventEditRuleAsync(UpdateEventEditRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExpandedDataSetAsync(UpdateExpandedDataSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGoogleAdsLinkAsync(UpdateGoogleAdsLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGoogleSignalsSettingsAsync(UpdateGoogleSignalsSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateKeyEventAsync(UpdateKeyEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMeasurementProtocolSecretAsync(UpdateMeasurementProtocolSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePropertyAsync(UpdatePropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSKAdNetworkConversionValueSchemaAsync(UpdateSKAdNetworkConversionValueSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSearchAds360LinkAsync(UpdateSearchAds360LinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSubpropertyEventFilterAsync(UpdateSubpropertyEventFilterRequest $request, array $optionalArgs = []) */ final class AnalyticsAdminServiceClient { diff --git a/AnalyticsAdmin/src/V1beta/Client/AnalyticsAdminServiceClient.php b/AnalyticsAdmin/src/V1beta/Client/AnalyticsAdminServiceClient.php index 73d2403cd831..dc8a0b9ab4e1 100644 --- a/AnalyticsAdmin/src/V1beta/Client/AnalyticsAdminServiceClient.php +++ b/AnalyticsAdmin/src/V1beta/Client/AnalyticsAdminServiceClient.php @@ -119,60 +119,60 @@ * * @experimental * - * @method PromiseInterface acknowledgeUserDataCollectionAsync(AcknowledgeUserDataCollectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface archiveCustomDimensionAsync(ArchiveCustomDimensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface archiveCustomMetricAsync(ArchiveCustomMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConversionEventAsync(CreateConversionEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomDimensionAsync(CreateCustomDimensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomMetricAsync(CreateCustomMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDataStreamAsync(CreateDataStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFirebaseLinkAsync(CreateFirebaseLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGoogleAdsLinkAsync(CreateGoogleAdsLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createKeyEventAsync(CreateKeyEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMeasurementProtocolSecretAsync(CreateMeasurementProtocolSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPropertyAsync(CreatePropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccountAsync(DeleteAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversionEventAsync(DeleteConversionEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataStreamAsync(DeleteDataStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFirebaseLinkAsync(DeleteFirebaseLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGoogleAdsLinkAsync(DeleteGoogleAdsLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteKeyEventAsync(DeleteKeyEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMeasurementProtocolSecretAsync(DeleteMeasurementProtocolSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePropertyAsync(DeletePropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAccountAsync(GetAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversionEventAsync(GetConversionEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomDimensionAsync(GetCustomDimensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomMetricAsync(GetCustomMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataRetentionSettingsAsync(GetDataRetentionSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataSharingSettingsAsync(GetDataSharingSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataStreamAsync(GetDataStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKeyEventAsync(GetKeyEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMeasurementProtocolSecretAsync(GetMeasurementProtocolSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPropertyAsync(GetPropertyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccountSummariesAsync(ListAccountSummariesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccountsAsync(ListAccountsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversionEventsAsync(ListConversionEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomDimensionsAsync(ListCustomDimensionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomMetricsAsync(ListCustomMetricsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataStreamsAsync(ListDataStreamsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFirebaseLinksAsync(ListFirebaseLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGoogleAdsLinksAsync(ListGoogleAdsLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listKeyEventsAsync(ListKeyEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMeasurementProtocolSecretsAsync(ListMeasurementProtocolSecretsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPropertiesAsync(ListPropertiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface provisionAccountTicketAsync(ProvisionAccountTicketRequest $request, array $optionalArgs = []) - * @method PromiseInterface runAccessReportAsync(RunAccessReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchChangeHistoryEventsAsync(SearchChangeHistoryEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccountAsync(UpdateAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConversionEventAsync(UpdateConversionEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomDimensionAsync(UpdateCustomDimensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomMetricAsync(UpdateCustomMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataRetentionSettingsAsync(UpdateDataRetentionSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataStreamAsync(UpdateDataStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGoogleAdsLinkAsync(UpdateGoogleAdsLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateKeyEventAsync(UpdateKeyEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMeasurementProtocolSecretAsync(UpdateMeasurementProtocolSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePropertyAsync(UpdatePropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface acknowledgeUserDataCollectionAsync(AcknowledgeUserDataCollectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface archiveCustomDimensionAsync(ArchiveCustomDimensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface archiveCustomMetricAsync(ArchiveCustomMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversionEventAsync(CreateConversionEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomDimensionAsync(CreateCustomDimensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomMetricAsync(CreateCustomMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataStreamAsync(CreateDataStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFirebaseLinkAsync(CreateFirebaseLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGoogleAdsLinkAsync(CreateGoogleAdsLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createKeyEventAsync(CreateKeyEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMeasurementProtocolSecretAsync(CreateMeasurementProtocolSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPropertyAsync(CreatePropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccountAsync(DeleteAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversionEventAsync(DeleteConversionEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataStreamAsync(DeleteDataStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFirebaseLinkAsync(DeleteFirebaseLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGoogleAdsLinkAsync(DeleteGoogleAdsLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteKeyEventAsync(DeleteKeyEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMeasurementProtocolSecretAsync(DeleteMeasurementProtocolSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePropertyAsync(DeletePropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAccountAsync(GetAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversionEventAsync(GetConversionEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomDimensionAsync(GetCustomDimensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomMetricAsync(GetCustomMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataRetentionSettingsAsync(GetDataRetentionSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataSharingSettingsAsync(GetDataSharingSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataStreamAsync(GetDataStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKeyEventAsync(GetKeyEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMeasurementProtocolSecretAsync(GetMeasurementProtocolSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPropertyAsync(GetPropertyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccountSummariesAsync(ListAccountSummariesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccountsAsync(ListAccountsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversionEventsAsync(ListConversionEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomDimensionsAsync(ListCustomDimensionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomMetricsAsync(ListCustomMetricsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataStreamsAsync(ListDataStreamsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFirebaseLinksAsync(ListFirebaseLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGoogleAdsLinksAsync(ListGoogleAdsLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listKeyEventsAsync(ListKeyEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMeasurementProtocolSecretsAsync(ListMeasurementProtocolSecretsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPropertiesAsync(ListPropertiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface provisionAccountTicketAsync(ProvisionAccountTicketRequest $request, array $optionalArgs = []) + * @method PromiseInterface runAccessReportAsync(RunAccessReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchChangeHistoryEventsAsync(SearchChangeHistoryEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccountAsync(UpdateAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConversionEventAsync(UpdateConversionEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomDimensionAsync(UpdateCustomDimensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomMetricAsync(UpdateCustomMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataRetentionSettingsAsync(UpdateDataRetentionSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataStreamAsync(UpdateDataStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGoogleAdsLinkAsync(UpdateGoogleAdsLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateKeyEventAsync(UpdateKeyEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMeasurementProtocolSecretAsync(UpdateMeasurementProtocolSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePropertyAsync(UpdatePropertyRequest $request, array $optionalArgs = []) */ final class AnalyticsAdminServiceClient { diff --git a/AnalyticsData/src/V1alpha/Client/AlphaAnalyticsDataClient.php b/AnalyticsData/src/V1alpha/Client/AlphaAnalyticsDataClient.php index 0f4e8ccbea65..14ddbf2bdf59 100644 --- a/AnalyticsData/src/V1alpha/Client/AlphaAnalyticsDataClient.php +++ b/AnalyticsData/src/V1alpha/Client/AlphaAnalyticsDataClient.php @@ -76,20 +76,20 @@ * * @experimental * - * @method PromiseInterface createAudienceListAsync(CreateAudienceListRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRecurringAudienceListAsync(CreateRecurringAudienceListRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReportTaskAsync(CreateReportTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAudienceListAsync(GetAudienceListRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPropertyQuotasSnapshotAsync(GetPropertyQuotasSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRecurringAudienceListAsync(GetRecurringAudienceListRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReportTaskAsync(GetReportTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAudienceListsAsync(ListAudienceListsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRecurringAudienceListsAsync(ListRecurringAudienceListsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReportTasksAsync(ListReportTasksRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryAudienceListAsync(QueryAudienceListRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryReportTaskAsync(QueryReportTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface runFunnelReportAsync(RunFunnelReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface sheetExportAudienceListAsync(SheetExportAudienceListRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAudienceListAsync(CreateAudienceListRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRecurringAudienceListAsync(CreateRecurringAudienceListRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReportTaskAsync(CreateReportTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAudienceListAsync(GetAudienceListRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPropertyQuotasSnapshotAsync(GetPropertyQuotasSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRecurringAudienceListAsync(GetRecurringAudienceListRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReportTaskAsync(GetReportTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAudienceListsAsync(ListAudienceListsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRecurringAudienceListsAsync(ListRecurringAudienceListsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReportTasksAsync(ListReportTasksRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryAudienceListAsync(QueryAudienceListRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryReportTaskAsync(QueryReportTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface runFunnelReportAsync(RunFunnelReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface sheetExportAudienceListAsync(SheetExportAudienceListRequest $request, array $optionalArgs = []) */ final class AlphaAnalyticsDataClient { diff --git a/AnalyticsData/src/V1beta/Client/BetaAnalyticsDataClient.php b/AnalyticsData/src/V1beta/Client/BetaAnalyticsDataClient.php index c876a83eb891..2caaa52f3485 100644 --- a/AnalyticsData/src/V1beta/Client/BetaAnalyticsDataClient.php +++ b/AnalyticsData/src/V1beta/Client/BetaAnalyticsDataClient.php @@ -75,17 +75,17 @@ * * @experimental * - * @method PromiseInterface batchRunPivotReportsAsync(BatchRunPivotReportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchRunReportsAsync(BatchRunReportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface checkCompatibilityAsync(CheckCompatibilityRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAudienceExportAsync(CreateAudienceExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAudienceExportAsync(GetAudienceExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMetadataAsync(GetMetadataRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAudienceExportsAsync(ListAudienceExportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryAudienceExportAsync(QueryAudienceExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface runPivotReportAsync(RunPivotReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface runRealtimeReportAsync(RunRealtimeReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface runReportAsync(RunReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchRunPivotReportsAsync(BatchRunPivotReportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchRunReportsAsync(BatchRunReportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkCompatibilityAsync(CheckCompatibilityRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAudienceExportAsync(CreateAudienceExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAudienceExportAsync(GetAudienceExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetadataAsync(GetMetadataRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAudienceExportsAsync(ListAudienceExportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryAudienceExportAsync(QueryAudienceExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface runPivotReportAsync(RunPivotReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface runRealtimeReportAsync(RunRealtimeReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface runReportAsync(RunReportRequest $request, array $optionalArgs = []) */ final class BetaAnalyticsDataClient { diff --git a/ApiGateway/src/V1/Client/ApiGatewayServiceClient.php b/ApiGateway/src/V1/Client/ApiGatewayServiceClient.php index 3a8380df0c34..7c0581291e02 100644 --- a/ApiGateway/src/V1/Client/ApiGatewayServiceClient.php +++ b/ApiGateway/src/V1/Client/ApiGatewayServiceClient.php @@ -67,21 +67,21 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createApiAsync(CreateApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface createApiConfigAsync(CreateApiConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGatewayAsync(CreateGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiAsync(DeleteApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiConfigAsync(DeleteApiConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGatewayAsync(DeleteGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiAsync(GetApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiConfigAsync(GetApiConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGatewayAsync(GetGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApiConfigsAsync(ListApiConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApisAsync(ListApisRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGatewaysAsync(ListGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApiAsync(UpdateApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApiConfigAsync(UpdateApiConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGatewayAsync(UpdateGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApiAsync(CreateApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApiConfigAsync(CreateApiConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGatewayAsync(CreateGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiAsync(DeleteApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiConfigAsync(DeleteApiConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGatewayAsync(DeleteGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiAsync(GetApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiConfigAsync(GetApiConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGatewayAsync(GetGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApiConfigsAsync(ListApiConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApisAsync(ListApisRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGatewaysAsync(ListGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApiAsync(UpdateApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApiConfigAsync(UpdateApiConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGatewayAsync(UpdateGatewayRequest $request, array $optionalArgs = []) */ final class ApiGatewayServiceClient { diff --git a/ApiHub/src/V1/Client/ApiHubClient.php b/ApiHub/src/V1/Client/ApiHubClient.php index b4aad22a0a71..a07bdf0c3546 100644 --- a/ApiHub/src/V1/Client/ApiHubClient.php +++ b/ApiHub/src/V1/Client/ApiHubClient.php @@ -93,43 +93,43 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createApiAsync(CreateApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAttributeAsync(CreateAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDeploymentAsync(CreateDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createExternalApiAsync(CreateExternalApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSpecAsync(CreateSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface createVersionAsync(CreateVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiAsync(DeleteApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAttributeAsync(DeleteAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDeploymentAsync(DeleteDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteExternalApiAsync(DeleteExternalApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSpecAsync(DeleteSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiAsync(GetApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiOperationAsync(GetApiOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAttributeAsync(GetAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDefinitionAsync(GetDefinitionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExternalApiAsync(GetExternalApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpecAsync(GetSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpecContentsAsync(GetSpecContentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApiOperationsAsync(ListApiOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApisAsync(ListApisRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAttributesAsync(ListAttributesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExternalApisAsync(ListExternalApisRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSpecsAsync(ListSpecsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchResourcesAsync(SearchResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApiAsync(UpdateApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAttributeAsync(UpdateAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDeploymentAsync(UpdateDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExternalApiAsync(UpdateExternalApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSpecAsync(UpdateSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApiAsync(CreateApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAttributeAsync(CreateAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeploymentAsync(CreateDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExternalApiAsync(CreateExternalApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSpecAsync(CreateSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVersionAsync(CreateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiAsync(DeleteApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAttributeAsync(DeleteAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDeploymentAsync(DeleteDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteExternalApiAsync(DeleteExternalApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSpecAsync(DeleteSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiAsync(GetApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiOperationAsync(GetApiOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttributeAsync(GetAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDefinitionAsync(GetDefinitionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExternalApiAsync(GetExternalApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpecAsync(GetSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpecContentsAsync(GetSpecContentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApiOperationsAsync(ListApiOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApisAsync(ListApisRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAttributesAsync(ListAttributesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExternalApisAsync(ListExternalApisRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSpecsAsync(ListSpecsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchResourcesAsync(SearchResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApiAsync(UpdateApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAttributeAsync(UpdateAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDeploymentAsync(UpdateDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExternalApiAsync(UpdateExternalApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSpecAsync(UpdateSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ApiHubClient { diff --git a/ApiHub/src/V1/Client/ApiHubDependenciesClient.php b/ApiHub/src/V1/Client/ApiHubDependenciesClient.php index acdedf5cd1c9..49c24660b965 100644 --- a/ApiHub/src/V1/Client/ApiHubDependenciesClient.php +++ b/ApiHub/src/V1/Client/ApiHubDependenciesClient.php @@ -56,13 +56,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDependencyAsync(CreateDependencyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDependencyAsync(DeleteDependencyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDependencyAsync(GetDependencyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDependenciesAsync(ListDependenciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDependencyAsync(UpdateDependencyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDependencyAsync(CreateDependencyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDependencyAsync(DeleteDependencyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDependencyAsync(GetDependencyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDependenciesAsync(ListDependenciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDependencyAsync(UpdateDependencyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ApiHubDependenciesClient { diff --git a/ApiHub/src/V1/Client/ApiHubPluginClient.php b/ApiHub/src/V1/Client/ApiHubPluginClient.php index 4a5e30165e09..a760cde8b8a3 100644 --- a/ApiHub/src/V1/Client/ApiHubPluginClient.php +++ b/ApiHub/src/V1/Client/ApiHubPluginClient.php @@ -53,11 +53,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface disablePluginAsync(DisablePluginRequest $request, array $optionalArgs = []) - * @method PromiseInterface enablePluginAsync(EnablePluginRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPluginAsync(GetPluginRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface disablePluginAsync(DisablePluginRequest $request, array $optionalArgs = []) + * @method PromiseInterface enablePluginAsync(EnablePluginRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPluginAsync(GetPluginRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ApiHubPluginClient { diff --git a/ApiHub/src/V1/Client/HostProjectRegistrationServiceClient.php b/ApiHub/src/V1/Client/HostProjectRegistrationServiceClient.php index f3d579d56d5a..72fd11890d20 100644 --- a/ApiHub/src/V1/Client/HostProjectRegistrationServiceClient.php +++ b/ApiHub/src/V1/Client/HostProjectRegistrationServiceClient.php @@ -53,11 +53,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createHostProjectRegistrationAsync(CreateHostProjectRegistrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHostProjectRegistrationAsync(GetHostProjectRegistrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listHostProjectRegistrationsAsync(ListHostProjectRegistrationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createHostProjectRegistrationAsync(CreateHostProjectRegistrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHostProjectRegistrationAsync(GetHostProjectRegistrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listHostProjectRegistrationsAsync(ListHostProjectRegistrationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class HostProjectRegistrationServiceClient { diff --git a/ApiHub/src/V1/Client/LintingServiceClient.php b/ApiHub/src/V1/Client/LintingServiceClient.php index 340ba7f6ea04..b277b343408d 100644 --- a/ApiHub/src/V1/Client/LintingServiceClient.php +++ b/ApiHub/src/V1/Client/LintingServiceClient.php @@ -55,12 +55,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getStyleGuideAsync(GetStyleGuideRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStyleGuideContentsAsync(GetStyleGuideContentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface lintSpecAsync(LintSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateStyleGuideAsync(UpdateStyleGuideRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStyleGuideAsync(GetStyleGuideRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStyleGuideContentsAsync(GetStyleGuideContentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface lintSpecAsync(LintSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateStyleGuideAsync(UpdateStyleGuideRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class LintingServiceClient { diff --git a/ApiHub/src/V1/Client/ProvisioningClient.php b/ApiHub/src/V1/Client/ProvisioningClient.php index 809100de664e..738f0cc59c72 100644 --- a/ApiHub/src/V1/Client/ProvisioningClient.php +++ b/ApiHub/src/V1/Client/ProvisioningClient.php @@ -57,11 +57,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createApiHubInstanceAsync(CreateApiHubInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiHubInstanceAsync(GetApiHubInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupApiHubInstanceAsync(LookupApiHubInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApiHubInstanceAsync(CreateApiHubInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiHubInstanceAsync(GetApiHubInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupApiHubInstanceAsync(LookupApiHubInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ProvisioningClient { diff --git a/ApiHub/src/V1/Client/RuntimeProjectAttachmentServiceClient.php b/ApiHub/src/V1/Client/RuntimeProjectAttachmentServiceClient.php index 2f4d697aaa52..b23c0a86bdcd 100644 --- a/ApiHub/src/V1/Client/RuntimeProjectAttachmentServiceClient.php +++ b/ApiHub/src/V1/Client/RuntimeProjectAttachmentServiceClient.php @@ -56,13 +56,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createRuntimeProjectAttachmentAsync(CreateRuntimeProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRuntimeProjectAttachmentAsync(DeleteRuntimeProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuntimeProjectAttachmentAsync(GetRuntimeProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRuntimeProjectAttachmentsAsync(ListRuntimeProjectAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupRuntimeProjectAttachmentAsync(LookupRuntimeProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRuntimeProjectAttachmentAsync(CreateRuntimeProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRuntimeProjectAttachmentAsync(DeleteRuntimeProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuntimeProjectAttachmentAsync(GetRuntimeProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRuntimeProjectAttachmentsAsync(ListRuntimeProjectAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupRuntimeProjectAttachmentAsync(LookupRuntimeProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class RuntimeProjectAttachmentServiceClient { diff --git a/ApiKeys/src/V2/Client/ApiKeysClient.php b/ApiKeys/src/V2/Client/ApiKeysClient.php index a0551e4e5ab5..9c5d0371a4c5 100644 --- a/ApiKeys/src/V2/Client/ApiKeysClient.php +++ b/ApiKeys/src/V2/Client/ApiKeysClient.php @@ -60,14 +60,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createKeyAsync(CreateKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteKeyAsync(DeleteKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKeyAsync(GetKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKeyStringAsync(GetKeyStringRequest $request, array $optionalArgs = []) - * @method PromiseInterface listKeysAsync(ListKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupKeyAsync(LookupKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteKeyAsync(UndeleteKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateKeyAsync(UpdateKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createKeyAsync(CreateKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteKeyAsync(DeleteKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKeyAsync(GetKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKeyStringAsync(GetKeyStringRequest $request, array $optionalArgs = []) + * @method PromiseInterface listKeysAsync(ListKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupKeyAsync(LookupKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteKeyAsync(UndeleteKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateKeyAsync(UpdateKeyRequest $request, array $optionalArgs = []) */ final class ApiKeysClient { diff --git a/ApigeeConnect/src/V1/Client/ConnectionServiceClient.php b/ApigeeConnect/src/V1/Client/ConnectionServiceClient.php index f32e0e799552..4d8853ad196c 100644 --- a/ApigeeConnect/src/V1/Client/ConnectionServiceClient.php +++ b/ApigeeConnect/src/V1/Client/ConnectionServiceClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) */ final class ConnectionServiceClient { diff --git a/ApigeeRegistry/src/V1/Client/ProvisioningClient.php b/ApigeeRegistry/src/V1/Client/ProvisioningClient.php index 6f87d64bf7f9..2bacb98f95ca 100644 --- a/ApigeeRegistry/src/V1/Client/ProvisioningClient.php +++ b/ApigeeRegistry/src/V1/Client/ProvisioningClient.php @@ -62,14 +62,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ProvisioningClient { diff --git a/ApigeeRegistry/src/V1/Client/RegistryClient.php b/ApigeeRegistry/src/V1/Client/RegistryClient.php index 121e337114e6..d66617c6dedc 100644 --- a/ApigeeRegistry/src/V1/Client/RegistryClient.php +++ b/ApigeeRegistry/src/V1/Client/RegistryClient.php @@ -95,46 +95,46 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createApiAsync(CreateApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface createApiDeploymentAsync(CreateApiDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createApiSpecAsync(CreateApiSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface createApiVersionAsync(CreateApiVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createArtifactAsync(CreateArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiAsync(DeleteApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiDeploymentAsync(DeleteApiDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiDeploymentRevisionAsync(DeleteApiDeploymentRevisionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiSpecAsync(DeleteApiSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiSpecRevisionAsync(DeleteApiSpecRevisionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApiVersionAsync(DeleteApiVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteArtifactAsync(DeleteArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiAsync(GetApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiDeploymentAsync(GetApiDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiSpecAsync(GetApiSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiSpecContentsAsync(GetApiSpecContentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApiVersionAsync(GetApiVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getArtifactAsync(GetArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface getArtifactContentsAsync(GetArtifactContentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApiDeploymentRevisionsAsync(ListApiDeploymentRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApiDeploymentsAsync(ListApiDeploymentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApiSpecRevisionsAsync(ListApiSpecRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApiSpecsAsync(ListApiSpecsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApiVersionsAsync(ListApiVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApisAsync(ListApisRequest $request, array $optionalArgs = []) - * @method PromiseInterface listArtifactsAsync(ListArtifactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface replaceArtifactAsync(ReplaceArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackApiDeploymentAsync(RollbackApiDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackApiSpecAsync(RollbackApiSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface tagApiDeploymentRevisionAsync(TagApiDeploymentRevisionRequest $request, array $optionalArgs = []) - * @method PromiseInterface tagApiSpecRevisionAsync(TagApiSpecRevisionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApiAsync(UpdateApiRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApiDeploymentAsync(UpdateApiDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApiSpecAsync(UpdateApiSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApiVersionAsync(UpdateApiVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApiAsync(CreateApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApiDeploymentAsync(CreateApiDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApiSpecAsync(CreateApiSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApiVersionAsync(CreateApiVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createArtifactAsync(CreateArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiAsync(DeleteApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiDeploymentAsync(DeleteApiDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiDeploymentRevisionAsync(DeleteApiDeploymentRevisionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiSpecAsync(DeleteApiSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiSpecRevisionAsync(DeleteApiSpecRevisionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApiVersionAsync(DeleteApiVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteArtifactAsync(DeleteArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiAsync(GetApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiDeploymentAsync(GetApiDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiSpecAsync(GetApiSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiSpecContentsAsync(GetApiSpecContentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApiVersionAsync(GetApiVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getArtifactAsync(GetArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface getArtifactContentsAsync(GetArtifactContentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApiDeploymentRevisionsAsync(ListApiDeploymentRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApiDeploymentsAsync(ListApiDeploymentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApiSpecRevisionsAsync(ListApiSpecRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApiSpecsAsync(ListApiSpecsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApiVersionsAsync(ListApiVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApisAsync(ListApisRequest $request, array $optionalArgs = []) + * @method PromiseInterface listArtifactsAsync(ListArtifactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface replaceArtifactAsync(ReplaceArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackApiDeploymentAsync(RollbackApiDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackApiSpecAsync(RollbackApiSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface tagApiDeploymentRevisionAsync(TagApiDeploymentRevisionRequest $request, array $optionalArgs = []) + * @method PromiseInterface tagApiSpecRevisionAsync(TagApiSpecRevisionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApiAsync(UpdateApiRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApiDeploymentAsync(UpdateApiDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApiSpecAsync(UpdateApiSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApiVersionAsync(UpdateApiVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class RegistryClient { diff --git a/AppEngineAdmin/src/V1/Client/ApplicationsClient.php b/AppEngineAdmin/src/V1/Client/ApplicationsClient.php index e8514baf13ff..8581da603a8e 100644 --- a/AppEngineAdmin/src/V1/Client/ApplicationsClient.php +++ b/AppEngineAdmin/src/V1/Client/ApplicationsClient.php @@ -47,10 +47,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createApplicationAsync(CreateApplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApplicationAsync(GetApplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface repairApplicationAsync(RepairApplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApplicationAsync(UpdateApplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApplicationAsync(CreateApplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApplicationAsync(GetApplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface repairApplicationAsync(RepairApplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApplicationAsync(UpdateApplicationRequest $request, array $optionalArgs = []) */ final class ApplicationsClient { diff --git a/AppEngineAdmin/src/V1/Client/AuthorizedCertificatesClient.php b/AppEngineAdmin/src/V1/Client/AuthorizedCertificatesClient.php index 8ed30d63fb7a..f0e7c7611cd8 100644 --- a/AppEngineAdmin/src/V1/Client/AuthorizedCertificatesClient.php +++ b/AppEngineAdmin/src/V1/Client/AuthorizedCertificatesClient.php @@ -47,11 +47,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createAuthorizedCertificateAsync(CreateAuthorizedCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAuthorizedCertificateAsync(DeleteAuthorizedCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAuthorizedCertificateAsync(GetAuthorizedCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAuthorizedCertificatesAsync(ListAuthorizedCertificatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAuthorizedCertificateAsync(UpdateAuthorizedCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAuthorizedCertificateAsync(CreateAuthorizedCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAuthorizedCertificateAsync(DeleteAuthorizedCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAuthorizedCertificateAsync(GetAuthorizedCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAuthorizedCertificatesAsync(ListAuthorizedCertificatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAuthorizedCertificateAsync(UpdateAuthorizedCertificateRequest $request, array $optionalArgs = []) */ final class AuthorizedCertificatesClient { diff --git a/AppEngineAdmin/src/V1/Client/AuthorizedDomainsClient.php b/AppEngineAdmin/src/V1/Client/AuthorizedDomainsClient.php index 1e4399551546..e162bb2ae415 100644 --- a/AppEngineAdmin/src/V1/Client/AuthorizedDomainsClient.php +++ b/AppEngineAdmin/src/V1/Client/AuthorizedDomainsClient.php @@ -43,7 +43,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface listAuthorizedDomainsAsync(ListAuthorizedDomainsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAuthorizedDomainsAsync(ListAuthorizedDomainsRequest $request, array $optionalArgs = []) */ final class AuthorizedDomainsClient { diff --git a/AppEngineAdmin/src/V1/Client/DomainMappingsClient.php b/AppEngineAdmin/src/V1/Client/DomainMappingsClient.php index 55ad78e926fb..f562523718eb 100644 --- a/AppEngineAdmin/src/V1/Client/DomainMappingsClient.php +++ b/AppEngineAdmin/src/V1/Client/DomainMappingsClient.php @@ -49,11 +49,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createDomainMappingAsync(CreateDomainMappingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDomainMappingAsync(DeleteDomainMappingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDomainMappingAsync(GetDomainMappingRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDomainMappingsAsync(ListDomainMappingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDomainMappingAsync(UpdateDomainMappingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDomainMappingAsync(CreateDomainMappingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDomainMappingAsync(DeleteDomainMappingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDomainMappingAsync(GetDomainMappingRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDomainMappingsAsync(ListDomainMappingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDomainMappingAsync(UpdateDomainMappingRequest $request, array $optionalArgs = []) */ final class DomainMappingsClient { diff --git a/AppEngineAdmin/src/V1/Client/FirewallClient.php b/AppEngineAdmin/src/V1/Client/FirewallClient.php index 9bd36a6de482..cafa6598011b 100644 --- a/AppEngineAdmin/src/V1/Client/FirewallClient.php +++ b/AppEngineAdmin/src/V1/Client/FirewallClient.php @@ -57,12 +57,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface batchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createIngressRuleAsync(CreateIngressRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIngressRuleAsync(DeleteIngressRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIngressRuleAsync(GetIngressRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIngressRulesAsync(ListIngressRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateIngressRuleAsync(UpdateIngressRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIngressRuleAsync(CreateIngressRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIngressRuleAsync(DeleteIngressRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIngressRuleAsync(GetIngressRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIngressRulesAsync(ListIngressRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateIngressRuleAsync(UpdateIngressRuleRequest $request, array $optionalArgs = []) */ final class FirewallClient { diff --git a/AppEngineAdmin/src/V1/Client/InstancesClient.php b/AppEngineAdmin/src/V1/Client/InstancesClient.php index 073ce3317fe5..ca5f8980cde8 100644 --- a/AppEngineAdmin/src/V1/Client/InstancesClient.php +++ b/AppEngineAdmin/src/V1/Client/InstancesClient.php @@ -48,10 +48,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface debugInstanceAsync(DebugInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface debugInstanceAsync(DebugInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) */ final class InstancesClient { diff --git a/AppEngineAdmin/src/V1/Client/ServicesClient.php b/AppEngineAdmin/src/V1/Client/ServicesClient.php index afff870c2281..2451f9d74400 100644 --- a/AppEngineAdmin/src/V1/Client/ServicesClient.php +++ b/AppEngineAdmin/src/V1/Client/ServicesClient.php @@ -48,10 +48,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) */ final class ServicesClient { diff --git a/AppEngineAdmin/src/V1/Client/VersionsClient.php b/AppEngineAdmin/src/V1/Client/VersionsClient.php index 5536ae4e6afb..6b61abecc9b4 100644 --- a/AppEngineAdmin/src/V1/Client/VersionsClient.php +++ b/AppEngineAdmin/src/V1/Client/VersionsClient.php @@ -49,11 +49,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createVersionAsync(CreateVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVersionAsync(CreateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) */ final class VersionsClient { diff --git a/AppHub/src/V1/Client/AppHubClient.php b/AppHub/src/V1/Client/AppHubClient.php index 0cbd2116701a..e944f105ba4b 100644 --- a/AppHub/src/V1/Client/AppHubClient.php +++ b/AppHub/src/V1/Client/AppHubClient.php @@ -94,38 +94,38 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createApplicationAsync(CreateApplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceProjectAttachmentAsync(CreateServiceProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createWorkloadAsync(CreateWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteApplicationAsync(DeleteApplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceProjectAttachmentAsync(DeleteServiceProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWorkloadAsync(DeleteWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface detachServiceProjectAttachmentAsync(DetachServiceProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getApplicationAsync(GetApplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDiscoveredServiceAsync(GetDiscoveredServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDiscoveredWorkloadAsync(GetDiscoveredWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceProjectAttachmentAsync(GetServiceProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkloadAsync(GetWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface listApplicationsAsync(ListApplicationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDiscoveredServicesAsync(ListDiscoveredServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDiscoveredWorkloadsAsync(ListDiscoveredWorkloadsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServiceProjectAttachmentsAsync(ListServiceProjectAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupDiscoveredServiceAsync(LookupDiscoveredServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupDiscoveredWorkloadAsync(LookupDiscoveredWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupServiceProjectAttachmentAsync(LookupServiceProjectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateApplicationAsync(UpdateApplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateWorkloadAsync(UpdateWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createApplicationAsync(CreateApplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceProjectAttachmentAsync(CreateServiceProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWorkloadAsync(CreateWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteApplicationAsync(DeleteApplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceProjectAttachmentAsync(DeleteServiceProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWorkloadAsync(DeleteWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface detachServiceProjectAttachmentAsync(DetachServiceProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getApplicationAsync(GetApplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDiscoveredServiceAsync(GetDiscoveredServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDiscoveredWorkloadAsync(GetDiscoveredWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceProjectAttachmentAsync(GetServiceProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkloadAsync(GetWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface listApplicationsAsync(ListApplicationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDiscoveredServicesAsync(ListDiscoveredServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDiscoveredWorkloadsAsync(ListDiscoveredWorkloadsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServiceProjectAttachmentsAsync(ListServiceProjectAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupDiscoveredServiceAsync(LookupDiscoveredServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupDiscoveredWorkloadAsync(LookupDiscoveredWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupServiceProjectAttachmentAsync(LookupServiceProjectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateApplicationAsync(UpdateApplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateWorkloadAsync(UpdateWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class AppHubClient { diff --git a/AppsChat/src/Chat/V1/Client/ChatServiceClient.php b/AppsChat/src/Chat/V1/Client/ChatServiceClient.php index 6f111785d59c..f5ce6214a1fd 100644 --- a/AppsChat/src/Chat/V1/Client/ChatServiceClient.php +++ b/AppsChat/src/Chat/V1/Client/ChatServiceClient.php @@ -86,35 +86,35 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface completeImportSpaceAsync(CompleteImportSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMembershipAsync(CreateMembershipRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMessageAsync(CreateMessageRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReactionAsync(CreateReactionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSpaceAsync(CreateSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMembershipAsync(DeleteMembershipRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMessageAsync(DeleteMessageRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteReactionAsync(DeleteReactionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSpaceAsync(DeleteSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface findDirectMessageAsync(FindDirectMessageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAttachmentAsync(GetAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMembershipAsync(GetMembershipRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMessageAsync(GetMessageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpaceAsync(GetSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpaceEventAsync(GetSpaceEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpaceReadStateAsync(GetSpaceReadStateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getThreadReadStateAsync(GetThreadReadStateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMembershipsAsync(ListMembershipsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMessagesAsync(ListMessagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReactionsAsync(ListReactionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSpaceEventsAsync(ListSpaceEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSpacesAsync(ListSpacesRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchSpacesAsync(SearchSpacesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setUpSpaceAsync(SetUpSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMembershipAsync(UpdateMembershipRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMessageAsync(UpdateMessageRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSpaceAsync(UpdateSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSpaceReadStateAsync(UpdateSpaceReadStateRequest $request, array $optionalArgs = []) - * @method PromiseInterface uploadAttachmentAsync(UploadAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface completeImportSpaceAsync(CompleteImportSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMembershipAsync(CreateMembershipRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMessageAsync(CreateMessageRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReactionAsync(CreateReactionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSpaceAsync(CreateSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMembershipAsync(DeleteMembershipRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMessageAsync(DeleteMessageRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteReactionAsync(DeleteReactionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSpaceAsync(DeleteSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface findDirectMessageAsync(FindDirectMessageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttachmentAsync(GetAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMembershipAsync(GetMembershipRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMessageAsync(GetMessageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpaceAsync(GetSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpaceEventAsync(GetSpaceEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpaceReadStateAsync(GetSpaceReadStateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getThreadReadStateAsync(GetThreadReadStateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMembershipsAsync(ListMembershipsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMessagesAsync(ListMessagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReactionsAsync(ListReactionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSpaceEventsAsync(ListSpaceEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSpacesAsync(ListSpacesRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchSpacesAsync(SearchSpacesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setUpSpaceAsync(SetUpSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMembershipAsync(UpdateMembershipRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMessageAsync(UpdateMessageRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSpaceAsync(UpdateSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSpaceReadStateAsync(UpdateSpaceReadStateRequest $request, array $optionalArgs = []) + * @method PromiseInterface uploadAttachmentAsync(UploadAttachmentRequest $request, array $optionalArgs = []) */ final class ChatServiceClient { diff --git a/AppsEventsSubscriptions/src/V1/Client/SubscriptionsServiceClient.php b/AppsEventsSubscriptions/src/V1/Client/SubscriptionsServiceClient.php index cad8645a3030..7ebdc82ac707 100644 --- a/AppsEventsSubscriptions/src/V1/Client/SubscriptionsServiceClient.php +++ b/AppsEventsSubscriptions/src/V1/Client/SubscriptionsServiceClient.php @@ -56,12 +56,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSubscriptionAsync(CreateSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSubscriptionAsync(DeleteSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSubscriptionAsync(GetSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSubscriptionsAsync(ListSubscriptionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface reactivateSubscriptionAsync(ReactivateSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSubscriptionAsync(UpdateSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSubscriptionAsync(CreateSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSubscriptionAsync(DeleteSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSubscriptionAsync(GetSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSubscriptionsAsync(ListSubscriptionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface reactivateSubscriptionAsync(ReactivateSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSubscriptionAsync(UpdateSubscriptionRequest $request, array $optionalArgs = []) */ final class SubscriptionsServiceClient { diff --git a/AppsMeet/src/V2/Client/ConferenceRecordsServiceClient.php b/AppsMeet/src/V2/Client/ConferenceRecordsServiceClient.php index 805549154df5..5c73fcff42dd 100644 --- a/AppsMeet/src/V2/Client/ConferenceRecordsServiceClient.php +++ b/AppsMeet/src/V2/Client/ConferenceRecordsServiceClient.php @@ -64,18 +64,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getConferenceRecordAsync(GetConferenceRecordRequest $request, array $optionalArgs = []) - * @method PromiseInterface getParticipantAsync(GetParticipantRequest $request, array $optionalArgs = []) - * @method PromiseInterface getParticipantSessionAsync(GetParticipantSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRecordingAsync(GetRecordingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTranscriptAsync(GetTranscriptRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTranscriptEntryAsync(GetTranscriptEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConferenceRecordsAsync(ListConferenceRecordsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listParticipantSessionsAsync(ListParticipantSessionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listParticipantsAsync(ListParticipantsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRecordingsAsync(ListRecordingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTranscriptEntriesAsync(ListTranscriptEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTranscriptsAsync(ListTranscriptsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConferenceRecordAsync(GetConferenceRecordRequest $request, array $optionalArgs = []) + * @method PromiseInterface getParticipantAsync(GetParticipantRequest $request, array $optionalArgs = []) + * @method PromiseInterface getParticipantSessionAsync(GetParticipantSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRecordingAsync(GetRecordingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTranscriptAsync(GetTranscriptRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTranscriptEntryAsync(GetTranscriptEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConferenceRecordsAsync(ListConferenceRecordsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listParticipantSessionsAsync(ListParticipantSessionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listParticipantsAsync(ListParticipantsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRecordingsAsync(ListRecordingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTranscriptEntriesAsync(ListTranscriptEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTranscriptsAsync(ListTranscriptsRequest $request, array $optionalArgs = []) */ final class ConferenceRecordsServiceClient { diff --git a/AppsMeet/src/V2/Client/SpacesServiceClient.php b/AppsMeet/src/V2/Client/SpacesServiceClient.php index 381f8fb71fbd..cd80b2f3ea4b 100644 --- a/AppsMeet/src/V2/Client/SpacesServiceClient.php +++ b/AppsMeet/src/V2/Client/SpacesServiceClient.php @@ -50,10 +50,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSpaceAsync(CreateSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface endActiveConferenceAsync(EndActiveConferenceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpaceAsync(GetSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSpaceAsync(UpdateSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSpaceAsync(CreateSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface endActiveConferenceAsync(EndActiveConferenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpaceAsync(GetSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSpaceAsync(UpdateSpaceRequest $request, array $optionalArgs = []) */ final class SpacesServiceClient { diff --git a/AppsMeet/src/V2beta/Client/ConferenceRecordsServiceClient.php b/AppsMeet/src/V2beta/Client/ConferenceRecordsServiceClient.php index 997a90c71065..292064cc5b4f 100644 --- a/AppsMeet/src/V2beta/Client/ConferenceRecordsServiceClient.php +++ b/AppsMeet/src/V2beta/Client/ConferenceRecordsServiceClient.php @@ -68,18 +68,18 @@ * * @experimental * - * @method PromiseInterface getConferenceRecordAsync(GetConferenceRecordRequest $request, array $optionalArgs = []) - * @method PromiseInterface getParticipantAsync(GetParticipantRequest $request, array $optionalArgs = []) - * @method PromiseInterface getParticipantSessionAsync(GetParticipantSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRecordingAsync(GetRecordingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTranscriptAsync(GetTranscriptRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTranscriptEntryAsync(GetTranscriptEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConferenceRecordsAsync(ListConferenceRecordsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listParticipantSessionsAsync(ListParticipantSessionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listParticipantsAsync(ListParticipantsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRecordingsAsync(ListRecordingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTranscriptEntriesAsync(ListTranscriptEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTranscriptsAsync(ListTranscriptsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConferenceRecordAsync(GetConferenceRecordRequest $request, array $optionalArgs = []) + * @method PromiseInterface getParticipantAsync(GetParticipantRequest $request, array $optionalArgs = []) + * @method PromiseInterface getParticipantSessionAsync(GetParticipantSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRecordingAsync(GetRecordingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTranscriptAsync(GetTranscriptRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTranscriptEntryAsync(GetTranscriptEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConferenceRecordsAsync(ListConferenceRecordsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listParticipantSessionsAsync(ListParticipantSessionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listParticipantsAsync(ListParticipantsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRecordingsAsync(ListRecordingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTranscriptEntriesAsync(ListTranscriptEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTranscriptsAsync(ListTranscriptsRequest $request, array $optionalArgs = []) */ final class ConferenceRecordsServiceClient { diff --git a/AppsMeet/src/V2beta/Client/SpacesServiceClient.php b/AppsMeet/src/V2beta/Client/SpacesServiceClient.php index 0d295f4d491c..d45a0f24d1e8 100644 --- a/AppsMeet/src/V2beta/Client/SpacesServiceClient.php +++ b/AppsMeet/src/V2beta/Client/SpacesServiceClient.php @@ -54,10 +54,10 @@ * * @experimental * - * @method PromiseInterface createSpaceAsync(CreateSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface endActiveConferenceAsync(EndActiveConferenceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpaceAsync(GetSpaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSpaceAsync(UpdateSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSpaceAsync(CreateSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface endActiveConferenceAsync(EndActiveConferenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpaceAsync(GetSpaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSpaceAsync(UpdateSpaceRequest $request, array $optionalArgs = []) */ final class SpacesServiceClient { diff --git a/Asset/src/V1/Client/AssetServiceClient.php b/Asset/src/V1/Client/AssetServiceClient.php index ef0d334c9463..461e1e66ff4a 100644 --- a/Asset/src/V1/Client/AssetServiceClient.php +++ b/Asset/src/V1/Client/AssetServiceClient.php @@ -80,29 +80,29 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface analyzeIamPolicyAsync(AnalyzeIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeIamPolicyLongrunningAsync(AnalyzeIamPolicyLongrunningRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeMoveAsync(AnalyzeMoveRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeOrgPoliciesAsync(AnalyzeOrgPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeOrgPolicyGovernedAssetsAsync(AnalyzeOrgPolicyGovernedAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeOrgPolicyGovernedContainersAsync(AnalyzeOrgPolicyGovernedContainersRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchGetAssetsHistoryAsync(BatchGetAssetsHistoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchGetEffectiveIamPoliciesAsync(BatchGetEffectiveIamPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFeedAsync(CreateFeedRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSavedQueryAsync(CreateSavedQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeedAsync(DeleteFeedRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSavedQueryAsync(DeleteSavedQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportAssetsAsync(ExportAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeedAsync(GetFeedRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSavedQueryAsync(GetSavedQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeedsAsync(ListFeedsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSavedQueriesAsync(ListSavedQueriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryAssetsAsync(QueryAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchAllIamPoliciesAsync(SearchAllIamPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchAllResourcesAsync(SearchAllResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFeedAsync(UpdateFeedRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSavedQueryAsync(UpdateSavedQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeIamPolicyAsync(AnalyzeIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeIamPolicyLongrunningAsync(AnalyzeIamPolicyLongrunningRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeMoveAsync(AnalyzeMoveRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeOrgPoliciesAsync(AnalyzeOrgPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeOrgPolicyGovernedAssetsAsync(AnalyzeOrgPolicyGovernedAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeOrgPolicyGovernedContainersAsync(AnalyzeOrgPolicyGovernedContainersRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchGetAssetsHistoryAsync(BatchGetAssetsHistoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchGetEffectiveIamPoliciesAsync(BatchGetEffectiveIamPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFeedAsync(CreateFeedRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSavedQueryAsync(CreateSavedQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeedAsync(DeleteFeedRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSavedQueryAsync(DeleteSavedQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportAssetsAsync(ExportAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeedAsync(GetFeedRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSavedQueryAsync(GetSavedQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeedsAsync(ListFeedsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSavedQueriesAsync(ListSavedQueriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryAssetsAsync(QueryAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchAllIamPoliciesAsync(SearchAllIamPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchAllResourcesAsync(SearchAllResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFeedAsync(UpdateFeedRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSavedQueryAsync(UpdateSavedQueryRequest $request, array $optionalArgs = []) */ final class AssetServiceClient { diff --git a/AssuredWorkloads/src/V1/Client/AssuredWorkloadsServiceClient.php b/AssuredWorkloads/src/V1/Client/AssuredWorkloadsServiceClient.php index 635f6b4714a0..58e2ff958744 100644 --- a/AssuredWorkloads/src/V1/Client/AssuredWorkloadsServiceClient.php +++ b/AssuredWorkloads/src/V1/Client/AssuredWorkloadsServiceClient.php @@ -62,15 +62,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface acknowledgeViolationAsync(AcknowledgeViolationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createWorkloadAsync(CreateWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWorkloadAsync(DeleteWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface getViolationAsync(GetViolationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkloadAsync(GetWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface listViolationsAsync(ListViolationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) - * @method PromiseInterface restrictAllowedResourcesAsync(RestrictAllowedResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateWorkloadAsync(UpdateWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface acknowledgeViolationAsync(AcknowledgeViolationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWorkloadAsync(CreateWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWorkloadAsync(DeleteWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface getViolationAsync(GetViolationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkloadAsync(GetWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface listViolationsAsync(ListViolationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) + * @method PromiseInterface restrictAllowedResourcesAsync(RestrictAllowedResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateWorkloadAsync(UpdateWorkloadRequest $request, array $optionalArgs = []) */ final class AssuredWorkloadsServiceClient { diff --git a/AssuredWorkloads/src/V1beta1/Client/AssuredWorkloadsServiceClient.php b/AssuredWorkloads/src/V1beta1/Client/AssuredWorkloadsServiceClient.php index 1883ed7224c7..99fdcc82c267 100644 --- a/AssuredWorkloads/src/V1beta1/Client/AssuredWorkloadsServiceClient.php +++ b/AssuredWorkloads/src/V1beta1/Client/AssuredWorkloadsServiceClient.php @@ -63,13 +63,13 @@ * * @experimental * - * @method PromiseInterface analyzeWorkloadMoveAsync(AnalyzeWorkloadMoveRequest $request, array $optionalArgs = []) - * @method PromiseInterface createWorkloadAsync(CreateWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWorkloadAsync(DeleteWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkloadAsync(GetWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) - * @method PromiseInterface restrictAllowedResourcesAsync(RestrictAllowedResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateWorkloadAsync(UpdateWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeWorkloadMoveAsync(AnalyzeWorkloadMoveRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWorkloadAsync(CreateWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWorkloadAsync(DeleteWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkloadAsync(GetWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) + * @method PromiseInterface restrictAllowedResourcesAsync(RestrictAllowedResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateWorkloadAsync(UpdateWorkloadRequest $request, array $optionalArgs = []) */ final class AssuredWorkloadsServiceClient { diff --git a/AutoMl/src/V1/Client/AutoMlClient.php b/AutoMl/src/V1/Client/AutoMlClient.php index 98fa0ec54eeb..22cb3da53a63 100644 --- a/AutoMl/src/V1/Client/AutoMlClient.php +++ b/AutoMl/src/V1/Client/AutoMlClient.php @@ -84,24 +84,24 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDatasetAsync(CreateDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createModelAsync(CreateModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDatasetAsync(DeleteDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteModelAsync(DeleteModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deployModelAsync(DeployModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportModelAsync(ExportModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAnnotationSpecAsync(GetAnnotationSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDatasetAsync(GetDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getModelAsync(GetModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getModelEvaluationAsync(GetModelEvaluationRequest $request, array $optionalArgs = []) - * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatasetsAsync(ListDatasetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listModelEvaluationsAsync(ListModelEvaluationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listModelsAsync(ListModelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeployModelAsync(UndeployModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDatasetAsync(UpdateDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateModelAsync(UpdateModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDatasetAsync(CreateDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createModelAsync(CreateModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDatasetAsync(DeleteDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteModelAsync(DeleteModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deployModelAsync(DeployModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportModelAsync(ExportModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAnnotationSpecAsync(GetAnnotationSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDatasetAsync(GetDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getModelAsync(GetModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getModelEvaluationAsync(GetModelEvaluationRequest $request, array $optionalArgs = []) + * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatasetsAsync(ListDatasetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listModelEvaluationsAsync(ListModelEvaluationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listModelsAsync(ListModelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeployModelAsync(UndeployModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDatasetAsync(UpdateDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateModelAsync(UpdateModelRequest $request, array $optionalArgs = []) */ final class AutoMlClient { diff --git a/AutoMl/src/V1/Client/PredictionServiceClient.php b/AutoMl/src/V1/Client/PredictionServiceClient.php index 9e8c66e67ed4..1f81911f0b21 100644 --- a/AutoMl/src/V1/Client/PredictionServiceClient.php +++ b/AutoMl/src/V1/Client/PredictionServiceClient.php @@ -55,8 +55,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchPredictAsync(BatchPredictRequest $request, array $optionalArgs = []) - * @method PromiseInterface predictAsync(PredictRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchPredictAsync(BatchPredictRequest $request, array $optionalArgs = []) + * @method PromiseInterface predictAsync(PredictRequest $request, array $optionalArgs = []) */ final class PredictionServiceClient { diff --git a/BackupDr/src/V1/Client/BackupDRClient.php b/BackupDr/src/V1/Client/BackupDRClient.php index 05d8d344e49c..d58d2a408b5c 100644 --- a/BackupDr/src/V1/Client/BackupDRClient.php +++ b/BackupDr/src/V1/Client/BackupDRClient.php @@ -90,38 +90,38 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createBackupPlanAsync(CreateBackupPlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupPlanAssociationAsync(CreateBackupPlanAssociationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupVaultAsync(CreateBackupVaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface createManagementServerAsync(CreateManagementServerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupPlanAsync(DeleteBackupPlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupPlanAssociationAsync(DeleteBackupPlanAssociationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupVaultAsync(DeleteBackupVaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteManagementServerAsync(DeleteManagementServerRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchUsableBackupVaultsAsync(FetchUsableBackupVaultsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupPlanAsync(GetBackupPlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupPlanAssociationAsync(GetBackupPlanAssociationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupVaultAsync(GetBackupVaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataSourceAsync(GetDataSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getManagementServerAsync(GetManagementServerRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupPlanAssociationsAsync(ListBackupPlanAssociationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupPlansAsync(ListBackupPlansRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupVaultsAsync(ListBackupVaultsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataSourcesAsync(ListDataSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listManagementServersAsync(ListManagementServersRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreBackupAsync(RestoreBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface triggerBackupAsync(TriggerBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupVaultAsync(UpdateBackupVaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataSourceAsync(UpdateDataSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupPlanAsync(CreateBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupPlanAssociationAsync(CreateBackupPlanAssociationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupVaultAsync(CreateBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface createManagementServerAsync(CreateManagementServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupPlanAsync(DeleteBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupPlanAssociationAsync(DeleteBackupPlanAssociationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupVaultAsync(DeleteBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteManagementServerAsync(DeleteManagementServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchUsableBackupVaultsAsync(FetchUsableBackupVaultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupPlanAsync(GetBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupPlanAssociationAsync(GetBackupPlanAssociationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupVaultAsync(GetBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataSourceAsync(GetDataSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getManagementServerAsync(GetManagementServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupPlanAssociationsAsync(ListBackupPlanAssociationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupPlansAsync(ListBackupPlansRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupVaultsAsync(ListBackupVaultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataSourcesAsync(ListDataSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listManagementServersAsync(ListManagementServersRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreBackupAsync(RestoreBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface triggerBackupAsync(TriggerBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupVaultAsync(UpdateBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataSourceAsync(UpdateDataSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class BackupDRClient { From 0414f3006d014f918a99512d044c880ae65ccd35 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 1 Nov 2024 14:30:06 -0400 Subject: [PATCH 064/157] docs: add response types for async magic methods (#7785) PiperOrigin-RevId: 691866489 Source-Link: https://github.com/googleapis/googleapis/commit/cf0f35efca7e0d507af89e9ddc46cba2f41eb9f7 Source-Link: https://github.com/googleapis/googleapis-gen/commit/e556aaed2dc6f46b6ff8cc769fabadcfbe2504a4 Copy-Tag: eyJwIjoiQmFyZU1ldGFsU29sdXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmF0Y2gvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmV5b25kQ29ycEFwcENvbm5lY3Rpb25zLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQmV5b25kQ29ycEFwcENvbm5lY3RvcnMvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmV5b25kQ29ycEFwcEdhdGV3YXlzLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQmV5b25kQ29ycENsaWVudENvbm5lY3RvclNlcnZpY2VzLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQmV5b25kQ29ycENsaWVudEdhdGV3YXlzLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQmlnUXVlcnlBbmFseXRpY3NIdWIvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlDb25uZWN0aW9uLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQmlnUXVlcnlEYXRhRXhjaGFuZ2UvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlEYXRhUG9saWNpZXMvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlEYXRhVHJhbnNmZXIvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlNaWdyYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlSZXNlcnZhdGlvbi8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQmlnUXVlcnlTdG9yYWdlLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQmlndGFibGUvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmlsbGluZy8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQmlsbGluZ0J1ZGdldHMvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiQmluYXJ5QXV0aG9yaXphdGlvbi8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQ2VydGlmaWNhdGVNYW5hZ2VyLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= --- .../src/V2/Client/BareMetalSolutionClient.php | 92 +++++++++---------- Batch/src/V1/Client/BatchServiceClient.php | 16 ++-- .../V1/Client/AppConnectionsServiceClient.php | 22 ++--- .../V1/Client/AppConnectorsServiceClient.php | 22 ++--- .../V1/Client/AppGatewaysServiceClient.php | 18 ++-- .../ClientConnectorServicesServiceClient.php | 20 ++-- .../V1/Client/ClientGatewaysServiceClient.php | 18 ++-- .../V1/Client/AnalyticsHubServiceClient.php | 44 ++++----- .../src/V1/Client/ConnectionServiceClient.php | 16 ++-- .../Client/AnalyticsHubServiceClient.php | 34 +++---- .../src/V1/Client/DataPolicyServiceClient.php | 18 ++-- .../V1/Client/DataTransferServiceClient.php | 36 ++++---- .../src/V2/Client/MigrationServiceClient.php | 14 +-- .../V1/Client/ReservationServiceClient.php | 42 ++++----- .../src/V1/Client/BigQueryReadClient.php | 4 +- .../src/V1/Client/BigQueryWriteClient.php | 10 +- .../V2/Client/BigtableInstanceAdminClient.php | 42 ++++----- .../V2/Client/BigtableTableAdminClient.php | 60 ++++++------ Bigtable/src/V2/Client/BigtableClient.php | 8 +- Billing/src/V1/Client/CloudBillingClient.php | 22 ++--- Billing/src/V1/Client/CloudCatalogClient.php | 4 +- .../src/V1/Client/BudgetServiceClient.php | 10 +- .../BinauthzManagementServiceV1Client.php | 14 +-- .../src/V1/Client/SystemPolicyV1Client.php | 2 +- .../V1/Client/ValidationHelperV1Client.php | 2 +- .../V1/Client/CertificateManagerClient.php | 62 ++++++------- 26 files changed, 326 insertions(+), 326 deletions(-) diff --git a/BareMetalSolution/src/V2/Client/BareMetalSolutionClient.php b/BareMetalSolution/src/V2/Client/BareMetalSolutionClient.php index bd66a99103f1..defe8a098090 100644 --- a/BareMetalSolution/src/V2/Client/BareMetalSolutionClient.php +++ b/BareMetalSolution/src/V2/Client/BareMetalSolutionClient.php @@ -113,52 +113,52 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createNfsShareAsync(CreateNfsShareRequest $request, array $optionalArgs = []) - * @method PromiseInterface createProvisioningConfigAsync(CreateProvisioningConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSSHKeyAsync(CreateSSHKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createVolumeSnapshotAsync(CreateVolumeSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNfsShareAsync(DeleteNfsShareRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSSHKeyAsync(DeleteSSHKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVolumeSnapshotAsync(DeleteVolumeSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface detachLunAsync(DetachLunRequest $request, array $optionalArgs = []) - * @method PromiseInterface disableInteractiveSerialConsoleAsync(DisableInteractiveSerialConsoleRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableInteractiveSerialConsoleAsync(EnableInteractiveSerialConsoleRequest $request, array $optionalArgs = []) - * @method PromiseInterface evictLunAsync(EvictLunRequest $request, array $optionalArgs = []) - * @method PromiseInterface evictVolumeAsync(EvictVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLunAsync(GetLunRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNetworkAsync(GetNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNfsShareAsync(GetNfsShareRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProvisioningConfigAsync(GetProvisioningConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVolumeAsync(GetVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVolumeSnapshotAsync(GetVolumeSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLunsAsync(ListLunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworkUsageAsync(ListNetworkUsageRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworksAsync(ListNetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNfsSharesAsync(ListNfsSharesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOSImagesAsync(ListOSImagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProvisioningQuotasAsync(ListProvisioningQuotasRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSSHKeysAsync(ListSSHKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVolumeSnapshotsAsync(ListVolumeSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVolumesAsync(ListVolumesRequest $request, array $optionalArgs = []) - * @method PromiseInterface renameInstanceAsync(RenameInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface renameNetworkAsync(RenameNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface renameNfsShareAsync(RenameNfsShareRequest $request, array $optionalArgs = []) - * @method PromiseInterface renameVolumeAsync(RenameVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetInstanceAsync(ResetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface resizeVolumeAsync(ResizeVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreVolumeSnapshotAsync(RestoreVolumeSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface startInstanceAsync(StartInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopInstanceAsync(StopInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface submitProvisioningConfigAsync(SubmitProvisioningConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNetworkAsync(UpdateNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNfsShareAsync(UpdateNfsShareRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProvisioningConfigAsync(UpdateProvisioningConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVolumeAsync(UpdateVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNfsShareAsync(CreateNfsShareRequest $request, array $optionalArgs = []) + * @method PromiseInterface createProvisioningConfigAsync(CreateProvisioningConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSSHKeyAsync(CreateSSHKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVolumeSnapshotAsync(CreateVolumeSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNfsShareAsync(DeleteNfsShareRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSSHKeyAsync(DeleteSSHKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVolumeSnapshotAsync(DeleteVolumeSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface detachLunAsync(DetachLunRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableInteractiveSerialConsoleAsync(DisableInteractiveSerialConsoleRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableInteractiveSerialConsoleAsync(EnableInteractiveSerialConsoleRequest $request, array $optionalArgs = []) + * @method PromiseInterface evictLunAsync(EvictLunRequest $request, array $optionalArgs = []) + * @method PromiseInterface evictVolumeAsync(EvictVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLunAsync(GetLunRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNetworkAsync(GetNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNfsShareAsync(GetNfsShareRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProvisioningConfigAsync(GetProvisioningConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVolumeAsync(GetVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVolumeSnapshotAsync(GetVolumeSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLunsAsync(ListLunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworkUsageAsync(ListNetworkUsageRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworksAsync(ListNetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNfsSharesAsync(ListNfsSharesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOSImagesAsync(ListOSImagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProvisioningQuotasAsync(ListProvisioningQuotasRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSSHKeysAsync(ListSSHKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVolumeSnapshotsAsync(ListVolumeSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVolumesAsync(ListVolumesRequest $request, array $optionalArgs = []) + * @method PromiseInterface renameInstanceAsync(RenameInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface renameNetworkAsync(RenameNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface renameNfsShareAsync(RenameNfsShareRequest $request, array $optionalArgs = []) + * @method PromiseInterface renameVolumeAsync(RenameVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetInstanceAsync(ResetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface resizeVolumeAsync(ResizeVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreVolumeSnapshotAsync(RestoreVolumeSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface startInstanceAsync(StartInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopInstanceAsync(StopInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface submitProvisioningConfigAsync(SubmitProvisioningConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNetworkAsync(UpdateNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNfsShareAsync(UpdateNfsShareRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProvisioningConfigAsync(UpdateProvisioningConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVolumeAsync(UpdateVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class BareMetalSolutionClient { diff --git a/Batch/src/V1/Client/BatchServiceClient.php b/Batch/src/V1/Client/BatchServiceClient.php index ea3a0cc8cb6e..e03594c07663 100644 --- a/Batch/src/V1/Client/BatchServiceClient.php +++ b/Batch/src/V1/Client/BatchServiceClient.php @@ -62,14 +62,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTaskAsync(GetTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTasksAsync(ListTasksRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTaskAsync(GetTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTasksAsync(ListTasksRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class BatchServiceClient { diff --git a/BeyondCorpAppConnections/src/V1/Client/AppConnectionsServiceClient.php b/BeyondCorpAppConnections/src/V1/Client/AppConnectionsServiceClient.php index 9ab45eca4fb5..3003a9688e99 100644 --- a/BeyondCorpAppConnections/src/V1/Client/AppConnectionsServiceClient.php +++ b/BeyondCorpAppConnections/src/V1/Client/AppConnectionsServiceClient.php @@ -77,17 +77,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAppConnectionAsync(CreateAppConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAppConnectionAsync(DeleteAppConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAppConnectionAsync(GetAppConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAppConnectionsAsync(ListAppConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface resolveAppConnectionsAsync(ResolveAppConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAppConnectionAsync(UpdateAppConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAppConnectionAsync(CreateAppConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAppConnectionAsync(DeleteAppConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAppConnectionAsync(GetAppConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAppConnectionsAsync(ListAppConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface resolveAppConnectionsAsync(ResolveAppConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAppConnectionAsync(UpdateAppConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class AppConnectionsServiceClient { diff --git a/BeyondCorpAppConnectors/src/V1/Client/AppConnectorsServiceClient.php b/BeyondCorpAppConnectors/src/V1/Client/AppConnectorsServiceClient.php index fa1f8d9717f6..7d03a1a245b9 100644 --- a/BeyondCorpAppConnectors/src/V1/Client/AppConnectorsServiceClient.php +++ b/BeyondCorpAppConnectors/src/V1/Client/AppConnectorsServiceClient.php @@ -77,17 +77,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAppConnectorAsync(CreateAppConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAppConnectorAsync(DeleteAppConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAppConnectorAsync(GetAppConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAppConnectorsAsync(ListAppConnectorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface reportStatusAsync(ReportStatusRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAppConnectorAsync(UpdateAppConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAppConnectorAsync(CreateAppConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAppConnectorAsync(DeleteAppConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAppConnectorAsync(GetAppConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAppConnectorsAsync(ListAppConnectorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface reportStatusAsync(ReportStatusRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAppConnectorAsync(UpdateAppConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class AppConnectorsServiceClient { diff --git a/BeyondCorpAppGateways/src/V1/Client/AppGatewaysServiceClient.php b/BeyondCorpAppGateways/src/V1/Client/AppGatewaysServiceClient.php index 88498369e2ce..636c409e52a9 100644 --- a/BeyondCorpAppGateways/src/V1/Client/AppGatewaysServiceClient.php +++ b/BeyondCorpAppGateways/src/V1/Client/AppGatewaysServiceClient.php @@ -75,15 +75,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAppGatewayAsync(CreateAppGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAppGatewayAsync(DeleteAppGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAppGatewayAsync(GetAppGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAppGatewaysAsync(ListAppGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAppGatewayAsync(CreateAppGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAppGatewayAsync(DeleteAppGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAppGatewayAsync(GetAppGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAppGatewaysAsync(ListAppGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class AppGatewaysServiceClient { diff --git a/BeyondCorpClientConnectorServices/src/V1/Client/ClientConnectorServicesServiceClient.php b/BeyondCorpClientConnectorServices/src/V1/Client/ClientConnectorServicesServiceClient.php index 1876632db42d..38d64b4d8dfb 100644 --- a/BeyondCorpClientConnectorServices/src/V1/Client/ClientConnectorServicesServiceClient.php +++ b/BeyondCorpClientConnectorServices/src/V1/Client/ClientConnectorServicesServiceClient.php @@ -73,16 +73,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createClientConnectorServiceAsync(CreateClientConnectorServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClientConnectorServiceAsync(DeleteClientConnectorServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClientConnectorServiceAsync(GetClientConnectorServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClientConnectorServicesAsync(ListClientConnectorServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClientConnectorServiceAsync(UpdateClientConnectorServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClientConnectorServiceAsync(CreateClientConnectorServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClientConnectorServiceAsync(DeleteClientConnectorServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClientConnectorServiceAsync(GetClientConnectorServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClientConnectorServicesAsync(ListClientConnectorServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClientConnectorServiceAsync(UpdateClientConnectorServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ClientConnectorServicesServiceClient { diff --git a/BeyondCorpClientGateways/src/V1/Client/ClientGatewaysServiceClient.php b/BeyondCorpClientGateways/src/V1/Client/ClientGatewaysServiceClient.php index d0aeb5edcc21..1416bafbe520 100644 --- a/BeyondCorpClientGateways/src/V1/Client/ClientGatewaysServiceClient.php +++ b/BeyondCorpClientGateways/src/V1/Client/ClientGatewaysServiceClient.php @@ -72,15 +72,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createClientGatewayAsync(CreateClientGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClientGatewayAsync(DeleteClientGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClientGatewayAsync(GetClientGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClientGatewaysAsync(ListClientGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClientGatewayAsync(CreateClientGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClientGatewayAsync(DeleteClientGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClientGatewayAsync(GetClientGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClientGatewaysAsync(ListClientGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ClientGatewaysServiceClient { diff --git a/BigQueryAnalyticsHub/src/V1/Client/AnalyticsHubServiceClient.php b/BigQueryAnalyticsHub/src/V1/Client/AnalyticsHubServiceClient.php index be71ede70594..d88f8d7ea3cb 100644 --- a/BigQueryAnalyticsHub/src/V1/Client/AnalyticsHubServiceClient.php +++ b/BigQueryAnalyticsHub/src/V1/Client/AnalyticsHubServiceClient.php @@ -83,28 +83,28 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDataExchangeAsync(CreateDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createListingAsync(CreateListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataExchangeAsync(DeleteDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteListingAsync(DeleteListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSubscriptionAsync(DeleteSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataExchangeAsync(GetDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getListingAsync(GetListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSubscriptionAsync(GetSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataExchangesAsync(ListDataExchangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listListingsAsync(ListListingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOrgDataExchangesAsync(ListOrgDataExchangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSharedResourceSubscriptionsAsync(ListSharedResourceSubscriptionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSubscriptionsAsync(ListSubscriptionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface refreshSubscriptionAsync(RefreshSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface revokeSubscriptionAsync(RevokeSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface subscribeDataExchangeAsync(SubscribeDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface subscribeListingAsync(SubscribeListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataExchangeAsync(UpdateDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateListingAsync(UpdateListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataExchangeAsync(CreateDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createListingAsync(CreateListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataExchangeAsync(DeleteDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteListingAsync(DeleteListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSubscriptionAsync(DeleteSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataExchangeAsync(GetDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getListingAsync(GetListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSubscriptionAsync(GetSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataExchangesAsync(ListDataExchangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listListingsAsync(ListListingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOrgDataExchangesAsync(ListOrgDataExchangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSharedResourceSubscriptionsAsync(ListSharedResourceSubscriptionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSubscriptionsAsync(ListSubscriptionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface refreshSubscriptionAsync(RefreshSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface revokeSubscriptionAsync(RevokeSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface subscribeDataExchangeAsync(SubscribeDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface subscribeListingAsync(SubscribeListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataExchangeAsync(UpdateDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateListingAsync(UpdateListingRequest $request, array $optionalArgs = []) */ final class AnalyticsHubServiceClient { diff --git a/BigQueryConnection/src/V1/Client/ConnectionServiceClient.php b/BigQueryConnection/src/V1/Client/ConnectionServiceClient.php index 524b44419005..9d98978af9a0 100644 --- a/BigQueryConnection/src/V1/Client/ConnectionServiceClient.php +++ b/BigQueryConnection/src/V1/Client/ConnectionServiceClient.php @@ -57,14 +57,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createConnectionAsync(CreateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectionAsync(DeleteConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectionAsync(GetConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConnectionAsync(UpdateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectionAsync(CreateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectionAsync(DeleteConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectionAsync(GetConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConnectionAsync(UpdateConnectionRequest $request, array $optionalArgs = []) */ final class ConnectionServiceClient { diff --git a/BigQueryDataExchange/src/V1beta1/Client/AnalyticsHubServiceClient.php b/BigQueryDataExchange/src/V1beta1/Client/AnalyticsHubServiceClient.php index 748d74eb1e97..dfe68c92546b 100644 --- a/BigQueryDataExchange/src/V1beta1/Client/AnalyticsHubServiceClient.php +++ b/BigQueryDataExchange/src/V1beta1/Client/AnalyticsHubServiceClient.php @@ -78,23 +78,23 @@ * * @experimental * - * @method PromiseInterface createDataExchangeAsync(CreateDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createListingAsync(CreateListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataExchangeAsync(DeleteDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteListingAsync(DeleteListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataExchangeAsync(GetDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getListingAsync(GetListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataExchangesAsync(ListDataExchangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listListingsAsync(ListListingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOrgDataExchangesAsync(ListOrgDataExchangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface subscribeListingAsync(SubscribeListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataExchangeAsync(UpdateDataExchangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateListingAsync(UpdateListingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataExchangeAsync(CreateDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createListingAsync(CreateListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataExchangeAsync(DeleteDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteListingAsync(DeleteListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataExchangeAsync(GetDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getListingAsync(GetListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataExchangesAsync(ListDataExchangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listListingsAsync(ListListingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOrgDataExchangesAsync(ListOrgDataExchangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface subscribeListingAsync(SubscribeListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataExchangeAsync(UpdateDataExchangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateListingAsync(UpdateListingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class AnalyticsHubServiceClient { diff --git a/BigQueryDataPolicies/src/V1/Client/DataPolicyServiceClient.php b/BigQueryDataPolicies/src/V1/Client/DataPolicyServiceClient.php index 974a34524c66..dba3a26fbfb7 100644 --- a/BigQueryDataPolicies/src/V1/Client/DataPolicyServiceClient.php +++ b/BigQueryDataPolicies/src/V1/Client/DataPolicyServiceClient.php @@ -58,15 +58,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDataPolicyAsync(CreateDataPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataPolicyAsync(DeleteDataPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataPolicyAsync(GetDataPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataPoliciesAsync(ListDataPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface renameDataPolicyAsync(RenameDataPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataPolicyAsync(UpdateDataPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataPolicyAsync(CreateDataPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataPolicyAsync(DeleteDataPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataPolicyAsync(GetDataPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataPoliciesAsync(ListDataPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface renameDataPolicyAsync(RenameDataPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataPolicyAsync(UpdateDataPolicyRequest $request, array $optionalArgs = []) */ final class DataPolicyServiceClient { diff --git a/BigQueryDataTransfer/src/V1/Client/DataTransferServiceClient.php b/BigQueryDataTransfer/src/V1/Client/DataTransferServiceClient.php index 6b37a511ec15..2573f7174a0e 100644 --- a/BigQueryDataTransfer/src/V1/Client/DataTransferServiceClient.php +++ b/BigQueryDataTransfer/src/V1/Client/DataTransferServiceClient.php @@ -71,24 +71,24 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface checkValidCredsAsync(CheckValidCredsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTransferConfigAsync(CreateTransferConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTransferConfigAsync(DeleteTransferConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTransferRunAsync(DeleteTransferRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface enrollDataSourcesAsync(EnrollDataSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataSourceAsync(GetDataSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTransferConfigAsync(GetTransferConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTransferRunAsync(GetTransferRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataSourcesAsync(ListDataSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTransferConfigsAsync(ListTransferConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTransferLogsAsync(ListTransferLogsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTransferRunsAsync(ListTransferRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface scheduleTransferRunsAsync(ScheduleTransferRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface startManualTransferRunsAsync(StartManualTransferRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface unenrollDataSourcesAsync(UnenrollDataSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTransferConfigAsync(UpdateTransferConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkValidCredsAsync(CheckValidCredsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTransferConfigAsync(CreateTransferConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTransferConfigAsync(DeleteTransferConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTransferRunAsync(DeleteTransferRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface enrollDataSourcesAsync(EnrollDataSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataSourceAsync(GetDataSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTransferConfigAsync(GetTransferConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTransferRunAsync(GetTransferRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataSourcesAsync(ListDataSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTransferConfigsAsync(ListTransferConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTransferLogsAsync(ListTransferLogsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTransferRunsAsync(ListTransferRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface scheduleTransferRunsAsync(ScheduleTransferRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface startManualTransferRunsAsync(StartManualTransferRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface unenrollDataSourcesAsync(UnenrollDataSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTransferConfigAsync(UpdateTransferConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DataTransferServiceClient { diff --git a/BigQueryMigration/src/V2/Client/MigrationServiceClient.php b/BigQueryMigration/src/V2/Client/MigrationServiceClient.php index 73ea0940ca76..244781248cdc 100644 --- a/BigQueryMigration/src/V2/Client/MigrationServiceClient.php +++ b/BigQueryMigration/src/V2/Client/MigrationServiceClient.php @@ -55,13 +55,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createMigrationWorkflowAsync(CreateMigrationWorkflowRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMigrationSubtaskAsync(GetMigrationSubtaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMigrationWorkflowAsync(GetMigrationWorkflowRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMigrationSubtasksAsync(ListMigrationSubtasksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMigrationWorkflowsAsync(ListMigrationWorkflowsRequest $request, array $optionalArgs = []) - * @method PromiseInterface startMigrationWorkflowAsync(StartMigrationWorkflowRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMigrationWorkflowAsync(CreateMigrationWorkflowRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMigrationSubtaskAsync(GetMigrationSubtaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMigrationWorkflowAsync(GetMigrationWorkflowRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMigrationSubtasksAsync(ListMigrationSubtasksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMigrationWorkflowsAsync(ListMigrationWorkflowsRequest $request, array $optionalArgs = []) + * @method PromiseInterface startMigrationWorkflowAsync(StartMigrationWorkflowRequest $request, array $optionalArgs = []) */ final class MigrationServiceClient { diff --git a/BigQueryReservation/src/V1/Client/ReservationServiceClient.php b/BigQueryReservation/src/V1/Client/ReservationServiceClient.php index 253e18dcf340..7d898d0ffb1b 100644 --- a/BigQueryReservation/src/V1/Client/ReservationServiceClient.php +++ b/BigQueryReservation/src/V1/Client/ReservationServiceClient.php @@ -86,27 +86,27 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAssignmentAsync(CreateAssignmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCapacityCommitmentAsync(CreateCapacityCommitmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReservationAsync(CreateReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAssignmentAsync(DeleteAssignmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCapacityCommitmentAsync(DeleteCapacityCommitmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteReservationAsync(DeleteReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBiReservationAsync(GetBiReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCapacityCommitmentAsync(GetCapacityCommitmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReservationAsync(GetReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAssignmentsAsync(ListAssignmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCapacityCommitmentsAsync(ListCapacityCommitmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReservationsAsync(ListReservationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface mergeCapacityCommitmentsAsync(MergeCapacityCommitmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveAssignmentAsync(MoveAssignmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchAllAssignmentsAsync(SearchAllAssignmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchAssignmentsAsync(SearchAssignmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface splitCapacityCommitmentAsync(SplitCapacityCommitmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAssignmentAsync(UpdateAssignmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBiReservationAsync(UpdateBiReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCapacityCommitmentAsync(UpdateCapacityCommitmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateReservationAsync(UpdateReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAssignmentAsync(CreateAssignmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCapacityCommitmentAsync(CreateCapacityCommitmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReservationAsync(CreateReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAssignmentAsync(DeleteAssignmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCapacityCommitmentAsync(DeleteCapacityCommitmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteReservationAsync(DeleteReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBiReservationAsync(GetBiReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCapacityCommitmentAsync(GetCapacityCommitmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReservationAsync(GetReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAssignmentsAsync(ListAssignmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCapacityCommitmentsAsync(ListCapacityCommitmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReservationsAsync(ListReservationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface mergeCapacityCommitmentsAsync(MergeCapacityCommitmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveAssignmentAsync(MoveAssignmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchAllAssignmentsAsync(SearchAllAssignmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchAssignmentsAsync(SearchAssignmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface splitCapacityCommitmentAsync(SplitCapacityCommitmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAssignmentAsync(UpdateAssignmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBiReservationAsync(UpdateBiReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCapacityCommitmentAsync(UpdateCapacityCommitmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateReservationAsync(UpdateReservationRequest $request, array $optionalArgs = []) */ final class ReservationServiceClient { diff --git a/BigQueryStorage/src/V1/Client/BigQueryReadClient.php b/BigQueryStorage/src/V1/Client/BigQueryReadClient.php index 72cbc19e3681..c08dc6a41419 100644 --- a/BigQueryStorage/src/V1/Client/BigQueryReadClient.php +++ b/BigQueryStorage/src/V1/Client/BigQueryReadClient.php @@ -53,8 +53,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createReadSessionAsync(CreateReadSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface splitReadStreamAsync(SplitReadStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReadSessionAsync(CreateReadSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface splitReadStreamAsync(SplitReadStreamRequest $request, array $optionalArgs = []) */ final class BigQueryReadClient { diff --git a/BigQueryStorage/src/V1/Client/BigQueryWriteClient.php b/BigQueryStorage/src/V1/Client/BigQueryWriteClient.php index 33c4e93e8eff..9624c1cf8977 100644 --- a/BigQueryStorage/src/V1/Client/BigQueryWriteClient.php +++ b/BigQueryStorage/src/V1/Client/BigQueryWriteClient.php @@ -60,11 +60,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCommitWriteStreamsAsync(BatchCommitWriteStreamsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createWriteStreamAsync(CreateWriteStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface finalizeWriteStreamAsync(FinalizeWriteStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface flushRowsAsync(FlushRowsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWriteStreamAsync(GetWriteStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCommitWriteStreamsAsync(BatchCommitWriteStreamsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWriteStreamAsync(CreateWriteStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface finalizeWriteStreamAsync(FinalizeWriteStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface flushRowsAsync(FlushRowsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWriteStreamAsync(GetWriteStreamRequest $request, array $optionalArgs = []) */ final class BigQueryWriteClient { diff --git a/Bigtable/src/Admin/V2/Client/BigtableInstanceAdminClient.php b/Bigtable/src/Admin/V2/Client/BigtableInstanceAdminClient.php index 724cfa65908e..b45bb6498897 100644 --- a/Bigtable/src/Admin/V2/Client/BigtableInstanceAdminClient.php +++ b/Bigtable/src/Admin/V2/Client/BigtableInstanceAdminClient.php @@ -79,27 +79,27 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAppProfileAsync(CreateAppProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAppProfileAsync(DeleteAppProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAppProfileAsync(GetAppProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAppProfilesAsync(ListAppProfilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listHotTabletsAsync(ListHotTabletsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface partialUpdateClusterAsync(PartialUpdateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface partialUpdateInstanceAsync(PartialUpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAppProfileAsync(UpdateAppProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClusterAsync(Cluster $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(Instance $request, array $optionalArgs = []) + * @method PromiseInterface createAppProfileAsync(CreateAppProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAppProfileAsync(DeleteAppProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAppProfileAsync(GetAppProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAppProfilesAsync(ListAppProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listHotTabletsAsync(ListHotTabletsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface partialUpdateClusterAsync(PartialUpdateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface partialUpdateInstanceAsync(PartialUpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAppProfileAsync(UpdateAppProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClusterAsync(Cluster $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(Instance $request, array $optionalArgs = []) */ final class BigtableInstanceAdminClient { diff --git a/Bigtable/src/Admin/V2/Client/BigtableTableAdminClient.php b/Bigtable/src/Admin/V2/Client/BigtableTableAdminClient.php index 6fc04363ca58..854d55554863 100644 --- a/Bigtable/src/Admin/V2/Client/BigtableTableAdminClient.php +++ b/Bigtable/src/Admin/V2/Client/BigtableTableAdminClient.php @@ -95,36 +95,36 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface checkConsistencyAsync(CheckConsistencyRequest $request, array $optionalArgs = []) - * @method PromiseInterface copyBackupAsync(CopyBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAuthorizedViewAsync(CreateAuthorizedViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTableAsync(CreateTableRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTableFromSnapshotAsync(CreateTableFromSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAuthorizedViewAsync(DeleteAuthorizedViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTableAsync(DeleteTableRequest $request, array $optionalArgs = []) - * @method PromiseInterface dropRowRangeAsync(DropRowRangeRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateConsistencyTokenAsync(GenerateConsistencyTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAuthorizedViewAsync(GetAuthorizedViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTableAsync(GetTableRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAuthorizedViewsAsync(ListAuthorizedViewsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTablesAsync(ListTablesRequest $request, array $optionalArgs = []) - * @method PromiseInterface modifyColumnFamiliesAsync(ModifyColumnFamiliesRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreTableAsync(RestoreTableRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface snapshotTableAsync(SnapshotTableRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteTableAsync(UndeleteTableRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAuthorizedViewAsync(UpdateAuthorizedViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTableAsync(UpdateTableRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkConsistencyAsync(CheckConsistencyRequest $request, array $optionalArgs = []) + * @method PromiseInterface copyBackupAsync(CopyBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAuthorizedViewAsync(CreateAuthorizedViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTableAsync(CreateTableRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTableFromSnapshotAsync(CreateTableFromSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAuthorizedViewAsync(DeleteAuthorizedViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTableAsync(DeleteTableRequest $request, array $optionalArgs = []) + * @method PromiseInterface dropRowRangeAsync(DropRowRangeRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateConsistencyTokenAsync(GenerateConsistencyTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAuthorizedViewAsync(GetAuthorizedViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface
getTableAsync(GetTableRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAuthorizedViewsAsync(ListAuthorizedViewsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTablesAsync(ListTablesRequest $request, array $optionalArgs = []) + * @method PromiseInterface
modifyColumnFamiliesAsync(ModifyColumnFamiliesRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreTableAsync(RestoreTableRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface snapshotTableAsync(SnapshotTableRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteTableAsync(UndeleteTableRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAuthorizedViewAsync(UpdateAuthorizedViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTableAsync(UpdateTableRequest $request, array $optionalArgs = []) */ final class BigtableTableAdminClient { diff --git a/Bigtable/src/V2/Client/BigtableClient.php b/Bigtable/src/V2/Client/BigtableClient.php index aeb45221a720..24c6994dd499 100644 --- a/Bigtable/src/V2/Client/BigtableClient.php +++ b/Bigtable/src/V2/Client/BigtableClient.php @@ -64,10 +64,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface checkAndMutateRowAsync(CheckAndMutateRowRequest $request, array $optionalArgs = []) - * @method PromiseInterface mutateRowAsync(MutateRowRequest $request, array $optionalArgs = []) - * @method PromiseInterface pingAndWarmAsync(PingAndWarmRequest $request, array $optionalArgs = []) - * @method PromiseInterface readModifyWriteRowAsync(ReadModifyWriteRowRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkAndMutateRowAsync(CheckAndMutateRowRequest $request, array $optionalArgs = []) + * @method PromiseInterface mutateRowAsync(MutateRowRequest $request, array $optionalArgs = []) + * @method PromiseInterface pingAndWarmAsync(PingAndWarmRequest $request, array $optionalArgs = []) + * @method PromiseInterface readModifyWriteRowAsync(ReadModifyWriteRowRequest $request, array $optionalArgs = []) */ final class BigtableClient { diff --git a/Billing/src/V1/Client/CloudBillingClient.php b/Billing/src/V1/Client/CloudBillingClient.php index 6be512f2258b..02b89aa97018 100644 --- a/Billing/src/V1/Client/CloudBillingClient.php +++ b/Billing/src/V1/Client/CloudBillingClient.php @@ -62,17 +62,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createBillingAccountAsync(CreateBillingAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBillingAccountAsync(GetBillingAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProjectBillingInfoAsync(GetProjectBillingInfoRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBillingAccountsAsync(ListBillingAccountsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProjectBillingInfoAsync(ListProjectBillingInfoRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveBillingAccountAsync(MoveBillingAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBillingAccountAsync(UpdateBillingAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProjectBillingInfoAsync(UpdateProjectBillingInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBillingAccountAsync(CreateBillingAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBillingAccountAsync(GetBillingAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProjectBillingInfoAsync(GetProjectBillingInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBillingAccountsAsync(ListBillingAccountsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProjectBillingInfoAsync(ListProjectBillingInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveBillingAccountAsync(MoveBillingAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBillingAccountAsync(UpdateBillingAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProjectBillingInfoAsync(UpdateProjectBillingInfoRequest $request, array $optionalArgs = []) */ final class CloudBillingClient { diff --git a/Billing/src/V1/Client/CloudCatalogClient.php b/Billing/src/V1/Client/CloudCatalogClient.php index 6ed99e9057b3..43ab99307e96 100644 --- a/Billing/src/V1/Client/CloudCatalogClient.php +++ b/Billing/src/V1/Client/CloudCatalogClient.php @@ -50,8 +50,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSkusAsync(ListSkusRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSkusAsync(ListSkusRequest $request, array $optionalArgs = []) */ final class CloudCatalogClient { diff --git a/BillingBudgets/src/V1/Client/BudgetServiceClient.php b/BillingBudgets/src/V1/Client/BudgetServiceClient.php index 71f0f5ec9af7..faf7e8493001 100644 --- a/BillingBudgets/src/V1/Client/BudgetServiceClient.php +++ b/BillingBudgets/src/V1/Client/BudgetServiceClient.php @@ -53,11 +53,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createBudgetAsync(CreateBudgetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBudgetAsync(DeleteBudgetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBudgetAsync(GetBudgetRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBudgetsAsync(ListBudgetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBudgetAsync(UpdateBudgetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBudgetAsync(CreateBudgetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBudgetAsync(DeleteBudgetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBudgetAsync(GetBudgetRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBudgetsAsync(ListBudgetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBudgetAsync(UpdateBudgetRequest $request, array $optionalArgs = []) */ final class BudgetServiceClient { diff --git a/BinaryAuthorization/src/V1/Client/BinauthzManagementServiceV1Client.php b/BinaryAuthorization/src/V1/Client/BinauthzManagementServiceV1Client.php index cdc693cc4c4b..488eb5f606d4 100644 --- a/BinaryAuthorization/src/V1/Client/BinauthzManagementServiceV1Client.php +++ b/BinaryAuthorization/src/V1/Client/BinauthzManagementServiceV1Client.php @@ -61,13 +61,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAttestorAsync(CreateAttestorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAttestorAsync(DeleteAttestorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAttestorAsync(GetAttestorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPolicyAsync(GetPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAttestorsAsync(ListAttestorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAttestorAsync(UpdateAttestorRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePolicyAsync(UpdatePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAttestorAsync(CreateAttestorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAttestorAsync(DeleteAttestorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttestorAsync(GetAttestorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPolicyAsync(GetPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAttestorsAsync(ListAttestorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAttestorAsync(UpdateAttestorRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePolicyAsync(UpdatePolicyRequest $request, array $optionalArgs = []) */ final class BinauthzManagementServiceV1Client { diff --git a/BinaryAuthorization/src/V1/Client/SystemPolicyV1Client.php b/BinaryAuthorization/src/V1/Client/SystemPolicyV1Client.php index 00cb8a0fb7ce..cb6080c475bc 100644 --- a/BinaryAuthorization/src/V1/Client/SystemPolicyV1Client.php +++ b/BinaryAuthorization/src/V1/Client/SystemPolicyV1Client.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getSystemPolicyAsync(GetSystemPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSystemPolicyAsync(GetSystemPolicyRequest $request, array $optionalArgs = []) */ final class SystemPolicyV1Client { diff --git a/BinaryAuthorization/src/V1/Client/ValidationHelperV1Client.php b/BinaryAuthorization/src/V1/Client/ValidationHelperV1Client.php index 0f65caad2bca..9123dc241ac4 100644 --- a/BinaryAuthorization/src/V1/Client/ValidationHelperV1Client.php +++ b/BinaryAuthorization/src/V1/Client/ValidationHelperV1Client.php @@ -41,7 +41,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface validateAttestationOccurrenceAsync(ValidateAttestationOccurrenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateAttestationOccurrenceAsync(ValidateAttestationOccurrenceRequest $request, array $optionalArgs = []) */ final class ValidationHelperV1Client { diff --git a/CertificateManager/src/V1/Client/CertificateManagerClient.php b/CertificateManager/src/V1/Client/CertificateManagerClient.php index ecc225cf16ee..2a58a4829c8c 100644 --- a/CertificateManager/src/V1/Client/CertificateManagerClient.php +++ b/CertificateManager/src/V1/Client/CertificateManagerClient.php @@ -112,37 +112,37 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createCertificateAsync(CreateCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCertificateIssuanceConfigAsync(CreateCertificateIssuanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCertificateMapAsync(CreateCertificateMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCertificateMapEntryAsync(CreateCertificateMapEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDnsAuthorizationAsync(CreateDnsAuthorizationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTrustConfigAsync(CreateTrustConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCertificateAsync(DeleteCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCertificateIssuanceConfigAsync(DeleteCertificateIssuanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCertificateMapAsync(DeleteCertificateMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCertificateMapEntryAsync(DeleteCertificateMapEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDnsAuthorizationAsync(DeleteDnsAuthorizationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTrustConfigAsync(DeleteTrustConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCertificateAsync(GetCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCertificateIssuanceConfigAsync(GetCertificateIssuanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCertificateMapAsync(GetCertificateMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCertificateMapEntryAsync(GetCertificateMapEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDnsAuthorizationAsync(GetDnsAuthorizationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTrustConfigAsync(GetTrustConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCertificateIssuanceConfigsAsync(ListCertificateIssuanceConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCertificateMapEntriesAsync(ListCertificateMapEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCertificateMapsAsync(ListCertificateMapsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCertificatesAsync(ListCertificatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDnsAuthorizationsAsync(ListDnsAuthorizationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTrustConfigsAsync(ListTrustConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCertificateAsync(UpdateCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCertificateMapAsync(UpdateCertificateMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCertificateMapEntryAsync(UpdateCertificateMapEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDnsAuthorizationAsync(UpdateDnsAuthorizationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTrustConfigAsync(UpdateTrustConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCertificateAsync(CreateCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCertificateIssuanceConfigAsync(CreateCertificateIssuanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCertificateMapAsync(CreateCertificateMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCertificateMapEntryAsync(CreateCertificateMapEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDnsAuthorizationAsync(CreateDnsAuthorizationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTrustConfigAsync(CreateTrustConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCertificateAsync(DeleteCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCertificateIssuanceConfigAsync(DeleteCertificateIssuanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCertificateMapAsync(DeleteCertificateMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCertificateMapEntryAsync(DeleteCertificateMapEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDnsAuthorizationAsync(DeleteDnsAuthorizationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTrustConfigAsync(DeleteTrustConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCertificateAsync(GetCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCertificateIssuanceConfigAsync(GetCertificateIssuanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCertificateMapAsync(GetCertificateMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCertificateMapEntryAsync(GetCertificateMapEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDnsAuthorizationAsync(GetDnsAuthorizationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTrustConfigAsync(GetTrustConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCertificateIssuanceConfigsAsync(ListCertificateIssuanceConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCertificateMapEntriesAsync(ListCertificateMapEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCertificateMapsAsync(ListCertificateMapsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCertificatesAsync(ListCertificatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDnsAuthorizationsAsync(ListDnsAuthorizationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTrustConfigsAsync(ListTrustConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCertificateAsync(UpdateCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCertificateMapAsync(UpdateCertificateMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCertificateMapEntryAsync(UpdateCertificateMapEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDnsAuthorizationAsync(UpdateDnsAuthorizationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTrustConfigAsync(UpdateTrustConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class CertificateManagerClient { From 60a4541afd8b66abd22f522d5ff73270cb0cad0e Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 1 Nov 2024 14:30:45 -0400 Subject: [PATCH 065/157] docs: add response types for async magic methods (#7786) PiperOrigin-RevId: 691866489 Source-Link: https://github.com/googleapis/googleapis/commit/cf0f35efca7e0d507af89e9ddc46cba2f41eb9f7 Source-Link: https://github.com/googleapis/googleapis-gen/commit/e556aaed2dc6f46b6ff8cc769fabadcfbe2504a4 Copy-Tag: eyJwIjoiQ2hhbm5lbC8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiQ29tbWVyY2VDb25zdW1lclByb2N1cmVtZW50Ly5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQ29uZmlkZW50aWFsQ29tcHV0aW5nLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQ29uZmlnLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQ29udGFjdENlbnRlckluc2lnaHRzLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiQ29udHJvbHNQYXJ0bmVyLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiRGF0YUNhdGFsb2cvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiRGF0YUNhdGFsb2dMaW5lYWdlLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiRGF0YUZ1c2lvbi8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiRGF0YUxhYmVsaW5nLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiRGF0YWZvcm0vLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiRGF0YXBsZXgvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiRGF0YXByb2MvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiRGF0YXN0cmVhbS8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiRGV2ZWxvcGVyQ29ubmVjdC8uT3dsQm90LnlhbWwiLCJoIjoiZTU1NmFhZWQyZGM2ZjQ2YjZmZjhjYzc2OWZhYmFkY2ZiZTI1MDRhNCJ9 Copy-Tag: eyJwIjoiRG1zLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiUXVvdGFzLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= Copy-Tag: eyJwIjoiU2VydmljZUNvbnRyb2wvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiU2VydmljZU1hbmFnZW1lbnQvLk93bEJvdC55YW1sIiwiaCI6ImU1NTZhYWVkMmRjNmY0NmI2ZmY4Y2M3NjlmYWJhZGNmYmUyNTA0YTQifQ== Copy-Tag: eyJwIjoiU2VydmljZVVzYWdlLy5Pd2xCb3QueWFtbCIsImgiOiJlNTU2YWFlZDJkYzZmNDZiNmZmOGNjNzY5ZmFiYWRjZmJlMjUwNGE0In0= --- .../CloudChannelReportsServiceClient.php | 6 +- .../V1/Client/CloudChannelServiceClient.php | 98 +++++++-------- .../ConsumerProcurementServiceClient.php | 10 +- .../Client/LicenseManagementServiceClient.php | 10 +- .../V1/Client/ConfidentialComputingClient.php | 8 +- Config/src/V1/Client/ConfigClient.php | 56 ++++----- .../V1/Client/ContactCenterInsightsClient.php | 86 +++++++------- .../Client/CloudControlsPartnerCoreClient.php | 16 +-- .../CloudControlsPartnerMonitoringClient.php | 4 +- .../src/V1/Client/DataCatalogClient.php | 68 +++++------ .../src/V1/Client/PolicyTagManagerClient.php | 26 ++-- .../PolicyTagManagerSerializationClient.php | 6 +- .../src/V1/Client/LineageClient.php | 34 +++--- DataFusion/src/V1/Client/DataFusionClient.php | 14 +-- .../Client/DataLabelingServiceClient.php | 68 +++++------ .../src/V1beta1/Client/DataformClient.php | 112 +++++++++--------- .../src/V1/Client/CatalogServiceClient.php | 54 ++++----- .../src/V1/Client/ContentServiceClient.php | 20 ++-- .../src/V1/Client/DataScanServiceClient.php | 28 ++--- .../V1/Client/DataTaxonomyServiceClient.php | 40 +++---- .../src/V1/Client/DataplexServiceClient.php | 76 ++++++------ .../src/V1/Client/MetadataServiceClient.php | 28 ++--- .../Client/AutoscalingPolicyServiceClient.php | 16 +-- .../src/V1/Client/BatchControllerClient.php | 14 +-- .../src/V1/Client/ClusterControllerClient.php | 22 ++-- .../src/V1/Client/JobControllerClient.php | 20 ++-- .../V1/Client/NodeGroupControllerClient.php | 12 +- .../src/V1/Client/SessionControllerClient.php | 16 +-- .../SessionTemplateControllerClient.php | 16 +-- .../Client/WorkflowTemplateServiceClient.php | 20 ++-- Datastream/src/V1/Client/DatastreamClient.php | 54 ++++----- .../src/V1/Client/DeveloperConnectClient.php | 32 ++--- .../V1/Client/DataMigrationServiceClient.php | 82 ++++++------- Quotas/src/V1/Client/CloudQuotasClient.php | 12 +- .../src/V1/Client/QuotaControllerClient.php | 2 +- .../src/V1/Client/ServiceControllerClient.php | 4 +- .../src/V1/Client/ServiceManagerClient.php | 32 ++--- .../src/V1/Client/ServiceUsageClient.php | 12 +- 38 files changed, 617 insertions(+), 617 deletions(-) diff --git a/Channel/src/V1/Client/CloudChannelReportsServiceClient.php b/Channel/src/V1/Client/CloudChannelReportsServiceClient.php index a5b69b8c1805..d85b5aeecd86 100644 --- a/Channel/src/V1/Client/CloudChannelReportsServiceClient.php +++ b/Channel/src/V1/Client/CloudChannelReportsServiceClient.php @@ -63,9 +63,9 @@ * * @deprecated This class will be removed in the next major version update. * - * @method PromiseInterface fetchReportResultsAsync(FetchReportResultsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReportsAsync(ListReportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface runReportJobAsync(RunReportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchReportResultsAsync(FetchReportResultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReportsAsync(ListReportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface runReportJobAsync(RunReportJobRequest $request, array $optionalArgs = []) */ final class CloudChannelReportsServiceClient { diff --git a/Channel/src/V1/Client/CloudChannelServiceClient.php b/Channel/src/V1/Client/CloudChannelServiceClient.php index 5b36756a9d4e..29aee928033b 100644 --- a/Channel/src/V1/Client/CloudChannelServiceClient.php +++ b/Channel/src/V1/Client/CloudChannelServiceClient.php @@ -129,55 +129,55 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface activateEntitlementAsync(ActivateEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelEntitlementAsync(CancelEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface changeOfferAsync(ChangeOfferRequest $request, array $optionalArgs = []) - * @method PromiseInterface changeParametersAsync(ChangeParametersRequest $request, array $optionalArgs = []) - * @method PromiseInterface changeRenewalSettingsAsync(ChangeRenewalSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface checkCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest $request, array $optionalArgs = []) - * @method PromiseInterface createChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createChannelPartnerRepricingConfigAsync(CreateChannelPartnerRepricingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomerAsync(CreateCustomerRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomerRepricingConfigAsync(CreateCustomerRepricingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntitlementAsync(CreateEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteChannelPartnerRepricingConfigAsync(DeleteChannelPartnerRepricingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCustomerAsync(DeleteCustomerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCustomerRepricingConfigAsync(DeleteCustomerRepricingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getChannelPartnerLinkAsync(GetChannelPartnerLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getChannelPartnerRepricingConfigAsync(GetChannelPartnerRepricingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomerAsync(GetCustomerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomerRepricingConfigAsync(GetCustomerRepricingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntitlementAsync(GetEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface importCustomerAsync(ImportCustomerRequest $request, array $optionalArgs = []) - * @method PromiseInterface listChannelPartnerLinksAsync(ListChannelPartnerLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listChannelPartnerRepricingConfigsAsync(ListChannelPartnerRepricingConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomerRepricingConfigsAsync(ListCustomerRepricingConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomersAsync(ListCustomersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntitlementChangesAsync(ListEntitlementChangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntitlementsAsync(ListEntitlementsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOffersAsync(ListOffersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProductsAsync(ListProductsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPurchasableOffersAsync(ListPurchasableOffersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPurchasableSkusAsync(ListPurchasableSkusRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSkuGroupBillableSkusAsync(ListSkuGroupBillableSkusRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSkuGroupsAsync(ListSkuGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSkusAsync(ListSkusRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSubscribersAsync(ListSubscribersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTransferableOffersAsync(ListTransferableOffersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTransferableSkusAsync(ListTransferableSkusRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupOfferAsync(LookupOfferRequest $request, array $optionalArgs = []) - * @method PromiseInterface provisionCloudIdentityAsync(ProvisionCloudIdentityRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryEligibleBillingAccountsAsync(QueryEligibleBillingAccountsRequest $request, array $optionalArgs = []) - * @method PromiseInterface registerSubscriberAsync(RegisterSubscriberRequest $request, array $optionalArgs = []) - * @method PromiseInterface startPaidServiceAsync(StartPaidServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface suspendEntitlementAsync(SuspendEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface transferEntitlementsAsync(TransferEntitlementsRequest $request, array $optionalArgs = []) - * @method PromiseInterface transferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest $request, array $optionalArgs = []) - * @method PromiseInterface unregisterSubscriberAsync(UnregisterSubscriberRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateChannelPartnerRepricingConfigAsync(UpdateChannelPartnerRepricingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomerAsync(UpdateCustomerRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomerRepricingConfigAsync(UpdateCustomerRepricingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface activateEntitlementAsync(ActivateEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelEntitlementAsync(CancelEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface changeOfferAsync(ChangeOfferRequest $request, array $optionalArgs = []) + * @method PromiseInterface changeParametersAsync(ChangeParametersRequest $request, array $optionalArgs = []) + * @method PromiseInterface changeRenewalSettingsAsync(ChangeRenewalSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest $request, array $optionalArgs = []) + * @method PromiseInterface createChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createChannelPartnerRepricingConfigAsync(CreateChannelPartnerRepricingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomerAsync(CreateCustomerRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomerRepricingConfigAsync(CreateCustomerRepricingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntitlementAsync(CreateEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteChannelPartnerRepricingConfigAsync(DeleteChannelPartnerRepricingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCustomerAsync(DeleteCustomerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCustomerRepricingConfigAsync(DeleteCustomerRepricingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getChannelPartnerLinkAsync(GetChannelPartnerLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getChannelPartnerRepricingConfigAsync(GetChannelPartnerRepricingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomerAsync(GetCustomerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomerRepricingConfigAsync(GetCustomerRepricingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntitlementAsync(GetEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface importCustomerAsync(ImportCustomerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listChannelPartnerLinksAsync(ListChannelPartnerLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listChannelPartnerRepricingConfigsAsync(ListChannelPartnerRepricingConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomerRepricingConfigsAsync(ListCustomerRepricingConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomersAsync(ListCustomersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntitlementChangesAsync(ListEntitlementChangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntitlementsAsync(ListEntitlementsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOffersAsync(ListOffersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProductsAsync(ListProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPurchasableOffersAsync(ListPurchasableOffersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPurchasableSkusAsync(ListPurchasableSkusRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSkuGroupBillableSkusAsync(ListSkuGroupBillableSkusRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSkuGroupsAsync(ListSkuGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSkusAsync(ListSkusRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSubscribersAsync(ListSubscribersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTransferableOffersAsync(ListTransferableOffersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTransferableSkusAsync(ListTransferableSkusRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupOfferAsync(LookupOfferRequest $request, array $optionalArgs = []) + * @method PromiseInterface provisionCloudIdentityAsync(ProvisionCloudIdentityRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryEligibleBillingAccountsAsync(QueryEligibleBillingAccountsRequest $request, array $optionalArgs = []) + * @method PromiseInterface registerSubscriberAsync(RegisterSubscriberRequest $request, array $optionalArgs = []) + * @method PromiseInterface startPaidServiceAsync(StartPaidServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface suspendEntitlementAsync(SuspendEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface transferEntitlementsAsync(TransferEntitlementsRequest $request, array $optionalArgs = []) + * @method PromiseInterface transferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest $request, array $optionalArgs = []) + * @method PromiseInterface unregisterSubscriberAsync(UnregisterSubscriberRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateChannelPartnerRepricingConfigAsync(UpdateChannelPartnerRepricingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomerAsync(UpdateCustomerRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomerRepricingConfigAsync(UpdateCustomerRepricingConfigRequest $request, array $optionalArgs = []) */ final class CloudChannelServiceClient { diff --git a/CommerceConsumerProcurement/src/V1/Client/ConsumerProcurementServiceClient.php b/CommerceConsumerProcurement/src/V1/Client/ConsumerProcurementServiceClient.php index 201f8e45d39b..4ae766daf309 100644 --- a/CommerceConsumerProcurement/src/V1/Client/ConsumerProcurementServiceClient.php +++ b/CommerceConsumerProcurement/src/V1/Client/ConsumerProcurementServiceClient.php @@ -64,11 +64,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface cancelOrderAsync(CancelOrderRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOrderAsync(GetOrderRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOrdersAsync(ListOrdersRequest $request, array $optionalArgs = []) - * @method PromiseInterface modifyOrderAsync(ModifyOrderRequest $request, array $optionalArgs = []) - * @method PromiseInterface placeOrderAsync(PlaceOrderRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelOrderAsync(CancelOrderRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOrderAsync(GetOrderRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOrdersAsync(ListOrdersRequest $request, array $optionalArgs = []) + * @method PromiseInterface modifyOrderAsync(ModifyOrderRequest $request, array $optionalArgs = []) + * @method PromiseInterface placeOrderAsync(PlaceOrderRequest $request, array $optionalArgs = []) */ final class ConsumerProcurementServiceClient { diff --git a/CommerceConsumerProcurement/src/V1/Client/LicenseManagementServiceClient.php b/CommerceConsumerProcurement/src/V1/Client/LicenseManagementServiceClient.php index e0e8cf45cd8a..1bd42c157ed1 100644 --- a/CommerceConsumerProcurement/src/V1/Client/LicenseManagementServiceClient.php +++ b/CommerceConsumerProcurement/src/V1/Client/LicenseManagementServiceClient.php @@ -54,11 +54,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface assignAsync(AssignRequest $request, array $optionalArgs = []) - * @method PromiseInterface enumerateLicensedUsersAsync(EnumerateLicensedUsersRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLicensePoolAsync(GetLicensePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface unassignAsync(UnassignRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateLicensePoolAsync(UpdateLicensePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface assignAsync(AssignRequest $request, array $optionalArgs = []) + * @method PromiseInterface enumerateLicensedUsersAsync(EnumerateLicensedUsersRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLicensePoolAsync(GetLicensePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface unassignAsync(UnassignRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateLicensePoolAsync(UpdateLicensePoolRequest $request, array $optionalArgs = []) */ final class LicenseManagementServiceClient { diff --git a/ConfidentialComputing/src/V1/Client/ConfidentialComputingClient.php b/ConfidentialComputing/src/V1/Client/ConfidentialComputingClient.php index 97bdb281ca25..61c856bcc986 100644 --- a/ConfidentialComputing/src/V1/Client/ConfidentialComputingClient.php +++ b/ConfidentialComputing/src/V1/Client/ConfidentialComputingClient.php @@ -53,10 +53,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createChallengeAsync(CreateChallengeRequest $request, array $optionalArgs = []) - * @method PromiseInterface verifyAttestationAsync(VerifyAttestationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createChallengeAsync(CreateChallengeRequest $request, array $optionalArgs = []) + * @method PromiseInterface verifyAttestationAsync(VerifyAttestationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ConfidentialComputingClient { diff --git a/Config/src/V1/Client/ConfigClient.php b/Config/src/V1/Client/ConfigClient.php index 4c4f3b19421c..80d6b2a3be09 100644 --- a/Config/src/V1/Client/ConfigClient.php +++ b/Config/src/V1/Client/ConfigClient.php @@ -89,34 +89,34 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDeploymentAsync(CreateDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPreviewAsync(CreatePreviewRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDeploymentAsync(DeleteDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePreviewAsync(DeletePreviewRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteStatefileAsync(DeleteStatefileRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportDeploymentStatefileAsync(ExportDeploymentStatefileRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportLockInfoAsync(ExportLockInfoRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportPreviewResultAsync(ExportPreviewResultRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportRevisionStatefileAsync(ExportRevisionStatefileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPreviewAsync(GetPreviewRequest $request, array $optionalArgs = []) - * @method PromiseInterface getResourceAsync(GetResourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRevisionAsync(GetRevisionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTerraformVersionAsync(GetTerraformVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface importStatefileAsync(ImportStatefileRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPreviewsAsync(ListPreviewsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listResourcesAsync(ListResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRevisionsAsync(ListRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTerraformVersionsAsync(ListTerraformVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface lockDeploymentAsync(LockDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface unlockDeploymentAsync(UnlockDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDeploymentAsync(UpdateDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeploymentAsync(CreateDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPreviewAsync(CreatePreviewRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDeploymentAsync(DeleteDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePreviewAsync(DeletePreviewRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteStatefileAsync(DeleteStatefileRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportDeploymentStatefileAsync(ExportDeploymentStatefileRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportLockInfoAsync(ExportLockInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportPreviewResultAsync(ExportPreviewResultRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportRevisionStatefileAsync(ExportRevisionStatefileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPreviewAsync(GetPreviewRequest $request, array $optionalArgs = []) + * @method PromiseInterface getResourceAsync(GetResourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRevisionAsync(GetRevisionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTerraformVersionAsync(GetTerraformVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface importStatefileAsync(ImportStatefileRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPreviewsAsync(ListPreviewsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listResourcesAsync(ListResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRevisionsAsync(ListRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTerraformVersionsAsync(ListTerraformVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface lockDeploymentAsync(LockDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface unlockDeploymentAsync(UnlockDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDeploymentAsync(UpdateDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ConfigClient { diff --git a/ContactCenterInsights/src/V1/Client/ContactCenterInsightsClient.php b/ContactCenterInsights/src/V1/Client/ContactCenterInsightsClient.php index 8a87b9d496f1..7a341cd1e74a 100644 --- a/ContactCenterInsights/src/V1/Client/ContactCenterInsightsClient.php +++ b/ContactCenterInsights/src/V1/Client/ContactCenterInsightsClient.php @@ -104,49 +104,49 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface bulkAnalyzeConversationsAsync(BulkAnalyzeConversationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface bulkDeleteConversationsAsync(BulkDeleteConversationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface calculateIssueModelStatsAsync(CalculateIssueModelStatsRequest $request, array $optionalArgs = []) - * @method PromiseInterface calculateStatsAsync(CalculateStatsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAnalysisAsync(CreateAnalysisRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConversationAsync(CreateConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createIssueModelAsync(CreateIssueModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPhraseMatcherAsync(CreatePhraseMatcherRequest $request, array $optionalArgs = []) - * @method PromiseInterface createViewAsync(CreateViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAnalysisAsync(DeleteAnalysisRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversationAsync(DeleteConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIssueAsync(DeleteIssueRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIssueModelAsync(DeleteIssueModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePhraseMatcherAsync(DeletePhraseMatcherRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteViewAsync(DeleteViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface deployIssueModelAsync(DeployIssueModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportInsightsDataAsync(ExportInsightsDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportIssueModelAsync(ExportIssueModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAnalysisAsync(GetAnalysisRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversationAsync(GetConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEncryptionSpecAsync(GetEncryptionSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIssueAsync(GetIssueRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIssueModelAsync(GetIssueModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPhraseMatcherAsync(GetPhraseMatcherRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getViewAsync(GetViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface importIssueModelAsync(ImportIssueModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface ingestConversationsAsync(IngestConversationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAnalysesAsync(ListAnalysesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversationsAsync(ListConversationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIssueModelsAsync(ListIssueModelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIssuesAsync(ListIssuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPhraseMatchersAsync(ListPhraseMatchersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listViewsAsync(ListViewsRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeployIssueModelAsync(UndeployIssueModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConversationAsync(UpdateConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateIssueAsync(UpdateIssueRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateIssueModelAsync(UpdateIssueModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePhraseMatcherAsync(UpdatePhraseMatcherRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSettingsAsync(UpdateSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateViewAsync(UpdateViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface uploadConversationAsync(UploadConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkAnalyzeConversationsAsync(BulkAnalyzeConversationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkDeleteConversationsAsync(BulkDeleteConversationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface calculateIssueModelStatsAsync(CalculateIssueModelStatsRequest $request, array $optionalArgs = []) + * @method PromiseInterface calculateStatsAsync(CalculateStatsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAnalysisAsync(CreateAnalysisRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversationAsync(CreateConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIssueModelAsync(CreateIssueModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPhraseMatcherAsync(CreatePhraseMatcherRequest $request, array $optionalArgs = []) + * @method PromiseInterface createViewAsync(CreateViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAnalysisAsync(DeleteAnalysisRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversationAsync(DeleteConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIssueAsync(DeleteIssueRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIssueModelAsync(DeleteIssueModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePhraseMatcherAsync(DeletePhraseMatcherRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteViewAsync(DeleteViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface deployIssueModelAsync(DeployIssueModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportInsightsDataAsync(ExportInsightsDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportIssueModelAsync(ExportIssueModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAnalysisAsync(GetAnalysisRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversationAsync(GetConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEncryptionSpecAsync(GetEncryptionSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIssueAsync(GetIssueRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIssueModelAsync(GetIssueModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPhraseMatcherAsync(GetPhraseMatcherRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getViewAsync(GetViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface importIssueModelAsync(ImportIssueModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface ingestConversationsAsync(IngestConversationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAnalysesAsync(ListAnalysesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversationsAsync(ListConversationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIssueModelsAsync(ListIssueModelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIssuesAsync(ListIssuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPhraseMatchersAsync(ListPhraseMatchersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listViewsAsync(ListViewsRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeployIssueModelAsync(UndeployIssueModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConversationAsync(UpdateConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateIssueAsync(UpdateIssueRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateIssueModelAsync(UpdateIssueModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePhraseMatcherAsync(UpdatePhraseMatcherRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSettingsAsync(UpdateSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateViewAsync(UpdateViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface uploadConversationAsync(UploadConversationRequest $request, array $optionalArgs = []) */ final class ContactCenterInsightsClient { diff --git a/ControlsPartner/src/V1beta/Client/CloudControlsPartnerCoreClient.php b/ControlsPartner/src/V1beta/Client/CloudControlsPartnerCoreClient.php index 88cfbd25ebf8..c7e8c6b39725 100644 --- a/ControlsPartner/src/V1beta/Client/CloudControlsPartnerCoreClient.php +++ b/ControlsPartner/src/V1beta/Client/CloudControlsPartnerCoreClient.php @@ -63,14 +63,14 @@ * * @experimental * - * @method PromiseInterface getCustomerAsync(GetCustomerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEkmConnectionsAsync(GetEkmConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPartnerAsync(GetPartnerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPartnerPermissionsAsync(GetPartnerPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkloadAsync(GetWorkloadRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccessApprovalRequestsAsync(ListAccessApprovalRequestsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomersAsync(ListCustomersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomerAsync(GetCustomerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEkmConnectionsAsync(GetEkmConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPartnerAsync(GetPartnerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPartnerPermissionsAsync(GetPartnerPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkloadAsync(GetWorkloadRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccessApprovalRequestsAsync(ListAccessApprovalRequestsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomersAsync(ListCustomersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) */ final class CloudControlsPartnerCoreClient { diff --git a/ControlsPartner/src/V1beta/Client/CloudControlsPartnerMonitoringClient.php b/ControlsPartner/src/V1beta/Client/CloudControlsPartnerMonitoringClient.php index b1459d1a16eb..5c5ab6ffee20 100644 --- a/ControlsPartner/src/V1beta/Client/CloudControlsPartnerMonitoringClient.php +++ b/ControlsPartner/src/V1beta/Client/CloudControlsPartnerMonitoringClient.php @@ -53,8 +53,8 @@ * * @experimental * - * @method PromiseInterface getViolationAsync(GetViolationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listViolationsAsync(ListViolationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getViolationAsync(GetViolationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listViolationsAsync(ListViolationsRequest $request, array $optionalArgs = []) */ final class CloudControlsPartnerMonitoringClient { diff --git a/DataCatalog/src/V1/Client/DataCatalogClient.php b/DataCatalog/src/V1/Client/DataCatalogClient.php index acf15e4aa73d..29ec8e0bba20 100644 --- a/DataCatalog/src/V1/Client/DataCatalogClient.php +++ b/DataCatalog/src/V1/Client/DataCatalogClient.php @@ -99,40 +99,40 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEntryAsync(CreateEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntryGroupAsync(CreateEntryGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTagAsync(CreateTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTagTemplateAsync(CreateTagTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTagTemplateFieldAsync(CreateTagTemplateFieldRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntryAsync(DeleteEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntryGroupAsync(DeleteEntryGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTagAsync(DeleteTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTagTemplateAsync(DeleteTagTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntryAsync(GetEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntryGroupAsync(GetEntryGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTagTemplateAsync(GetTagTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface importEntriesAsync(ImportEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntriesAsync(ListEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntryGroupsAsync(ListEntryGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTagsAsync(ListTagsRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupEntryAsync(LookupEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface modifyEntryContactsAsync(ModifyEntryContactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface modifyEntryOverviewAsync(ModifyEntryOverviewRequest $request, array $optionalArgs = []) - * @method PromiseInterface reconcileTagsAsync(ReconcileTagsRequest $request, array $optionalArgs = []) - * @method PromiseInterface renameTagTemplateFieldAsync(RenameTagTemplateFieldRequest $request, array $optionalArgs = []) - * @method PromiseInterface renameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchCatalogAsync(SearchCatalogRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface starEntryAsync(StarEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface unstarEntryAsync(UnstarEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntryAsync(UpdateEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntryGroupAsync(UpdateEntryGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTagAsync(UpdateTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTagTemplateAsync(UpdateTagTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntryAsync(CreateEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntryGroupAsync(CreateEntryGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTagAsync(CreateTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTagTemplateAsync(CreateTagTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTagTemplateFieldAsync(CreateTagTemplateFieldRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntryAsync(DeleteEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntryGroupAsync(DeleteEntryGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTagAsync(DeleteTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTagTemplateAsync(DeleteTagTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntryAsync(GetEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntryGroupAsync(GetEntryGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTagTemplateAsync(GetTagTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface importEntriesAsync(ImportEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntriesAsync(ListEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntryGroupsAsync(ListEntryGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTagsAsync(ListTagsRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupEntryAsync(LookupEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface modifyEntryContactsAsync(ModifyEntryContactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface modifyEntryOverviewAsync(ModifyEntryOverviewRequest $request, array $optionalArgs = []) + * @method PromiseInterface reconcileTagsAsync(ReconcileTagsRequest $request, array $optionalArgs = []) + * @method PromiseInterface renameTagTemplateFieldAsync(RenameTagTemplateFieldRequest $request, array $optionalArgs = []) + * @method PromiseInterface renameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchCatalogAsync(SearchCatalogRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface starEntryAsync(StarEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface unstarEntryAsync(UnstarEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntryAsync(UpdateEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntryGroupAsync(UpdateEntryGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTagAsync(UpdateTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTagTemplateAsync(UpdateTagTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest $request, array $optionalArgs = []) */ final class DataCatalogClient { diff --git a/DataCatalog/src/V1/Client/PolicyTagManagerClient.php b/DataCatalog/src/V1/Client/PolicyTagManagerClient.php index fc90ee91f8bf..6cafa87cc467 100644 --- a/DataCatalog/src/V1/Client/PolicyTagManagerClient.php +++ b/DataCatalog/src/V1/Client/PolicyTagManagerClient.php @@ -68,19 +68,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createPolicyTagAsync(CreatePolicyTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTaxonomyAsync(CreateTaxonomyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePolicyTagAsync(DeletePolicyTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTaxonomyAsync(DeleteTaxonomyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPolicyTagAsync(GetPolicyTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTaxonomyAsync(GetTaxonomyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPolicyTagsAsync(ListPolicyTagsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTaxonomiesAsync(ListTaxonomiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePolicyTagAsync(UpdatePolicyTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTaxonomyAsync(UpdateTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPolicyTagAsync(CreatePolicyTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTaxonomyAsync(CreateTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePolicyTagAsync(DeletePolicyTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTaxonomyAsync(DeleteTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPolicyTagAsync(GetPolicyTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTaxonomyAsync(GetTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPolicyTagsAsync(ListPolicyTagsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTaxonomiesAsync(ListTaxonomiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePolicyTagAsync(UpdatePolicyTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTaxonomyAsync(UpdateTaxonomyRequest $request, array $optionalArgs = []) */ final class PolicyTagManagerClient { diff --git a/DataCatalog/src/V1/Client/PolicyTagManagerSerializationClient.php b/DataCatalog/src/V1/Client/PolicyTagManagerSerializationClient.php index 7b8022ce51ab..ae1cc89e818e 100644 --- a/DataCatalog/src/V1/Client/PolicyTagManagerSerializationClient.php +++ b/DataCatalog/src/V1/Client/PolicyTagManagerSerializationClient.php @@ -54,9 +54,9 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface exportTaxonomiesAsync(ExportTaxonomiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface importTaxonomiesAsync(ImportTaxonomiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface replaceTaxonomyAsync(ReplaceTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportTaxonomiesAsync(ExportTaxonomiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface importTaxonomiesAsync(ImportTaxonomiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface replaceTaxonomyAsync(ReplaceTaxonomyRequest $request, array $optionalArgs = []) */ final class PolicyTagManagerSerializationClient { diff --git a/DataCatalogLineage/src/V1/Client/LineageClient.php b/DataCatalogLineage/src/V1/Client/LineageClient.php index 6e72dcf9b989..4ec182349162 100644 --- a/DataCatalogLineage/src/V1/Client/LineageClient.php +++ b/DataCatalogLineage/src/V1/Client/LineageClient.php @@ -73,23 +73,23 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchSearchLinkProcessesAsync(BatchSearchLinkProcessesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createLineageEventAsync(CreateLineageEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface createProcessAsync(CreateProcessRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRunAsync(CreateRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteLineageEventAsync(DeleteLineageEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteProcessAsync(DeleteProcessRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRunAsync(DeleteRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLineageEventAsync(GetLineageEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProcessAsync(GetProcessRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRunAsync(GetRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLineageEventsAsync(ListLineageEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProcessesAsync(ListProcessesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRunsAsync(ListRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface processOpenLineageRunEventAsync(ProcessOpenLineageRunEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchLinksAsync(SearchLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProcessAsync(UpdateProcessRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRunAsync(UpdateRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchSearchLinkProcessesAsync(BatchSearchLinkProcessesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLineageEventAsync(CreateLineageEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface createProcessAsync(CreateProcessRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRunAsync(CreateRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLineageEventAsync(DeleteLineageEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteProcessAsync(DeleteProcessRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRunAsync(DeleteRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLineageEventAsync(GetLineageEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProcessAsync(GetProcessRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRunAsync(GetRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLineageEventsAsync(ListLineageEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProcessesAsync(ListProcessesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRunsAsync(ListRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface processOpenLineageRunEventAsync(ProcessOpenLineageRunEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchLinksAsync(SearchLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProcessAsync(UpdateProcessRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRunAsync(UpdateRunRequest $request, array $optionalArgs = []) */ final class LineageClient { diff --git a/DataFusion/src/V1/Client/DataFusionClient.php b/DataFusion/src/V1/Client/DataFusionClient.php index 85c30581700d..78cf2efd3803 100644 --- a/DataFusion/src/V1/Client/DataFusionClient.php +++ b/DataFusion/src/V1/Client/DataFusionClient.php @@ -59,13 +59,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAvailableVersionsAsync(ListAvailableVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface restartInstanceAsync(RestartInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAvailableVersionsAsync(ListAvailableVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface restartInstanceAsync(RestartInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) */ final class DataFusionClient { diff --git a/DataLabeling/src/V1beta1/Client/DataLabelingServiceClient.php b/DataLabeling/src/V1beta1/Client/DataLabelingServiceClient.php index d58bae5399e0..7faf24bc1b4c 100644 --- a/DataLabeling/src/V1beta1/Client/DataLabelingServiceClient.php +++ b/DataLabeling/src/V1beta1/Client/DataLabelingServiceClient.php @@ -95,40 +95,40 @@ * * @experimental * - * @method PromiseInterface createAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDatasetAsync(CreateDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEvaluationJobAsync(CreateEvaluationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstructionAsync(CreateInstructionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDatasetAsync(DeleteDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEvaluationJobAsync(DeleteEvaluationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstructionAsync(DeleteInstructionRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAnnotatedDatasetAsync(GetAnnotatedDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAnnotationSpecSetAsync(GetAnnotationSpecSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataItemAsync(GetDataItemRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDatasetAsync(GetDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEvaluationAsync(GetEvaluationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEvaluationJobAsync(GetEvaluationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExampleAsync(GetExampleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstructionAsync(GetInstructionRequest $request, array $optionalArgs = []) - * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface labelImageAsync(LabelImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface labelTextAsync(LabelTextRequest $request, array $optionalArgs = []) - * @method PromiseInterface labelVideoAsync(LabelVideoRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataItemsAsync(ListDataItemsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatasetsAsync(ListDatasetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEvaluationJobsAsync(ListEvaluationJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExamplesAsync(ListExamplesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstructionsAsync(ListInstructionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseEvaluationJobAsync(PauseEvaluationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeEvaluationJobAsync(ResumeEvaluationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchEvaluationsAsync(SearchEvaluationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchExampleComparisonsAsync(SearchExampleComparisonsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEvaluationJobAsync(UpdateEvaluationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDatasetAsync(CreateDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEvaluationJobAsync(CreateEvaluationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstructionAsync(CreateInstructionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDatasetAsync(DeleteDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEvaluationJobAsync(DeleteEvaluationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstructionAsync(DeleteInstructionRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAnnotatedDatasetAsync(GetAnnotatedDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAnnotationSpecSetAsync(GetAnnotationSpecSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataItemAsync(GetDataItemRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDatasetAsync(GetDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEvaluationAsync(GetEvaluationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEvaluationJobAsync(GetEvaluationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExampleAsync(GetExampleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstructionAsync(GetInstructionRequest $request, array $optionalArgs = []) + * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface labelImageAsync(LabelImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface labelTextAsync(LabelTextRequest $request, array $optionalArgs = []) + * @method PromiseInterface labelVideoAsync(LabelVideoRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataItemsAsync(ListDataItemsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatasetsAsync(ListDatasetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEvaluationJobsAsync(ListEvaluationJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExamplesAsync(ListExamplesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstructionsAsync(ListInstructionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseEvaluationJobAsync(PauseEvaluationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeEvaluationJobAsync(ResumeEvaluationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchEvaluationsAsync(SearchEvaluationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchExampleComparisonsAsync(SearchExampleComparisonsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEvaluationJobAsync(UpdateEvaluationJobRequest $request, array $optionalArgs = []) */ final class DataLabelingServiceClient { diff --git a/Dataform/src/V1beta1/Client/DataformClient.php b/Dataform/src/V1beta1/Client/DataformClient.php index df0455646fc8..0881a8ae67ab 100644 --- a/Dataform/src/V1beta1/Client/DataformClient.php +++ b/Dataform/src/V1beta1/Client/DataformClient.php @@ -128,62 +128,62 @@ * * @experimental * - * @method PromiseInterface cancelWorkflowInvocationAsync(CancelWorkflowInvocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface commitRepositoryChangesAsync(CommitRepositoryChangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface commitWorkspaceChangesAsync(CommitWorkspaceChangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface computeRepositoryAccessTokenStatusAsync(ComputeRepositoryAccessTokenStatusRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCompilationResultAsync(CreateCompilationResultRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReleaseConfigAsync(CreateReleaseConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface createWorkflowConfigAsync(CreateWorkflowConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createWorkflowInvocationAsync(CreateWorkflowInvocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createWorkspaceAsync(CreateWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteReleaseConfigAsync(DeleteReleaseConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWorkflowConfigAsync(DeleteWorkflowConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWorkflowInvocationAsync(DeleteWorkflowInvocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWorkspaceAsync(DeleteWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchFileDiffAsync(FetchFileDiffRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchFileGitStatusesAsync(FetchFileGitStatusesRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchGitAheadBehindAsync(FetchGitAheadBehindRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchRemoteBranchesAsync(FetchRemoteBranchesRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchRepositoryHistoryAsync(FetchRepositoryHistoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCompilationResultAsync(GetCompilationResultRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReleaseConfigAsync(GetReleaseConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkflowConfigAsync(GetWorkflowConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkflowInvocationAsync(GetWorkflowInvocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkspaceAsync(GetWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface installNpmPackagesAsync(InstallNpmPackagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCompilationResultsAsync(ListCompilationResultsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReleaseConfigsAsync(ListReleaseConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkflowConfigsAsync(ListWorkflowConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkflowInvocationsAsync(ListWorkflowInvocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkspacesAsync(ListWorkspacesRequest $request, array $optionalArgs = []) - * @method PromiseInterface makeDirectoryAsync(MakeDirectoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveDirectoryAsync(MoveDirectoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveFileAsync(MoveFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface pullGitCommitsAsync(PullGitCommitsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pushGitCommitsAsync(PushGitCommitsRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryCompilationResultActionsAsync(QueryCompilationResultActionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryDirectoryContentsAsync(QueryDirectoryContentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryRepositoryDirectoryContentsAsync(QueryRepositoryDirectoryContentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryWorkflowInvocationActionsAsync(QueryWorkflowInvocationActionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface readFileAsync(ReadFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface readRepositoryFileAsync(ReadRepositoryFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeDirectoryAsync(RemoveDirectoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeFileAsync(RemoveFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetWorkspaceChangesAsync(ResetWorkspaceChangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateReleaseConfigAsync(UpdateReleaseConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRepositoryAsync(UpdateRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateWorkflowConfigAsync(UpdateWorkflowConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface writeFileAsync(WriteFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelWorkflowInvocationAsync(CancelWorkflowInvocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface commitRepositoryChangesAsync(CommitRepositoryChangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface commitWorkspaceChangesAsync(CommitWorkspaceChangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface computeRepositoryAccessTokenStatusAsync(ComputeRepositoryAccessTokenStatusRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCompilationResultAsync(CreateCompilationResultRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReleaseConfigAsync(CreateReleaseConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWorkflowConfigAsync(CreateWorkflowConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWorkflowInvocationAsync(CreateWorkflowInvocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWorkspaceAsync(CreateWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteReleaseConfigAsync(DeleteReleaseConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWorkflowConfigAsync(DeleteWorkflowConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWorkflowInvocationAsync(DeleteWorkflowInvocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWorkspaceAsync(DeleteWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchFileDiffAsync(FetchFileDiffRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchFileGitStatusesAsync(FetchFileGitStatusesRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchGitAheadBehindAsync(FetchGitAheadBehindRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchRemoteBranchesAsync(FetchRemoteBranchesRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchRepositoryHistoryAsync(FetchRepositoryHistoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCompilationResultAsync(GetCompilationResultRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReleaseConfigAsync(GetReleaseConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkflowConfigAsync(GetWorkflowConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkflowInvocationAsync(GetWorkflowInvocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkspaceAsync(GetWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface installNpmPackagesAsync(InstallNpmPackagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCompilationResultsAsync(ListCompilationResultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReleaseConfigsAsync(ListReleaseConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkflowConfigsAsync(ListWorkflowConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkflowInvocationsAsync(ListWorkflowInvocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkspacesAsync(ListWorkspacesRequest $request, array $optionalArgs = []) + * @method PromiseInterface makeDirectoryAsync(MakeDirectoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveDirectoryAsync(MoveDirectoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveFileAsync(MoveFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface pullGitCommitsAsync(PullGitCommitsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pushGitCommitsAsync(PushGitCommitsRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryCompilationResultActionsAsync(QueryCompilationResultActionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryDirectoryContentsAsync(QueryDirectoryContentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryRepositoryDirectoryContentsAsync(QueryRepositoryDirectoryContentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryWorkflowInvocationActionsAsync(QueryWorkflowInvocationActionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface readFileAsync(ReadFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface readRepositoryFileAsync(ReadRepositoryFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeDirectoryAsync(RemoveDirectoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeFileAsync(RemoveFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetWorkspaceChangesAsync(ResetWorkspaceChangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateReleaseConfigAsync(UpdateReleaseConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRepositoryAsync(UpdateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateWorkflowConfigAsync(UpdateWorkflowConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface writeFileAsync(WriteFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DataformClient { diff --git a/Dataplex/src/V1/Client/CatalogServiceClient.php b/Dataplex/src/V1/Client/CatalogServiceClient.php index 8739ab269f5a..f9e51b12dcd4 100644 --- a/Dataplex/src/V1/Client/CatalogServiceClient.php +++ b/Dataplex/src/V1/Client/CatalogServiceClient.php @@ -87,33 +87,33 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAspectTypeAsync(CreateAspectTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntryAsync(CreateEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntryGroupAsync(CreateEntryGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntryTypeAsync(CreateEntryTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAspectTypeAsync(DeleteAspectTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntryAsync(DeleteEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntryGroupAsync(DeleteEntryGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntryTypeAsync(DeleteEntryTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAspectTypeAsync(GetAspectTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntryAsync(GetEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntryGroupAsync(GetEntryGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntryTypeAsync(GetEntryTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAspectTypesAsync(ListAspectTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntriesAsync(ListEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntryGroupsAsync(ListEntryGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntryTypesAsync(ListEntryTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupEntryAsync(LookupEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchEntriesAsync(SearchEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAspectTypeAsync(UpdateAspectTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntryAsync(UpdateEntryRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntryGroupAsync(UpdateEntryGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntryTypeAsync(UpdateEntryTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAspectTypeAsync(CreateAspectTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntryAsync(CreateEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntryGroupAsync(CreateEntryGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntryTypeAsync(CreateEntryTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAspectTypeAsync(DeleteAspectTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntryAsync(DeleteEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntryGroupAsync(DeleteEntryGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntryTypeAsync(DeleteEntryTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAspectTypeAsync(GetAspectTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntryAsync(GetEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntryGroupAsync(GetEntryGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntryTypeAsync(GetEntryTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAspectTypesAsync(ListAspectTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntriesAsync(ListEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntryGroupsAsync(ListEntryGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntryTypesAsync(ListEntryTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupEntryAsync(LookupEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchEntriesAsync(SearchEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAspectTypeAsync(UpdateAspectTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntryAsync(UpdateEntryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntryGroupAsync(UpdateEntryGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntryTypeAsync(UpdateEntryTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class CatalogServiceClient { diff --git a/Dataplex/src/V1/Client/ContentServiceClient.php b/Dataplex/src/V1/Client/ContentServiceClient.php index 88e6e19da0ec..a86b182f7a94 100644 --- a/Dataplex/src/V1/Client/ContentServiceClient.php +++ b/Dataplex/src/V1/Client/ContentServiceClient.php @@ -60,16 +60,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createContentAsync(CreateContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteContentAsync(DeleteContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getContentAsync(GetContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listContentAsync(ListContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateContentAsync(UpdateContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createContentAsync(CreateContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteContentAsync(DeleteContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getContentAsync(GetContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listContentAsync(ListContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateContentAsync(UpdateContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ContentServiceClient { diff --git a/Dataplex/src/V1/Client/DataScanServiceClient.php b/Dataplex/src/V1/Client/DataScanServiceClient.php index 68ff93659909..796f4f3c729d 100644 --- a/Dataplex/src/V1/Client/DataScanServiceClient.php +++ b/Dataplex/src/V1/Client/DataScanServiceClient.php @@ -72,20 +72,20 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDataScanAsync(CreateDataScanRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataScanAsync(DeleteDataScanRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateDataQualityRulesAsync(GenerateDataQualityRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataScanAsync(GetDataScanRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataScanJobAsync(GetDataScanJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataScanJobsAsync(ListDataScanJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataScansAsync(ListDataScansRequest $request, array $optionalArgs = []) - * @method PromiseInterface runDataScanAsync(RunDataScanRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataScanAsync(UpdateDataScanRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataScanAsync(CreateDataScanRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataScanAsync(DeleteDataScanRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateDataQualityRulesAsync(GenerateDataQualityRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataScanAsync(GetDataScanRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataScanJobAsync(GetDataScanJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataScanJobsAsync(ListDataScanJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataScansAsync(ListDataScansRequest $request, array $optionalArgs = []) + * @method PromiseInterface runDataScanAsync(RunDataScanRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataScanAsync(UpdateDataScanRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DataScanServiceClient { diff --git a/Dataplex/src/V1/Client/DataTaxonomyServiceClient.php b/Dataplex/src/V1/Client/DataTaxonomyServiceClient.php index c9691942bfb4..486ed6bac67b 100644 --- a/Dataplex/src/V1/Client/DataTaxonomyServiceClient.php +++ b/Dataplex/src/V1/Client/DataTaxonomyServiceClient.php @@ -76,26 +76,26 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDataAttributeAsync(CreateDataAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDataAttributeBindingAsync(CreateDataAttributeBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDataTaxonomyAsync(CreateDataTaxonomyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataAttributeAsync(DeleteDataAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataAttributeBindingAsync(DeleteDataAttributeBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataTaxonomyAsync(DeleteDataTaxonomyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataAttributeAsync(GetDataAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataAttributeBindingAsync(GetDataAttributeBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataTaxonomyAsync(GetDataTaxonomyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataAttributeBindingsAsync(ListDataAttributeBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataAttributesAsync(ListDataAttributesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataTaxonomiesAsync(ListDataTaxonomiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataAttributeAsync(UpdateDataAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataAttributeBindingAsync(UpdateDataAttributeBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataTaxonomyAsync(UpdateDataTaxonomyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataAttributeAsync(CreateDataAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataAttributeBindingAsync(CreateDataAttributeBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataTaxonomyAsync(CreateDataTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataAttributeAsync(DeleteDataAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataAttributeBindingAsync(DeleteDataAttributeBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataTaxonomyAsync(DeleteDataTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataAttributeAsync(GetDataAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataAttributeBindingAsync(GetDataAttributeBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataTaxonomyAsync(GetDataTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataAttributeBindingsAsync(ListDataAttributeBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataAttributesAsync(ListDataAttributesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataTaxonomiesAsync(ListDataTaxonomiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataAttributeAsync(UpdateDataAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataAttributeBindingAsync(UpdateDataAttributeBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataTaxonomyAsync(UpdateDataTaxonomyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DataTaxonomyServiceClient { diff --git a/Dataplex/src/V1/Client/DataplexServiceClient.php b/Dataplex/src/V1/Client/DataplexServiceClient.php index 60cb0c5845a3..4e190b177ed9 100644 --- a/Dataplex/src/V1/Client/DataplexServiceClient.php +++ b/Dataplex/src/V1/Client/DataplexServiceClient.php @@ -101,44 +101,44 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface cancelJobAsync(CancelJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAssetAsync(CreateAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createLakeAsync(CreateLakeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTaskAsync(CreateTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface createZoneAsync(CreateZoneRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAssetAsync(DeleteAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteLakeAsync(DeleteLakeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTaskAsync(DeleteTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteZoneAsync(DeleteZoneRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAssetAsync(GetAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLakeAsync(GetLakeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTaskAsync(GetTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface getZoneAsync(GetZoneRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAssetActionsAsync(ListAssetActionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLakeActionsAsync(ListLakeActionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLakesAsync(ListLakesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSessionsAsync(ListSessionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTasksAsync(ListTasksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listZoneActionsAsync(ListZoneActionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listZonesAsync(ListZonesRequest $request, array $optionalArgs = []) - * @method PromiseInterface runTaskAsync(RunTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAssetAsync(UpdateAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEnvironmentAsync(UpdateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateLakeAsync(UpdateLakeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTaskAsync(UpdateTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateZoneAsync(UpdateZoneRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelJobAsync(CancelJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAssetAsync(CreateAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLakeAsync(CreateLakeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTaskAsync(CreateTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface createZoneAsync(CreateZoneRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAssetAsync(DeleteAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLakeAsync(DeleteLakeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTaskAsync(DeleteTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteZoneAsync(DeleteZoneRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAssetAsync(GetAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLakeAsync(GetLakeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTaskAsync(GetTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getZoneAsync(GetZoneRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAssetActionsAsync(ListAssetActionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLakeActionsAsync(ListLakeActionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLakesAsync(ListLakesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSessionsAsync(ListSessionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTasksAsync(ListTasksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listZoneActionsAsync(ListZoneActionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listZonesAsync(ListZonesRequest $request, array $optionalArgs = []) + * @method PromiseInterface runTaskAsync(RunTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAssetAsync(UpdateAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEnvironmentAsync(UpdateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateLakeAsync(UpdateLakeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTaskAsync(UpdateTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateZoneAsync(UpdateZoneRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DataplexServiceClient { diff --git a/Dataplex/src/V1/Client/MetadataServiceClient.php b/Dataplex/src/V1/Client/MetadataServiceClient.php index 69088348a127..1a312e43452a 100644 --- a/Dataplex/src/V1/Client/MetadataServiceClient.php +++ b/Dataplex/src/V1/Client/MetadataServiceClient.php @@ -66,20 +66,20 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEntityAsync(CreateEntityRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPartitionAsync(CreatePartitionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntityAsync(DeleteEntityRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePartitionAsync(DeletePartitionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntityAsync(GetEntityRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPartitionAsync(GetPartitionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntitiesAsync(ListEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPartitionsAsync(ListPartitionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntityAsync(UpdateEntityRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntityAsync(CreateEntityRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPartitionAsync(CreatePartitionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntityAsync(DeleteEntityRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePartitionAsync(DeletePartitionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntityAsync(GetEntityRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPartitionAsync(GetPartitionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntitiesAsync(ListEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPartitionsAsync(ListPartitionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntityAsync(UpdateEntityRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class MetadataServiceClient { diff --git a/Dataproc/src/V1/Client/AutoscalingPolicyServiceClient.php b/Dataproc/src/V1/Client/AutoscalingPolicyServiceClient.php index 9380d7a22a04..04b1e4dcb513 100644 --- a/Dataproc/src/V1/Client/AutoscalingPolicyServiceClient.php +++ b/Dataproc/src/V1/Client/AutoscalingPolicyServiceClient.php @@ -58,14 +58,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAutoscalingPolicyAsync(CreateAutoscalingPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAutoscalingPolicyAsync(DeleteAutoscalingPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAutoscalingPolicyAsync(GetAutoscalingPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAutoscalingPoliciesAsync(ListAutoscalingPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAutoscalingPolicyAsync(UpdateAutoscalingPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAutoscalingPolicyAsync(CreateAutoscalingPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAutoscalingPolicyAsync(DeleteAutoscalingPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAutoscalingPolicyAsync(GetAutoscalingPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAutoscalingPoliciesAsync(ListAutoscalingPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAutoscalingPolicyAsync(UpdateAutoscalingPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class AutoscalingPolicyServiceClient { diff --git a/Dataproc/src/V1/Client/BatchControllerClient.php b/Dataproc/src/V1/Client/BatchControllerClient.php index 8e2e165c68c0..817a0b25b75f 100644 --- a/Dataproc/src/V1/Client/BatchControllerClient.php +++ b/Dataproc/src/V1/Client/BatchControllerClient.php @@ -59,13 +59,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createBatchAsync(CreateBatchRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBatchAsync(DeleteBatchRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBatchAsync(GetBatchRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBatchesAsync(ListBatchesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBatchAsync(CreateBatchRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBatchAsync(DeleteBatchRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBatchAsync(GetBatchRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBatchesAsync(ListBatchesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class BatchControllerClient { diff --git a/Dataproc/src/V1/Client/ClusterControllerClient.php b/Dataproc/src/V1/Client/ClusterControllerClient.php index bddd5b3913bd..9c88fa41ebe3 100644 --- a/Dataproc/src/V1/Client/ClusterControllerClient.php +++ b/Dataproc/src/V1/Client/ClusterControllerClient.php @@ -66,17 +66,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface diagnoseClusterAsync(DiagnoseClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface startClusterAsync(StartClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopClusterAsync(StopClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface diagnoseClusterAsync(DiagnoseClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface startClusterAsync(StartClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopClusterAsync(StopClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ClusterControllerClient { diff --git a/Dataproc/src/V1/Client/JobControllerClient.php b/Dataproc/src/V1/Client/JobControllerClient.php index 4123d52299ca..452a4c5963f4 100644 --- a/Dataproc/src/V1/Client/JobControllerClient.php +++ b/Dataproc/src/V1/Client/JobControllerClient.php @@ -55,16 +55,16 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface cancelJobAsync(CancelJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface submitJobAsync(SubmitJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface submitJobAsOperationAsync(SubmitJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateJobAsync(UpdateJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelJobAsync(CancelJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface submitJobAsync(SubmitJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface submitJobAsOperationAsync(SubmitJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateJobAsync(UpdateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class JobControllerClient { diff --git a/Dataproc/src/V1/Client/NodeGroupControllerClient.php b/Dataproc/src/V1/Client/NodeGroupControllerClient.php index 646824105c14..e736a4a75161 100644 --- a/Dataproc/src/V1/Client/NodeGroupControllerClient.php +++ b/Dataproc/src/V1/Client/NodeGroupControllerClient.php @@ -59,12 +59,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createNodeGroupAsync(CreateNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNodeGroupAsync(GetNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface resizeNodeGroupAsync(ResizeNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNodeGroupAsync(CreateNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNodeGroupAsync(GetNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface resizeNodeGroupAsync(ResizeNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class NodeGroupControllerClient { diff --git a/Dataproc/src/V1/Client/SessionControllerClient.php b/Dataproc/src/V1/Client/SessionControllerClient.php index 51647dd11b98..14080722a937 100644 --- a/Dataproc/src/V1/Client/SessionControllerClient.php +++ b/Dataproc/src/V1/Client/SessionControllerClient.php @@ -60,14 +60,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSessionAsync(CreateSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSessionAsync(DeleteSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSessionAsync(GetSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSessionsAsync(ListSessionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface terminateSessionAsync(TerminateSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSessionAsync(CreateSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSessionAsync(DeleteSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSessionAsync(GetSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSessionsAsync(ListSessionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface terminateSessionAsync(TerminateSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class SessionControllerClient { diff --git a/Dataproc/src/V1/Client/SessionTemplateControllerClient.php b/Dataproc/src/V1/Client/SessionTemplateControllerClient.php index a32d735a6f0f..481cddad72db 100644 --- a/Dataproc/src/V1/Client/SessionTemplateControllerClient.php +++ b/Dataproc/src/V1/Client/SessionTemplateControllerClient.php @@ -57,14 +57,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSessionTemplateAsync(CreateSessionTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSessionTemplateAsync(DeleteSessionTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSessionTemplateAsync(GetSessionTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSessionTemplatesAsync(ListSessionTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSessionTemplateAsync(UpdateSessionTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSessionTemplateAsync(CreateSessionTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSessionTemplateAsync(DeleteSessionTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSessionTemplateAsync(GetSessionTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSessionTemplatesAsync(ListSessionTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSessionTemplateAsync(UpdateSessionTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class SessionTemplateControllerClient { diff --git a/Dataproc/src/V1/Client/WorkflowTemplateServiceClient.php b/Dataproc/src/V1/Client/WorkflowTemplateServiceClient.php index f430890f58e0..e3f313e1bc0d 100644 --- a/Dataproc/src/V1/Client/WorkflowTemplateServiceClient.php +++ b/Dataproc/src/V1/Client/WorkflowTemplateServiceClient.php @@ -64,16 +64,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createWorkflowTemplateAsync(CreateWorkflowTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkflowTemplateAsync(GetWorkflowTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface instantiateInlineWorkflowTemplateAsync(InstantiateInlineWorkflowTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface instantiateWorkflowTemplateAsync(InstantiateWorkflowTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkflowTemplatesAsync(ListWorkflowTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateWorkflowTemplateAsync(UpdateWorkflowTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWorkflowTemplateAsync(CreateWorkflowTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkflowTemplateAsync(GetWorkflowTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface instantiateInlineWorkflowTemplateAsync(InstantiateInlineWorkflowTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface instantiateWorkflowTemplateAsync(InstantiateWorkflowTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkflowTemplatesAsync(ListWorkflowTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateWorkflowTemplateAsync(UpdateWorkflowTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class WorkflowTemplateServiceClient { diff --git a/Datastream/src/V1/Client/DatastreamClient.php b/Datastream/src/V1/Client/DatastreamClient.php index de4abf49b4f6..1a48e64914cd 100644 --- a/Datastream/src/V1/Client/DatastreamClient.php +++ b/Datastream/src/V1/Client/DatastreamClient.php @@ -85,33 +85,33 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createConnectionProfileAsync(CreateConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPrivateConnectionAsync(CreatePrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRouteAsync(CreateRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface createStreamAsync(CreateStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectionProfileAsync(DeleteConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePrivateConnectionAsync(DeletePrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRouteAsync(DeleteRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteStreamAsync(DeleteStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface discoverConnectionProfileAsync(DiscoverConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchStaticIpsAsync(FetchStaticIpsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectionProfileAsync(GetConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPrivateConnectionAsync(GetPrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRouteAsync(GetRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStreamAsync(GetStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStreamObjectAsync(GetStreamObjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectionProfilesAsync(ListConnectionProfilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPrivateConnectionsAsync(ListPrivateConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRoutesAsync(ListRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listStreamObjectsAsync(ListStreamObjectsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listStreamsAsync(ListStreamsRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupStreamObjectAsync(LookupStreamObjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface startBackfillJobAsync(StartBackfillJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopBackfillJobAsync(StopBackfillJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConnectionProfileAsync(UpdateConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateStreamAsync(UpdateStreamRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectionProfileAsync(CreateConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPrivateConnectionAsync(CreatePrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRouteAsync(CreateRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface createStreamAsync(CreateStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectionProfileAsync(DeleteConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePrivateConnectionAsync(DeletePrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRouteAsync(DeleteRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteStreamAsync(DeleteStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface discoverConnectionProfileAsync(DiscoverConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchStaticIpsAsync(FetchStaticIpsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectionProfileAsync(GetConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPrivateConnectionAsync(GetPrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRouteAsync(GetRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStreamAsync(GetStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStreamObjectAsync(GetStreamObjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectionProfilesAsync(ListConnectionProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPrivateConnectionsAsync(ListPrivateConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRoutesAsync(ListRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listStreamObjectsAsync(ListStreamObjectsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listStreamsAsync(ListStreamsRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupStreamObjectAsync(LookupStreamObjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface startBackfillJobAsync(StartBackfillJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopBackfillJobAsync(StopBackfillJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConnectionProfileAsync(UpdateConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateStreamAsync(UpdateStreamRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DatastreamClient { diff --git a/DeveloperConnect/src/V1/Client/DeveloperConnectClient.php b/DeveloperConnect/src/V1/Client/DeveloperConnectClient.php index 9831de633cf9..46718be4a797 100644 --- a/DeveloperConnect/src/V1/Client/DeveloperConnectClient.php +++ b/DeveloperConnect/src/V1/Client/DeveloperConnectClient.php @@ -71,22 +71,22 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createConnectionAsync(CreateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGitRepositoryLinkAsync(CreateGitRepositoryLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectionAsync(DeleteConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGitRepositoryLinkAsync(DeleteGitRepositoryLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchGitHubInstallationsAsync(FetchGitHubInstallationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchGitRefsAsync(FetchGitRefsRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchLinkableGitRepositoriesAsync(FetchLinkableGitRepositoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchReadTokenAsync(FetchReadTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchReadWriteTokenAsync(FetchReadWriteTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectionAsync(GetConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGitRepositoryLinkAsync(GetGitRepositoryLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGitRepositoryLinksAsync(ListGitRepositoryLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConnectionAsync(UpdateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectionAsync(CreateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGitRepositoryLinkAsync(CreateGitRepositoryLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectionAsync(DeleteConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGitRepositoryLinkAsync(DeleteGitRepositoryLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchGitHubInstallationsAsync(FetchGitHubInstallationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchGitRefsAsync(FetchGitRefsRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchLinkableGitRepositoriesAsync(FetchLinkableGitRepositoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchReadTokenAsync(FetchReadTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchReadWriteTokenAsync(FetchReadWriteTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectionAsync(GetConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGitRepositoryLinkAsync(GetGitRepositoryLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGitRepositoryLinksAsync(ListGitRepositoryLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConnectionAsync(UpdateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DeveloperConnectClient { diff --git a/Dms/src/V1/Client/DataMigrationServiceClient.php b/Dms/src/V1/Client/DataMigrationServiceClient.php index 28098656d526..01ff5fbd1d1c 100644 --- a/Dms/src/V1/Client/DataMigrationServiceClient.php +++ b/Dms/src/V1/Client/DataMigrationServiceClient.php @@ -99,47 +99,47 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface applyConversionWorkspaceAsync(ApplyConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface commitConversionWorkspaceAsync(CommitConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface convertConversionWorkspaceAsync(ConvertConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConnectionProfileAsync(CreateConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConversionWorkspaceAsync(CreateConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMappingRuleAsync(CreateMappingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMigrationJobAsync(CreateMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPrivateConnectionAsync(CreatePrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectionProfileAsync(DeleteConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversionWorkspaceAsync(DeleteConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMappingRuleAsync(DeleteMappingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMigrationJobAsync(DeleteMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePrivateConnectionAsync(DeletePrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface describeConversionWorkspaceRevisionsAsync(DescribeConversionWorkspaceRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface describeDatabaseEntitiesAsync(DescribeDatabaseEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchStaticIpsAsync(FetchStaticIpsRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateSshScriptAsync(GenerateSshScriptRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateTcpProxyScriptAsync(GenerateTcpProxyScriptRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectionProfileAsync(GetConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversionWorkspaceAsync(GetConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMappingRuleAsync(GetMappingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMigrationJobAsync(GetMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPrivateConnectionAsync(GetPrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface importMappingRulesAsync(ImportMappingRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectionProfilesAsync(ListConnectionProfilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversionWorkspacesAsync(ListConversionWorkspacesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMappingRulesAsync(ListMappingRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMigrationJobsAsync(ListMigrationJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPrivateConnectionsAsync(ListPrivateConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface promoteMigrationJobAsync(PromoteMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface restartMigrationJobAsync(RestartMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeMigrationJobAsync(ResumeMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackConversionWorkspaceAsync(RollbackConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchBackgroundJobsAsync(SearchBackgroundJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface seedConversionWorkspaceAsync(SeedConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface startMigrationJobAsync(StartMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopMigrationJobAsync(StopMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConnectionProfileAsync(UpdateConnectionProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConversionWorkspaceAsync(UpdateConversionWorkspaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMigrationJobAsync(UpdateMigrationJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface verifyMigrationJobAsync(VerifyMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface applyConversionWorkspaceAsync(ApplyConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface commitConversionWorkspaceAsync(CommitConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface convertConversionWorkspaceAsync(ConvertConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectionProfileAsync(CreateConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversionWorkspaceAsync(CreateConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMappingRuleAsync(CreateMappingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMigrationJobAsync(CreateMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPrivateConnectionAsync(CreatePrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectionProfileAsync(DeleteConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversionWorkspaceAsync(DeleteConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMappingRuleAsync(DeleteMappingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMigrationJobAsync(DeleteMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePrivateConnectionAsync(DeletePrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface describeConversionWorkspaceRevisionsAsync(DescribeConversionWorkspaceRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface describeDatabaseEntitiesAsync(DescribeDatabaseEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchStaticIpsAsync(FetchStaticIpsRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateSshScriptAsync(GenerateSshScriptRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateTcpProxyScriptAsync(GenerateTcpProxyScriptRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectionProfileAsync(GetConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversionWorkspaceAsync(GetConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMappingRuleAsync(GetMappingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMigrationJobAsync(GetMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPrivateConnectionAsync(GetPrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface importMappingRulesAsync(ImportMappingRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectionProfilesAsync(ListConnectionProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversionWorkspacesAsync(ListConversionWorkspacesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMappingRulesAsync(ListMappingRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMigrationJobsAsync(ListMigrationJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPrivateConnectionsAsync(ListPrivateConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface promoteMigrationJobAsync(PromoteMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface restartMigrationJobAsync(RestartMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeMigrationJobAsync(ResumeMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackConversionWorkspaceAsync(RollbackConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchBackgroundJobsAsync(SearchBackgroundJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface seedConversionWorkspaceAsync(SeedConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface startMigrationJobAsync(StartMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopMigrationJobAsync(StopMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConnectionProfileAsync(UpdateConnectionProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConversionWorkspaceAsync(UpdateConversionWorkspaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMigrationJobAsync(UpdateMigrationJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface verifyMigrationJobAsync(VerifyMigrationJobRequest $request, array $optionalArgs = []) */ final class DataMigrationServiceClient { diff --git a/Quotas/src/V1/Client/CloudQuotasClient.php b/Quotas/src/V1/Client/CloudQuotasClient.php index dc4ba2ba4e3e..e74c69b5528f 100644 --- a/Quotas/src/V1/Client/CloudQuotasClient.php +++ b/Quotas/src/V1/Client/CloudQuotasClient.php @@ -60,12 +60,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createQuotaPreferenceAsync(CreateQuotaPreferenceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getQuotaInfoAsync(GetQuotaInfoRequest $request, array $optionalArgs = []) - * @method PromiseInterface getQuotaPreferenceAsync(GetQuotaPreferenceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listQuotaInfosAsync(ListQuotaInfosRequest $request, array $optionalArgs = []) - * @method PromiseInterface listQuotaPreferencesAsync(ListQuotaPreferencesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateQuotaPreferenceAsync(UpdateQuotaPreferenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createQuotaPreferenceAsync(CreateQuotaPreferenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getQuotaInfoAsync(GetQuotaInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface getQuotaPreferenceAsync(GetQuotaPreferenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listQuotaInfosAsync(ListQuotaInfosRequest $request, array $optionalArgs = []) + * @method PromiseInterface listQuotaPreferencesAsync(ListQuotaPreferencesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateQuotaPreferenceAsync(UpdateQuotaPreferenceRequest $request, array $optionalArgs = []) */ final class CloudQuotasClient { diff --git a/ServiceControl/src/V1/Client/QuotaControllerClient.php b/ServiceControl/src/V1/Client/QuotaControllerClient.php index e90a6c80c440..6756a16b28b6 100644 --- a/ServiceControl/src/V1/Client/QuotaControllerClient.php +++ b/ServiceControl/src/V1/Client/QuotaControllerClient.php @@ -44,7 +44,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface allocateQuotaAsync(AllocateQuotaRequest $request, array $optionalArgs = []) + * @method PromiseInterface allocateQuotaAsync(AllocateQuotaRequest $request, array $optionalArgs = []) */ final class QuotaControllerClient { diff --git a/ServiceControl/src/V1/Client/ServiceControllerClient.php b/ServiceControl/src/V1/Client/ServiceControllerClient.php index eeb0413dc325..2d8328ee0a83 100644 --- a/ServiceControl/src/V1/Client/ServiceControllerClient.php +++ b/ServiceControl/src/V1/Client/ServiceControllerClient.php @@ -47,8 +47,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface checkAsync(CheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface reportAsync(ReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkAsync(CheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface reportAsync(ReportRequest $request, array $optionalArgs = []) */ final class ServiceControllerClient { diff --git a/ServiceManagement/src/V1/Client/ServiceManagerClient.php b/ServiceManagement/src/V1/Client/ServiceManagerClient.php index 99999b62e6fc..9f3cfa1b61a5 100644 --- a/ServiceManagement/src/V1/Client/ServiceManagerClient.php +++ b/ServiceManagement/src/V1/Client/ServiceManagerClient.php @@ -68,22 +68,22 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceConfigAsync(CreateServiceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceRolloutAsync(CreateServiceRolloutRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateConfigReportAsync(GenerateConfigReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceConfigAsync(GetServiceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceRolloutAsync(GetServiceRolloutRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServiceConfigsAsync(ListServiceConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServiceRolloutsAsync(ListServiceRolloutsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface submitConfigSourceAsync(SubmitConfigSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteServiceAsync(UndeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceConfigAsync(CreateServiceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceRolloutAsync(CreateServiceRolloutRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateConfigReportAsync(GenerateConfigReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceConfigAsync(GetServiceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceRolloutAsync(GetServiceRolloutRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServiceConfigsAsync(ListServiceConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServiceRolloutsAsync(ListServiceRolloutsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface submitConfigSourceAsync(SubmitConfigSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteServiceAsync(UndeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ServiceManagerClient { diff --git a/ServiceUsage/src/V1/Client/ServiceUsageClient.php b/ServiceUsage/src/V1/Client/ServiceUsageClient.php index e0a6778b0886..1be48aeeef10 100644 --- a/ServiceUsage/src/V1/Client/ServiceUsageClient.php +++ b/ServiceUsage/src/V1/Client/ServiceUsageClient.php @@ -55,12 +55,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface batchEnableServicesAsync(BatchEnableServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchGetServicesAsync(BatchGetServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface disableServiceAsync(DisableServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableServiceAsync(EnableServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchEnableServicesAsync(BatchEnableServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchGetServicesAsync(BatchGetServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableServiceAsync(DisableServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableServiceAsync(EnableServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) */ final class ServiceUsageClient { From f400f71623791e5a04df5630b0d72534219e118d Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Fri, 1 Nov 2024 11:37:24 -0700 Subject: [PATCH 066/157] docs: fix URLs for new package name (#7790) --- .repo-metadata-full.json | 2 +- AdsMarketingPlatformAdmin/README.md | 6 +++--- AdsMarketingPlatformAdmin/composer.json | 2 +- composer.json | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.repo-metadata-full.json b/.repo-metadata-full.json index e6f2308fdc03..e5f8c12aa5ff 100644 --- a/.repo-metadata-full.json +++ b/.repo-metadata-full.json @@ -27,7 +27,7 @@ "language": "php", "distribution_name": "googleads/marketingplatform-admin", "release_level": "preview", - "client_documentation": "https://cloud.google.com/php/docs/reference/ads-marketingplatform-admin/latest", + "client_documentation": "https://cloud.google.com/php/docs/reference/googleads/marketingplatform-admin/latest", "library_type": "GAPIC_AUTO", "api_shortname": "marketingplatformadmin" }, diff --git a/AdsMarketingPlatformAdmin/README.md b/AdsMarketingPlatformAdmin/README.md index 31ea7c042b46..0e291996dff1 100644 --- a/AdsMarketingPlatformAdmin/README.md +++ b/AdsMarketingPlatformAdmin/README.md @@ -2,9 +2,9 @@ > Idiomatic PHP client for [Google Ads Marketing Platform Admin](https://developers.google.com/analytics/devguides/config/gmp/v1). -[![Latest Stable Version](https://poser.pugx.org/google/ads-marketingplatform-admin/v/stable)](https://packagist.org/packages/google/ads-marketingplatform-admin) [![Packagist](https://img.shields.io/packagist/dm/google/ads-marketingplatform-admin.svg)](https://packagist.org/packages/google/ads-marketingplatform-admin) +[![Latest Stable Version](https://poser.pugx.org/googleads/marketingplatform-admin/v/stable)](https://packagist.org/packages/googleads/marketingplatform-admin) [![Packagist](https://img.shields.io/packagist/dm/googleads/marketingplatform-admin.svg)](https://packagist.org/packages/googleads/marketingplatform-admin) -* [API documentation](https://cloud.google.com/php/docs/reference/ads-marketingplatform-admin/latest) +* [API documentation](https://cloud.google.com/php/docs/referenc/googleeads/marketingplatform-admin/latest) **NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googleapis/google-cloud-php). Any support requests, bug reports, or development contributions should be directed to @@ -17,7 +17,7 @@ To begin, install the preferred dependency manager for PHP, [Composer](https://g Now, install this component: ```sh -$ composer require google/ads-marketingplatform-admin +$ composer require googleads/marketingplatform-admin ``` > Browse the complete list of [Google Cloud APIs](https://cloud.google.com/php/docs/reference) diff --git a/AdsMarketingPlatformAdmin/composer.json b/AdsMarketingPlatformAdmin/composer.json index 2c3690e679d5..8308a114ace5 100644 --- a/AdsMarketingPlatformAdmin/composer.json +++ b/AdsMarketingPlatformAdmin/composer.json @@ -11,7 +11,7 @@ }, "extra": { "component": { - "id": "ads-marketingplatform-admin", + "id": "googleads/marketingplatform-admin", "path": "AdsMarketingPlatformAdmin", "target": "googleapis/php-ads-marketingplatform-admin" } diff --git a/composer.json b/composer.json index 5f1433d8b8a9..f54c928e1efe 100644 --- a/composer.json +++ b/composer.json @@ -68,7 +68,6 @@ }, "replace": { "google/access-context-manager": "1.0.0", - "google/ads-marketingplatform-admin": "0.1.0", "google/analytics-admin": "0.24.0", "google/analytics-data": "0.20.0", "google/apps-chat": "0.6.0", @@ -262,7 +261,8 @@ "google/shopping-merchant-promotions": "0.1.0", "google/shopping-merchant-quota": "0.1.3", "google/shopping-merchant-reports": "0.8.1", - "googleads/ad-manager": "0.1.0" + "googleads/ad-manager": "0.1.0", + "googleads/marketingplatform-admin": "0.1.0" }, "suggest": { "opis/closure": "May be used to serialize closures to process jobs in the batch daemon. Please require version ^3.", From e3e1d065c0362fe044e570986c99fcfc5746681b Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 1 Nov 2024 14:46:23 -0400 Subject: [PATCH 067/157] docs: publishing v1 version of Memorystore API (#7788) * feat: publishing v1 version of Memorystore API PiperOrigin-RevId: 691873596 Source-Link: https://github.com/googleapis/googleapis/commit/b7c5b60ee76c4591e32c874978c6cd8231087ed6 Source-Link: https://github.com/googleapis/googleapis-gen/commit/d276c5cfca6af4a2b6c48944230f763f20f5d2fb Copy-Tag: eyJwIjoiRGlhbG9nZmxvdy8uT3dsQm90LnlhbWwiLCJoIjoiZDI3NmM1Y2ZjYTZhZjRhMmI2YzQ4OTQ0MjMwZjc2M2YyMGY1ZDJmYiJ9 --- Dialogflow/src/V2/Client/AgentsClient.php | 22 ++++++++--------- .../src/V2/Client/AnswerRecordsClient.php | 8 +++---- Dialogflow/src/V2/Client/ContextsClient.php | 16 ++++++------- .../V2/Client/ConversationDatasetsClient.php | 14 +++++------ .../V2/Client/ConversationModelsClient.php | 22 ++++++++--------- .../V2/Client/ConversationProfilesClient.php | 18 +++++++------- .../src/V2/Client/ConversationsClient.php | 22 ++++++++--------- Dialogflow/src/V2/Client/DocumentsClient.php | 20 ++++++++-------- .../V2/Client/EncryptionSpecServiceClient.php | 8 +++---- .../src/V2/Client/EntityTypesClient.php | 24 +++++++++---------- .../src/V2/Client/EnvironmentsClient.php | 16 ++++++------- .../src/V2/Client/FulfillmentsClient.php | 8 +++---- Dialogflow/src/V2/Client/GeneratorsClient.php | 14 +++++------ Dialogflow/src/V2/Client/IntentsClient.php | 18 +++++++------- .../src/V2/Client/KnowledgeBasesClient.php | 14 +++++------ .../src/V2/Client/ParticipantsClient.php | 22 ++++++++--------- .../V2/Client/SessionEntityTypesClient.php | 14 +++++------ Dialogflow/src/V2/Client/SessionsClient.php | 6 ++--- Dialogflow/src/V2/Client/VersionsClient.php | 14 +++++------ 19 files changed, 150 insertions(+), 150 deletions(-) diff --git a/Dialogflow/src/V2/Client/AgentsClient.php b/Dialogflow/src/V2/Client/AgentsClient.php index fa5b3b493647..8af3ff77f142 100644 --- a/Dialogflow/src/V2/Client/AgentsClient.php +++ b/Dialogflow/src/V2/Client/AgentsClient.php @@ -65,17 +65,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface deleteAgentAsync(DeleteAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportAgentAsync(ExportAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAgentAsync(GetAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getValidationResultAsync(GetValidationResultRequest $request, array $optionalArgs = []) - * @method PromiseInterface importAgentAsync(ImportAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreAgentAsync(RestoreAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchAgentsAsync(SearchAgentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setAgentAsync(SetAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface trainAgentAsync(TrainAgentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAgentAsync(DeleteAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportAgentAsync(ExportAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAgentAsync(GetAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getValidationResultAsync(GetValidationResultRequest $request, array $optionalArgs = []) + * @method PromiseInterface importAgentAsync(ImportAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreAgentAsync(RestoreAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchAgentsAsync(SearchAgentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setAgentAsync(SetAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface trainAgentAsync(TrainAgentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class AgentsClient { diff --git a/Dialogflow/src/V2/Client/AnswerRecordsClient.php b/Dialogflow/src/V2/Client/AnswerRecordsClient.php index 720b629f5072..eeabf2fff236 100644 --- a/Dialogflow/src/V2/Client/AnswerRecordsClient.php +++ b/Dialogflow/src/V2/Client/AnswerRecordsClient.php @@ -53,10 +53,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface listAnswerRecordsAsync(ListAnswerRecordsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAnswerRecordAsync(UpdateAnswerRecordRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAnswerRecordsAsync(ListAnswerRecordsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAnswerRecordAsync(UpdateAnswerRecordRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class AnswerRecordsClient { diff --git a/Dialogflow/src/V2/Client/ContextsClient.php b/Dialogflow/src/V2/Client/ContextsClient.php index f840b4e8f7dc..ac53a4872ed3 100644 --- a/Dialogflow/src/V2/Client/ContextsClient.php +++ b/Dialogflow/src/V2/Client/ContextsClient.php @@ -56,14 +56,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createContextAsync(CreateContextRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAllContextsAsync(DeleteAllContextsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteContextAsync(DeleteContextRequest $request, array $optionalArgs = []) - * @method PromiseInterface getContextAsync(GetContextRequest $request, array $optionalArgs = []) - * @method PromiseInterface listContextsAsync(ListContextsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateContextAsync(UpdateContextRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createContextAsync(CreateContextRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAllContextsAsync(DeleteAllContextsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteContextAsync(DeleteContextRequest $request, array $optionalArgs = []) + * @method PromiseInterface getContextAsync(GetContextRequest $request, array $optionalArgs = []) + * @method PromiseInterface listContextsAsync(ListContextsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateContextAsync(UpdateContextRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ContextsClient { diff --git a/Dialogflow/src/V2/Client/ConversationDatasetsClient.php b/Dialogflow/src/V2/Client/ConversationDatasetsClient.php index 6226c8cd89f6..9c17f4433cbe 100644 --- a/Dialogflow/src/V2/Client/ConversationDatasetsClient.php +++ b/Dialogflow/src/V2/Client/ConversationDatasetsClient.php @@ -65,13 +65,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createConversationDatasetAsync(CreateConversationDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversationDatasetAsync(DeleteConversationDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversationDatasetAsync(GetConversationDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface importConversationDataAsync(ImportConversationDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversationDatasetsAsync(ListConversationDatasetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversationDatasetAsync(CreateConversationDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversationDatasetAsync(DeleteConversationDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversationDatasetAsync(GetConversationDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface importConversationDataAsync(ImportConversationDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversationDatasetsAsync(ListConversationDatasetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ConversationDatasetsClient { diff --git a/Dialogflow/src/V2/Client/ConversationModelsClient.php b/Dialogflow/src/V2/Client/ConversationModelsClient.php index 14f464af10fc..278139871ba4 100644 --- a/Dialogflow/src/V2/Client/ConversationModelsClient.php +++ b/Dialogflow/src/V2/Client/ConversationModelsClient.php @@ -67,17 +67,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createConversationModelAsync(CreateConversationModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConversationModelEvaluationAsync(CreateConversationModelEvaluationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversationModelAsync(DeleteConversationModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deployConversationModelAsync(DeployConversationModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversationModelAsync(GetConversationModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversationModelEvaluationAsync(GetConversationModelEvaluationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversationModelEvaluationsAsync(ListConversationModelEvaluationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversationModelsAsync(ListConversationModelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeployConversationModelAsync(UndeployConversationModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversationModelAsync(CreateConversationModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversationModelEvaluationAsync(CreateConversationModelEvaluationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversationModelAsync(DeleteConversationModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deployConversationModelAsync(DeployConversationModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversationModelAsync(GetConversationModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversationModelEvaluationAsync(GetConversationModelEvaluationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversationModelEvaluationsAsync(ListConversationModelEvaluationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversationModelsAsync(ListConversationModelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeployConversationModelAsync(UndeployConversationModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ConversationModelsClient { diff --git a/Dialogflow/src/V2/Client/ConversationProfilesClient.php b/Dialogflow/src/V2/Client/ConversationProfilesClient.php index ad5f5bff0f4a..30bae2237aaf 100644 --- a/Dialogflow/src/V2/Client/ConversationProfilesClient.php +++ b/Dialogflow/src/V2/Client/ConversationProfilesClient.php @@ -63,15 +63,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface clearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConversationProfileAsync(CreateConversationProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversationProfileAsync(DeleteConversationProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversationProfileAsync(GetConversationProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversationProfilesAsync(ListConversationProfilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConversationProfileAsync(UpdateConversationProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface clearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversationProfileAsync(CreateConversationProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversationProfileAsync(DeleteConversationProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversationProfileAsync(GetConversationProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversationProfilesAsync(ListConversationProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConversationProfileAsync(UpdateConversationProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ConversationProfilesClient { diff --git a/Dialogflow/src/V2/Client/ConversationsClient.php b/Dialogflow/src/V2/Client/ConversationsClient.php index 08a43d210fc7..079279f65b71 100644 --- a/Dialogflow/src/V2/Client/ConversationsClient.php +++ b/Dialogflow/src/V2/Client/ConversationsClient.php @@ -64,17 +64,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface completeConversationAsync(CompleteConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConversationAsync(CreateConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateStatelessSuggestionAsync(GenerateStatelessSuggestionRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateStatelessSummaryAsync(GenerateStatelessSummaryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversationAsync(GetConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversationsAsync(ListConversationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMessagesAsync(ListMessagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchKnowledgeAsync(SearchKnowledgeRequest $request, array $optionalArgs = []) - * @method PromiseInterface suggestConversationSummaryAsync(SuggestConversationSummaryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface completeConversationAsync(CompleteConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversationAsync(CreateConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateStatelessSuggestionAsync(GenerateStatelessSuggestionRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateStatelessSummaryAsync(GenerateStatelessSummaryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversationAsync(GetConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversationsAsync(ListConversationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMessagesAsync(ListMessagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchKnowledgeAsync(SearchKnowledgeRequest $request, array $optionalArgs = []) + * @method PromiseInterface suggestConversationSummaryAsync(SuggestConversationSummaryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ConversationsClient { diff --git a/Dialogflow/src/V2/Client/DocumentsClient.php b/Dialogflow/src/V2/Client/DocumentsClient.php index de7a9a0a752d..178c20d909fa 100644 --- a/Dialogflow/src/V2/Client/DocumentsClient.php +++ b/Dialogflow/src/V2/Client/DocumentsClient.php @@ -64,16 +64,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDocumentAsync(CreateDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDocumentAsync(DeleteDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportDocumentAsync(ExportDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDocumentAsync(GetDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface importDocumentsAsync(ImportDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDocumentsAsync(ListDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface reloadDocumentAsync(ReloadDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDocumentAsync(UpdateDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDocumentAsync(CreateDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDocumentAsync(DeleteDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportDocumentAsync(ExportDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDocumentAsync(GetDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface importDocumentsAsync(ImportDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDocumentsAsync(ListDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface reloadDocumentAsync(ReloadDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDocumentAsync(UpdateDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DocumentsClient { diff --git a/Dialogflow/src/V2/Client/EncryptionSpecServiceClient.php b/Dialogflow/src/V2/Client/EncryptionSpecServiceClient.php index 547b5b510197..c78ea7f5409f 100644 --- a/Dialogflow/src/V2/Client/EncryptionSpecServiceClient.php +++ b/Dialogflow/src/V2/Client/EncryptionSpecServiceClient.php @@ -55,10 +55,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getEncryptionSpecAsync(GetEncryptionSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEncryptionSpecAsync(GetEncryptionSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class EncryptionSpecServiceClient { diff --git a/Dialogflow/src/V2/Client/EntityTypesClient.php b/Dialogflow/src/V2/Client/EntityTypesClient.php index e55cc3dca49c..28e7feb4b215 100644 --- a/Dialogflow/src/V2/Client/EntityTypesClient.php +++ b/Dialogflow/src/V2/Client/EntityTypesClient.php @@ -66,18 +66,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateEntitiesAsync(BatchCreateEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchDeleteEntitiesAsync(BatchDeleteEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchUpdateEntitiesAsync(BatchUpdateEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntityTypeAsync(CreateEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntityTypeAsync(DeleteEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntityTypeAsync(GetEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntityTypesAsync(ListEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntityTypeAsync(UpdateEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateEntitiesAsync(BatchCreateEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeleteEntitiesAsync(BatchDeleteEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateEntitiesAsync(BatchUpdateEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntityTypeAsync(CreateEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntityTypeAsync(DeleteEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntityTypeAsync(GetEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntityTypesAsync(ListEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntityTypeAsync(UpdateEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class EntityTypesClient { diff --git a/Dialogflow/src/V2/Client/EnvironmentsClient.php b/Dialogflow/src/V2/Client/EnvironmentsClient.php index 9bf61e8b878f..3258fcd59c25 100644 --- a/Dialogflow/src/V2/Client/EnvironmentsClient.php +++ b/Dialogflow/src/V2/Client/EnvironmentsClient.php @@ -56,14 +56,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnvironmentHistoryAsync(GetEnvironmentHistoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEnvironmentAsync(UpdateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnvironmentHistoryAsync(GetEnvironmentHistoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEnvironmentAsync(UpdateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class EnvironmentsClient { diff --git a/Dialogflow/src/V2/Client/FulfillmentsClient.php b/Dialogflow/src/V2/Client/FulfillmentsClient.php index e32abe622bfd..4a1cecba696b 100644 --- a/Dialogflow/src/V2/Client/FulfillmentsClient.php +++ b/Dialogflow/src/V2/Client/FulfillmentsClient.php @@ -52,10 +52,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getFulfillmentAsync(GetFulfillmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFulfillmentAsync(UpdateFulfillmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFulfillmentAsync(GetFulfillmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFulfillmentAsync(UpdateFulfillmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class FulfillmentsClient { diff --git a/Dialogflow/src/V2/Client/GeneratorsClient.php b/Dialogflow/src/V2/Client/GeneratorsClient.php index 495de526bd8e..5bbe5e390eed 100644 --- a/Dialogflow/src/V2/Client/GeneratorsClient.php +++ b/Dialogflow/src/V2/Client/GeneratorsClient.php @@ -59,13 +59,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createGeneratorAsync(CreateGeneratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGeneratorAsync(DeleteGeneratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGeneratorAsync(GetGeneratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGeneratorsAsync(ListGeneratorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGeneratorAsync(UpdateGeneratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGeneratorAsync(CreateGeneratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGeneratorAsync(DeleteGeneratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGeneratorAsync(GetGeneratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGeneratorsAsync(ListGeneratorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGeneratorAsync(UpdateGeneratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class GeneratorsClient { diff --git a/Dialogflow/src/V2/Client/IntentsClient.php b/Dialogflow/src/V2/Client/IntentsClient.php index 071a108e8f38..6daf063d5418 100644 --- a/Dialogflow/src/V2/Client/IntentsClient.php +++ b/Dialogflow/src/V2/Client/IntentsClient.php @@ -62,15 +62,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchDeleteIntentsAsync(BatchDeleteIntentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchUpdateIntentsAsync(BatchUpdateIntentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createIntentAsync(CreateIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIntentAsync(DeleteIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIntentAsync(GetIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIntentsAsync(ListIntentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateIntentAsync(UpdateIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeleteIntentsAsync(BatchDeleteIntentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateIntentsAsync(BatchUpdateIntentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIntentAsync(CreateIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIntentAsync(DeleteIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIntentAsync(GetIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIntentsAsync(ListIntentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateIntentAsync(UpdateIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class IntentsClient { diff --git a/Dialogflow/src/V2/Client/KnowledgeBasesClient.php b/Dialogflow/src/V2/Client/KnowledgeBasesClient.php index 10e3982fcc6d..9be56bdb998b 100644 --- a/Dialogflow/src/V2/Client/KnowledgeBasesClient.php +++ b/Dialogflow/src/V2/Client/KnowledgeBasesClient.php @@ -56,13 +56,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createKnowledgeBaseAsync(CreateKnowledgeBaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKnowledgeBaseAsync(GetKnowledgeBaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface listKnowledgeBasesAsync(ListKnowledgeBasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createKnowledgeBaseAsync(CreateKnowledgeBaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKnowledgeBaseAsync(GetKnowledgeBaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface listKnowledgeBasesAsync(ListKnowledgeBasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class KnowledgeBasesClient { diff --git a/Dialogflow/src/V2/Client/ParticipantsClient.php b/Dialogflow/src/V2/Client/ParticipantsClient.php index 3917214c0b5f..1c7382efb4a4 100644 --- a/Dialogflow/src/V2/Client/ParticipantsClient.php +++ b/Dialogflow/src/V2/Client/ParticipantsClient.php @@ -65,17 +65,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface analyzeContentAsync(AnalyzeContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createParticipantAsync(CreateParticipantRequest $request, array $optionalArgs = []) - * @method PromiseInterface getParticipantAsync(GetParticipantRequest $request, array $optionalArgs = []) - * @method PromiseInterface listParticipantsAsync(ListParticipantsRequest $request, array $optionalArgs = []) - * @method PromiseInterface suggestArticlesAsync(SuggestArticlesRequest $request, array $optionalArgs = []) - * @method PromiseInterface suggestFaqAnswersAsync(SuggestFaqAnswersRequest $request, array $optionalArgs = []) - * @method PromiseInterface suggestKnowledgeAssistAsync(SuggestKnowledgeAssistRequest $request, array $optionalArgs = []) - * @method PromiseInterface suggestSmartRepliesAsync(SuggestSmartRepliesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateParticipantAsync(UpdateParticipantRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeContentAsync(AnalyzeContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createParticipantAsync(CreateParticipantRequest $request, array $optionalArgs = []) + * @method PromiseInterface getParticipantAsync(GetParticipantRequest $request, array $optionalArgs = []) + * @method PromiseInterface listParticipantsAsync(ListParticipantsRequest $request, array $optionalArgs = []) + * @method PromiseInterface suggestArticlesAsync(SuggestArticlesRequest $request, array $optionalArgs = []) + * @method PromiseInterface suggestFaqAnswersAsync(SuggestFaqAnswersRequest $request, array $optionalArgs = []) + * @method PromiseInterface suggestKnowledgeAssistAsync(SuggestKnowledgeAssistRequest $request, array $optionalArgs = []) + * @method PromiseInterface suggestSmartRepliesAsync(SuggestSmartRepliesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateParticipantAsync(UpdateParticipantRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ParticipantsClient { diff --git a/Dialogflow/src/V2/Client/SessionEntityTypesClient.php b/Dialogflow/src/V2/Client/SessionEntityTypesClient.php index 1aa782b0a84e..c17cae3023dc 100644 --- a/Dialogflow/src/V2/Client/SessionEntityTypesClient.php +++ b/Dialogflow/src/V2/Client/SessionEntityTypesClient.php @@ -56,13 +56,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSessionEntityTypeAsync(CreateSessionEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSessionEntityTypeAsync(DeleteSessionEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSessionEntityTypeAsync(GetSessionEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSessionEntityTypesAsync(ListSessionEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSessionEntityTypeAsync(UpdateSessionEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSessionEntityTypeAsync(CreateSessionEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSessionEntityTypeAsync(DeleteSessionEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSessionEntityTypeAsync(GetSessionEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSessionEntityTypesAsync(ListSessionEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSessionEntityTypeAsync(UpdateSessionEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SessionEntityTypesClient { diff --git a/Dialogflow/src/V2/Client/SessionsClient.php b/Dialogflow/src/V2/Client/SessionsClient.php index b2cbe503593b..33223c3dfd05 100644 --- a/Dialogflow/src/V2/Client/SessionsClient.php +++ b/Dialogflow/src/V2/Client/SessionsClient.php @@ -55,9 +55,9 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface detectIntentAsync(DetectIntentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface detectIntentAsync(DetectIntentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SessionsClient { diff --git a/Dialogflow/src/V2/Client/VersionsClient.php b/Dialogflow/src/V2/Client/VersionsClient.php index db040e2ee030..f4cc7f3c34ae 100644 --- a/Dialogflow/src/V2/Client/VersionsClient.php +++ b/Dialogflow/src/V2/Client/VersionsClient.php @@ -55,13 +55,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createVersionAsync(CreateVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVersionAsync(CreateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class VersionsClient { From 88be871d44f49c839d00a9ed0a6e0a9dedd3de19 Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Fri, 1 Nov 2024 15:34:13 -0400 Subject: [PATCH 068/157] chore(main): release 0.266.0 (#7774) * chore(main): release 0.266.0 * chore(main): release 0.266.0 --------- Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- AccessApproval/VERSION | 2 +- AdsAdManager/VERSION | 2 +- AdsMarketingPlatformAdmin/VERSION | 2 +- AdvisoryNotifications/VERSION | 2 +- AiPlatform/VERSION | 2 +- AlloyDb/VERSION | 2 +- AnalyticsAdmin/VERSION | 2 +- AnalyticsData/VERSION | 2 +- ApiGateway/VERSION | 2 +- ApiHub/VERSION | 2 +- ApiKeys/VERSION | 2 +- ApigeeConnect/VERSION | 2 +- ApigeeRegistry/VERSION | 2 +- AppEngineAdmin/VERSION | 2 +- AppHub/VERSION | 2 +- AppsChat/VERSION | 2 +- AppsEventsSubscriptions/VERSION | 2 +- AppsMeet/VERSION | 2 +- ArtifactRegistry/VERSION | 2 +- Asset/VERSION | 2 +- AssuredWorkloads/VERSION | 2 +- AutoMl/VERSION | 2 +- BackupDr/VERSION | 2 +- BareMetalSolution/VERSION | 2 +- Batch/VERSION | 2 +- BeyondCorpAppConnections/VERSION | 2 +- BeyondCorpAppConnectors/VERSION | 2 +- BeyondCorpAppGateways/VERSION | 2 +- BeyondCorpClientConnectorServices/VERSION | 2 +- BeyondCorpClientGateways/VERSION | 2 +- BigQueryAnalyticsHub/VERSION | 2 +- BigQueryConnection/VERSION | 2 +- BigQueryDataExchange/VERSION | 2 +- BigQueryDataPolicies/VERSION | 2 +- BigQueryDataTransfer/VERSION | 2 +- BigQueryMigration/VERSION | 2 +- BigQueryReservation/VERSION | 2 +- BigQueryStorage/VERSION | 2 +- Bigtable/VERSION | 2 +- Billing/VERSION | 2 +- BillingBudgets/VERSION | 2 +- BinaryAuthorization/VERSION | 2 +- CHANGELOG.md | 809 ++++++++++++++++++++++ CertificateManager/VERSION | 2 +- Channel/VERSION | 2 +- CommerceConsumerProcurement/VERSION | 2 +- ConfidentialComputing/VERSION | 2 +- Config/VERSION | 2 +- ContactCenterInsights/VERSION | 2 +- ControlsPartner/VERSION | 2 +- DataCatalog/VERSION | 2 +- DataCatalogLineage/VERSION | 2 +- DataFusion/VERSION | 2 +- DataLabeling/VERSION | 2 +- Dataform/VERSION | 2 +- Dataplex/VERSION | 2 +- Dataproc/VERSION | 2 +- Datastream/VERSION | 2 +- Deploy/VERSION | 2 +- DeveloperConnect/VERSION | 2 +- Dialogflow/VERSION | 2 +- DialogflowCx/VERSION | 2 +- DiscoveryEngine/VERSION | 2 +- Dms/VERSION | 2 +- Eventarc/VERSION | 2 +- EventarcPublishing/VERSION | 2 +- Kms/VERSION | 2 +- Quotas/VERSION | 2 +- RecaptchaEnterprise/VERSION | 2 +- SecurityCenterManagement/VERSION | 2 +- ServiceControl/VERSION | 2 +- ServiceManagement/VERSION | 2 +- ServiceUsage/VERSION | 2 +- Storage/VERSION | 2 +- Storage/src/StorageClient.php | 2 +- TextToSpeech/VERSION | 2 +- composer.json | 148 ++-- 77 files changed, 958 insertions(+), 149 deletions(-) diff --git a/AccessApproval/VERSION b/AccessApproval/VERSION index 38f77a65b301..e9307ca5751b 100644 --- a/AccessApproval/VERSION +++ b/AccessApproval/VERSION @@ -1 +1 @@ -2.0.1 +2.0.2 diff --git a/AdsAdManager/VERSION b/AdsAdManager/VERSION index 6e8bf73aa550..17e51c385ea3 100644 --- a/AdsAdManager/VERSION +++ b/AdsAdManager/VERSION @@ -1 +1 @@ -0.1.0 +0.1.1 diff --git a/AdsMarketingPlatformAdmin/VERSION b/AdsMarketingPlatformAdmin/VERSION index 6e8bf73aa550..17e51c385ea3 100644 --- a/AdsMarketingPlatformAdmin/VERSION +++ b/AdsMarketingPlatformAdmin/VERSION @@ -1 +1 @@ -0.1.0 +0.1.1 diff --git a/AdvisoryNotifications/VERSION b/AdvisoryNotifications/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/AdvisoryNotifications/VERSION +++ b/AdvisoryNotifications/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/AiPlatform/VERSION b/AiPlatform/VERSION index f8e233b27332..81c871de46b3 100644 --- a/AiPlatform/VERSION +++ b/AiPlatform/VERSION @@ -1 +1 @@ -1.9.0 +1.10.0 diff --git a/AlloyDb/VERSION b/AlloyDb/VERSION index 9084fa2f716a..524cb55242b5 100644 --- a/AlloyDb/VERSION +++ b/AlloyDb/VERSION @@ -1 +1 @@ -1.1.0 +1.1.1 diff --git a/AnalyticsAdmin/VERSION b/AnalyticsAdmin/VERSION index 2094a100ca8b..48b91fd89c07 100644 --- a/AnalyticsAdmin/VERSION +++ b/AnalyticsAdmin/VERSION @@ -1 +1 @@ -0.24.0 +0.24.1 diff --git a/AnalyticsData/VERSION b/AnalyticsData/VERSION index 5a03fb737b38..847e9aef6d1f 100644 --- a/AnalyticsData/VERSION +++ b/AnalyticsData/VERSION @@ -1 +1 @@ -0.20.0 +0.20.1 diff --git a/ApiGateway/VERSION b/ApiGateway/VERSION index 227cea215648..38f77a65b301 100644 --- a/ApiGateway/VERSION +++ b/ApiGateway/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/ApiHub/VERSION b/ApiHub/VERSION index 17e51c385ea3..d917d3e26adc 100644 --- a/ApiHub/VERSION +++ b/ApiHub/VERSION @@ -1 +1 @@ -0.1.1 +0.1.2 diff --git a/ApiKeys/VERSION b/ApiKeys/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/ApiKeys/VERSION +++ b/ApiKeys/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/ApigeeConnect/VERSION b/ApigeeConnect/VERSION index 38f77a65b301..e9307ca5751b 100644 --- a/ApigeeConnect/VERSION +++ b/ApigeeConnect/VERSION @@ -1 +1 @@ -2.0.1 +2.0.2 diff --git a/ApigeeRegistry/VERSION b/ApigeeRegistry/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/ApigeeRegistry/VERSION +++ b/ApigeeRegistry/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/AppEngineAdmin/VERSION b/AppEngineAdmin/VERSION index 227cea215648..38f77a65b301 100644 --- a/AppEngineAdmin/VERSION +++ b/AppEngineAdmin/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/AppHub/VERSION b/AppHub/VERSION index b1e80bb2480a..845639eef26c 100644 --- a/AppHub/VERSION +++ b/AppHub/VERSION @@ -1 +1 @@ -0.1.3 +0.1.4 diff --git a/AppsChat/VERSION b/AppsChat/VERSION index a918a2aa18d5..ee6cdce3c290 100644 --- a/AppsChat/VERSION +++ b/AppsChat/VERSION @@ -1 +1 @@ -0.6.0 +0.6.1 diff --git a/AppsEventsSubscriptions/VERSION b/AppsEventsSubscriptions/VERSION index b1e80bb2480a..845639eef26c 100644 --- a/AppsEventsSubscriptions/VERSION +++ b/AppsEventsSubscriptions/VERSION @@ -1 +1 @@ -0.1.3 +0.1.4 diff --git a/AppsMeet/VERSION b/AppsMeet/VERSION index 7179039691ce..abd410582dea 100644 --- a/AppsMeet/VERSION +++ b/AppsMeet/VERSION @@ -1 +1 @@ -0.2.3 +0.2.4 diff --git a/ArtifactRegistry/VERSION b/ArtifactRegistry/VERSION index 3eefcb9dd5b3..9084fa2f716a 100644 --- a/ArtifactRegistry/VERSION +++ b/ArtifactRegistry/VERSION @@ -1 +1 @@ -1.0.0 +1.1.0 diff --git a/Asset/VERSION b/Asset/VERSION index 7ec1d6db4087..3e3c2f1e5edb 100644 --- a/Asset/VERSION +++ b/Asset/VERSION @@ -1 +1 @@ -2.1.0 +2.1.1 diff --git a/AssuredWorkloads/VERSION b/AssuredWorkloads/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/AssuredWorkloads/VERSION +++ b/AssuredWorkloads/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/AutoMl/VERSION b/AutoMl/VERSION index 227cea215648..38f77a65b301 100644 --- a/AutoMl/VERSION +++ b/AutoMl/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/BackupDr/VERSION b/BackupDr/VERSION index 1d0ba9ea182b..267577d47e49 100644 --- a/BackupDr/VERSION +++ b/BackupDr/VERSION @@ -1 +1 @@ -0.4.0 +0.4.1 diff --git a/BareMetalSolution/VERSION b/BareMetalSolution/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/BareMetalSolution/VERSION +++ b/BareMetalSolution/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/Batch/VERSION b/Batch/VERSION index 524cb55242b5..45a1b3f44523 100644 --- a/Batch/VERSION +++ b/Batch/VERSION @@ -1 +1 @@ -1.1.1 +1.1.2 diff --git a/BeyondCorpAppConnections/VERSION b/BeyondCorpAppConnections/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/BeyondCorpAppConnections/VERSION +++ b/BeyondCorpAppConnections/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/BeyondCorpAppConnectors/VERSION b/BeyondCorpAppConnectors/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/BeyondCorpAppConnectors/VERSION +++ b/BeyondCorpAppConnectors/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/BeyondCorpAppGateways/VERSION b/BeyondCorpAppGateways/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/BeyondCorpAppGateways/VERSION +++ b/BeyondCorpAppGateways/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/BeyondCorpClientConnectorServices/VERSION b/BeyondCorpClientConnectorServices/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/BeyondCorpClientConnectorServices/VERSION +++ b/BeyondCorpClientConnectorServices/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/BeyondCorpClientGateways/VERSION b/BeyondCorpClientGateways/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/BeyondCorpClientGateways/VERSION +++ b/BeyondCorpClientGateways/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/BigQueryAnalyticsHub/VERSION b/BigQueryAnalyticsHub/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/BigQueryAnalyticsHub/VERSION +++ b/BigQueryAnalyticsHub/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/BigQueryConnection/VERSION b/BigQueryConnection/VERSION index 227cea215648..38f77a65b301 100644 --- a/BigQueryConnection/VERSION +++ b/BigQueryConnection/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/BigQueryDataExchange/VERSION b/BigQueryDataExchange/VERSION index 0bfccb080404..ef52a648073d 100644 --- a/BigQueryDataExchange/VERSION +++ b/BigQueryDataExchange/VERSION @@ -1 +1 @@ -0.4.5 +0.4.6 diff --git a/BigQueryDataPolicies/VERSION b/BigQueryDataPolicies/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/BigQueryDataPolicies/VERSION +++ b/BigQueryDataPolicies/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/BigQueryDataTransfer/VERSION b/BigQueryDataTransfer/VERSION index 7ec1d6db4087..3e3c2f1e5edb 100644 --- a/BigQueryDataTransfer/VERSION +++ b/BigQueryDataTransfer/VERSION @@ -1 +1 @@ -2.1.0 +2.1.1 diff --git a/BigQueryMigration/VERSION b/BigQueryMigration/VERSION index 9084fa2f716a..524cb55242b5 100644 --- a/BigQueryMigration/VERSION +++ b/BigQueryMigration/VERSION @@ -1 +1 @@ -1.1.0 +1.1.1 diff --git a/BigQueryReservation/VERSION b/BigQueryReservation/VERSION index 38f77a65b301..e9307ca5751b 100644 --- a/BigQueryReservation/VERSION +++ b/BigQueryReservation/VERSION @@ -1 +1 @@ -2.0.1 +2.0.2 diff --git a/BigQueryStorage/VERSION b/BigQueryStorage/VERSION index 7ec1d6db4087..3e3c2f1e5edb 100644 --- a/BigQueryStorage/VERSION +++ b/BigQueryStorage/VERSION @@ -1 +1 @@ -2.1.0 +2.1.1 diff --git a/Bigtable/VERSION b/Bigtable/VERSION index 437459cd94c9..e70b4523ae7f 100644 --- a/Bigtable/VERSION +++ b/Bigtable/VERSION @@ -1 +1 @@ -2.5.0 +2.6.0 diff --git a/Billing/VERSION b/Billing/VERSION index 227cea215648..38f77a65b301 100644 --- a/Billing/VERSION +++ b/Billing/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/BillingBudgets/VERSION b/BillingBudgets/VERSION index 38f77a65b301..e9307ca5751b 100644 --- a/BillingBudgets/VERSION +++ b/BillingBudgets/VERSION @@ -1 +1 @@ -2.0.1 +2.0.2 diff --git a/BinaryAuthorization/VERSION b/BinaryAuthorization/VERSION index 7dea76edb3dc..6d7de6e6abef 100644 --- a/BinaryAuthorization/VERSION +++ b/BinaryAuthorization/VERSION @@ -1 +1 @@ -1.0.1 +1.0.2 diff --git a/CHANGELOG.md b/CHANGELOG.md index d5a24c3cf7e8..41e0eb564fca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,814 @@ # Changelog +## 0.266.0 + +
google/cloud-access-approval 2.0.2 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
googleads/ad-manager 0.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
googleads/marketingplatform-admin 0.1.1 + + + +### Documentation + +* Fix URLs for new package name ([#7790](https://github.com/googleapis/google-cloud-php/issues/7790)) ([f400f71](https://github.com/googleapis/google-cloud-php/commit/f400f71623791e5a04df5630b0d72534219e118d)) + +
+ +
google/cloud-advisorynotifications 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-ai-platform 1.10.0 + + + +### Features + +* Add StopNotebookRuntime method ([#7782](https://github.com/googleapis/google-cloud-php/issues/7782)) ([5271d4e](https://github.com/googleapis/google-cloud-php/commit/5271d4e6d2d70cd385246ca2edd888eade9d8a58)) + +
+ +
google/cloud-alloydb 1.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/analytics-admin 0.24.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/analytics-data 0.20.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-api-gateway 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-apihub 0.1.2 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-api-keys 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-apigee-connect 2.0.2 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-apigee-registry 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-appengine-admin 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-apphub 0.1.4 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/apps-chat 0.6.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/apps-events-subscriptions 0.1.4 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/apps-meet 0.2.4 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-artifact-registry 1.1.0 + + + +### Features + +* Add Artifact Registry attachment API ([#7768](https://github.com/googleapis/google-cloud-php/issues/7768)) ([31098df](https://github.com/googleapis/google-cloud-php/commit/31098df0b6df048189c4ab1c863b2c1b755610c4)) +* Add Artifact Registry custom remote support ([31098df](https://github.com/googleapis/google-cloud-php/commit/31098df0b6df048189c4ab1c863b2c1b755610c4)) +* Add Artifact Registry generic repository support ([31098df](https://github.com/googleapis/google-cloud-php/commit/31098df0b6df048189c4ab1c863b2c1b755610c4)) +* Add Artifact Registry rule APIs ([31098df](https://github.com/googleapis/google-cloud-php/commit/31098df0b6df048189c4ab1c863b2c1b755610c4)) +* Add Artifact Registry server side resource filtering and sorting ([31098df](https://github.com/googleapis/google-cloud-php/commit/31098df0b6df048189c4ab1c863b2c1b755610c4)) +* Add Artifact Registry UpdateFile and DeleteFile APIs ([31098df](https://github.com/googleapis/google-cloud-php/commit/31098df0b6df048189c4ab1c863b2c1b755610c4)) + + +### Documentation + +* Include max page size for all Artifact Registry APIs ([31098df](https://github.com/googleapis/google-cloud-php/commit/31098df0b6df048189c4ab1c863b2c1b755610c4)) + +
+ +
google/cloud-asset 2.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-assured-workloads 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-automl 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-backupdr 0.4.1 + + + +### Documentation + +* Add response types for async magic methods ([#7784](https://github.com/googleapis/google-cloud-php/issues/7784)) ([880808c](https://github.com/googleapis/google-cloud-php/commit/880808c36024e72b5142cf85fb02b9fe708cd178)) + +
+ +
google/cloud-bare-metal-solution 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-batch 1.1.2 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-beyondcorp-appconnections 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-beyondcorp-appconnectors 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-beyondcorp-appgateways 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-beyondcorp-clientconnectorservices 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-beyondcorp-clientgateways 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigquery-analyticshub 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigquery-connection 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigquery-data-exchange 0.4.6 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigquery-datapolicies 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigquerydatatransfer 2.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigquery-migration 1.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigquery-reservation 2.0.2 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigquery-storage 2.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-bigtable 2.6.0 + + + +### Features + +* Add feature flags proto for Direct Access ([#7770](https://github.com/googleapis/google-cloud-php/issues/7770)) ([b1dcfc6](https://github.com/googleapis/google-cloud-php/commit/b1dcfc615fef5fcbb316d0fa5eb8d41e79ed1565)) + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-billing 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-billing-budgets 2.0.2 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-binary-authorization 1.0.2 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-certificate-manager 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7785](https://github.com/googleapis/google-cloud-php/issues/7785)) ([0414f30](https://github.com/googleapis/google-cloud-php/commit/0414f3006d014f918a99512d044c880ae65ccd35)) + +
+ +
google/cloud-channel 2.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-commerce-consumer-procurement 1.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-confidentialcomputing 1.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-config 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-contact-center-insights 2.1.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-cloudcontrolspartner 0.2.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-data-catalog 2.0.2 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-datacatalog-lineage 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-data-fusion 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-datalabeling 0.5.6 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-dataform 0.4.6 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-dataplex 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-dataproc 2.2.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-datastream 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-deploy 1.3.0 + + + +### Features + +* Add response types for async magic methods ([#7773](https://github.com/googleapis/google-cloud-php/issues/7773)) ([a2eb865](https://github.com/googleapis/google-cloud-php/commit/a2eb865459782d36cc3d438eb8c4006d121f17bd)) + +
+ +
google/cloud-developerconnect 0.1.2 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-dialogflow 1.15.1 + + + +### Documentation + +* Publishing v1 version of Memorystore API ([#7788](https://github.com/googleapis/google-cloud-php/issues/7788)) ([e3e1d06](https://github.com/googleapis/google-cloud-php/commit/e3e1d065c0362fe044e570986c99fcfc5746681b)) + +
+ +
google/cloud-dialogflow-cx 0.4.1 + + + +### Documentation + +* Publishing v1beta version of Memorystore API ([#7787](https://github.com/googleapis/google-cloud-php/issues/7787)) ([c059372](https://github.com/googleapis/google-cloud-php/commit/c05937252134d063c790ec8a1b4ab62e24d5a2e2)) + +
+ +
google/cloud-discoveryengine 1.3.0 + + + +### Features + +* Add lite search API to allow public website search with API key ([#7765](https://github.com/googleapis/google-cloud-php/issues/7765)) ([0bd701e](https://github.com/googleapis/google-cloud-php/commit/0bd701e40b44bc7485d06c2dd6e4c7722f34e14e)) +* Add LOW_GROUNDED_ANSWER in answer skip reasons ([0bd701e](https://github.com/googleapis/google-cloud-php/commit/0bd701e40b44bc7485d06c2dd6e4c7722f34e14e)) +* Support query regex in control match rules ([0bd701e](https://github.com/googleapis/google-cloud-php/commit/0bd701e40b44bc7485d06c2dd6e4c7722f34e14e)) + + +### Documentation + +* Keep the API doc up-to-date with recent changes ([0bd701e](https://github.com/googleapis/google-cloud-php/commit/0bd701e40b44bc7485d06c2dd6e4c7722f34e14e)) + +
+ +
google/cloud-dms 2.0.2 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-eventarc 2.1.0 + + + +### Features + +* Publish Eventarc Advanced protos ([#7772](https://github.com/googleapis/google-cloud-php/issues/7772)) ([9e21daa](https://github.com/googleapis/google-cloud-php/commit/9e21daa78f8bd303777ac87409d31cb3bcdb71c8)) + + +### Documentation + +* Clarified multiple comments in Eventarc Standard protos ([9e21daa](https://github.com/googleapis/google-cloud-php/commit/9e21daa78f8bd303777ac87409d31cb3bcdb71c8)) + +
+ +
google/cloud-eventarc-publishing 1.1.0 + + + +### Features + +* Add AdvancedCompleteQuery API ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Add BillingEstimation in data store ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Add GroundedGenerationService API ([#7781](https://github.com/googleapis/google-cloud-php/issues/7781)) ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Add lite search API to allow public website search with API key ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Add one_box_page_size on search ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Add Sitemap APIs to preview channel ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Support advanced boost search ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Support Google Workspace search ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Support natural language understanding search ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Support query regex in control match rules ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Support search personalization to preview channel ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) + + +### Documentation + +* Deprecate asynchronous mode in answer generation ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Deprecate extractive_answers in answer generation ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) +* Keep the API doc up-to-date with recent changes ([ab36815](https://github.com/googleapis/google-cloud-php/commit/ab36815118c7fea625e734ca3957fe4addd55c6e)) + +
+ +
google/cloud-kms 2.1.1 + + + +### Documentation + +* update KMS docs ([068f434](https://github.com/googleapis/google-cloud-php/commit/068f434c7b00645ed7ec817b9359b6c5f9d2d466)) + +
+ +
google/cloud-quotas 1.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-recaptcha-enterprise 1.16.0 + + + +### Features + +* Enable Akamai web application firewall ([4d95d21](https://github.com/googleapis/google-cloud-php/commit/4d95d210ed316d1e3235e076ad5c71a1082d3164)) +* Support for ListIpOverrides and RemoveIpOverride ([#7777](https://github.com/googleapis/google-cloud-php/issues/7777)) ([4d95d21](https://github.com/googleapis/google-cloud-php/commit/4d95d210ed316d1e3235e076ad5c71a1082d3164)) + + +### Documentation + +* Minor updates to reference documentation ([4d95d21](https://github.com/googleapis/google-cloud-php/commit/4d95d210ed316d1e3235e076ad5c71a1082d3164)) + +
+ +
google/cloud-securitycentermanagement 1.1.0 + + + +### Features + +* Add AdvancedCompleteQuery API ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Add BillingEstimation in data store ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Add GroundedGenerationService API ([#7779](https://github.com/googleapis/google-cloud-php/issues/7779)) ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Add lite search API to allow public website search with API key ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Add one_box_page_size on search ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Add Sitemap APIs to preview channel ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Support advanced boost search ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Support Google Workspace search ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Support natural language understanding search ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Support query regex in control match rules ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Support search personalization to preview channel ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) + + +### Documentation + +* Deprecate asynchronous mode in answer generation ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Deprecate extractive_answers in answer generation ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) +* Keep the API doc up-to-date with recent changes ([cb053e3](https://github.com/googleapis/google-cloud-php/commit/cb053e3bcb689eb10630380d9b843df437ef3a10)) + +
+ +
google/cloud-service-control 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-service-management 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-service-usage 2.0.1 + + + +### Documentation + +* Add response types for async magic methods ([#7786](https://github.com/googleapis/google-cloud-php/issues/7786)) ([60a4541](https://github.com/googleapis/google-cloud-php/commit/60a4541afd8b66abd22f522d5ff73270cb0cad0e)) + +
+ +
google/cloud-storage 1.44.0 + + + +### Features + +* **Storage:** Add support for restore token ([#7775](https://github.com/googleapis/google-cloud-php/issues/7775)) ([4e408c3](https://github.com/googleapis/google-cloud-php/commit/4e408c363e197524feb8b2109f07d58d3d812045)) + +
+ +
google/cloud-text-to-speech 1.12.0 + + + +### Features + +* Add multi-speaker markup, which allows generating dialogue between multiple speakers ([#7769](https://github.com/googleapis/google-cloud-php/issues/7769)) ([e0b9c6f](https://github.com/googleapis/google-cloud-php/commit/e0b9c6f1a962fbe441fd8ab15b7275a101354553)) + +
+ ## 0.265.0
googleads/ad-manager 0.1.0 diff --git a/CertificateManager/VERSION b/CertificateManager/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/CertificateManager/VERSION +++ b/CertificateManager/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/Channel/VERSION b/Channel/VERSION index 7ec1d6db4087..3e3c2f1e5edb 100644 --- a/Channel/VERSION +++ b/Channel/VERSION @@ -1 +1 @@ -2.1.0 +2.1.1 diff --git a/CommerceConsumerProcurement/VERSION b/CommerceConsumerProcurement/VERSION index 9084fa2f716a..524cb55242b5 100644 --- a/CommerceConsumerProcurement/VERSION +++ b/CommerceConsumerProcurement/VERSION @@ -1 +1 @@ -1.1.0 +1.1.1 diff --git a/ConfidentialComputing/VERSION b/ConfidentialComputing/VERSION index 9084fa2f716a..524cb55242b5 100644 --- a/ConfidentialComputing/VERSION +++ b/ConfidentialComputing/VERSION @@ -1 +1 @@ -1.1.0 +1.1.1 diff --git a/Config/VERSION b/Config/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/Config/VERSION +++ b/Config/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/ContactCenterInsights/VERSION b/ContactCenterInsights/VERSION index 7ec1d6db4087..3e3c2f1e5edb 100644 --- a/ContactCenterInsights/VERSION +++ b/ContactCenterInsights/VERSION @@ -1 +1 @@ -2.1.0 +2.1.1 diff --git a/ControlsPartner/VERSION b/ControlsPartner/VERSION index 0ea3a944b399..0c62199f16ac 100644 --- a/ControlsPartner/VERSION +++ b/ControlsPartner/VERSION @@ -1 +1 @@ -0.2.0 +0.2.1 diff --git a/DataCatalog/VERSION b/DataCatalog/VERSION index 38f77a65b301..e9307ca5751b 100644 --- a/DataCatalog/VERSION +++ b/DataCatalog/VERSION @@ -1 +1 @@ -2.0.1 +2.0.2 diff --git a/DataCatalogLineage/VERSION b/DataCatalogLineage/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/DataCatalogLineage/VERSION +++ b/DataCatalogLineage/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/DataFusion/VERSION b/DataFusion/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/DataFusion/VERSION +++ b/DataFusion/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/DataLabeling/VERSION b/DataLabeling/VERSION index d1d899fa33a0..b49b25336d47 100644 --- a/DataLabeling/VERSION +++ b/DataLabeling/VERSION @@ -1 +1 @@ -0.5.5 +0.5.6 diff --git a/Dataform/VERSION b/Dataform/VERSION index 0bfccb080404..ef52a648073d 100644 --- a/Dataform/VERSION +++ b/Dataform/VERSION @@ -1 +1 @@ -0.4.5 +0.4.6 diff --git a/Dataplex/VERSION b/Dataplex/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/Dataplex/VERSION +++ b/Dataplex/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/Dataproc/VERSION b/Dataproc/VERSION index ccbccc3dc626..c043eea7767e 100644 --- a/Dataproc/VERSION +++ b/Dataproc/VERSION @@ -1 +1 @@ -2.2.0 +2.2.1 diff --git a/Datastream/VERSION b/Datastream/VERSION index 227cea215648..38f77a65b301 100644 --- a/Datastream/VERSION +++ b/Datastream/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/Deploy/VERSION b/Deploy/VERSION index 26aaba0e8663..f0bb29e76388 100644 --- a/Deploy/VERSION +++ b/Deploy/VERSION @@ -1 +1 @@ -1.2.0 +1.3.0 diff --git a/DeveloperConnect/VERSION b/DeveloperConnect/VERSION index 17e51c385ea3..d917d3e26adc 100644 --- a/DeveloperConnect/VERSION +++ b/DeveloperConnect/VERSION @@ -1 +1 @@ -0.1.1 +0.1.2 diff --git a/Dialogflow/VERSION b/Dialogflow/VERSION index 141f2e805beb..ace44233b4aa 100644 --- a/Dialogflow/VERSION +++ b/Dialogflow/VERSION @@ -1 +1 @@ -1.15.0 +1.15.1 diff --git a/DialogflowCx/VERSION b/DialogflowCx/VERSION index 1d0ba9ea182b..267577d47e49 100644 --- a/DialogflowCx/VERSION +++ b/DialogflowCx/VERSION @@ -1 +1 @@ -0.4.0 +0.4.1 diff --git a/DiscoveryEngine/VERSION b/DiscoveryEngine/VERSION index 26aaba0e8663..f0bb29e76388 100644 --- a/DiscoveryEngine/VERSION +++ b/DiscoveryEngine/VERSION @@ -1 +1 @@ -1.2.0 +1.3.0 diff --git a/Dms/VERSION b/Dms/VERSION index 38f77a65b301..e9307ca5751b 100644 --- a/Dms/VERSION +++ b/Dms/VERSION @@ -1 +1 @@ -2.0.1 +2.0.2 diff --git a/Eventarc/VERSION b/Eventarc/VERSION index 38f77a65b301..7ec1d6db4087 100644 --- a/Eventarc/VERSION +++ b/Eventarc/VERSION @@ -1 +1 @@ -2.0.1 +2.1.0 diff --git a/EventarcPublishing/VERSION b/EventarcPublishing/VERSION index 3eefcb9dd5b3..9084fa2f716a 100644 --- a/EventarcPublishing/VERSION +++ b/EventarcPublishing/VERSION @@ -1 +1 @@ -1.0.0 +1.1.0 diff --git a/Kms/VERSION b/Kms/VERSION index 7ec1d6db4087..3e3c2f1e5edb 100644 --- a/Kms/VERSION +++ b/Kms/VERSION @@ -1 +1 @@ -2.1.0 +2.1.1 diff --git a/Quotas/VERSION b/Quotas/VERSION index 3eefcb9dd5b3..7dea76edb3dc 100644 --- a/Quotas/VERSION +++ b/Quotas/VERSION @@ -1 +1 @@ -1.0.0 +1.0.1 diff --git a/RecaptchaEnterprise/VERSION b/RecaptchaEnterprise/VERSION index 141f2e805beb..15b989e398fc 100644 --- a/RecaptchaEnterprise/VERSION +++ b/RecaptchaEnterprise/VERSION @@ -1 +1 @@ -1.15.0 +1.16.0 diff --git a/SecurityCenterManagement/VERSION b/SecurityCenterManagement/VERSION index 3eefcb9dd5b3..9084fa2f716a 100644 --- a/SecurityCenterManagement/VERSION +++ b/SecurityCenterManagement/VERSION @@ -1 +1 @@ -1.0.0 +1.1.0 diff --git a/ServiceControl/VERSION b/ServiceControl/VERSION index 227cea215648..38f77a65b301 100644 --- a/ServiceControl/VERSION +++ b/ServiceControl/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/ServiceManagement/VERSION b/ServiceManagement/VERSION index 227cea215648..38f77a65b301 100644 --- a/ServiceManagement/VERSION +++ b/ServiceManagement/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/ServiceUsage/VERSION b/ServiceUsage/VERSION index 227cea215648..38f77a65b301 100644 --- a/ServiceUsage/VERSION +++ b/ServiceUsage/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/Storage/VERSION b/Storage/VERSION index 3987c472943e..372cf402c73f 100644 --- a/Storage/VERSION +++ b/Storage/VERSION @@ -1 +1 @@ -1.43.1 +1.44.0 diff --git a/Storage/src/StorageClient.php b/Storage/src/StorageClient.php index 2eef4fb0f9f1..5b8bf929776f 100644 --- a/Storage/src/StorageClient.php +++ b/Storage/src/StorageClient.php @@ -47,7 +47,7 @@ class StorageClient use ArrayTrait; use ClientTrait; - const VERSION = '1.43.1'; + const VERSION = '1.44.0'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/devstorage.full_control'; const READ_ONLY_SCOPE = 'https://www.googleapis.com/auth/devstorage.read_only'; diff --git a/TextToSpeech/VERSION b/TextToSpeech/VERSION index 1cac385c6cb8..0eed1a29efd6 100644 --- a/TextToSpeech/VERSION +++ b/TextToSpeech/VERSION @@ -1 +1 @@ -1.11.0 +1.12.0 diff --git a/composer.json b/composer.json index f54c928e1efe..2560944b0e4b 100644 --- a/composer.json +++ b/composer.json @@ -68,87 +68,87 @@ }, "replace": { "google/access-context-manager": "1.0.0", - "google/analytics-admin": "0.24.0", - "google/analytics-data": "0.20.0", - "google/apps-chat": "0.6.0", - "google/apps-events-subscriptions": "0.1.3", - "google/apps-meet": "0.2.3", - "google/cloud-access-approval": "2.0.1", - "google/cloud-advisorynotifications": "1.0.0", - "google/cloud-ai-platform": "1.9.0", - "google/cloud-alloydb": "1.1.0", - "google/cloud-api-gateway": "2.0.0", - "google/cloud-api-keys": "1.0.0", - "google/cloud-apigee-connect": "2.0.1", - "google/cloud-apigee-registry": "1.0.0", - "google/cloud-apihub": "0.1.1", - "google/cloud-appengine-admin": "2.0.0", - "google/cloud-apphub": "0.1.3", - "google/cloud-artifact-registry": "1.0.0", - "google/cloud-asset": "2.1.0", - "google/cloud-assured-workloads": "1.0.0", - "google/cloud-automl": "2.0.0", - "google/cloud-backupdr": "0.4.0", - "google/cloud-bare-metal-solution": "1.0.0", - "google/cloud-batch": "1.1.1", - "google/cloud-beyondcorp-appconnections": "1.0.0", - "google/cloud-beyondcorp-appconnectors": "1.0.0", - "google/cloud-beyondcorp-appgateways": "1.0.0", - "google/cloud-beyondcorp-clientconnectorservices": "1.0.0", - "google/cloud-beyondcorp-clientgateways": "1.0.0", + "google/analytics-admin": "0.24.1", + "google/analytics-data": "0.20.1", + "google/apps-chat": "0.6.1", + "google/apps-events-subscriptions": "0.1.4", + "google/apps-meet": "0.2.4", + "google/cloud-access-approval": "2.0.2", + "google/cloud-advisorynotifications": "1.0.1", + "google/cloud-ai-platform": "1.10.0", + "google/cloud-alloydb": "1.1.1", + "google/cloud-api-gateway": "2.0.1", + "google/cloud-api-keys": "1.0.1", + "google/cloud-apigee-connect": "2.0.2", + "google/cloud-apigee-registry": "1.0.1", + "google/cloud-apihub": "0.1.2", + "google/cloud-appengine-admin": "2.0.1", + "google/cloud-apphub": "0.1.4", + "google/cloud-artifact-registry": "1.1.0", + "google/cloud-asset": "2.1.1", + "google/cloud-assured-workloads": "1.0.1", + "google/cloud-automl": "2.0.1", + "google/cloud-backupdr": "0.4.1", + "google/cloud-bare-metal-solution": "1.0.1", + "google/cloud-batch": "1.1.2", + "google/cloud-beyondcorp-appconnections": "1.0.1", + "google/cloud-beyondcorp-appconnectors": "1.0.1", + "google/cloud-beyondcorp-appgateways": "1.0.1", + "google/cloud-beyondcorp-clientconnectorservices": "1.0.1", + "google/cloud-beyondcorp-clientgateways": "1.0.1", "google/cloud-bigquery": "1.31.0", - "google/cloud-bigquery-analyticshub": "1.0.0", - "google/cloud-bigquery-connection": "2.0.0", - "google/cloud-bigquery-data-exchange": "0.4.5", - "google/cloud-bigquery-datapolicies": "1.0.0", - "google/cloud-bigquery-migration": "1.1.0", - "google/cloud-bigquery-reservation": "2.0.1", - "google/cloud-bigquery-storage": "2.1.0", - "google/cloud-bigquerydatatransfer": "2.1.0", - "google/cloud-bigtable": "2.5.0", - "google/cloud-billing": "2.0.0", - "google/cloud-billing-budgets": "2.0.1", - "google/cloud-binary-authorization": "1.0.1", + "google/cloud-bigquery-analyticshub": "1.0.1", + "google/cloud-bigquery-connection": "2.0.1", + "google/cloud-bigquery-data-exchange": "0.4.6", + "google/cloud-bigquery-datapolicies": "1.0.1", + "google/cloud-bigquery-migration": "1.1.1", + "google/cloud-bigquery-reservation": "2.0.2", + "google/cloud-bigquery-storage": "2.1.1", + "google/cloud-bigquerydatatransfer": "2.1.1", + "google/cloud-bigtable": "2.6.0", + "google/cloud-billing": "2.0.1", + "google/cloud-billing-budgets": "2.0.2", + "google/cloud-binary-authorization": "1.0.2", "google/cloud-build": "1.0.0", - "google/cloud-certificate-manager": "1.0.0", - "google/cloud-channel": "2.1.0", - "google/cloud-cloudcontrolspartner": "0.2.0", - "google/cloud-commerce-consumer-procurement": "1.1.0", + "google/cloud-certificate-manager": "1.0.1", + "google/cloud-channel": "2.1.1", + "google/cloud-cloudcontrolspartner": "0.2.1", + "google/cloud-commerce-consumer-procurement": "1.1.1", "google/cloud-common-protos": "0.6.0", "google/cloud-compute": "1.19.0", - "google/cloud-confidentialcomputing": "1.1.0", - "google/cloud-config": "1.0.0", - "google/cloud-contact-center-insights": "2.1.0", + "google/cloud-confidentialcomputing": "1.1.1", + "google/cloud-config": "1.0.1", + "google/cloud-contact-center-insights": "2.1.1", "google/cloud-container": "2.2.0", "google/cloud-container-analysis": "1.0.1", "google/cloud-core": "1.60.0", - "google/cloud-data-catalog": "2.0.1", - "google/cloud-data-fusion": "1.0.0", - "google/cloud-datacatalog-lineage": "1.0.0", + "google/cloud-data-catalog": "2.0.2", + "google/cloud-data-fusion": "1.0.1", + "google/cloud-datacatalog-lineage": "1.0.1", "google/cloud-dataflow": "0.6.4", - "google/cloud-dataform": "0.4.5", - "google/cloud-datalabeling": "0.5.5", - "google/cloud-dataplex": "1.0.0", - "google/cloud-dataproc": "2.2.0", + "google/cloud-dataform": "0.4.6", + "google/cloud-datalabeling": "0.5.6", + "google/cloud-dataplex": "1.0.1", + "google/cloud-dataproc": "2.2.1", "google/cloud-dataproc-metastore": "1.0.0", "google/cloud-datastore": "1.32.0", "google/cloud-datastore-admin": "1.0.0", - "google/cloud-datastream": "2.0.0", + "google/cloud-datastream": "2.0.1", "google/cloud-debugger": "1.9.0", - "google/cloud-deploy": "1.2.0", - "google/cloud-developerconnect": "0.1.1", - "google/cloud-dialogflow": "1.15.0", - "google/cloud-dialogflow-cx": "0.4.0", - "google/cloud-discoveryengine": "1.2.0", + "google/cloud-deploy": "1.3.0", + "google/cloud-developerconnect": "0.1.2", + "google/cloud-dialogflow": "1.15.1", + "google/cloud-dialogflow-cx": "0.4.1", + "google/cloud-discoveryengine": "1.3.0", "google/cloud-dlp": "2.2.0", - "google/cloud-dms": "2.0.1", + "google/cloud-dms": "2.0.2", "google/cloud-document-ai": "2.1.0", "google/cloud-domains": "1.0.0", "google/cloud-edgenetwork": "1.1.1", "google/cloud-error-reporting": "0.22.7", "google/cloud-essential-contacts": "1.0.1", - "google/cloud-eventarc": "2.0.1", - "google/cloud-eventarc-publishing": "1.0.0", + "google/cloud-eventarc": "2.1.0", + "google/cloud-eventarc-publishing": "1.1.0", "google/cloud-filestore": "2.0.1", "google/cloud-firestore": "1.47.0", "google/cloud-functions": "2.0.0", @@ -161,7 +161,7 @@ "google/cloud-iam-credentials": "2.0.0", "google/cloud-iap": "2.0.0", "google/cloud-ids": "1.0.0", - "google/cloud-kms": "2.1.0", + "google/cloud-kms": "2.1.1", "google/cloud-kms-inventory": "1.0.1", "google/cloud-language": "0.34.0", "google/cloud-life-sciences": "0.6.6", @@ -192,9 +192,9 @@ "google/cloud-privilegedaccessmanager": "0.1.0", "google/cloud-profiler": "2.0.0", "google/cloud-pubsub": "2.8.0", - "google/cloud-quotas": "1.0.0", + "google/cloud-quotas": "1.0.1", "google/cloud-rapidmigrationassessment": "1.0.0", - "google/cloud-recaptcha-enterprise": "1.15.0", + "google/cloud-recaptcha-enterprise": "1.16.0", "google/cloud-recommendations-ai": "0.7.5", "google/cloud-recommender": "2.0.1", "google/cloud-redis": "2.1.1", @@ -209,17 +209,17 @@ "google/cloud-security-center": "2.0.1", "google/cloud-security-private-ca": "2.0.0", "google/cloud-security-public-ca": "1.0.0", - "google/cloud-securitycentermanagement": "1.0.0", - "google/cloud-service-control": "2.0.0", + "google/cloud-securitycentermanagement": "1.1.0", + "google/cloud-service-control": "2.0.1", "google/cloud-service-directory": "2.0.0", - "google/cloud-service-management": "2.0.0", - "google/cloud-service-usage": "2.0.0", + "google/cloud-service-management": "2.0.1", + "google/cloud-service-usage": "2.0.1", "google/cloud-servicehealth": "0.1.6", "google/cloud-shell": "2.0.1", "google/cloud-spanner": "1.88.0", "google/cloud-speech": "1.19.0", "google/cloud-sql-admin": "1.2.0", - "google/cloud-storage": "1.43.1", + "google/cloud-storage": "1.44.0", "google/cloud-storage-control": "1.0.0", "google/cloud-storage-transfer": "2.0.0", "google/cloud-storageinsights": "1.0.0", @@ -227,7 +227,7 @@ "google/cloud-talent": "2.0.0", "google/cloud-tasks": "1.15.0", "google/cloud-telcoautomation": "1.0.0", - "google/cloud-text-to-speech": "1.11.0", + "google/cloud-text-to-speech": "1.12.0", "google/cloud-tpu": "1.4.5", "google/cloud-trace": "1.8.6", "google/cloud-translate": "1.19.0", @@ -261,8 +261,8 @@ "google/shopping-merchant-promotions": "0.1.0", "google/shopping-merchant-quota": "0.1.3", "google/shopping-merchant-reports": "0.8.1", - "googleads/ad-manager": "0.1.0", - "googleads/marketingplatform-admin": "0.1.0" + "googleads/ad-manager": "0.1.1", + "googleads/marketingplatform-admin": "0.1.1" }, "suggest": { "opis/closure": "May be used to serialize closures to process jobs in the batch daemon. Please require version ^3.", From 24d302cccdae50e3bf2a2f55bd9702e54e6c6a9f Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Mon, 4 Nov 2024 10:32:38 -0800 Subject: [PATCH 069/157] fix(docs): fix error in publish postrun (#7794) --- .kokoro/docs/publish.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.kokoro/docs/publish.sh b/.kokoro/docs/publish.sh index 0f500c7ba52a..1b21dcbc60cd 100755 --- a/.kokoro/docs/publish.sh +++ b/.kokoro/docs/publish.sh @@ -81,7 +81,7 @@ if [ "$KOKORO_GITHUB_COMMIT" != "" ]; then # Store composer.lock for SBOM generation mkdir "pkg/$module" - composer update -d "$module" + composer update -d "$module" --ignore-platform-req ext-grpc cp "$module/composer.lock" "pkg/$module/composer.lock" done fi From c393d14658bc4a2ac2753e3df716b684e4c2fcaf Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Mon, 4 Nov 2024 16:20:43 -0800 Subject: [PATCH 070/157] chore(docs): update README to reflect GA status (#7798) --- ApiKeys/README.md | 3 ++- Batch/README.md | 3 ++- BeyondCorpAppConnections/README.md | 3 ++- BeyondCorpAppConnectors/README.md | 3 ++- BeyondCorpAppGateways/README.md | 3 ++- BeyondCorpClientConnectorServices/README.md | 3 ++- BeyondCorpClientGateways/README.md | 3 ++- BigQueryAnalyticsHub/README.md | 3 ++- BigQueryDataPolicies/README.md | 3 ++- BigQueryMigration/README.md | 3 ++- GSuiteAddOns/README.md | 3 ++- Iam/README.md | 3 ++- SecurityPublicCA/README.md | 3 ++- VmwareEngine/README.md | 3 ++- 14 files changed, 28 insertions(+), 14 deletions(-) diff --git a/ApiKeys/README.md b/ApiKeys/README.md index e3390338d0ed..6b0c2a2dbd52 100644 --- a/ApiKeys/README.md +++ b/ApiKeys/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/Batch/README.md b/Batch/README.md index 03d46b199d98..bd155cc876a6 100644 --- a/Batch/README.md +++ b/Batch/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/BeyondCorpAppConnections/README.md b/BeyondCorpAppConnections/README.md index 32dccc106177..ff58526cde5f 100644 --- a/BeyondCorpAppConnections/README.md +++ b/BeyondCorpAppConnections/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/BeyondCorpAppConnectors/README.md b/BeyondCorpAppConnectors/README.md index 7116f362323c..ebbce1f78c51 100644 --- a/BeyondCorpAppConnectors/README.md +++ b/BeyondCorpAppConnectors/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/BeyondCorpAppGateways/README.md b/BeyondCorpAppGateways/README.md index 81c8e3fbe2d1..f3a2174d6033 100644 --- a/BeyondCorpAppGateways/README.md +++ b/BeyondCorpAppGateways/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/BeyondCorpClientConnectorServices/README.md b/BeyondCorpClientConnectorServices/README.md index bf7c9d0025a2..ef858addf4c5 100644 --- a/BeyondCorpClientConnectorServices/README.md +++ b/BeyondCorpClientConnectorServices/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/BeyondCorpClientGateways/README.md b/BeyondCorpClientGateways/README.md index 60521cab4f85..de0f9708c32b 100644 --- a/BeyondCorpClientGateways/README.md +++ b/BeyondCorpClientGateways/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/BigQueryAnalyticsHub/README.md b/BigQueryAnalyticsHub/README.md index ec69066e6dd1..3acb7cbe9f37 100644 --- a/BigQueryAnalyticsHub/README.md +++ b/BigQueryAnalyticsHub/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/BigQueryDataPolicies/README.md b/BigQueryDataPolicies/README.md index 5305c9fe20ad..e73267201960 100644 --- a/BigQueryDataPolicies/README.md +++ b/BigQueryDataPolicies/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/BigQueryMigration/README.md b/BigQueryMigration/README.md index 5e9b1e9ebebb..7d109742bdb1 100644 --- a/BigQueryMigration/README.md +++ b/BigQueryMigration/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/GSuiteAddOns/README.md b/GSuiteAddOns/README.md index 3c2ec3b98749..7defc0ed5245 100644 --- a/GSuiteAddOns/README.md +++ b/GSuiteAddOns/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/Iam/README.md b/Iam/README.md index f0c0c474a3d5..2aceb82fc150 100644 --- a/Iam/README.md +++ b/Iam/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/SecurityPublicCA/README.md b/SecurityPublicCA/README.md index 9801ecb10194..311cf9f5fb7e 100644 --- a/SecurityPublicCA/README.md +++ b/SecurityPublicCA/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps diff --git a/VmwareEngine/README.md b/VmwareEngine/README.md index bab1fb3dc7f1..c70ff5147944 100644 --- a/VmwareEngine/README.md +++ b/VmwareEngine/README.md @@ -30,7 +30,8 @@ on authenticating your client. Once authenticated, you'll be ready to start maki ### Version -This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. +This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in +any minor or patch releases. We will address issues and requests with the highest priority. ### Next Steps From 4bd4e0df0bbd7cec18cd73ea2f3f871b9551062f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Mendoza?= Date: Tue, 5 Nov 2024 15:14:07 -0500 Subject: [PATCH 071/157] fix(docs): Escape HTML characters for generic types (#7807) --- dev/src/DocFx/Node/XrefTrait.php | 2 +- dev/tests/Unit/DocFx/NodeTest.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/src/DocFx/Node/XrefTrait.php b/dev/src/DocFx/Node/XrefTrait.php index 6b691a398b49..f977c783a950 100644 --- a/dev/src/DocFx/Node/XrefTrait.php +++ b/dev/src/DocFx/Node/XrefTrait.php @@ -162,7 +162,7 @@ private function replaceUidWithLink(string $uid, string $name = null): string // Case for generic types if (preg_match('/(.*)<(.*)>/', $uid, $matches)) { return sprintf( - '%s<%s>', + '%s<%s>', $this->replaceUidWithLink($matches[1]), $this->replaceUidWithLink($matches[2]) ); diff --git a/dev/tests/Unit/DocFx/NodeTest.php b/dev/tests/Unit/DocFx/NodeTest.php index 310fe7fea7b1..84c6c935cfce 100644 --- a/dev/tests/Unit/DocFx/NodeTest.php +++ b/dev/tests/Unit/DocFx/NodeTest.php @@ -161,7 +161,7 @@ public function testReplaceGenericPromiseClass() $uid = $guzzlePromiseClassName . '<' . $googleReference . '>'; $expected = 'GuzzleHttp\Promise\PromiseInterface'; - $expected .= '<Google\Cloud\AdvisoryNotifications\V1\Notification>'; + $expected .= '<Google\Cloud\AdvisoryNotifications\V1\Notification>'; $xref = new class { use XrefTrait; From 3f7860194ae680765ab0f41cce3f4fec187c2a0b Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:15:24 -0800 Subject: [PATCH 072/157] chore: remove body selector from http rule (#7803) PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiU2VjdXJpdHlDZW50ZXIvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU2VjdXJpdHlDZW50ZXJNYW5hZ2VtZW50Ly5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2VjdXJpdHlQcml2YXRlQ2EvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU2VjdXJpdHlQdWJsaWNDQS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiU2VydmljZURpcmVjdG9yeS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiU2VydmljZUhlYWx0aC8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiU2hlbGwvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU2hvcHBpbmdDc3MvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudEFjY291bnRzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudENvbnZlcnNpb25zLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudERhdGFTb3VyY2VzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudEludmVudG9yaWVzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudExmcC8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudE5vdGlmaWNhdGlvbnMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudFByb2R1Y3RzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudFByb21vdGlvbnMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudFF1b3RhLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2hvcHBpbmdNZXJjaGFudFJlcG9ydHMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU3Bhbm5lci8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiU3BlZWNoLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= --- .../src/V1/Client/SecurityCenterClient.php | 126 +++++++++--------- .../src/V2/Client/SecurityCenterClient.php | 80 +++++------ .../Client/SecurityCenterManagementClient.php | 46 +++---- .../CertificateAuthorityServiceClient.php | 68 +++++----- ...ublicCertificateAuthorityServiceClient.php | 2 +- .../src/V1/Client/LookupServiceClient.php | 6 +- .../V1/Client/RegistrationServiceClient.php | 40 +++--- .../src/V1/Client/ServiceHealthClient.php | 16 +-- .../src/V1/Client/CloudShellServiceClient.php | 10 +- .../V1/Client/AccountLabelsServiceClient.php | 8 +- .../src/V1/Client/AccountsServiceClient.php | 6 +- .../Client/CssProductInputsServiceClient.php | 4 +- .../V1/Client/CssProductsServiceClient.php | 4 +- .../Client/AccountIssueServiceClient.php | 2 +- .../V1beta/Client/AccountTaxServiceClient.php | 6 +- .../V1beta/Client/AccountsServiceClient.php | 12 +- .../Client/AutofeedSettingsServiceClient.php | 4 +- .../Client/BusinessIdentityServiceClient.php | 4 +- .../Client/BusinessInfoServiceClient.php | 4 +- .../Client/EmailPreferencesServiceClient.php | 4 +- .../V1beta/Client/HomepageServiceClient.php | 8 +- .../OnlineReturnPolicyServiceClient.php | 4 +- .../V1beta/Client/ProgramsServiceClient.php | 8 +- .../V1beta/Client/RegionsServiceClient.php | 10 +- .../Client/ShippingSettingsServiceClient.php | 4 +- ...msOfServiceAgreementStateServiceClient.php | 4 +- .../Client/TermsOfServiceServiceClient.php | 6 +- .../src/V1beta/Client/UserServiceClient.php | 10 +- .../Client/ConversionSourcesServiceClient.php | 12 +- .../Client/DataSourcesServiceClient.php | 12 +- .../Client/FileUploadsServiceClient.php | 2 +- .../Client/LocalInventoryServiceClient.php | 6 +- .../Client/RegionalInventoryServiceClient.php | 6 +- .../Client/LfpInventoryServiceClient.php | 2 +- .../V1beta/Client/LfpSaleServiceClient.php | 2 +- .../V1beta/Client/LfpStoreServiceClient.php | 8 +- .../Client/NotificationsApiServiceClient.php | 10 +- .../Client/ProductInputsServiceClient.php | 4 +- .../V1beta/Client/ProductsServiceClient.php | 4 +- .../V1beta/Client/PromotionsServiceClient.php | 6 +- .../src/V1beta/Client/QuotaServiceClient.php | 2 +- .../src/V1beta/Client/ReportServiceClient.php | 2 +- .../V1/Client/DatabaseAdminClient.php | 50 +++---- .../V1/Client/InstanceAdminClient.php | 42 +++--- Spanner/src/V1/Client/SpannerClient.php | 26 ++-- Speech/src/V2/Client/SpeechClient.php | 48 +++---- 46 files changed, 375 insertions(+), 375 deletions(-) diff --git a/SecurityCenter/src/V1/Client/SecurityCenterClient.php b/SecurityCenter/src/V1/Client/SecurityCenterClient.php index 4852fd9d4145..f2ef9c4863ce 100644 --- a/SecurityCenter/src/V1/Client/SecurityCenterClient.php +++ b/SecurityCenter/src/V1/Client/SecurityCenterClient.php @@ -132,69 +132,69 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateResourceValueConfigsAsync(BatchCreateResourceValueConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface bulkMuteFindingsAsync(BulkMuteFindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBigQueryExportAsync(CreateBigQueryExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEventThreatDetectionCustomModuleAsync(CreateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFindingAsync(CreateFindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMuteConfigAsync(CreateMuteConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNotificationConfigAsync(CreateNotificationConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSecurityHealthAnalyticsCustomModuleAsync(CreateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSourceAsync(CreateSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBigQueryExportAsync(DeleteBigQueryExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEventThreatDetectionCustomModuleAsync(DeleteEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMuteConfigAsync(DeleteMuteConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNotificationConfigAsync(DeleteNotificationConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteResourceValueConfigAsync(DeleteResourceValueConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSecurityHealthAnalyticsCustomModuleAsync(DeleteSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBigQueryExportAsync(GetBigQueryExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEffectiveEventThreatDetectionCustomModuleAsync(GetEffectiveEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEffectiveSecurityHealthAnalyticsCustomModuleAsync(GetEffectiveSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEventThreatDetectionCustomModuleAsync(GetEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMuteConfigAsync(GetMuteConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotificationConfigAsync(GetNotificationConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOrganizationSettingsAsync(GetOrganizationSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getResourceValueConfigAsync(GetResourceValueConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSecurityHealthAnalyticsCustomModuleAsync(GetSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSimulationAsync(GetSimulationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSourceAsync(GetSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getValuedResourceAsync(GetValuedResourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface groupAssetsAsync(GroupAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface groupFindingsAsync(GroupFindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAttackPathsAsync(ListAttackPathsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBigQueryExportsAsync(ListBigQueryExportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDescendantEventThreatDetectionCustomModulesAsync(ListDescendantEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDescendantSecurityHealthAnalyticsCustomModulesAsync(ListDescendantSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEffectiveEventThreatDetectionCustomModulesAsync(ListEffectiveEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEffectiveSecurityHealthAnalyticsCustomModulesAsync(ListEffectiveSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEventThreatDetectionCustomModulesAsync(ListEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFindingsAsync(ListFindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMuteConfigsAsync(ListMuteConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotificationConfigsAsync(ListNotificationConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listResourceValueConfigsAsync(ListResourceValueConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSecurityHealthAnalyticsCustomModulesAsync(ListSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSourcesAsync(ListSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listValuedResourcesAsync(ListValuedResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface runAssetDiscoveryAsync(RunAssetDiscoveryRequest $request, array $optionalArgs = []) - * @method PromiseInterface setFindingStateAsync(SetFindingStateRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMuteAsync(SetMuteRequest $request, array $optionalArgs = []) - * @method PromiseInterface simulateSecurityHealthAnalyticsCustomModuleAsync(SimulateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBigQueryExportAsync(UpdateBigQueryExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEventThreatDetectionCustomModuleAsync(UpdateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExternalSystemAsync(UpdateExternalSystemRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFindingAsync(UpdateFindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMuteConfigAsync(UpdateMuteConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNotificationConfigAsync(UpdateNotificationConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateOrganizationSettingsAsync(UpdateOrganizationSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateResourceValueConfigAsync(UpdateResourceValueConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSecurityHealthAnalyticsCustomModuleAsync(UpdateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSecurityMarksAsync(UpdateSecurityMarksRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSourceAsync(UpdateSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateEventThreatDetectionCustomModuleAsync(ValidateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateResourceValueConfigsAsync(BatchCreateResourceValueConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkMuteFindingsAsync(BulkMuteFindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBigQueryExportAsync(CreateBigQueryExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEventThreatDetectionCustomModuleAsync(CreateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFindingAsync(CreateFindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMuteConfigAsync(CreateMuteConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNotificationConfigAsync(CreateNotificationConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSecurityHealthAnalyticsCustomModuleAsync(CreateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSourceAsync(CreateSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBigQueryExportAsync(DeleteBigQueryExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEventThreatDetectionCustomModuleAsync(DeleteEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMuteConfigAsync(DeleteMuteConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNotificationConfigAsync(DeleteNotificationConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteResourceValueConfigAsync(DeleteResourceValueConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSecurityHealthAnalyticsCustomModuleAsync(DeleteSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBigQueryExportAsync(GetBigQueryExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEffectiveEventThreatDetectionCustomModuleAsync(GetEffectiveEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEffectiveSecurityHealthAnalyticsCustomModuleAsync(GetEffectiveSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEventThreatDetectionCustomModuleAsync(GetEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMuteConfigAsync(GetMuteConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotificationConfigAsync(GetNotificationConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOrganizationSettingsAsync(GetOrganizationSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getResourceValueConfigAsync(GetResourceValueConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSecurityHealthAnalyticsCustomModuleAsync(GetSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSimulationAsync(GetSimulationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSourceAsync(GetSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getValuedResourceAsync(GetValuedResourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface groupAssetsAsync(GroupAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface groupFindingsAsync(GroupFindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAttackPathsAsync(ListAttackPathsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBigQueryExportsAsync(ListBigQueryExportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDescendantEventThreatDetectionCustomModulesAsync(ListDescendantEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDescendantSecurityHealthAnalyticsCustomModulesAsync(ListDescendantSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEffectiveEventThreatDetectionCustomModulesAsync(ListEffectiveEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEffectiveSecurityHealthAnalyticsCustomModulesAsync(ListEffectiveSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEventThreatDetectionCustomModulesAsync(ListEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFindingsAsync(ListFindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMuteConfigsAsync(ListMuteConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotificationConfigsAsync(ListNotificationConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listResourceValueConfigsAsync(ListResourceValueConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSecurityHealthAnalyticsCustomModulesAsync(ListSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSourcesAsync(ListSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listValuedResourcesAsync(ListValuedResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface runAssetDiscoveryAsync(RunAssetDiscoveryRequest $request, array $optionalArgs = []) + * @method PromiseInterface setFindingStateAsync(SetFindingStateRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMuteAsync(SetMuteRequest $request, array $optionalArgs = []) + * @method PromiseInterface simulateSecurityHealthAnalyticsCustomModuleAsync(SimulateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBigQueryExportAsync(UpdateBigQueryExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEventThreatDetectionCustomModuleAsync(UpdateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExternalSystemAsync(UpdateExternalSystemRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFindingAsync(UpdateFindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMuteConfigAsync(UpdateMuteConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNotificationConfigAsync(UpdateNotificationConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateOrganizationSettingsAsync(UpdateOrganizationSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateResourceValueConfigAsync(UpdateResourceValueConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSecurityHealthAnalyticsCustomModuleAsync(UpdateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSecurityMarksAsync(UpdateSecurityMarksRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSourceAsync(UpdateSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateEventThreatDetectionCustomModuleAsync(ValidateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) */ final class SecurityCenterClient { diff --git a/SecurityCenter/src/V2/Client/SecurityCenterClient.php b/SecurityCenter/src/V2/Client/SecurityCenterClient.php index 94fcf6196d2c..6ce16ee843dc 100644 --- a/SecurityCenter/src/V2/Client/SecurityCenterClient.php +++ b/SecurityCenter/src/V2/Client/SecurityCenterClient.php @@ -102,46 +102,46 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateResourceValueConfigsAsync(BatchCreateResourceValueConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface bulkMuteFindingsAsync(BulkMuteFindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBigQueryExportAsync(CreateBigQueryExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFindingAsync(CreateFindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMuteConfigAsync(CreateMuteConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNotificationConfigAsync(CreateNotificationConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSourceAsync(CreateSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBigQueryExportAsync(DeleteBigQueryExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMuteConfigAsync(DeleteMuteConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNotificationConfigAsync(DeleteNotificationConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteResourceValueConfigAsync(DeleteResourceValueConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBigQueryExportAsync(GetBigQueryExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMuteConfigAsync(GetMuteConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotificationConfigAsync(GetNotificationConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getResourceValueConfigAsync(GetResourceValueConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSimulationAsync(GetSimulationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSourceAsync(GetSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getValuedResourceAsync(GetValuedResourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface groupFindingsAsync(GroupFindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAttackPathsAsync(ListAttackPathsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBigQueryExportsAsync(ListBigQueryExportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFindingsAsync(ListFindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMuteConfigsAsync(ListMuteConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotificationConfigsAsync(ListNotificationConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listResourceValueConfigsAsync(ListResourceValueConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSourcesAsync(ListSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listValuedResourcesAsync(ListValuedResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setFindingStateAsync(SetFindingStateRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMuteAsync(SetMuteRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBigQueryExportAsync(UpdateBigQueryExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExternalSystemAsync(UpdateExternalSystemRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFindingAsync(UpdateFindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMuteConfigAsync(UpdateMuteConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNotificationConfigAsync(UpdateNotificationConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateResourceValueConfigAsync(UpdateResourceValueConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSecurityMarksAsync(UpdateSecurityMarksRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSourceAsync(UpdateSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateResourceValueConfigsAsync(BatchCreateResourceValueConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkMuteFindingsAsync(BulkMuteFindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBigQueryExportAsync(CreateBigQueryExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFindingAsync(CreateFindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMuteConfigAsync(CreateMuteConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNotificationConfigAsync(CreateNotificationConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSourceAsync(CreateSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBigQueryExportAsync(DeleteBigQueryExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMuteConfigAsync(DeleteMuteConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNotificationConfigAsync(DeleteNotificationConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteResourceValueConfigAsync(DeleteResourceValueConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBigQueryExportAsync(GetBigQueryExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMuteConfigAsync(GetMuteConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotificationConfigAsync(GetNotificationConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getResourceValueConfigAsync(GetResourceValueConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSimulationAsync(GetSimulationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSourceAsync(GetSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getValuedResourceAsync(GetValuedResourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface groupFindingsAsync(GroupFindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAttackPathsAsync(ListAttackPathsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBigQueryExportsAsync(ListBigQueryExportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFindingsAsync(ListFindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMuteConfigsAsync(ListMuteConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotificationConfigsAsync(ListNotificationConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listResourceValueConfigsAsync(ListResourceValueConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSourcesAsync(ListSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listValuedResourcesAsync(ListValuedResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setFindingStateAsync(SetFindingStateRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMuteAsync(SetMuteRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBigQueryExportAsync(UpdateBigQueryExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExternalSystemAsync(UpdateExternalSystemRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFindingAsync(UpdateFindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMuteConfigAsync(UpdateMuteConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNotificationConfigAsync(UpdateNotificationConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateResourceValueConfigAsync(UpdateResourceValueConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSecurityMarksAsync(UpdateSecurityMarksRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSourceAsync(UpdateSourceRequest $request, array $optionalArgs = []) */ final class SecurityCenterClient { diff --git a/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php b/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php index b750d3f4aa06..5e5ae684492b 100644 --- a/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php +++ b/SecurityCenterManagement/src/V1/Client/SecurityCenterManagementClient.php @@ -77,29 +77,29 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEventThreatDetectionCustomModuleAsync(CreateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSecurityHealthAnalyticsCustomModuleAsync(CreateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEventThreatDetectionCustomModuleAsync(DeleteEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSecurityHealthAnalyticsCustomModuleAsync(DeleteSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEffectiveEventThreatDetectionCustomModuleAsync(GetEffectiveEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEffectiveSecurityHealthAnalyticsCustomModuleAsync(GetEffectiveSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEventThreatDetectionCustomModuleAsync(GetEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSecurityCenterServiceAsync(GetSecurityCenterServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSecurityHealthAnalyticsCustomModuleAsync(GetSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDescendantEventThreatDetectionCustomModulesAsync(ListDescendantEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDescendantSecurityHealthAnalyticsCustomModulesAsync(ListDescendantSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEffectiveEventThreatDetectionCustomModulesAsync(ListEffectiveEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEffectiveSecurityHealthAnalyticsCustomModulesAsync(ListEffectiveSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEventThreatDetectionCustomModulesAsync(ListEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSecurityCenterServicesAsync(ListSecurityCenterServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSecurityHealthAnalyticsCustomModulesAsync(ListSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface simulateSecurityHealthAnalyticsCustomModuleAsync(SimulateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEventThreatDetectionCustomModuleAsync(UpdateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSecurityCenterServiceAsync(UpdateSecurityCenterServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSecurityHealthAnalyticsCustomModuleAsync(UpdateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateEventThreatDetectionCustomModuleAsync(ValidateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEventThreatDetectionCustomModuleAsync(CreateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSecurityHealthAnalyticsCustomModuleAsync(CreateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEventThreatDetectionCustomModuleAsync(DeleteEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSecurityHealthAnalyticsCustomModuleAsync(DeleteSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEffectiveEventThreatDetectionCustomModuleAsync(GetEffectiveEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEffectiveSecurityHealthAnalyticsCustomModuleAsync(GetEffectiveSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEventThreatDetectionCustomModuleAsync(GetEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSecurityCenterServiceAsync(GetSecurityCenterServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSecurityHealthAnalyticsCustomModuleAsync(GetSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDescendantEventThreatDetectionCustomModulesAsync(ListDescendantEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDescendantSecurityHealthAnalyticsCustomModulesAsync(ListDescendantSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEffectiveEventThreatDetectionCustomModulesAsync(ListEffectiveEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEffectiveSecurityHealthAnalyticsCustomModulesAsync(ListEffectiveSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEventThreatDetectionCustomModulesAsync(ListEventThreatDetectionCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSecurityCenterServicesAsync(ListSecurityCenterServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSecurityHealthAnalyticsCustomModulesAsync(ListSecurityHealthAnalyticsCustomModulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface simulateSecurityHealthAnalyticsCustomModuleAsync(SimulateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEventThreatDetectionCustomModuleAsync(UpdateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSecurityCenterServiceAsync(UpdateSecurityCenterServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSecurityHealthAnalyticsCustomModuleAsync(UpdateSecurityHealthAnalyticsCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateEventThreatDetectionCustomModuleAsync(ValidateEventThreatDetectionCustomModuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SecurityCenterManagementClient { diff --git a/SecurityPrivateCa/src/V1/Client/CertificateAuthorityServiceClient.php b/SecurityPrivateCa/src/V1/Client/CertificateAuthorityServiceClient.php index 35a522d91fee..8746f90da90b 100644 --- a/SecurityPrivateCa/src/V1/Client/CertificateAuthorityServiceClient.php +++ b/SecurityPrivateCa/src/V1/Client/CertificateAuthorityServiceClient.php @@ -95,40 +95,40 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface activateCertificateAuthorityAsync(ActivateCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCaPoolAsync(CreateCaPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCertificateAsync(CreateCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCertificateAuthorityAsync(CreateCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCertificateTemplateAsync(CreateCertificateTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCaPoolAsync(DeleteCaPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCertificateAuthorityAsync(DeleteCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCertificateTemplateAsync(DeleteCertificateTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface disableCertificateAuthorityAsync(DisableCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableCertificateAuthorityAsync(EnableCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchCaCertsAsync(FetchCaCertsRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchCertificateAuthorityCsrAsync(FetchCertificateAuthorityCsrRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCaPoolAsync(GetCaPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCertificateAsync(GetCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCertificateAuthorityAsync(GetCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCertificateRevocationListAsync(GetCertificateRevocationListRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCertificateTemplateAsync(GetCertificateTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCaPoolsAsync(ListCaPoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCertificateAuthoritiesAsync(ListCertificateAuthoritiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCertificateRevocationListsAsync(ListCertificateRevocationListsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCertificateTemplatesAsync(ListCertificateTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCertificatesAsync(ListCertificatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface revokeCertificateAsync(RevokeCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteCertificateAuthorityAsync(UndeleteCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCaPoolAsync(UpdateCaPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCertificateAsync(UpdateCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCertificateAuthorityAsync(UpdateCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCertificateRevocationListAsync(UpdateCertificateRevocationListRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCertificateTemplateAsync(UpdateCertificateTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface activateCertificateAuthorityAsync(ActivateCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCaPoolAsync(CreateCaPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCertificateAsync(CreateCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCertificateAuthorityAsync(CreateCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCertificateTemplateAsync(CreateCertificateTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCaPoolAsync(DeleteCaPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCertificateAuthorityAsync(DeleteCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCertificateTemplateAsync(DeleteCertificateTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableCertificateAuthorityAsync(DisableCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableCertificateAuthorityAsync(EnableCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchCaCertsAsync(FetchCaCertsRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchCertificateAuthorityCsrAsync(FetchCertificateAuthorityCsrRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCaPoolAsync(GetCaPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCertificateAsync(GetCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCertificateAuthorityAsync(GetCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCertificateRevocationListAsync(GetCertificateRevocationListRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCertificateTemplateAsync(GetCertificateTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCaPoolsAsync(ListCaPoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCertificateAuthoritiesAsync(ListCertificateAuthoritiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCertificateRevocationListsAsync(ListCertificateRevocationListsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCertificateTemplatesAsync(ListCertificateTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCertificatesAsync(ListCertificatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface revokeCertificateAsync(RevokeCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteCertificateAuthorityAsync(UndeleteCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCaPoolAsync(UpdateCaPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCertificateAsync(UpdateCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCertificateAuthorityAsync(UpdateCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCertificateRevocationListAsync(UpdateCertificateRevocationListRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCertificateTemplateAsync(UpdateCertificateTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class CertificateAuthorityServiceClient { diff --git a/SecurityPublicCA/src/V1/Client/PublicCertificateAuthorityServiceClient.php b/SecurityPublicCA/src/V1/Client/PublicCertificateAuthorityServiceClient.php index 8caddf8dfe9a..544e1ea7cd39 100644 --- a/SecurityPublicCA/src/V1/Client/PublicCertificateAuthorityServiceClient.php +++ b/SecurityPublicCA/src/V1/Client/PublicCertificateAuthorityServiceClient.php @@ -49,7 +49,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createExternalAccountKeyAsync(CreateExternalAccountKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExternalAccountKeyAsync(CreateExternalAccountKeyRequest $request, array $optionalArgs = []) */ final class PublicCertificateAuthorityServiceClient { diff --git a/ServiceDirectory/src/V1/Client/LookupServiceClient.php b/ServiceDirectory/src/V1/Client/LookupServiceClient.php index 2f3e9d182de5..b77a84c504d7 100644 --- a/ServiceDirectory/src/V1/Client/LookupServiceClient.php +++ b/ServiceDirectory/src/V1/Client/LookupServiceClient.php @@ -51,9 +51,9 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface resolveServiceAsync(ResolveServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface resolveServiceAsync(ResolveServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class LookupServiceClient { diff --git a/ServiceDirectory/src/V1/Client/RegistrationServiceClient.php b/ServiceDirectory/src/V1/Client/RegistrationServiceClient.php index ba663610b4d9..fc15ebecfee0 100644 --- a/ServiceDirectory/src/V1/Client/RegistrationServiceClient.php +++ b/ServiceDirectory/src/V1/Client/RegistrationServiceClient.php @@ -86,26 +86,26 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEndpointAsync(CreateEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNamespaceAsync(CreateNamespaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEndpointAsync(DeleteEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNamespaceAsync(DeleteNamespaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEndpointAsync(GetEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNamespaceAsync(GetNamespaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEndpointsAsync(ListEndpointsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNamespacesAsync(ListNamespacesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEndpointAsync(UpdateEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNamespaceAsync(UpdateNamespaceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEndpointAsync(CreateEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNamespaceAsync(CreateNamespaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEndpointAsync(DeleteEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNamespaceAsync(DeleteNamespaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEndpointAsync(GetEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNamespaceAsync(GetNamespaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEndpointsAsync(ListEndpointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNamespacesAsync(ListNamespacesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEndpointAsync(UpdateEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNamespaceAsync(UpdateNamespaceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class RegistrationServiceClient { diff --git a/ServiceHealth/src/V1/Client/ServiceHealthClient.php b/ServiceHealth/src/V1/Client/ServiceHealthClient.php index 26b838ec4521..6c71de5195e9 100644 --- a/ServiceHealth/src/V1/Client/ServiceHealthClient.php +++ b/ServiceHealth/src/V1/Client/ServiceHealthClient.php @@ -58,14 +58,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getEventAsync(GetEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOrganizationEventAsync(GetOrganizationEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOrganizationImpactAsync(GetOrganizationImpactRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEventsAsync(ListEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOrganizationEventsAsync(ListOrganizationEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOrganizationImpactsAsync(ListOrganizationImpactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEventAsync(GetEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOrganizationEventAsync(GetOrganizationEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOrganizationImpactAsync(GetOrganizationImpactRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEventsAsync(ListEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOrganizationEventsAsync(ListOrganizationEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOrganizationImpactsAsync(ListOrganizationImpactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ServiceHealthClient { diff --git a/Shell/src/V1/Client/CloudShellServiceClient.php b/Shell/src/V1/Client/CloudShellServiceClient.php index a085d15a3fb8..bab4bd6acef5 100644 --- a/Shell/src/V1/Client/CloudShellServiceClient.php +++ b/Shell/src/V1/Client/CloudShellServiceClient.php @@ -62,11 +62,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addPublicKeyAsync(AddPublicKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface authorizeEnvironmentAsync(AuthorizeEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface removePublicKeyAsync(RemovePublicKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface startEnvironmentAsync(StartEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface addPublicKeyAsync(AddPublicKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface authorizeEnvironmentAsync(AuthorizeEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface removePublicKeyAsync(RemovePublicKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface startEnvironmentAsync(StartEnvironmentRequest $request, array $optionalArgs = []) */ final class CloudShellServiceClient { diff --git a/ShoppingCss/src/V1/Client/AccountLabelsServiceClient.php b/ShoppingCss/src/V1/Client/AccountLabelsServiceClient.php index e14da6c1b3e5..1ba8f38047cc 100644 --- a/ShoppingCss/src/V1/Client/AccountLabelsServiceClient.php +++ b/ShoppingCss/src/V1/Client/AccountLabelsServiceClient.php @@ -51,10 +51,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAccountLabelAsync(CreateAccountLabelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccountLabelAsync(DeleteAccountLabelRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccountLabelsAsync(ListAccountLabelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccountLabelAsync(UpdateAccountLabelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAccountLabelAsync(CreateAccountLabelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccountLabelAsync(DeleteAccountLabelRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccountLabelsAsync(ListAccountLabelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccountLabelAsync(UpdateAccountLabelRequest $request, array $optionalArgs = []) */ final class AccountLabelsServiceClient { diff --git a/ShoppingCss/src/V1/Client/AccountsServiceClient.php b/ShoppingCss/src/V1/Client/AccountsServiceClient.php index 4f7d4baf8560..307156461f64 100644 --- a/ShoppingCss/src/V1/Client/AccountsServiceClient.php +++ b/ShoppingCss/src/V1/Client/AccountsServiceClient.php @@ -50,9 +50,9 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getAccountAsync(GetAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface listChildAccountsAsync(ListChildAccountsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateLabelsAsync(UpdateAccountLabelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAccountAsync(GetAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface listChildAccountsAsync(ListChildAccountsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateLabelsAsync(UpdateAccountLabelsRequest $request, array $optionalArgs = []) */ final class AccountsServiceClient { diff --git a/ShoppingCss/src/V1/Client/CssProductInputsServiceClient.php b/ShoppingCss/src/V1/Client/CssProductInputsServiceClient.php index 19c3637e5ee3..fd1765810e84 100644 --- a/ShoppingCss/src/V1/Client/CssProductInputsServiceClient.php +++ b/ShoppingCss/src/V1/Client/CssProductInputsServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface deleteCssProductInputAsync(DeleteCssProductInputRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertCssProductInputAsync(InsertCssProductInputRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCssProductInputAsync(DeleteCssProductInputRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertCssProductInputAsync(InsertCssProductInputRequest $request, array $optionalArgs = []) */ final class CssProductInputsServiceClient { diff --git a/ShoppingCss/src/V1/Client/CssProductsServiceClient.php b/ShoppingCss/src/V1/Client/CssProductsServiceClient.php index b26afddbf399..4d8462718933 100644 --- a/ShoppingCss/src/V1/Client/CssProductsServiceClient.php +++ b/ShoppingCss/src/V1/Client/CssProductsServiceClient.php @@ -50,8 +50,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getCssProductAsync(GetCssProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCssProductsAsync(ListCssProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCssProductAsync(GetCssProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCssProductsAsync(ListCssProductsRequest $request, array $optionalArgs = []) */ final class CssProductsServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/AccountIssueServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/AccountIssueServiceClient.php index ef1611a481bd..419c47e90a81 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/AccountIssueServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/AccountIssueServiceClient.php @@ -51,7 +51,7 @@ * * @experimental * - * @method PromiseInterface listAccountIssuesAsync(ListAccountIssuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccountIssuesAsync(ListAccountIssuesRequest $request, array $optionalArgs = []) */ final class AccountIssueServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/AccountTaxServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/AccountTaxServiceClient.php index bf760cb30598..d4d890561988 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/AccountTaxServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/AccountTaxServiceClient.php @@ -58,9 +58,9 @@ * * @experimental * - * @method PromiseInterface getAccountTaxAsync(GetAccountTaxRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccountTaxAsync(ListAccountTaxRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccountTaxAsync(UpdateAccountTaxRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAccountTaxAsync(GetAccountTaxRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccountTaxAsync(ListAccountTaxRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccountTaxAsync(UpdateAccountTaxRequest $request, array $optionalArgs = []) */ final class AccountTaxServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/AccountsServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/AccountsServiceClient.php index be2558f94430..ad4e7ea2faf7 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/AccountsServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/AccountsServiceClient.php @@ -57,12 +57,12 @@ * * @experimental * - * @method PromiseInterface createAndConfigureAccountAsync(CreateAndConfigureAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccountAsync(DeleteAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAccountAsync(GetAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccountsAsync(ListAccountsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSubAccountsAsync(ListSubAccountsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccountAsync(UpdateAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAndConfigureAccountAsync(CreateAndConfigureAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccountAsync(DeleteAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAccountAsync(GetAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccountsAsync(ListAccountsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSubAccountsAsync(ListSubAccountsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccountAsync(UpdateAccountRequest $request, array $optionalArgs = []) */ final class AccountsServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/AutofeedSettingsServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/AutofeedSettingsServiceClient.php index 6a1f35c828f7..69054ad148ef 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/AutofeedSettingsServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/AutofeedSettingsServiceClient.php @@ -53,8 +53,8 @@ * * @experimental * - * @method PromiseInterface getAutofeedSettingsAsync(GetAutofeedSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAutofeedSettingsAsync(UpdateAutofeedSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAutofeedSettingsAsync(GetAutofeedSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAutofeedSettingsAsync(UpdateAutofeedSettingsRequest $request, array $optionalArgs = []) */ final class AutofeedSettingsServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/BusinessIdentityServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/BusinessIdentityServiceClient.php index 60894a0f6bcc..bee88d262f57 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/BusinessIdentityServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/BusinessIdentityServiceClient.php @@ -53,8 +53,8 @@ * * @experimental * - * @method PromiseInterface getBusinessIdentityAsync(GetBusinessIdentityRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBusinessIdentityAsync(UpdateBusinessIdentityRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBusinessIdentityAsync(GetBusinessIdentityRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBusinessIdentityAsync(UpdateBusinessIdentityRequest $request, array $optionalArgs = []) */ final class BusinessIdentityServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/BusinessInfoServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/BusinessInfoServiceClient.php index fa4096db0b84..876c7b7154d1 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/BusinessInfoServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/BusinessInfoServiceClient.php @@ -52,8 +52,8 @@ * * @experimental * - * @method PromiseInterface getBusinessInfoAsync(GetBusinessInfoRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBusinessInfoAsync(UpdateBusinessInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBusinessInfoAsync(GetBusinessInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBusinessInfoAsync(UpdateBusinessInfoRequest $request, array $optionalArgs = []) */ final class BusinessInfoServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/EmailPreferencesServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/EmailPreferencesServiceClient.php index 82b795a8a131..412ee83140ef 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/EmailPreferencesServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/EmailPreferencesServiceClient.php @@ -55,8 +55,8 @@ * * @experimental * - * @method PromiseInterface getEmailPreferencesAsync(GetEmailPreferencesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEmailPreferencesAsync(UpdateEmailPreferencesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEmailPreferencesAsync(GetEmailPreferencesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEmailPreferencesAsync(UpdateEmailPreferencesRequest $request, array $optionalArgs = []) */ final class EmailPreferencesServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/HomepageServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/HomepageServiceClient.php index b19e66b3d2ab..54c7001a2cd8 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/HomepageServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/HomepageServiceClient.php @@ -54,10 +54,10 @@ * * @experimental * - * @method PromiseInterface claimHomepageAsync(ClaimHomepageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHomepageAsync(GetHomepageRequest $request, array $optionalArgs = []) - * @method PromiseInterface unclaimHomepageAsync(UnclaimHomepageRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateHomepageAsync(UpdateHomepageRequest $request, array $optionalArgs = []) + * @method PromiseInterface claimHomepageAsync(ClaimHomepageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHomepageAsync(GetHomepageRequest $request, array $optionalArgs = []) + * @method PromiseInterface unclaimHomepageAsync(UnclaimHomepageRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateHomepageAsync(UpdateHomepageRequest $request, array $optionalArgs = []) */ final class HomepageServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/OnlineReturnPolicyServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/OnlineReturnPolicyServiceClient.php index 7219e14001e8..39449ab601c2 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/OnlineReturnPolicyServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/OnlineReturnPolicyServiceClient.php @@ -57,8 +57,8 @@ * * @experimental * - * @method PromiseInterface getOnlineReturnPolicyAsync(GetOnlineReturnPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOnlineReturnPoliciesAsync(ListOnlineReturnPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOnlineReturnPolicyAsync(GetOnlineReturnPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOnlineReturnPoliciesAsync(ListOnlineReturnPoliciesRequest $request, array $optionalArgs = []) */ final class OnlineReturnPolicyServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/ProgramsServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/ProgramsServiceClient.php index 9d54d2584501..6d31f5f827b1 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/ProgramsServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/ProgramsServiceClient.php @@ -65,10 +65,10 @@ * * @experimental * - * @method PromiseInterface disableProgramAsync(DisableProgramRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableProgramAsync(EnableProgramRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProgramAsync(GetProgramRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProgramsAsync(ListProgramsRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableProgramAsync(DisableProgramRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableProgramAsync(EnableProgramRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProgramAsync(GetProgramRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProgramsAsync(ListProgramsRequest $request, array $optionalArgs = []) */ final class ProgramsServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/RegionsServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/RegionsServiceClient.php index cb42ff72b237..088b669e4891 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/RegionsServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/RegionsServiceClient.php @@ -60,11 +60,11 @@ * * @experimental * - * @method PromiseInterface createRegionAsync(CreateRegionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRegionAsync(DeleteRegionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRegionAsync(GetRegionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRegionsAsync(ListRegionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRegionAsync(UpdateRegionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRegionAsync(CreateRegionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRegionAsync(DeleteRegionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRegionAsync(GetRegionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRegionsAsync(ListRegionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRegionAsync(UpdateRegionRequest $request, array $optionalArgs = []) */ final class RegionsServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/ShippingSettingsServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/ShippingSettingsServiceClient.php index 8c59f7e795a3..391ebbc58a3f 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/ShippingSettingsServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/ShippingSettingsServiceClient.php @@ -53,8 +53,8 @@ * * @experimental * - * @method PromiseInterface getShippingSettingsAsync(GetShippingSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertShippingSettingsAsync(InsertShippingSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getShippingSettingsAsync(GetShippingSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertShippingSettingsAsync(InsertShippingSettingsRequest $request, array $optionalArgs = []) */ final class ShippingSettingsServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/TermsOfServiceAgreementStateServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/TermsOfServiceAgreementStateServiceClient.php index 553c3a223ba8..a49010eae689 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/TermsOfServiceAgreementStateServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/TermsOfServiceAgreementStateServiceClient.php @@ -52,8 +52,8 @@ * * @experimental * - * @method PromiseInterface getTermsOfServiceAgreementStateAsync(GetTermsOfServiceAgreementStateRequest $request, array $optionalArgs = []) - * @method PromiseInterface retrieveForApplicationTermsOfServiceAgreementStateAsync(RetrieveForApplicationTermsOfServiceAgreementStateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTermsOfServiceAgreementStateAsync(GetTermsOfServiceAgreementStateRequest $request, array $optionalArgs = []) + * @method PromiseInterface retrieveForApplicationTermsOfServiceAgreementStateAsync(RetrieveForApplicationTermsOfServiceAgreementStateRequest $request, array $optionalArgs = []) */ final class TermsOfServiceAgreementStateServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/TermsOfServiceServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/TermsOfServiceServiceClient.php index 9d4887c48a05..c00c9b8e58d0 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/TermsOfServiceServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/TermsOfServiceServiceClient.php @@ -53,9 +53,9 @@ * * @experimental * - * @method PromiseInterface acceptTermsOfServiceAsync(AcceptTermsOfServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTermsOfServiceAsync(GetTermsOfServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface retrieveLatestTermsOfServiceAsync(RetrieveLatestTermsOfServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface acceptTermsOfServiceAsync(AcceptTermsOfServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTermsOfServiceAsync(GetTermsOfServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface retrieveLatestTermsOfServiceAsync(RetrieveLatestTermsOfServiceRequest $request, array $optionalArgs = []) */ final class TermsOfServiceServiceClient { diff --git a/ShoppingMerchantAccounts/src/V1beta/Client/UserServiceClient.php b/ShoppingMerchantAccounts/src/V1beta/Client/UserServiceClient.php index 278054e34fe7..1a51567511d1 100644 --- a/ShoppingMerchantAccounts/src/V1beta/Client/UserServiceClient.php +++ b/ShoppingMerchantAccounts/src/V1beta/Client/UserServiceClient.php @@ -56,11 +56,11 @@ * * @experimental * - * @method PromiseInterface createUserAsync(CreateUserRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteUserAsync(DeleteUserRequest $request, array $optionalArgs = []) - * @method PromiseInterface getUserAsync(GetUserRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUsersAsync(ListUsersRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateUserAsync(UpdateUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface createUserAsync(CreateUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteUserAsync(DeleteUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface getUserAsync(GetUserRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUsersAsync(ListUsersRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateUserAsync(UpdateUserRequest $request, array $optionalArgs = []) */ final class UserServiceClient { diff --git a/ShoppingMerchantConversions/src/V1beta/Client/ConversionSourcesServiceClient.php b/ShoppingMerchantConversions/src/V1beta/Client/ConversionSourcesServiceClient.php index 5842afa5c654..b35139ad712b 100644 --- a/ShoppingMerchantConversions/src/V1beta/Client/ConversionSourcesServiceClient.php +++ b/ShoppingMerchantConversions/src/V1beta/Client/ConversionSourcesServiceClient.php @@ -57,12 +57,12 @@ * * @experimental * - * @method PromiseInterface createConversionSourceAsync(CreateConversionSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversionSourceAsync(DeleteConversionSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversionSourceAsync(GetConversionSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversionSourcesAsync(ListConversionSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteConversionSourceAsync(UndeleteConversionSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConversionSourceAsync(UpdateConversionSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversionSourceAsync(CreateConversionSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversionSourceAsync(DeleteConversionSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversionSourceAsync(GetConversionSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversionSourcesAsync(ListConversionSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteConversionSourceAsync(UndeleteConversionSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConversionSourceAsync(UpdateConversionSourceRequest $request, array $optionalArgs = []) */ final class ConversionSourcesServiceClient { diff --git a/ShoppingMerchantDataSources/src/V1beta/Client/DataSourcesServiceClient.php b/ShoppingMerchantDataSources/src/V1beta/Client/DataSourcesServiceClient.php index bad560e26e0d..9a5fb543347d 100644 --- a/ShoppingMerchantDataSources/src/V1beta/Client/DataSourcesServiceClient.php +++ b/ShoppingMerchantDataSources/src/V1beta/Client/DataSourcesServiceClient.php @@ -59,12 +59,12 @@ * * @experimental * - * @method PromiseInterface createDataSourceAsync(CreateDataSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataSourceAsync(DeleteDataSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchDataSourceAsync(FetchDataSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataSourceAsync(GetDataSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataSourcesAsync(ListDataSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataSourceAsync(UpdateDataSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataSourceAsync(CreateDataSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataSourceAsync(DeleteDataSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchDataSourceAsync(FetchDataSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataSourceAsync(GetDataSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataSourcesAsync(ListDataSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataSourceAsync(UpdateDataSourceRequest $request, array $optionalArgs = []) */ final class DataSourcesServiceClient { diff --git a/ShoppingMerchantDataSources/src/V1beta/Client/FileUploadsServiceClient.php b/ShoppingMerchantDataSources/src/V1beta/Client/FileUploadsServiceClient.php index 7c3acfc4a6b6..2e50cf95021b 100644 --- a/ShoppingMerchantDataSources/src/V1beta/Client/FileUploadsServiceClient.php +++ b/ShoppingMerchantDataSources/src/V1beta/Client/FileUploadsServiceClient.php @@ -51,7 +51,7 @@ * * @experimental * - * @method PromiseInterface getFileUploadAsync(GetFileUploadRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFileUploadAsync(GetFileUploadRequest $request, array $optionalArgs = []) */ final class FileUploadsServiceClient { diff --git a/ShoppingMerchantInventories/src/V1beta/Client/LocalInventoryServiceClient.php b/ShoppingMerchantInventories/src/V1beta/Client/LocalInventoryServiceClient.php index fa0307140184..51c68266c0e5 100644 --- a/ShoppingMerchantInventories/src/V1beta/Client/LocalInventoryServiceClient.php +++ b/ShoppingMerchantInventories/src/V1beta/Client/LocalInventoryServiceClient.php @@ -54,9 +54,9 @@ * * @experimental * - * @method PromiseInterface deleteLocalInventoryAsync(DeleteLocalInventoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertLocalInventoryAsync(InsertLocalInventoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocalInventoriesAsync(ListLocalInventoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLocalInventoryAsync(DeleteLocalInventoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertLocalInventoryAsync(InsertLocalInventoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocalInventoriesAsync(ListLocalInventoriesRequest $request, array $optionalArgs = []) */ final class LocalInventoryServiceClient { diff --git a/ShoppingMerchantInventories/src/V1beta/Client/RegionalInventoryServiceClient.php b/ShoppingMerchantInventories/src/V1beta/Client/RegionalInventoryServiceClient.php index 22c19b9ba2f5..282456fe8228 100644 --- a/ShoppingMerchantInventories/src/V1beta/Client/RegionalInventoryServiceClient.php +++ b/ShoppingMerchantInventories/src/V1beta/Client/RegionalInventoryServiceClient.php @@ -55,9 +55,9 @@ * * @experimental * - * @method PromiseInterface deleteRegionalInventoryAsync(DeleteRegionalInventoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertRegionalInventoryAsync(InsertRegionalInventoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRegionalInventoriesAsync(ListRegionalInventoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRegionalInventoryAsync(DeleteRegionalInventoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertRegionalInventoryAsync(InsertRegionalInventoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRegionalInventoriesAsync(ListRegionalInventoriesRequest $request, array $optionalArgs = []) */ final class RegionalInventoryServiceClient { diff --git a/ShoppingMerchantLfp/src/V1beta/Client/LfpInventoryServiceClient.php b/ShoppingMerchantLfp/src/V1beta/Client/LfpInventoryServiceClient.php index e3b20b17deb7..13c983f738b3 100644 --- a/ShoppingMerchantLfp/src/V1beta/Client/LfpInventoryServiceClient.php +++ b/ShoppingMerchantLfp/src/V1beta/Client/LfpInventoryServiceClient.php @@ -53,7 +53,7 @@ * * @experimental * - * @method PromiseInterface insertLfpInventoryAsync(InsertLfpInventoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertLfpInventoryAsync(InsertLfpInventoryRequest $request, array $optionalArgs = []) */ final class LfpInventoryServiceClient { diff --git a/ShoppingMerchantLfp/src/V1beta/Client/LfpSaleServiceClient.php b/ShoppingMerchantLfp/src/V1beta/Client/LfpSaleServiceClient.php index b8f6ae64e486..d694946b0ba9 100644 --- a/ShoppingMerchantLfp/src/V1beta/Client/LfpSaleServiceClient.php +++ b/ShoppingMerchantLfp/src/V1beta/Client/LfpSaleServiceClient.php @@ -53,7 +53,7 @@ * * @experimental * - * @method PromiseInterface insertLfpSaleAsync(InsertLfpSaleRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertLfpSaleAsync(InsertLfpSaleRequest $request, array $optionalArgs = []) */ final class LfpSaleServiceClient { diff --git a/ShoppingMerchantLfp/src/V1beta/Client/LfpStoreServiceClient.php b/ShoppingMerchantLfp/src/V1beta/Client/LfpStoreServiceClient.php index 55b891b12662..82374f85170a 100644 --- a/ShoppingMerchantLfp/src/V1beta/Client/LfpStoreServiceClient.php +++ b/ShoppingMerchantLfp/src/V1beta/Client/LfpStoreServiceClient.php @@ -57,10 +57,10 @@ * * @experimental * - * @method PromiseInterface deleteLfpStoreAsync(DeleteLfpStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLfpStoreAsync(GetLfpStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertLfpStoreAsync(InsertLfpStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLfpStoresAsync(ListLfpStoresRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLfpStoreAsync(DeleteLfpStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLfpStoreAsync(GetLfpStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertLfpStoreAsync(InsertLfpStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLfpStoresAsync(ListLfpStoresRequest $request, array $optionalArgs = []) */ final class LfpStoreServiceClient { diff --git a/ShoppingMerchantNotifications/src/V1beta/Client/NotificationsApiServiceClient.php b/ShoppingMerchantNotifications/src/V1beta/Client/NotificationsApiServiceClient.php index 946b2e52c72a..1e91596c7f91 100644 --- a/ShoppingMerchantNotifications/src/V1beta/Client/NotificationsApiServiceClient.php +++ b/ShoppingMerchantNotifications/src/V1beta/Client/NotificationsApiServiceClient.php @@ -56,11 +56,11 @@ * * @experimental * - * @method PromiseInterface createNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotificationSubscriptionAsync(GetNotificationSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotificationSubscriptionAsync(GetNotificationSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest $request, array $optionalArgs = []) */ final class NotificationsApiServiceClient { diff --git a/ShoppingMerchantProducts/src/V1beta/Client/ProductInputsServiceClient.php b/ShoppingMerchantProducts/src/V1beta/Client/ProductInputsServiceClient.php index fe1d7d3475e8..43c138fc2ebf 100644 --- a/ShoppingMerchantProducts/src/V1beta/Client/ProductInputsServiceClient.php +++ b/ShoppingMerchantProducts/src/V1beta/Client/ProductInputsServiceClient.php @@ -53,8 +53,8 @@ * * @experimental * - * @method PromiseInterface deleteProductInputAsync(DeleteProductInputRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertProductInputAsync(InsertProductInputRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteProductInputAsync(DeleteProductInputRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertProductInputAsync(InsertProductInputRequest $request, array $optionalArgs = []) */ final class ProductInputsServiceClient { diff --git a/ShoppingMerchantProducts/src/V1beta/Client/ProductsServiceClient.php b/ShoppingMerchantProducts/src/V1beta/Client/ProductsServiceClient.php index ed36d24d1bd3..921c26ea5f0c 100644 --- a/ShoppingMerchantProducts/src/V1beta/Client/ProductsServiceClient.php +++ b/ShoppingMerchantProducts/src/V1beta/Client/ProductsServiceClient.php @@ -54,8 +54,8 @@ * * @experimental * - * @method PromiseInterface getProductAsync(GetProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProductsAsync(ListProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProductAsync(GetProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProductsAsync(ListProductsRequest $request, array $optionalArgs = []) */ final class ProductsServiceClient { diff --git a/ShoppingMerchantPromotions/src/V1beta/Client/PromotionsServiceClient.php b/ShoppingMerchantPromotions/src/V1beta/Client/PromotionsServiceClient.php index d84120b553c9..ddaed9316382 100644 --- a/ShoppingMerchantPromotions/src/V1beta/Client/PromotionsServiceClient.php +++ b/ShoppingMerchantPromotions/src/V1beta/Client/PromotionsServiceClient.php @@ -54,9 +54,9 @@ * * @experimental * - * @method PromiseInterface getPromotionAsync(GetPromotionRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertPromotionAsync(InsertPromotionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPromotionsAsync(ListPromotionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPromotionAsync(GetPromotionRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertPromotionAsync(InsertPromotionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPromotionsAsync(ListPromotionsRequest $request, array $optionalArgs = []) */ final class PromotionsServiceClient { diff --git a/ShoppingMerchantQuota/src/V1beta/Client/QuotaServiceClient.php b/ShoppingMerchantQuota/src/V1beta/Client/QuotaServiceClient.php index 4ae59b5794ba..735238ce48cb 100644 --- a/ShoppingMerchantQuota/src/V1beta/Client/QuotaServiceClient.php +++ b/ShoppingMerchantQuota/src/V1beta/Client/QuotaServiceClient.php @@ -51,7 +51,7 @@ * * @experimental * - * @method PromiseInterface listQuotaGroupsAsync(ListQuotaGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listQuotaGroupsAsync(ListQuotaGroupsRequest $request, array $optionalArgs = []) */ final class QuotaServiceClient { diff --git a/ShoppingMerchantReports/src/V1beta/Client/ReportServiceClient.php b/ShoppingMerchantReports/src/V1beta/Client/ReportServiceClient.php index 40d54733010e..bfa10c51d9cb 100644 --- a/ShoppingMerchantReports/src/V1beta/Client/ReportServiceClient.php +++ b/ShoppingMerchantReports/src/V1beta/Client/ReportServiceClient.php @@ -46,7 +46,7 @@ * * @experimental * - * @method PromiseInterface searchAsync(SearchRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchAsync(SearchRequest $request, array $optionalArgs = []) */ final class ReportServiceClient { diff --git a/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php b/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php index 05ea952d580f..a3ba5c882d2e 100644 --- a/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php +++ b/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php @@ -94,31 +94,31 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface copyBackupAsync(CopyBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupScheduleAsync(CreateBackupScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDatabaseAsync(CreateDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupScheduleAsync(DeleteBackupScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface dropDatabaseAsync(DropDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupScheduleAsync(GetBackupScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDatabaseAsync(GetDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDatabaseDdlAsync(GetDatabaseDdlRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupOperationsAsync(ListBackupOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupSchedulesAsync(ListBackupSchedulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatabaseOperationsAsync(ListDatabaseOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatabaseRolesAsync(ListDatabaseRolesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatabasesAsync(ListDatabasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreDatabaseAsync(RestoreDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupScheduleAsync(UpdateBackupScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDatabaseAsync(UpdateDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDatabaseDdlAsync(UpdateDatabaseDdlRequest $request, array $optionalArgs = []) + * @method PromiseInterface copyBackupAsync(CopyBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupScheduleAsync(CreateBackupScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDatabaseAsync(CreateDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupScheduleAsync(DeleteBackupScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface dropDatabaseAsync(DropDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupScheduleAsync(GetBackupScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDatabaseAsync(GetDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDatabaseDdlAsync(GetDatabaseDdlRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupOperationsAsync(ListBackupOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupSchedulesAsync(ListBackupSchedulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatabaseOperationsAsync(ListDatabaseOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatabaseRolesAsync(ListDatabaseRolesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatabasesAsync(ListDatabasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreDatabaseAsync(RestoreDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupScheduleAsync(UpdateBackupScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDatabaseAsync(UpdateDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDatabaseDdlAsync(UpdateDatabaseDdlRequest $request, array $optionalArgs = []) */ final class DatabaseAdminClient { diff --git a/Spanner/src/Admin/Instance/V1/Client/InstanceAdminClient.php b/Spanner/src/Admin/Instance/V1/Client/InstanceAdminClient.php index 82162bfe6374..1b3d5d0816e3 100644 --- a/Spanner/src/Admin/Instance/V1/Client/InstanceAdminClient.php +++ b/Spanner/src/Admin/Instance/V1/Client/InstanceAdminClient.php @@ -104,27 +104,27 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstanceConfigAsync(CreateInstanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstancePartitionAsync(CreateInstancePartitionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceConfigAsync(DeleteInstanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstancePartitionAsync(DeleteInstancePartitionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceConfigAsync(GetInstanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstancePartitionAsync(GetInstancePartitionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstanceConfigOperationsAsync(ListInstanceConfigOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstanceConfigsAsync(ListInstanceConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancePartitionOperationsAsync(ListInstancePartitionOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancePartitionsAsync(ListInstancePartitionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveInstanceAsync(MoveInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceConfigAsync(UpdateInstanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstancePartitionAsync(UpdateInstancePartitionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceConfigAsync(CreateInstanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstancePartitionAsync(CreateInstancePartitionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceConfigAsync(DeleteInstanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstancePartitionAsync(DeleteInstancePartitionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceConfigAsync(GetInstanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstancePartitionAsync(GetInstancePartitionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstanceConfigOperationsAsync(ListInstanceConfigOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstanceConfigsAsync(ListInstanceConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancePartitionOperationsAsync(ListInstancePartitionOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancePartitionsAsync(ListInstancePartitionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveInstanceAsync(MoveInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceConfigAsync(UpdateInstanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstancePartitionAsync(UpdateInstancePartitionRequest $request, array $optionalArgs = []) */ final class InstanceAdminClient { diff --git a/Spanner/src/V1/Client/SpannerClient.php b/Spanner/src/V1/Client/SpannerClient.php index 743bdbe9a60e..599de9deb370 100644 --- a/Spanner/src/V1/Client/SpannerClient.php +++ b/Spanner/src/V1/Client/SpannerClient.php @@ -75,19 +75,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateSessionsAsync(BatchCreateSessionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface beginTransactionAsync(BeginTransactionRequest $request, array $optionalArgs = []) - * @method PromiseInterface commitAsync(CommitRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSessionAsync(CreateSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSessionAsync(DeleteSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface executeBatchDmlAsync(ExecuteBatchDmlRequest $request, array $optionalArgs = []) - * @method PromiseInterface executeSqlAsync(ExecuteSqlRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSessionAsync(GetSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSessionsAsync(ListSessionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface partitionQueryAsync(PartitionQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface partitionReadAsync(PartitionReadRequest $request, array $optionalArgs = []) - * @method PromiseInterface readAsync(ReadRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackAsync(RollbackRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateSessionsAsync(BatchCreateSessionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface beginTransactionAsync(BeginTransactionRequest $request, array $optionalArgs = []) + * @method PromiseInterface commitAsync(CommitRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSessionAsync(CreateSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSessionAsync(DeleteSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface executeBatchDmlAsync(ExecuteBatchDmlRequest $request, array $optionalArgs = []) + * @method PromiseInterface executeSqlAsync(ExecuteSqlRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSessionAsync(GetSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSessionsAsync(ListSessionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface partitionQueryAsync(PartitionQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface partitionReadAsync(PartitionReadRequest $request, array $optionalArgs = []) + * @method PromiseInterface readAsync(ReadRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackAsync(RollbackRequest $request, array $optionalArgs = []) */ final class SpannerClient { diff --git a/Speech/src/V2/Client/SpeechClient.php b/Speech/src/V2/Client/SpeechClient.php index 3adfab40d81a..60cf5ec19d55 100644 --- a/Speech/src/V2/Client/SpeechClient.php +++ b/Speech/src/V2/Client/SpeechClient.php @@ -80,30 +80,30 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchRecognizeAsync(BatchRecognizeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomClassAsync(CreateCustomClassRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPhraseSetAsync(CreatePhraseSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRecognizerAsync(CreateRecognizerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCustomClassAsync(DeleteCustomClassRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePhraseSetAsync(DeletePhraseSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRecognizerAsync(DeleteRecognizerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConfigAsync(GetConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomClassAsync(GetCustomClassRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPhraseSetAsync(GetPhraseSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRecognizerAsync(GetRecognizerRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomClassesAsync(ListCustomClassesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPhraseSetsAsync(ListPhraseSetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRecognizersAsync(ListRecognizersRequest $request, array $optionalArgs = []) - * @method PromiseInterface recognizeAsync(RecognizeRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteCustomClassAsync(UndeleteCustomClassRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeletePhraseSetAsync(UndeletePhraseSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteRecognizerAsync(UndeleteRecognizerRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConfigAsync(UpdateConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomClassAsync(UpdateCustomClassRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePhraseSetAsync(UpdatePhraseSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRecognizerAsync(UpdateRecognizerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchRecognizeAsync(BatchRecognizeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomClassAsync(CreateCustomClassRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPhraseSetAsync(CreatePhraseSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRecognizerAsync(CreateRecognizerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCustomClassAsync(DeleteCustomClassRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePhraseSetAsync(DeletePhraseSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRecognizerAsync(DeleteRecognizerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConfigAsync(GetConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomClassAsync(GetCustomClassRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPhraseSetAsync(GetPhraseSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRecognizerAsync(GetRecognizerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomClassesAsync(ListCustomClassesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPhraseSetsAsync(ListPhraseSetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRecognizersAsync(ListRecognizersRequest $request, array $optionalArgs = []) + * @method PromiseInterface recognizeAsync(RecognizeRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteCustomClassAsync(UndeleteCustomClassRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeletePhraseSetAsync(UndeletePhraseSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteRecognizerAsync(UndeleteRecognizerRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConfigAsync(UpdateConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomClassAsync(UpdateCustomClassRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePhraseSetAsync(UpdatePhraseSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRecognizerAsync(UpdateRecognizerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SpeechClient { From 8a0df08c36c077feb9ada5caa910324c04ab0f24 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:16:32 -0800 Subject: [PATCH 073/157] chore: add types for async methods (#7801) chore: remove body selector from http rule PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiTWFuYWdlZEthZmthLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTWFwc0ZsZWV0RW5naW5lLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTWFwc0ZsZWV0RW5naW5lRGVsaXZlcnkvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiTWFwc1JvdXRlT3B0aW1pemF0aW9uLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTWVtY2FjaGUvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiTWlncmF0aW9uQ2VudGVyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTW9uaXRvcmluZy8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiTmV0QXBwLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTmV0d29ya0Nvbm5lY3Rpdml0eS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiTmV0d29ya01hbmFnZW1lbnQvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiTmV0d29ya1NlY3VyaXR5Ly5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTmV0d29ya1NlcnZpY2VzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTm90ZWJvb2tzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiT3B0aW1pemF0aW9uLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiT3JhY2xlRGF0YWJhc2UvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiT3JjaGVzdHJhdGlvbkFpcmZsb3cvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiT3JnUG9saWN5Ly5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiT3NDb25maWcvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiT3NMb2dpbi8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiUGFyYWxsZWxzdG9yZS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 --- .../src/V1/Client/ManagedKafkaClient.php | 32 +++--- MapsFleetEngine/metadata/V1/Fleetengine.php | Bin 4553 -> 4557 bytes MapsFleetEngine/metadata/V1/Header.php | Bin 1410 -> 1414 bytes MapsFleetEngine/metadata/V1/Traffic.php | Bin 1206 -> 1210 bytes MapsFleetEngine/metadata/V1/TripApi.php | Bin 4476 -> 4480 bytes MapsFleetEngine/metadata/V1/Trips.php | Bin 4249 -> 4253 bytes MapsFleetEngine/metadata/V1/VehicleApi.php | Bin 7420 -> 7424 bytes MapsFleetEngine/metadata/V1/Vehicles.php | Bin 4387 -> 4391 bytes .../src/V1/Client/TripServiceClient.php | 10 +- .../src/V1/Client/VehicleServiceClient.php | 12 +- .../metadata/V1/Common.php | Bin 3677 -> 3682 bytes .../metadata/V1/DeliveryApi.php | 6 +- .../metadata/V1/DeliveryVehicles.php | Bin 3110 -> 3115 bytes .../metadata/V1/Header.php | Bin 1530 -> 1535 bytes .../metadata/V1/TaskTrackingInfo.php | 6 +- MapsFleetEngineDelivery/metadata/V1/Tasks.php | Bin 4071 -> 4076 bytes .../src/V1/Client/DeliveryServiceClient.php | 20 ++-- .../src/V1/Client/RouteOptimizationClient.php | 4 +- .../src/V1/Client/CloudMemcacheClient.php | 20 ++-- .../src/V1/Client/MigrationCenterClient.php | 100 ++++++++-------- .../V3/Client/AlertPolicyServiceClient.php | 10 +- .../src/V3/Client/GroupServiceClient.php | 12 +- .../src/V3/Client/MetricServiceClient.php | 18 +-- .../NotificationChannelServiceClient.php | 20 ++-- .../src/V3/Client/QueryServiceClient.php | 2 +- .../Client/ServiceMonitoringServiceClient.php | 20 ++-- .../src/V3/Client/SnoozeServiceClient.php | 8 +- .../V3/Client/UptimeCheckServiceClient.php | 12 +- NetApp/src/V1/Client/NetAppClient.php | 108 +++++++++--------- .../src/V1/Client/HubServiceClient.php | 48 ++++---- .../PolicyBasedRoutingServiceClient.php | 18 +-- .../V1/Client/ReachabilityServiceClient.php | 22 ++-- .../src/V1/Client/NetworkSecurityClient.php | 40 +++---- .../src/V1/Client/DepServiceClient.php | 30 ++--- .../src/V1/Client/NetworkServicesClient.php | 88 +++++++------- .../Client/ManagedNotebookServiceClient.php | 36 +++--- .../src/V1/Client/NotebookServiceClient.php | 78 ++++++------- .../src/V2/Client/NotebookServiceClient.php | 34 +++--- .../src/V1/Client/FleetRoutingClient.php | 4 +- .../src/V1/Client/OracleDatabaseClient.php | 48 ++++---- .../src/V1/Client/EnvironmentsClient.php | 48 ++++---- .../src/V1/Client/ImageVersionsClient.php | 2 +- OrgPolicy/src/V2/Client/OrgPolicyClient.php | 24 ++-- .../src/V1/Client/OsConfigServiceClient.php | 24 ++-- .../V1/Client/OsConfigZonalServiceClient.php | 24 ++-- .../src/V1/Client/OsLoginServiceClient.php | 14 +-- .../src/V1/Client/ParallelstoreClient.php | 18 +-- .../src/V1beta/Client/ParallelstoreClient.php | 18 +-- .../parallelstore_rest_client_config.php | 1 - 49 files changed, 519 insertions(+), 520 deletions(-) diff --git a/ManagedKafka/src/V1/Client/ManagedKafkaClient.php b/ManagedKafka/src/V1/Client/ManagedKafkaClient.php index 7cbb343f0498..2b733c1a9131 100644 --- a/ManagedKafka/src/V1/Client/ManagedKafkaClient.php +++ b/ManagedKafka/src/V1/Client/ManagedKafkaClient.php @@ -70,22 +70,22 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTopicAsync(CreateTopicRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConsumerGroupAsync(DeleteConsumerGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTopicAsync(DeleteTopicRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConsumerGroupAsync(GetConsumerGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTopicAsync(GetTopicRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConsumerGroupsAsync(ListConsumerGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTopicsAsync(ListTopicsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConsumerGroupAsync(UpdateConsumerGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTopicAsync(UpdateTopicRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTopicAsync(CreateTopicRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConsumerGroupAsync(DeleteConsumerGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTopicAsync(DeleteTopicRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConsumerGroupAsync(GetConsumerGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTopicAsync(GetTopicRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConsumerGroupsAsync(ListConsumerGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTopicsAsync(ListTopicsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConsumerGroupAsync(UpdateConsumerGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTopicAsync(UpdateTopicRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ManagedKafkaClient { diff --git a/MapsFleetEngine/metadata/V1/Fleetengine.php b/MapsFleetEngine/metadata/V1/Fleetengine.php index aaab11d355c6c5870967991c761efe1467f808e4..11ab219baf22a4e85eda528d0b9885d9bf5540bd 100644 GIT binary patch delta 38 ucmX@9d{%jb4>RM|&A!axynNRgx#W`bbM?~m^V4%uCr{)N*?dTVoe=;8NesdO delta 24 gcmX@Bd{TLX4>RM&&A!axyeyX)xuiC)5m00V0Bi9Ff&c&j diff --git a/MapsFleetEngine/metadata/V1/Header.php b/MapsFleetEngine/metadata/V1/Header.php index d4a4374673067696175c76d50570b888da532fed..52f1053ac43c8dcfc58a40db1bf162d39d348b9d 100644 GIT binary patch delta 28 jcmZqTZsXn{#>BXEvpAC%6USvnF1h6VT)oYyEV7IMZo3Ci delta 24 fcmZqUZsOh`#>BXAvpAC%6U%uBWC diff --git a/MapsFleetEngine/metadata/V1/Traffic.php b/MapsFleetEngine/metadata/V1/Traffic.php index 2c026b23d9b5c881146c6428b378a45f6ba2b8e1..7331280b61397512cdf6d1566fe3eb43a86703ce 100644 GIT binary patch delta 28 kcmdnSxr=kdT}H;qo9{7hV&u5N$R(GYpR2cd3bPU;0G|*E%>V!Z delta 24 gcmdnRxs7wfT}H*s<=jx^B=cnhSPF7?S*(@)>!UzENObd(v delta 34 qcmZ3kv{-3_05ju>&4SDyc(^Vwa!IA<=cnhSPF7?S*{m$U!UzDwC<+q* diff --git a/MapsFleetEngine/src/V1/Client/TripServiceClient.php b/MapsFleetEngine/src/V1/Client/TripServiceClient.php index 22ab8f6bb049..07c1f7f6c070 100644 --- a/MapsFleetEngine/src/V1/Client/TripServiceClient.php +++ b/MapsFleetEngine/src/V1/Client/TripServiceClient.php @@ -52,11 +52,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTripAsync(CreateTripRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTripAsync(GetTripRequest $request, array $optionalArgs = []) - * @method PromiseInterface reportBillableTripAsync(ReportBillableTripRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchTripsAsync(SearchTripsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTripAsync(UpdateTripRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTripAsync(CreateTripRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTripAsync(GetTripRequest $request, array $optionalArgs = []) + * @method PromiseInterface reportBillableTripAsync(ReportBillableTripRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchTripsAsync(SearchTripsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTripAsync(UpdateTripRequest $request, array $optionalArgs = []) */ final class TripServiceClient { diff --git a/MapsFleetEngine/src/V1/Client/VehicleServiceClient.php b/MapsFleetEngine/src/V1/Client/VehicleServiceClient.php index 4d33b5c894e9..9eb70d735cf0 100644 --- a/MapsFleetEngine/src/V1/Client/VehicleServiceClient.php +++ b/MapsFleetEngine/src/V1/Client/VehicleServiceClient.php @@ -56,12 +56,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createVehicleAsync(CreateVehicleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVehicleAsync(GetVehicleRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVehiclesAsync(ListVehiclesRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchVehiclesAsync(SearchVehiclesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVehicleAsync(UpdateVehicleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVehicleAttributesAsync(UpdateVehicleAttributesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVehicleAsync(CreateVehicleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVehicleAsync(GetVehicleRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVehiclesAsync(ListVehiclesRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchVehiclesAsync(SearchVehiclesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVehicleAsync(UpdateVehicleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVehicleAttributesAsync(UpdateVehicleAttributesRequest $request, array $optionalArgs = []) */ final class VehicleServiceClient { diff --git a/MapsFleetEngineDelivery/metadata/V1/Common.php b/MapsFleetEngineDelivery/metadata/V1/Common.php index 7ee87d6950d535c8ad9c8d1cf3199e9f8e25103d..6706e838d022a8fa0f947615d039af9b18a1e465 100644 GIT binary patch delta 44 zcmcaB^GIgH6(*L0Vq69jy$v>VFmrM7|7PThQBTg#)l1LMPtQr6#3j4gl2?Th08r-* A$^ZZW delta 30 mcmaDPb5~}=6(*LwVq69jy$v>VFmrLSd}riR-Ym`Q&IkabDG0d$ diff --git a/MapsFleetEngineDelivery/metadata/V1/DeliveryApi.php b/MapsFleetEngineDelivery/metadata/V1/DeliveryApi.php index 087818359815..daae42f83879 100644 --- a/MapsFleetEngineDelivery/metadata/V1/DeliveryApi.php +++ b/MapsFleetEngineDelivery/metadata/V1/DeliveryApi.php @@ -27,7 +27,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\FieldMask::initOnce(); $pool->internalAddGeneratedFile( ' -Ö, +Ú, 6google/maps/fleetengine/delivery/v1/delivery_api.protomaps.fleetengine.delivery.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.protogoogle/api/routing.protogoogle/geo/type/viewport.proto;google/maps/fleetengine/delivery/v1/delivery_vehicles.proto0google/maps/fleetengine/delivery/v1/header.proto|BjZT*~SB`RO^SlN~u^H~;0*V*~)qwF@@@ diff --git a/MapsFleetEngineDelivery/metadata/V1/Header.php b/MapsFleetEngineDelivery/metadata/V1/Header.php index b3e165a74fe77697e6a50e06ed8f78a080aad53d..abed82a5a10f763114103d1b5fa98bd468f3b2c6 100644 GIT binary patch delta 40 wcmeyx{hxb-1`}h~W=*D6CV@YUTruj&`MG-O`T6NNsd|&+m}E9zWl?1W03It1O#lD@ delta 24 gcmey*{fm2p1`}i3W=*D6CYB$JT*{lbvv@E90Bp<$w*UYD diff --git a/MapsFleetEngineDelivery/metadata/V1/TaskTrackingInfo.php b/MapsFleetEngineDelivery/metadata/V1/TaskTrackingInfo.php index d6497b5b6af4..c4744271fecc 100644 --- a/MapsFleetEngineDelivery/metadata/V1/TaskTrackingInfo.php +++ b/MapsFleetEngineDelivery/metadata/V1/TaskTrackingInfo.php @@ -24,7 +24,7 @@ public static function initOnce() { \GPBMetadata\Google\Type\Latlng::initOnce(); $pool->internalAddGeneratedFile( ' -´ +¸ A{xnk6l^K batchCreateTasksAsync(BatchCreateTasksRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeliveryVehicleAsync(CreateDeliveryVehicleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTaskAsync(CreateTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeliveryVehicleAsync(GetDeliveryVehicleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTaskAsync(GetTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTaskTrackingInfoAsync(GetTaskTrackingInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeliveryVehiclesAsync(ListDeliveryVehiclesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTasksAsync(ListTasksRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDeliveryVehicleAsync(UpdateDeliveryVehicleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTaskAsync(UpdateTaskRequest $request, array $optionalArgs = []) */ final class DeliveryServiceClient { diff --git a/MapsRouteOptimization/src/V1/Client/RouteOptimizationClient.php b/MapsRouteOptimization/src/V1/Client/RouteOptimizationClient.php index a2cc19408408..440aa0e2093c 100644 --- a/MapsRouteOptimization/src/V1/Client/RouteOptimizationClient.php +++ b/MapsRouteOptimization/src/V1/Client/RouteOptimizationClient.php @@ -63,8 +63,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface batchOptimizeToursAsync(BatchOptimizeToursRequest $request, array $optionalArgs = []) - * @method PromiseInterface optimizeToursAsync(OptimizeToursRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchOptimizeToursAsync(BatchOptimizeToursRequest $request, array $optionalArgs = []) + * @method PromiseInterface optimizeToursAsync(OptimizeToursRequest $request, array $optionalArgs = []) */ final class RouteOptimizationClient { diff --git a/Memcache/src/V1/Client/CloudMemcacheClient.php b/Memcache/src/V1/Client/CloudMemcacheClient.php index 63b13b67af63..4d0fc0e5e9d4 100644 --- a/Memcache/src/V1/Client/CloudMemcacheClient.php +++ b/Memcache/src/V1/Client/CloudMemcacheClient.php @@ -75,16 +75,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface applyParametersAsync(ApplyParametersRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface rescheduleMaintenanceAsync(RescheduleMaintenanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateParametersAsync(UpdateParametersRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface applyParametersAsync(ApplyParametersRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface rescheduleMaintenanceAsync(RescheduleMaintenanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateParametersAsync(UpdateParametersRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class CloudMemcacheClient { diff --git a/MigrationCenter/src/V1/Client/MigrationCenterClient.php b/MigrationCenter/src/V1/Client/MigrationCenterClient.php index b00c3f936fe9..dcb131fa2b6e 100644 --- a/MigrationCenter/src/V1/Client/MigrationCenterClient.php +++ b/MigrationCenter/src/V1/Client/MigrationCenterClient.php @@ -113,56 +113,56 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addAssetsToGroupAsync(AddAssetsToGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregateAssetsValuesAsync(AggregateAssetsValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchDeleteAssetsAsync(BatchDeleteAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchUpdateAssetsAsync(BatchUpdateAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGroupAsync(CreateGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createImportDataFileAsync(CreateImportDataFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface createImportJobAsync(CreateImportJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPreferenceSetAsync(CreatePreferenceSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReportAsync(CreateReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReportConfigAsync(CreateReportConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSourceAsync(CreateSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAssetAsync(DeleteAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGroupAsync(DeleteGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteImportDataFileAsync(DeleteImportDataFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteImportJobAsync(DeleteImportJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePreferenceSetAsync(DeletePreferenceSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteReportAsync(DeleteReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteReportConfigAsync(DeleteReportConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSourceAsync(DeleteSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAssetAsync(GetAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getErrorFrameAsync(GetErrorFrameRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getImportDataFileAsync(GetImportDataFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getImportJobAsync(GetImportJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPreferenceSetAsync(GetPreferenceSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReportAsync(GetReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReportConfigAsync(GetReportConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSourceAsync(GetSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listErrorFramesAsync(ListErrorFramesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGroupsAsync(ListGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listImportDataFilesAsync(ListImportDataFilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listImportJobsAsync(ListImportJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPreferenceSetsAsync(ListPreferenceSetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReportConfigsAsync(ListReportConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReportsAsync(ListReportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSourcesAsync(ListSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeAssetsFromGroupAsync(RemoveAssetsFromGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface reportAssetFramesAsync(ReportAssetFramesRequest $request, array $optionalArgs = []) - * @method PromiseInterface runImportJobAsync(RunImportJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAssetAsync(UpdateAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGroupAsync(UpdateGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateImportJobAsync(UpdateImportJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePreferenceSetAsync(UpdatePreferenceSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSettingsAsync(UpdateSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSourceAsync(UpdateSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateImportJobAsync(ValidateImportJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface addAssetsToGroupAsync(AddAssetsToGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregateAssetsValuesAsync(AggregateAssetsValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeleteAssetsAsync(BatchDeleteAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateAssetsAsync(BatchUpdateAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGroupAsync(CreateGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createImportDataFileAsync(CreateImportDataFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface createImportJobAsync(CreateImportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPreferenceSetAsync(CreatePreferenceSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReportAsync(CreateReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReportConfigAsync(CreateReportConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSourceAsync(CreateSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAssetAsync(DeleteAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGroupAsync(DeleteGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteImportDataFileAsync(DeleteImportDataFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteImportJobAsync(DeleteImportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePreferenceSetAsync(DeletePreferenceSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteReportAsync(DeleteReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteReportConfigAsync(DeleteReportConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSourceAsync(DeleteSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAssetAsync(GetAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getErrorFrameAsync(GetErrorFrameRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getImportDataFileAsync(GetImportDataFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getImportJobAsync(GetImportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPreferenceSetAsync(GetPreferenceSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReportAsync(GetReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReportConfigAsync(GetReportConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSourceAsync(GetSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listErrorFramesAsync(ListErrorFramesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGroupsAsync(ListGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listImportDataFilesAsync(ListImportDataFilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listImportJobsAsync(ListImportJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPreferenceSetsAsync(ListPreferenceSetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReportConfigsAsync(ListReportConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReportsAsync(ListReportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSourcesAsync(ListSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeAssetsFromGroupAsync(RemoveAssetsFromGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface reportAssetFramesAsync(ReportAssetFramesRequest $request, array $optionalArgs = []) + * @method PromiseInterface runImportJobAsync(RunImportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAssetAsync(UpdateAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGroupAsync(UpdateGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateImportJobAsync(UpdateImportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePreferenceSetAsync(UpdatePreferenceSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSettingsAsync(UpdateSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSourceAsync(UpdateSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateImportJobAsync(ValidateImportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class MigrationCenterClient { diff --git a/Monitoring/src/V3/Client/AlertPolicyServiceClient.php b/Monitoring/src/V3/Client/AlertPolicyServiceClient.php index b48dd0260f52..ae1115fe9fec 100644 --- a/Monitoring/src/V3/Client/AlertPolicyServiceClient.php +++ b/Monitoring/src/V3/Client/AlertPolicyServiceClient.php @@ -60,11 +60,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAlertPolicyAsync(CreateAlertPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAlertPolicyAsync(DeleteAlertPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAlertPolicyAsync(GetAlertPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAlertPoliciesAsync(ListAlertPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAlertPolicyAsync(UpdateAlertPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAlertPolicyAsync(CreateAlertPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAlertPolicyAsync(DeleteAlertPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAlertPolicyAsync(GetAlertPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAlertPoliciesAsync(ListAlertPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAlertPolicyAsync(UpdateAlertPolicyRequest $request, array $optionalArgs = []) */ final class AlertPolicyServiceClient { diff --git a/Monitoring/src/V3/Client/GroupServiceClient.php b/Monitoring/src/V3/Client/GroupServiceClient.php index 7fd5c869f434..0d70cc2c18b7 100644 --- a/Monitoring/src/V3/Client/GroupServiceClient.php +++ b/Monitoring/src/V3/Client/GroupServiceClient.php @@ -64,12 +64,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createGroupAsync(CreateGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGroupAsync(DeleteGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGroupMembersAsync(ListGroupMembersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGroupsAsync(ListGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGroupAsync(UpdateGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGroupAsync(CreateGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGroupAsync(DeleteGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGroupMembersAsync(ListGroupMembersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGroupsAsync(ListGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGroupAsync(UpdateGroupRequest $request, array $optionalArgs = []) */ final class GroupServiceClient { diff --git a/Monitoring/src/V3/Client/MetricServiceClient.php b/Monitoring/src/V3/Client/MetricServiceClient.php index 768b64becf4d..bf2cf9e8163e 100644 --- a/Monitoring/src/V3/Client/MetricServiceClient.php +++ b/Monitoring/src/V3/Client/MetricServiceClient.php @@ -58,15 +58,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createMetricDescriptorAsync(CreateMetricDescriptorRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceTimeSeriesAsync(CreateTimeSeriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTimeSeriesAsync(CreateTimeSeriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMetricDescriptorAsync(DeleteMetricDescriptorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMetricDescriptorAsync(GetMetricDescriptorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMonitoredResourceDescriptorAsync(GetMonitoredResourceDescriptorRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMetricDescriptorsAsync(ListMetricDescriptorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMonitoredResourceDescriptorsAsync(ListMonitoredResourceDescriptorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTimeSeriesAsync(ListTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMetricDescriptorAsync(CreateMetricDescriptorRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceTimeSeriesAsync(CreateTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTimeSeriesAsync(CreateTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMetricDescriptorAsync(DeleteMetricDescriptorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetricDescriptorAsync(GetMetricDescriptorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMonitoredResourceDescriptorAsync(GetMonitoredResourceDescriptorRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMetricDescriptorsAsync(ListMetricDescriptorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMonitoredResourceDescriptorsAsync(ListMonitoredResourceDescriptorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTimeSeriesAsync(ListTimeSeriesRequest $request, array $optionalArgs = []) */ final class MetricServiceClient { diff --git a/Monitoring/src/V3/Client/NotificationChannelServiceClient.php b/Monitoring/src/V3/Client/NotificationChannelServiceClient.php index 65ea9438bb7a..361ddf6b6df9 100644 --- a/Monitoring/src/V3/Client/NotificationChannelServiceClient.php +++ b/Monitoring/src/V3/Client/NotificationChannelServiceClient.php @@ -60,16 +60,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createNotificationChannelAsync(CreateNotificationChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNotificationChannelAsync(DeleteNotificationChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotificationChannelAsync(GetNotificationChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotificationChannelDescriptorAsync(GetNotificationChannelDescriptorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotificationChannelVerificationCodeAsync(GetNotificationChannelVerificationCodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotificationChannelDescriptorsAsync(ListNotificationChannelDescriptorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotificationChannelsAsync(ListNotificationChannelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface sendNotificationChannelVerificationCodeAsync(SendNotificationChannelVerificationCodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNotificationChannelAsync(UpdateNotificationChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface verifyNotificationChannelAsync(VerifyNotificationChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNotificationChannelAsync(CreateNotificationChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNotificationChannelAsync(DeleteNotificationChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotificationChannelAsync(GetNotificationChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotificationChannelDescriptorAsync(GetNotificationChannelDescriptorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotificationChannelVerificationCodeAsync(GetNotificationChannelVerificationCodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotificationChannelDescriptorsAsync(ListNotificationChannelDescriptorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotificationChannelsAsync(ListNotificationChannelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface sendNotificationChannelVerificationCodeAsync(SendNotificationChannelVerificationCodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNotificationChannelAsync(UpdateNotificationChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface verifyNotificationChannelAsync(VerifyNotificationChannelRequest $request, array $optionalArgs = []) */ final class NotificationChannelServiceClient { diff --git a/Monitoring/src/V3/Client/QueryServiceClient.php b/Monitoring/src/V3/Client/QueryServiceClient.php index 747ac7297018..c9f5c8943803 100644 --- a/Monitoring/src/V3/Client/QueryServiceClient.php +++ b/Monitoring/src/V3/Client/QueryServiceClient.php @@ -43,7 +43,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface queryTimeSeriesAsync(QueryTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryTimeSeriesAsync(QueryTimeSeriesRequest $request, array $optionalArgs = []) */ final class QueryServiceClient { diff --git a/Monitoring/src/V3/Client/ServiceMonitoringServiceClient.php b/Monitoring/src/V3/Client/ServiceMonitoringServiceClient.php index d45da317e3a0..1a6b71cc14ae 100644 --- a/Monitoring/src/V3/Client/ServiceMonitoringServiceClient.php +++ b/Monitoring/src/V3/Client/ServiceMonitoringServiceClient.php @@ -61,16 +61,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceLevelObjectiveAsync(CreateServiceLevelObjectiveRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceLevelObjectiveAsync(DeleteServiceLevelObjectiveRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceLevelObjectiveAsync(GetServiceLevelObjectiveRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServiceLevelObjectivesAsync(ListServiceLevelObjectivesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServiceLevelObjectiveAsync(UpdateServiceLevelObjectiveRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceLevelObjectiveAsync(CreateServiceLevelObjectiveRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceLevelObjectiveAsync(DeleteServiceLevelObjectiveRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceLevelObjectiveAsync(GetServiceLevelObjectiveRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServiceLevelObjectivesAsync(ListServiceLevelObjectivesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServiceLevelObjectiveAsync(UpdateServiceLevelObjectiveRequest $request, array $optionalArgs = []) */ final class ServiceMonitoringServiceClient { diff --git a/Monitoring/src/V3/Client/SnoozeServiceClient.php b/Monitoring/src/V3/Client/SnoozeServiceClient.php index 06465a163c78..d616e5fad17f 100644 --- a/Monitoring/src/V3/Client/SnoozeServiceClient.php +++ b/Monitoring/src/V3/Client/SnoozeServiceClient.php @@ -53,10 +53,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSnoozeAsync(CreateSnoozeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSnoozeAsync(GetSnoozeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSnoozesAsync(ListSnoozesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSnoozeAsync(UpdateSnoozeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSnoozeAsync(CreateSnoozeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSnoozeAsync(GetSnoozeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSnoozesAsync(ListSnoozesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSnoozeAsync(UpdateSnoozeRequest $request, array $optionalArgs = []) */ final class SnoozeServiceClient { diff --git a/Monitoring/src/V3/Client/UptimeCheckServiceClient.php b/Monitoring/src/V3/Client/UptimeCheckServiceClient.php index 17e4d2b2270e..f166cb860fcd 100644 --- a/Monitoring/src/V3/Client/UptimeCheckServiceClient.php +++ b/Monitoring/src/V3/Client/UptimeCheckServiceClient.php @@ -60,12 +60,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getUptimeCheckConfigAsync(GetUptimeCheckConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUptimeCheckIpsAsync(ListUptimeCheckIpsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getUptimeCheckConfigAsync(GetUptimeCheckConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUptimeCheckIpsAsync(ListUptimeCheckIpsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest $request, array $optionalArgs = []) */ final class UptimeCheckServiceClient { diff --git a/NetApp/src/V1/Client/NetAppClient.php b/NetApp/src/V1/Client/NetAppClient.php index 0d207a3d5c45..537ccf1f5381 100644 --- a/NetApp/src/V1/Client/NetAppClient.php +++ b/NetApp/src/V1/Client/NetAppClient.php @@ -114,60 +114,60 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createActiveDirectoryAsync(CreateActiveDirectoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupPolicyAsync(CreateBackupPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupVaultAsync(CreateBackupVaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface createKmsConfigAsync(CreateKmsConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReplicationAsync(CreateReplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSnapshotAsync(CreateSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface createStoragePoolAsync(CreateStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface createVolumeAsync(CreateVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteActiveDirectoryAsync(DeleteActiveDirectoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupPolicyAsync(DeleteBackupPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupVaultAsync(DeleteBackupVaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteKmsConfigAsync(DeleteKmsConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteReplicationAsync(DeleteReplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteStoragePoolAsync(DeleteStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVolumeAsync(DeleteVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface encryptVolumesAsync(EncryptVolumesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getActiveDirectoryAsync(GetActiveDirectoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupPolicyAsync(GetBackupPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupVaultAsync(GetBackupVaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKmsConfigAsync(GetKmsConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReplicationAsync(GetReplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStoragePoolAsync(GetStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVolumeAsync(GetVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listActiveDirectoriesAsync(ListActiveDirectoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupPoliciesAsync(ListBackupPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupVaultsAsync(ListBackupVaultsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listKmsConfigsAsync(ListKmsConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReplicationsAsync(ListReplicationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listStoragePoolsAsync(ListStoragePoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVolumesAsync(ListVolumesRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeReplicationAsync(ResumeReplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface reverseReplicationDirectionAsync(ReverseReplicationDirectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface revertVolumeAsync(RevertVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopReplicationAsync(StopReplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface switchActiveReplicaZoneAsync(SwitchActiveReplicaZoneRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateActiveDirectoryAsync(UpdateActiveDirectoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupPolicyAsync(UpdateBackupPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupVaultAsync(UpdateBackupVaultRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateKmsConfigAsync(UpdateKmsConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateReplicationAsync(UpdateReplicationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSnapshotAsync(UpdateSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateStoragePoolAsync(UpdateStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVolumeAsync(UpdateVolumeRequest $request, array $optionalArgs = []) - * @method PromiseInterface verifyKmsConfigAsync(VerifyKmsConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createActiveDirectoryAsync(CreateActiveDirectoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupPolicyAsync(CreateBackupPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupVaultAsync(CreateBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface createKmsConfigAsync(CreateKmsConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReplicationAsync(CreateReplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSnapshotAsync(CreateSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface createStoragePoolAsync(CreateStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVolumeAsync(CreateVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteActiveDirectoryAsync(DeleteActiveDirectoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupPolicyAsync(DeleteBackupPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupVaultAsync(DeleteBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteKmsConfigAsync(DeleteKmsConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteReplicationAsync(DeleteReplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteStoragePoolAsync(DeleteStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVolumeAsync(DeleteVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface encryptVolumesAsync(EncryptVolumesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getActiveDirectoryAsync(GetActiveDirectoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupPolicyAsync(GetBackupPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupVaultAsync(GetBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKmsConfigAsync(GetKmsConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReplicationAsync(GetReplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStoragePoolAsync(GetStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVolumeAsync(GetVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listActiveDirectoriesAsync(ListActiveDirectoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupPoliciesAsync(ListBackupPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupVaultsAsync(ListBackupVaultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listKmsConfigsAsync(ListKmsConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReplicationsAsync(ListReplicationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listStoragePoolsAsync(ListStoragePoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVolumesAsync(ListVolumesRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeReplicationAsync(ResumeReplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface reverseReplicationDirectionAsync(ReverseReplicationDirectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface revertVolumeAsync(RevertVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopReplicationAsync(StopReplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface switchActiveReplicaZoneAsync(SwitchActiveReplicaZoneRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateActiveDirectoryAsync(UpdateActiveDirectoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupPolicyAsync(UpdateBackupPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupVaultAsync(UpdateBackupVaultRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateKmsConfigAsync(UpdateKmsConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateReplicationAsync(UpdateReplicationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSnapshotAsync(UpdateSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateStoragePoolAsync(UpdateStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVolumeAsync(UpdateVolumeRequest $request, array $optionalArgs = []) + * @method PromiseInterface verifyKmsConfigAsync(VerifyKmsConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class NetAppClient { diff --git a/NetworkConnectivity/src/V1/Client/HubServiceClient.php b/NetworkConnectivity/src/V1/Client/HubServiceClient.php index 62a6bcebed19..0bd8a6cc1f9d 100644 --- a/NetworkConnectivity/src/V1/Client/HubServiceClient.php +++ b/NetworkConnectivity/src/V1/Client/HubServiceClient.php @@ -83,30 +83,30 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface acceptHubSpokeAsync(AcceptHubSpokeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createHubAsync(CreateHubRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSpokeAsync(CreateSpokeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteHubAsync(DeleteHubRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSpokeAsync(DeleteSpokeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHubAsync(GetHubRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRouteAsync(GetRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRouteTableAsync(GetRouteTableRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpokeAsync(GetSpokeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGroupsAsync(ListGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listHubSpokesAsync(ListHubSpokesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listHubsAsync(ListHubsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRouteTablesAsync(ListRouteTablesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRoutesAsync(ListRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSpokesAsync(ListSpokesRequest $request, array $optionalArgs = []) - * @method PromiseInterface rejectHubSpokeAsync(RejectHubSpokeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateHubAsync(UpdateHubRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSpokeAsync(UpdateSpokeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface acceptHubSpokeAsync(AcceptHubSpokeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createHubAsync(CreateHubRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSpokeAsync(CreateSpokeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteHubAsync(DeleteHubRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSpokeAsync(DeleteSpokeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHubAsync(GetHubRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRouteAsync(GetRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRouteTableAsync(GetRouteTableRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpokeAsync(GetSpokeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGroupsAsync(ListGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listHubSpokesAsync(ListHubSpokesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listHubsAsync(ListHubsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRouteTablesAsync(ListRouteTablesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRoutesAsync(ListRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSpokesAsync(ListSpokesRequest $request, array $optionalArgs = []) + * @method PromiseInterface rejectHubSpokeAsync(RejectHubSpokeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateHubAsync(UpdateHubRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSpokeAsync(UpdateSpokeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class HubServiceClient { diff --git a/NetworkConnectivity/src/V1/Client/PolicyBasedRoutingServiceClient.php b/NetworkConnectivity/src/V1/Client/PolicyBasedRoutingServiceClient.php index 0fbdaef55f8f..daf283d58a53 100644 --- a/NetworkConnectivity/src/V1/Client/PolicyBasedRoutingServiceClient.php +++ b/NetworkConnectivity/src/V1/Client/PolicyBasedRoutingServiceClient.php @@ -63,15 +63,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createPolicyBasedRouteAsync(CreatePolicyBasedRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePolicyBasedRouteAsync(DeletePolicyBasedRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPolicyBasedRouteAsync(GetPolicyBasedRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPolicyBasedRoutesAsync(ListPolicyBasedRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPolicyBasedRouteAsync(CreatePolicyBasedRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePolicyBasedRouteAsync(DeletePolicyBasedRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPolicyBasedRouteAsync(GetPolicyBasedRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPolicyBasedRoutesAsync(ListPolicyBasedRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class PolicyBasedRoutingServiceClient { diff --git a/NetworkManagement/src/V1/Client/ReachabilityServiceClient.php b/NetworkManagement/src/V1/Client/ReachabilityServiceClient.php index 8996957f5fdb..f1fa700c6cbf 100644 --- a/NetworkManagement/src/V1/Client/ReachabilityServiceClient.php +++ b/NetworkManagement/src/V1/Client/ReachabilityServiceClient.php @@ -71,17 +71,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createConnectivityTestAsync(CreateConnectivityTestRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectivityTestAsync(DeleteConnectivityTestRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectivityTestAsync(GetConnectivityTestRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectivityTestsAsync(ListConnectivityTestsRequest $request, array $optionalArgs = []) - * @method PromiseInterface rerunConnectivityTestAsync(RerunConnectivityTestRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConnectivityTestAsync(UpdateConnectivityTestRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectivityTestAsync(CreateConnectivityTestRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectivityTestAsync(DeleteConnectivityTestRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectivityTestAsync(GetConnectivityTestRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectivityTestsAsync(ListConnectivityTestsRequest $request, array $optionalArgs = []) + * @method PromiseInterface rerunConnectivityTestAsync(RerunConnectivityTestRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConnectivityTestAsync(UpdateConnectivityTestRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ReachabilityServiceClient { diff --git a/NetworkSecurity/src/V1/Client/NetworkSecurityClient.php b/NetworkSecurity/src/V1/Client/NetworkSecurityClient.php index 3b766fbcefd1..cf85a7e87a41 100644 --- a/NetworkSecurity/src/V1/Client/NetworkSecurityClient.php +++ b/NetworkSecurity/src/V1/Client/NetworkSecurityClient.php @@ -77,26 +77,26 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAuthorizationPolicyAsync(CreateAuthorizationPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createClientTlsPolicyAsync(CreateClientTlsPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServerTlsPolicyAsync(CreateServerTlsPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAuthorizationPolicyAsync(DeleteAuthorizationPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClientTlsPolicyAsync(DeleteClientTlsPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServerTlsPolicyAsync(DeleteServerTlsPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAuthorizationPolicyAsync(GetAuthorizationPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClientTlsPolicyAsync(GetClientTlsPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServerTlsPolicyAsync(GetServerTlsPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAuthorizationPoliciesAsync(ListAuthorizationPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClientTlsPoliciesAsync(ListClientTlsPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServerTlsPoliciesAsync(ListServerTlsPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAuthorizationPolicyAsync(UpdateAuthorizationPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClientTlsPolicyAsync(UpdateClientTlsPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServerTlsPolicyAsync(UpdateServerTlsPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAuthorizationPolicyAsync(CreateAuthorizationPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClientTlsPolicyAsync(CreateClientTlsPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServerTlsPolicyAsync(CreateServerTlsPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAuthorizationPolicyAsync(DeleteAuthorizationPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClientTlsPolicyAsync(DeleteClientTlsPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServerTlsPolicyAsync(DeleteServerTlsPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAuthorizationPolicyAsync(GetAuthorizationPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClientTlsPolicyAsync(GetClientTlsPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServerTlsPolicyAsync(GetServerTlsPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAuthorizationPoliciesAsync(ListAuthorizationPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClientTlsPoliciesAsync(ListClientTlsPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServerTlsPoliciesAsync(ListServerTlsPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAuthorizationPolicyAsync(UpdateAuthorizationPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClientTlsPolicyAsync(UpdateClientTlsPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServerTlsPolicyAsync(UpdateServerTlsPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class NetworkSecurityClient { diff --git a/NetworkServices/src/V1/Client/DepServiceClient.php b/NetworkServices/src/V1/Client/DepServiceClient.php index 5c916d26db60..bdba8921d50a 100644 --- a/NetworkServices/src/V1/Client/DepServiceClient.php +++ b/NetworkServices/src/V1/Client/DepServiceClient.php @@ -69,21 +69,21 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createLbRouteExtensionAsync(CreateLbRouteExtensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createLbTrafficExtensionAsync(CreateLbTrafficExtensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteLbRouteExtensionAsync(DeleteLbRouteExtensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteLbTrafficExtensionAsync(DeleteLbTrafficExtensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLbRouteExtensionAsync(GetLbRouteExtensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLbTrafficExtensionAsync(GetLbTrafficExtensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLbRouteExtensionsAsync(ListLbRouteExtensionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLbTrafficExtensionsAsync(ListLbTrafficExtensionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateLbRouteExtensionAsync(UpdateLbRouteExtensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateLbTrafficExtensionAsync(UpdateLbTrafficExtensionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLbRouteExtensionAsync(CreateLbRouteExtensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLbTrafficExtensionAsync(CreateLbTrafficExtensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLbRouteExtensionAsync(DeleteLbRouteExtensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLbTrafficExtensionAsync(DeleteLbTrafficExtensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLbRouteExtensionAsync(GetLbRouteExtensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLbTrafficExtensionAsync(GetLbTrafficExtensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLbRouteExtensionsAsync(ListLbRouteExtensionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLbTrafficExtensionsAsync(ListLbTrafficExtensionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateLbRouteExtensionAsync(UpdateLbRouteExtensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateLbTrafficExtensionAsync(UpdateLbTrafficExtensionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DepServiceClient { diff --git a/NetworkServices/src/V1/Client/NetworkServicesClient.php b/NetworkServices/src/V1/Client/NetworkServicesClient.php index 25fb316e2f8c..d80619a26a6c 100644 --- a/NetworkServices/src/V1/Client/NetworkServicesClient.php +++ b/NetworkServices/src/V1/Client/NetworkServicesClient.php @@ -104,50 +104,50 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEndpointPolicyAsync(CreateEndpointPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGatewayAsync(CreateGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGrpcRouteAsync(CreateGrpcRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface createHttpRouteAsync(CreateHttpRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMeshAsync(CreateMeshRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceBindingAsync(CreateServiceBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTcpRouteAsync(CreateTcpRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTlsRouteAsync(CreateTlsRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEndpointPolicyAsync(DeleteEndpointPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGatewayAsync(DeleteGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGrpcRouteAsync(DeleteGrpcRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteHttpRouteAsync(DeleteHttpRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMeshAsync(DeleteMeshRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceBindingAsync(DeleteServiceBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTcpRouteAsync(DeleteTcpRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTlsRouteAsync(DeleteTlsRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEndpointPolicyAsync(GetEndpointPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGatewayAsync(GetGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGrpcRouteAsync(GetGrpcRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHttpRouteAsync(GetHttpRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMeshAsync(GetMeshRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceBindingAsync(GetServiceBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTcpRouteAsync(GetTcpRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTlsRouteAsync(GetTlsRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEndpointPoliciesAsync(ListEndpointPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGatewaysAsync(ListGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGrpcRoutesAsync(ListGrpcRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listHttpRoutesAsync(ListHttpRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMeshesAsync(ListMeshesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServiceBindingsAsync(ListServiceBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTcpRoutesAsync(ListTcpRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTlsRoutesAsync(ListTlsRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEndpointPolicyAsync(UpdateEndpointPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGatewayAsync(UpdateGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGrpcRouteAsync(UpdateGrpcRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateHttpRouteAsync(UpdateHttpRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMeshAsync(UpdateMeshRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTcpRouteAsync(UpdateTcpRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTlsRouteAsync(UpdateTlsRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEndpointPolicyAsync(CreateEndpointPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGatewayAsync(CreateGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGrpcRouteAsync(CreateGrpcRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface createHttpRouteAsync(CreateHttpRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMeshAsync(CreateMeshRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceBindingAsync(CreateServiceBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTcpRouteAsync(CreateTcpRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTlsRouteAsync(CreateTlsRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEndpointPolicyAsync(DeleteEndpointPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGatewayAsync(DeleteGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGrpcRouteAsync(DeleteGrpcRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteHttpRouteAsync(DeleteHttpRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMeshAsync(DeleteMeshRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceBindingAsync(DeleteServiceBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTcpRouteAsync(DeleteTcpRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTlsRouteAsync(DeleteTlsRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEndpointPolicyAsync(GetEndpointPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGatewayAsync(GetGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGrpcRouteAsync(GetGrpcRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHttpRouteAsync(GetHttpRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMeshAsync(GetMeshRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceBindingAsync(GetServiceBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTcpRouteAsync(GetTcpRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTlsRouteAsync(GetTlsRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEndpointPoliciesAsync(ListEndpointPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGatewaysAsync(ListGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGrpcRoutesAsync(ListGrpcRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listHttpRoutesAsync(ListHttpRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMeshesAsync(ListMeshesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServiceBindingsAsync(ListServiceBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTcpRoutesAsync(ListTcpRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTlsRoutesAsync(ListTlsRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEndpointPolicyAsync(UpdateEndpointPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGatewayAsync(UpdateGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGrpcRouteAsync(UpdateGrpcRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateHttpRouteAsync(UpdateHttpRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMeshAsync(UpdateMeshRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTcpRouteAsync(UpdateTcpRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTlsRouteAsync(UpdateTlsRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class NetworkServicesClient { diff --git a/Notebooks/src/V1/Client/ManagedNotebookServiceClient.php b/Notebooks/src/V1/Client/ManagedNotebookServiceClient.php index f373975d269a..1e3859121f8d 100644 --- a/Notebooks/src/V1/Client/ManagedNotebookServiceClient.php +++ b/Notebooks/src/V1/Client/ManagedNotebookServiceClient.php @@ -72,24 +72,24 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createRuntimeAsync(CreateRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRuntimeAsync(DeleteRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface diagnoseRuntimeAsync(DiagnoseRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuntimeAsync(GetRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRuntimesAsync(ListRuntimesRequest $request, array $optionalArgs = []) - * @method PromiseInterface refreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest $request, array $optionalArgs = []) - * @method PromiseInterface reportRuntimeEventAsync(ReportRuntimeEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetRuntimeAsync(ResetRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface startRuntimeAsync(StartRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopRuntimeAsync(StopRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface switchRuntimeAsync(SwitchRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRuntimeAsync(UpdateRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface upgradeRuntimeAsync(UpgradeRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRuntimeAsync(CreateRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRuntimeAsync(DeleteRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface diagnoseRuntimeAsync(DiagnoseRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuntimeAsync(GetRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRuntimesAsync(ListRuntimesRequest $request, array $optionalArgs = []) + * @method PromiseInterface refreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest $request, array $optionalArgs = []) + * @method PromiseInterface reportRuntimeEventAsync(ReportRuntimeEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetRuntimeAsync(ResetRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface startRuntimeAsync(StartRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopRuntimeAsync(StopRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface switchRuntimeAsync(SwitchRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRuntimeAsync(UpdateRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface upgradeRuntimeAsync(UpgradeRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ManagedNotebookServiceClient { diff --git a/Notebooks/src/V1/Client/NotebookServiceClient.php b/Notebooks/src/V1/Client/NotebookServiceClient.php index 744311d10c83..fb1d043a19b6 100644 --- a/Notebooks/src/V1/Client/NotebookServiceClient.php +++ b/Notebooks/src/V1/Client/NotebookServiceClient.php @@ -98,45 +98,45 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createExecutionAsync(CreateExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createScheduleAsync(CreateScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteExecutionAsync(DeleteExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteScheduleAsync(DeleteScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface diagnoseInstanceAsync(DiagnoseInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExecutionAsync(GetExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceHealthAsync(GetInstanceHealthRequest $request, array $optionalArgs = []) - * @method PromiseInterface getScheduleAsync(GetScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface isInstanceUpgradeableAsync(IsInstanceUpgradeableRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExecutionsAsync(ListExecutionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSchedulesAsync(ListSchedulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface registerInstanceAsync(RegisterInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface reportInstanceInfoAsync(ReportInstanceInfoRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetInstanceAsync(ResetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackInstanceAsync(RollbackInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setInstanceAcceleratorAsync(SetInstanceAcceleratorRequest $request, array $optionalArgs = []) - * @method PromiseInterface setInstanceLabelsAsync(SetInstanceLabelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setInstanceMachineTypeAsync(SetInstanceMachineTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface startInstanceAsync(StartInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopInstanceAsync(StopInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface triggerScheduleAsync(TriggerScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceConfigAsync(UpdateInstanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface upgradeInstanceAsync(UpgradeInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface upgradeInstanceInternalAsync(UpgradeInstanceInternalRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExecutionAsync(CreateExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createScheduleAsync(CreateScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteExecutionAsync(DeleteExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteScheduleAsync(DeleteScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface diagnoseInstanceAsync(DiagnoseInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExecutionAsync(GetExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceHealthAsync(GetInstanceHealthRequest $request, array $optionalArgs = []) + * @method PromiseInterface getScheduleAsync(GetScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface isInstanceUpgradeableAsync(IsInstanceUpgradeableRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExecutionsAsync(ListExecutionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSchedulesAsync(ListSchedulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface registerInstanceAsync(RegisterInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface reportInstanceInfoAsync(ReportInstanceInfoRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetInstanceAsync(ResetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackInstanceAsync(RollbackInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setInstanceAcceleratorAsync(SetInstanceAcceleratorRequest $request, array $optionalArgs = []) + * @method PromiseInterface setInstanceLabelsAsync(SetInstanceLabelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setInstanceMachineTypeAsync(SetInstanceMachineTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface startInstanceAsync(StartInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopInstanceAsync(StopInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface triggerScheduleAsync(TriggerScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceConfigAsync(UpdateInstanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface upgradeInstanceAsync(UpgradeInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface upgradeInstanceInternalAsync(UpgradeInstanceInternalRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class NotebookServiceClient { diff --git a/Notebooks/src/V2/Client/NotebookServiceClient.php b/Notebooks/src/V2/Client/NotebookServiceClient.php index d626f221dec2..9290daf0cb05 100644 --- a/Notebooks/src/V2/Client/NotebookServiceClient.php +++ b/Notebooks/src/V2/Client/NotebookServiceClient.php @@ -71,23 +71,23 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface checkInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface diagnoseInstanceAsync(DiagnoseInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetInstanceAsync(ResetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackInstanceAsync(RollbackInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface startInstanceAsync(StartInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopInstanceAsync(StopInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface upgradeInstanceAsync(UpgradeInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface diagnoseInstanceAsync(DiagnoseInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetInstanceAsync(ResetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackInstanceAsync(RollbackInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface startInstanceAsync(StartInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopInstanceAsync(StopInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface upgradeInstanceAsync(UpgradeInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class NotebookServiceClient { diff --git a/Optimization/src/V1/Client/FleetRoutingClient.php b/Optimization/src/V1/Client/FleetRoutingClient.php index 8635b879fae2..f82865bd5554 100644 --- a/Optimization/src/V1/Client/FleetRoutingClient.php +++ b/Optimization/src/V1/Client/FleetRoutingClient.php @@ -62,8 +62,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface batchOptimizeToursAsync(BatchOptimizeToursRequest $request, array $optionalArgs = []) - * @method PromiseInterface optimizeToursAsync(OptimizeToursRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchOptimizeToursAsync(BatchOptimizeToursRequest $request, array $optionalArgs = []) + * @method PromiseInterface optimizeToursAsync(OptimizeToursRequest $request, array $optionalArgs = []) */ final class FleetRoutingClient { diff --git a/OracleDatabase/src/V1/Client/OracleDatabaseClient.php b/OracleDatabase/src/V1/Client/OracleDatabaseClient.php index eebc783d4917..ae385a2af8c6 100644 --- a/OracleDatabase/src/V1/Client/OracleDatabaseClient.php +++ b/OracleDatabase/src/V1/Client/OracleDatabaseClient.php @@ -78,30 +78,30 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAutonomousDatabaseAsync(CreateAutonomousDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCloudExadataInfrastructureAsync(CreateCloudExadataInfrastructureRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCloudVmClusterAsync(CreateCloudVmClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAutonomousDatabaseAsync(DeleteAutonomousDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCloudExadataInfrastructureAsync(DeleteCloudExadataInfrastructureRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCloudVmClusterAsync(DeleteCloudVmClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateAutonomousDatabaseWalletAsync(GenerateAutonomousDatabaseWalletRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAutonomousDatabaseAsync(GetAutonomousDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCloudExadataInfrastructureAsync(GetCloudExadataInfrastructureRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCloudVmClusterAsync(GetCloudVmClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAutonomousDatabaseBackupsAsync(ListAutonomousDatabaseBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAutonomousDatabaseCharacterSetsAsync(ListAutonomousDatabaseCharacterSetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAutonomousDatabasesAsync(ListAutonomousDatabasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAutonomousDbVersionsAsync(ListAutonomousDbVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCloudExadataInfrastructuresAsync(ListCloudExadataInfrastructuresRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCloudVmClustersAsync(ListCloudVmClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDbNodesAsync(ListDbNodesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDbServersAsync(ListDbServersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDbSystemShapesAsync(ListDbSystemShapesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntitlementsAsync(ListEntitlementsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGiVersionsAsync(ListGiVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreAutonomousDatabaseAsync(RestoreAutonomousDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAutonomousDatabaseAsync(CreateAutonomousDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCloudExadataInfrastructureAsync(CreateCloudExadataInfrastructureRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCloudVmClusterAsync(CreateCloudVmClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAutonomousDatabaseAsync(DeleteAutonomousDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCloudExadataInfrastructureAsync(DeleteCloudExadataInfrastructureRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCloudVmClusterAsync(DeleteCloudVmClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateAutonomousDatabaseWalletAsync(GenerateAutonomousDatabaseWalletRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAutonomousDatabaseAsync(GetAutonomousDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCloudExadataInfrastructureAsync(GetCloudExadataInfrastructureRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCloudVmClusterAsync(GetCloudVmClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAutonomousDatabaseBackupsAsync(ListAutonomousDatabaseBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAutonomousDatabaseCharacterSetsAsync(ListAutonomousDatabaseCharacterSetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAutonomousDatabasesAsync(ListAutonomousDatabasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAutonomousDbVersionsAsync(ListAutonomousDbVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCloudExadataInfrastructuresAsync(ListCloudExadataInfrastructuresRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCloudVmClustersAsync(ListCloudVmClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDbNodesAsync(ListDbNodesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDbServersAsync(ListDbServersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDbSystemShapesAsync(ListDbSystemShapesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntitlementsAsync(ListEntitlementsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGiVersionsAsync(ListGiVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreAutonomousDatabaseAsync(RestoreAutonomousDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class OracleDatabaseClient { diff --git a/OrchestrationAirflow/src/V1/Client/EnvironmentsClient.php b/OrchestrationAirflow/src/V1/Client/EnvironmentsClient.php index 1400e507fa02..5b4f6dd4cbb5 100644 --- a/OrchestrationAirflow/src/V1/Client/EnvironmentsClient.php +++ b/OrchestrationAirflow/src/V1/Client/EnvironmentsClient.php @@ -80,30 +80,30 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface checkUpgradeAsync(CheckUpgradeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createUserWorkloadsConfigMapAsync(CreateUserWorkloadsConfigMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface createUserWorkloadsSecretAsync(CreateUserWorkloadsSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface databaseFailoverAsync(DatabaseFailoverRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteUserWorkloadsConfigMapAsync(DeleteUserWorkloadsConfigMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteUserWorkloadsSecretAsync(DeleteUserWorkloadsSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface executeAirflowCommandAsync(ExecuteAirflowCommandRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getUserWorkloadsConfigMapAsync(GetUserWorkloadsConfigMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface getUserWorkloadsSecretAsync(GetUserWorkloadsSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUserWorkloadsConfigMapsAsync(ListUserWorkloadsConfigMapsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUserWorkloadsSecretsAsync(ListUserWorkloadsSecretsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) - * @method PromiseInterface loadSnapshotAsync(LoadSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface pollAirflowCommandAsync(PollAirflowCommandRequest $request, array $optionalArgs = []) - * @method PromiseInterface saveSnapshotAsync(SaveSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopAirflowCommandAsync(StopAirflowCommandRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEnvironmentAsync(UpdateEnvironmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateUserWorkloadsConfigMapAsync(UpdateUserWorkloadsConfigMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateUserWorkloadsSecretAsync(UpdateUserWorkloadsSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkUpgradeAsync(CheckUpgradeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEnvironmentAsync(CreateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createUserWorkloadsConfigMapAsync(CreateUserWorkloadsConfigMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface createUserWorkloadsSecretAsync(CreateUserWorkloadsSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface databaseFailoverAsync(DatabaseFailoverRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEnvironmentAsync(DeleteEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteUserWorkloadsConfigMapAsync(DeleteUserWorkloadsConfigMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteUserWorkloadsSecretAsync(DeleteUserWorkloadsSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface executeAirflowCommandAsync(ExecuteAirflowCommandRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnvironmentAsync(GetEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getUserWorkloadsConfigMapAsync(GetUserWorkloadsConfigMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface getUserWorkloadsSecretAsync(GetUserWorkloadsSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEnvironmentsAsync(ListEnvironmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUserWorkloadsConfigMapsAsync(ListUserWorkloadsConfigMapsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUserWorkloadsSecretsAsync(ListUserWorkloadsSecretsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkloadsAsync(ListWorkloadsRequest $request, array $optionalArgs = []) + * @method PromiseInterface loadSnapshotAsync(LoadSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface pollAirflowCommandAsync(PollAirflowCommandRequest $request, array $optionalArgs = []) + * @method PromiseInterface saveSnapshotAsync(SaveSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopAirflowCommandAsync(StopAirflowCommandRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEnvironmentAsync(UpdateEnvironmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateUserWorkloadsConfigMapAsync(UpdateUserWorkloadsConfigMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateUserWorkloadsSecretAsync(UpdateUserWorkloadsSecretRequest $request, array $optionalArgs = []) */ final class EnvironmentsClient { diff --git a/OrchestrationAirflow/src/V1/Client/ImageVersionsClient.php b/OrchestrationAirflow/src/V1/Client/ImageVersionsClient.php index a6f866bfa7cc..dbd7cd38f1d7 100644 --- a/OrchestrationAirflow/src/V1/Client/ImageVersionsClient.php +++ b/OrchestrationAirflow/src/V1/Client/ImageVersionsClient.php @@ -41,7 +41,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface listImageVersionsAsync(ListImageVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listImageVersionsAsync(ListImageVersionsRequest $request, array $optionalArgs = []) */ final class ImageVersionsClient { diff --git a/OrgPolicy/src/V2/Client/OrgPolicyClient.php b/OrgPolicy/src/V2/Client/OrgPolicyClient.php index ddbf9810e36b..fbbbad583939 100644 --- a/OrgPolicy/src/V2/Client/OrgPolicyClient.php +++ b/OrgPolicy/src/V2/Client/OrgPolicyClient.php @@ -79,18 +79,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createCustomConstraintAsync(CreateCustomConstraintRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPolicyAsync(CreatePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCustomConstraintAsync(DeleteCustomConstraintRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePolicyAsync(DeletePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomConstraintAsync(GetCustomConstraintRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEffectivePolicyAsync(GetEffectivePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPolicyAsync(GetPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConstraintsAsync(ListConstraintsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomConstraintsAsync(ListCustomConstraintsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPoliciesAsync(ListPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCustomConstraintAsync(UpdateCustomConstraintRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePolicyAsync(UpdatePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomConstraintAsync(CreateCustomConstraintRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPolicyAsync(CreatePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCustomConstraintAsync(DeleteCustomConstraintRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePolicyAsync(DeletePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomConstraintAsync(GetCustomConstraintRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEffectivePolicyAsync(GetEffectivePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPolicyAsync(GetPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConstraintsAsync(ListConstraintsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomConstraintsAsync(ListCustomConstraintsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPoliciesAsync(ListPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCustomConstraintAsync(UpdateCustomConstraintRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePolicyAsync(UpdatePolicyRequest $request, array $optionalArgs = []) */ final class OrgPolicyClient { diff --git a/OsConfig/src/V1/Client/OsConfigServiceClient.php b/OsConfig/src/V1/Client/OsConfigServiceClient.php index e892ad57401d..9842432e6c67 100644 --- a/OsConfig/src/V1/Client/OsConfigServiceClient.php +++ b/OsConfig/src/V1/Client/OsConfigServiceClient.php @@ -63,18 +63,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface cancelPatchJobAsync(CancelPatchJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPatchDeploymentAsync(CreatePatchDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePatchDeploymentAsync(DeletePatchDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface executePatchJobAsync(ExecutePatchJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPatchDeploymentAsync(GetPatchDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPatchJobAsync(GetPatchJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPatchDeploymentsAsync(ListPatchDeploymentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPatchJobInstanceDetailsAsync(ListPatchJobInstanceDetailsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPatchJobsAsync(ListPatchJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pausePatchDeploymentAsync(PausePatchDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumePatchDeploymentAsync(ResumePatchDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePatchDeploymentAsync(UpdatePatchDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelPatchJobAsync(CancelPatchJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPatchDeploymentAsync(CreatePatchDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePatchDeploymentAsync(DeletePatchDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface executePatchJobAsync(ExecutePatchJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPatchDeploymentAsync(GetPatchDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPatchJobAsync(GetPatchJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPatchDeploymentsAsync(ListPatchDeploymentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPatchJobInstanceDetailsAsync(ListPatchJobInstanceDetailsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPatchJobsAsync(ListPatchJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pausePatchDeploymentAsync(PausePatchDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumePatchDeploymentAsync(ResumePatchDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePatchDeploymentAsync(UpdatePatchDeploymentRequest $request, array $optionalArgs = []) */ final class OsConfigServiceClient { diff --git a/OsConfig/src/V1/Client/OsConfigZonalServiceClient.php b/OsConfig/src/V1/Client/OsConfigZonalServiceClient.php index eae4f4d2dc1d..d2b6fe9aa965 100644 --- a/OsConfig/src/V1/Client/OsConfigZonalServiceClient.php +++ b/OsConfig/src/V1/Client/OsConfigZonalServiceClient.php @@ -68,18 +68,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createOSPolicyAssignmentAsync(CreateOSPolicyAssignmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteOSPolicyAssignmentAsync(DeleteOSPolicyAssignmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInventoryAsync(GetInventoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOSPolicyAssignmentAsync(GetOSPolicyAssignmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOSPolicyAssignmentReportAsync(GetOSPolicyAssignmentReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVulnerabilityReportAsync(GetVulnerabilityReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInventoriesAsync(ListInventoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOSPolicyAssignmentReportsAsync(ListOSPolicyAssignmentReportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOSPolicyAssignmentRevisionsAsync(ListOSPolicyAssignmentRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOSPolicyAssignmentsAsync(ListOSPolicyAssignmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVulnerabilityReportsAsync(ListVulnerabilityReportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateOSPolicyAssignmentAsync(UpdateOSPolicyAssignmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createOSPolicyAssignmentAsync(CreateOSPolicyAssignmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteOSPolicyAssignmentAsync(DeleteOSPolicyAssignmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInventoryAsync(GetInventoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOSPolicyAssignmentAsync(GetOSPolicyAssignmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOSPolicyAssignmentReportAsync(GetOSPolicyAssignmentReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVulnerabilityReportAsync(GetVulnerabilityReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInventoriesAsync(ListInventoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOSPolicyAssignmentReportsAsync(ListOSPolicyAssignmentReportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOSPolicyAssignmentRevisionsAsync(ListOSPolicyAssignmentRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOSPolicyAssignmentsAsync(ListOSPolicyAssignmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVulnerabilityReportsAsync(ListVulnerabilityReportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateOSPolicyAssignmentAsync(UpdateOSPolicyAssignmentRequest $request, array $optionalArgs = []) */ final class OsConfigZonalServiceClient { diff --git a/OsLogin/src/V1/Client/OsLoginServiceClient.php b/OsLogin/src/V1/Client/OsLoginServiceClient.php index 39a32ff2fdff..5d15d64d451a 100644 --- a/OsLogin/src/V1/Client/OsLoginServiceClient.php +++ b/OsLogin/src/V1/Client/OsLoginServiceClient.php @@ -58,13 +58,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSshPublicKeyAsync(CreateSshPublicKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePosixAccountAsync(DeletePosixAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLoginProfileAsync(GetLoginProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSshPublicKeyAsync(GetSshPublicKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface importSshPublicKeyAsync(ImportSshPublicKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSshPublicKeyAsync(UpdateSshPublicKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSshPublicKeyAsync(CreateSshPublicKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePosixAccountAsync(DeletePosixAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSshPublicKeyAsync(DeleteSshPublicKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLoginProfileAsync(GetLoginProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSshPublicKeyAsync(GetSshPublicKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface importSshPublicKeyAsync(ImportSshPublicKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSshPublicKeyAsync(UpdateSshPublicKeyRequest $request, array $optionalArgs = []) */ final class OsLoginServiceClient { diff --git a/Parallelstore/src/V1/Client/ParallelstoreClient.php b/Parallelstore/src/V1/Client/ParallelstoreClient.php index d7f7d28afc7a..26374b478f70 100644 --- a/Parallelstore/src/V1/Client/ParallelstoreClient.php +++ b/Parallelstore/src/V1/Client/ParallelstoreClient.php @@ -74,15 +74,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ParallelstoreClient { diff --git a/Parallelstore/src/V1beta/Client/ParallelstoreClient.php b/Parallelstore/src/V1beta/Client/ParallelstoreClient.php index e6270a5e31fc..a703d343bb48 100644 --- a/Parallelstore/src/V1beta/Client/ParallelstoreClient.php +++ b/Parallelstore/src/V1beta/Client/ParallelstoreClient.php @@ -78,15 +78,15 @@ * * @experimental * - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ParallelstoreClient { diff --git a/Parallelstore/src/V1beta/resources/parallelstore_rest_client_config.php b/Parallelstore/src/V1beta/resources/parallelstore_rest_client_config.php index f20e236b21ac..f1562b87effb 100644 --- a/Parallelstore/src/V1beta/resources/parallelstore_rest_client_config.php +++ b/Parallelstore/src/V1beta/resources/parallelstore_rest_client_config.php @@ -140,7 +140,6 @@ 'CancelOperation' => [ 'method' => 'post', 'uriTemplate' => '/v1beta/{name=projects/*/locations/*/operations/*}:cancel', - 'body' => '*', 'placeholders' => [ 'name' => [ 'getters' => [ From 897ed552d180dc8d60aae8723f9bc1925a337e8a Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:17:26 -0800 Subject: [PATCH 074/157] chore: add types for async methods (#7799) PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiQWNjZXNzQ29udGV4dE1hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiQWRzTWFya2V0aW5nUGxhdGZvcm1BZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiQXJ0aWZhY3RSZWdpc3RyeS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiQnVpbGQvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiQ29udGFpbmVyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiQ29udGFpbmVyQW5hbHlzaXMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRGF0YWZsb3cvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRGF0YXByb2NNZXRhc3RvcmUvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRGF0YXN0b3JlLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiRGF0YXN0b3JlQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRGVidWdnZXIvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRGlzY292ZXJ5RW5naW5lLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiRGxwLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiRG9jdW1lbnRBaS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiRG9tYWlucy8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiRWRnZU5ldHdvcmsvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRXJyb3JSZXBvcnRpbmcvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRXNzZW50aWFsQ29udGFjdHMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRXZlbnRhcmMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiRXZlbnRhcmNQdWJsaXNoaW5nLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= --- .../V1/Client/AccessContextManagerClient.php | 52 ++++----- .../MarketingplatformAdminServiceClient.php | 10 +- .../src/V1/Client/ArtifactRegistryClient.php | 102 ++++++++-------- .../src/V2/Client/RepositoryManagerClient.php | 34 +++--- .../src/V1/Client/ClusterManagerClient.php | 68 +++++------ .../src/V1/Client/ContainerAnalysisClient.php | 8 +- .../Client/FlexTemplatesServiceClient.php | 2 +- .../src/V1beta3/Client/JobsV1Beta3Client.php | 14 +-- .../V1beta3/Client/MessagesV1Beta3Client.php | 2 +- .../V1beta3/Client/MetricsV1Beta3Client.php | 6 +- .../V1beta3/Client/SnapshotsV1Beta3Client.php | 6 +- .../V1beta3/Client/TemplatesServiceClient.php | 6 +- .../src/V1/Client/DataprocMetastoreClient.php | 46 ++++---- .../DataprocMetastoreFederationClient.php | 20 ++-- .../Client/DataprocMetastoreClient.php | 48 ++++---- .../DataprocMetastoreFederationClient.php | 20 ++-- .../V1beta/Client/DataprocMetastoreClient.php | 48 ++++---- .../DataprocMetastoreFederationClient.php | 20 ++-- Datastore/src/V1/Client/DatastoreClient.php | 16 +-- .../src/V1/Client/DatastoreAdminClient.php | 12 +- Debugger/src/V2/Client/Controller2Client.php | 6 +- Debugger/src/V2/Client/Debugger2Client.php | 10 +- .../src/V1/Client/CompletionServiceClient.php | 10 +- .../src/V1/Client/ControlServiceClient.php | 10 +- .../ConversationalSearchServiceClient.php | 26 ++--- .../src/V1/Client/DataStoreServiceClient.php | 10 +- .../src/V1/Client/DocumentServiceClient.php | 16 +-- .../src/V1/Client/EngineServiceClient.php | 10 +- .../GroundedGenerationServiceClient.php | 4 +- .../src/V1/Client/ProjectServiceClient.php | 2 +- .../src/V1/Client/RankServiceClient.php | 2 +- .../V1/Client/RecommendationServiceClient.php | 2 +- .../src/V1/Client/SchemaServiceClient.php | 10 +- .../src/V1/Client/SearchServiceClient.php | 4 +- .../V1/Client/SearchTuningServiceClient.php | 4 +- .../Client/SiteSearchEngineServiceClient.php | 24 ++-- .../src/V1/Client/UserEventServiceClient.php | 8 +- Dlp/src/V2/Client/DlpServiceClient.php | 110 +++++++++--------- .../Client/DocumentProcessorServiceClient.php | 48 ++++---- Domains/src/V1/Client/DomainsClient.php | 30 ++--- .../src/V1/Client/EdgeNetworkClient.php | 56 ++++----- .../Client/ErrorGroupServiceClient.php | 4 +- .../Client/ErrorStatsServiceClient.php | 6 +- .../Client/ReportErrorsServiceClient.php | 2 +- .../Client/EssentialContactsServiceClient.php | 14 +-- Eventarc/src/V1/Client/EventarcClient.php | 88 +++++++------- .../src/V1/Client/PublisherClient.php | 6 +- 47 files changed, 531 insertions(+), 531 deletions(-) diff --git a/AccessContextManager/src/V1/Client/AccessContextManagerClient.php b/AccessContextManager/src/V1/Client/AccessContextManagerClient.php index 556de5234f4e..731fcab21267 100644 --- a/AccessContextManager/src/V1/Client/AccessContextManagerClient.php +++ b/AccessContextManager/src/V1/Client/AccessContextManagerClient.php @@ -93,32 +93,32 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface commitServicePerimetersAsync(CommitServicePerimetersRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAccessLevelAsync(CreateAccessLevelRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAccessPolicyAsync(AccessPolicy $request, array $optionalArgs = []) - * @method PromiseInterface createGcpUserAccessBindingAsync(CreateGcpUserAccessBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServicePerimeterAsync(CreateServicePerimeterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccessLevelAsync(DeleteAccessLevelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccessPolicyAsync(DeleteAccessPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGcpUserAccessBindingAsync(DeleteGcpUserAccessBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServicePerimeterAsync(DeleteServicePerimeterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAccessLevelAsync(GetAccessLevelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAccessPolicyAsync(GetAccessPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGcpUserAccessBindingAsync(GetGcpUserAccessBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServicePerimeterAsync(GetServicePerimeterRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccessLevelsAsync(ListAccessLevelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAccessPoliciesAsync(ListAccessPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGcpUserAccessBindingsAsync(ListGcpUserAccessBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicePerimetersAsync(ListServicePerimetersRequest $request, array $optionalArgs = []) - * @method PromiseInterface replaceAccessLevelsAsync(ReplaceAccessLevelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface replaceServicePerimetersAsync(ReplaceServicePerimetersRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccessLevelAsync(UpdateAccessLevelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccessPolicyAsync(UpdateAccessPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGcpUserAccessBindingAsync(UpdateGcpUserAccessBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServicePerimeterAsync(UpdateServicePerimeterRequest $request, array $optionalArgs = []) + * @method PromiseInterface commitServicePerimetersAsync(CommitServicePerimetersRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAccessLevelAsync(CreateAccessLevelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAccessPolicyAsync(AccessPolicy $request, array $optionalArgs = []) + * @method PromiseInterface createGcpUserAccessBindingAsync(CreateGcpUserAccessBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServicePerimeterAsync(CreateServicePerimeterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccessLevelAsync(DeleteAccessLevelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccessPolicyAsync(DeleteAccessPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGcpUserAccessBindingAsync(DeleteGcpUserAccessBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServicePerimeterAsync(DeleteServicePerimeterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAccessLevelAsync(GetAccessLevelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAccessPolicyAsync(GetAccessPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGcpUserAccessBindingAsync(GetGcpUserAccessBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServicePerimeterAsync(GetServicePerimeterRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccessLevelsAsync(ListAccessLevelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAccessPoliciesAsync(ListAccessPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGcpUserAccessBindingsAsync(ListGcpUserAccessBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicePerimetersAsync(ListServicePerimetersRequest $request, array $optionalArgs = []) + * @method PromiseInterface replaceAccessLevelsAsync(ReplaceAccessLevelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface replaceServicePerimetersAsync(ReplaceServicePerimetersRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccessLevelAsync(UpdateAccessLevelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccessPolicyAsync(UpdateAccessPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGcpUserAccessBindingAsync(UpdateGcpUserAccessBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServicePerimeterAsync(UpdateServicePerimeterRequest $request, array $optionalArgs = []) */ final class AccessContextManagerClient { diff --git a/AdsMarketingPlatformAdmin/src/V1alpha/Client/MarketingplatformAdminServiceClient.php b/AdsMarketingPlatformAdmin/src/V1alpha/Client/MarketingplatformAdminServiceClient.php index 2eff337aa60a..ccdc022b1a0f 100644 --- a/AdsMarketingPlatformAdmin/src/V1alpha/Client/MarketingplatformAdminServiceClient.php +++ b/AdsMarketingPlatformAdmin/src/V1alpha/Client/MarketingplatformAdminServiceClient.php @@ -58,11 +58,11 @@ * * @experimental * - * @method PromiseInterface createAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOrganizationAsync(GetOrganizationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface setPropertyServiceLevelAsync(SetPropertyServiceLevelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAnalyticsAccountLinkAsync(CreateAnalyticsAccountLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAnalyticsAccountLinkAsync(DeleteAnalyticsAccountLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOrganizationAsync(GetOrganizationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAnalyticsAccountLinksAsync(ListAnalyticsAccountLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface setPropertyServiceLevelAsync(SetPropertyServiceLevelRequest $request, array $optionalArgs = []) */ final class MarketingplatformAdminServiceClient { diff --git a/ArtifactRegistry/src/V1/Client/ArtifactRegistryClient.php b/ArtifactRegistry/src/V1/Client/ArtifactRegistryClient.php index b47093978340..d3dba2797b07 100644 --- a/ArtifactRegistry/src/V1/Client/ArtifactRegistryClient.php +++ b/ArtifactRegistry/src/V1/Client/ArtifactRegistryClient.php @@ -128,57 +128,57 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchDeleteVersionsAsync(BatchDeleteVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAttachmentAsync(CreateAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRuleAsync(CreateRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTagAsync(CreateTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAttachmentAsync(DeleteAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFileAsync(DeleteFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePackageAsync(DeletePackageRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRuleAsync(DeleteRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTagAsync(DeleteTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAttachmentAsync(GetAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDockerImageAsync(GetDockerImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFileAsync(GetFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMavenArtifactAsync(GetMavenArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNpmPackageAsync(GetNpmPackageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPackageAsync(GetPackageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProjectSettingsAsync(GetProjectSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPythonPackageAsync(GetPythonPackageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuleAsync(GetRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTagAsync(GetTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVPCSCConfigAsync(GetVPCSCConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface importAptArtifactsAsync(ImportAptArtifactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface importYumArtifactsAsync(ImportYumArtifactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAttachmentsAsync(ListAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDockerImagesAsync(ListDockerImagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFilesAsync(ListFilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMavenArtifactsAsync(ListMavenArtifactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNpmPackagesAsync(ListNpmPackagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPackagesAsync(ListPackagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPythonPackagesAsync(ListPythonPackagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRulesAsync(ListRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTagsAsync(ListTagsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFileAsync(UpdateFileRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePackageAsync(UpdatePackageRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProjectSettingsAsync(UpdateProjectSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRepositoryAsync(UpdateRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRuleAsync(UpdateRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTagAsync(UpdateTagRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVPCSCConfigAsync(UpdateVPCSCConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeleteVersionsAsync(BatchDeleteVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAttachmentAsync(CreateAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRuleAsync(CreateRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTagAsync(CreateTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAttachmentAsync(DeleteAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFileAsync(DeleteFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePackageAsync(DeletePackageRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRuleAsync(DeleteRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTagAsync(DeleteTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVersionAsync(DeleteVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttachmentAsync(GetAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDockerImageAsync(GetDockerImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFileAsync(GetFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMavenArtifactAsync(GetMavenArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNpmPackageAsync(GetNpmPackageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPackageAsync(GetPackageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProjectSettingsAsync(GetProjectSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPythonPackageAsync(GetPythonPackageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuleAsync(GetRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTagAsync(GetTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVPCSCConfigAsync(GetVPCSCConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVersionAsync(GetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface importAptArtifactsAsync(ImportAptArtifactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface importYumArtifactsAsync(ImportYumArtifactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAttachmentsAsync(ListAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDockerImagesAsync(ListDockerImagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFilesAsync(ListFilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMavenArtifactsAsync(ListMavenArtifactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNpmPackagesAsync(ListNpmPackagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPackagesAsync(ListPackagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPythonPackagesAsync(ListPythonPackagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRulesAsync(ListRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTagsAsync(ListTagsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVersionsAsync(ListVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFileAsync(UpdateFileRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePackageAsync(UpdatePackageRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProjectSettingsAsync(UpdateProjectSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRepositoryAsync(UpdateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRuleAsync(UpdateRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTagAsync(UpdateTagRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVPCSCConfigAsync(UpdateVPCSCConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVersionAsync(UpdateVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class ArtifactRegistryClient { diff --git a/Build/src/V2/Client/RepositoryManagerClient.php b/Build/src/V2/Client/RepositoryManagerClient.php index 81c5204ea7c9..59e1209b7b9c 100644 --- a/Build/src/V2/Client/RepositoryManagerClient.php +++ b/Build/src/V2/Client/RepositoryManagerClient.php @@ -73,23 +73,23 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateRepositoriesAsync(BatchCreateRepositoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConnectionAsync(CreateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectionAsync(DeleteConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchGitRefsAsync(FetchGitRefsRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchLinkableRepositoriesAsync(FetchLinkableRepositoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchReadTokenAsync(FetchReadTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchReadWriteTokenAsync(FetchReadWriteTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectionAsync(GetConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConnectionAsync(UpdateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateRepositoriesAsync(BatchCreateRepositoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectionAsync(CreateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectionAsync(DeleteConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchGitRefsAsync(FetchGitRefsRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchLinkableRepositoriesAsync(FetchLinkableRepositoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchReadTokenAsync(FetchReadTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchReadWriteTokenAsync(FetchReadWriteTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectionAsync(GetConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConnectionAsync(UpdateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class RepositoryManagerClient { diff --git a/Container/src/V1/Client/ClusterManagerClient.php b/Container/src/V1/Client/ClusterManagerClient.php index 1baf5f0edca0..2312a9998373 100644 --- a/Container/src/V1/Client/ClusterManagerClient.php +++ b/Container/src/V1/Client/ClusterManagerClient.php @@ -89,40 +89,40 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface cancelOperationAsync(CancelOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface checkAutopilotCompatibilityAsync(CheckAutopilotCompatibilityRequest $request, array $optionalArgs = []) - * @method PromiseInterface completeIPRotationAsync(CompleteIPRotationRequest $request, array $optionalArgs = []) - * @method PromiseInterface completeNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNodePoolAsync(CreateNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNodePoolAsync(DeleteNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJSONWebKeysAsync(GetJSONWebKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNodePoolAsync(GetNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOperationAsync(GetOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServerConfigAsync(GetServerConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNodePoolsAsync(ListNodePoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOperationsAsync(ListOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUsableSubnetworksAsync(ListUsableSubnetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackNodePoolUpgradeAsync(RollbackNodePoolUpgradeRequest $request, array $optionalArgs = []) - * @method PromiseInterface setAddonsConfigAsync(SetAddonsConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLegacyAbacAsync(SetLegacyAbacRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLocationsAsync(SetLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLoggingServiceAsync(SetLoggingServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMaintenancePolicyAsync(SetMaintenancePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMasterAuthAsync(SetMasterAuthRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMonitoringServiceAsync(SetMonitoringServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setNetworkPolicyAsync(SetNetworkPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setNodePoolAutoscalingAsync(SetNodePoolAutoscalingRequest $request, array $optionalArgs = []) - * @method PromiseInterface setNodePoolManagementAsync(SetNodePoolManagementRequest $request, array $optionalArgs = []) - * @method PromiseInterface setNodePoolSizeAsync(SetNodePoolSizeRequest $request, array $optionalArgs = []) - * @method PromiseInterface startIPRotationAsync(StartIPRotationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMasterAsync(UpdateMasterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNodePoolAsync(UpdateNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelOperationAsync(CancelOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkAutopilotCompatibilityAsync(CheckAutopilotCompatibilityRequest $request, array $optionalArgs = []) + * @method PromiseInterface completeIPRotationAsync(CompleteIPRotationRequest $request, array $optionalArgs = []) + * @method PromiseInterface completeNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNodePoolAsync(CreateNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNodePoolAsync(DeleteNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJSONWebKeysAsync(GetJSONWebKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNodePoolAsync(GetNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOperationAsync(GetOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServerConfigAsync(GetServerConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNodePoolsAsync(ListNodePoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOperationsAsync(ListOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUsableSubnetworksAsync(ListUsableSubnetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackNodePoolUpgradeAsync(RollbackNodePoolUpgradeRequest $request, array $optionalArgs = []) + * @method PromiseInterface setAddonsConfigAsync(SetAddonsConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLegacyAbacAsync(SetLegacyAbacRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLocationsAsync(SetLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLoggingServiceAsync(SetLoggingServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMaintenancePolicyAsync(SetMaintenancePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMasterAuthAsync(SetMasterAuthRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMonitoringServiceAsync(SetMonitoringServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setNetworkPolicyAsync(SetNetworkPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setNodePoolAutoscalingAsync(SetNodePoolAutoscalingRequest $request, array $optionalArgs = []) + * @method PromiseInterface setNodePoolManagementAsync(SetNodePoolManagementRequest $request, array $optionalArgs = []) + * @method PromiseInterface setNodePoolSizeAsync(SetNodePoolSizeRequest $request, array $optionalArgs = []) + * @method PromiseInterface startIPRotationAsync(StartIPRotationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMasterAsync(UpdateMasterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNodePoolAsync(UpdateNodePoolRequest $request, array $optionalArgs = []) */ final class ClusterManagerClient { diff --git a/ContainerAnalysis/src/V1/Client/ContainerAnalysisClient.php b/ContainerAnalysis/src/V1/Client/ContainerAnalysisClient.php index e109beea3bb6..434e1d2e72f8 100644 --- a/ContainerAnalysis/src/V1/Client/ContainerAnalysisClient.php +++ b/ContainerAnalysis/src/V1/Client/ContainerAnalysisClient.php @@ -64,10 +64,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVulnerabilityOccurrencesSummaryAsync(GetVulnerabilityOccurrencesSummaryRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVulnerabilityOccurrencesSummaryAsync(GetVulnerabilityOccurrencesSummaryRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ContainerAnalysisClient { diff --git a/Dataflow/src/V1beta3/Client/FlexTemplatesServiceClient.php b/Dataflow/src/V1beta3/Client/FlexTemplatesServiceClient.php index ea7b89ab57d2..af432c5b54cb 100644 --- a/Dataflow/src/V1beta3/Client/FlexTemplatesServiceClient.php +++ b/Dataflow/src/V1beta3/Client/FlexTemplatesServiceClient.php @@ -45,7 +45,7 @@ * * @experimental * - * @method PromiseInterface launchFlexTemplateAsync(LaunchFlexTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface launchFlexTemplateAsync(LaunchFlexTemplateRequest $request, array $optionalArgs = []) */ final class FlexTemplatesServiceClient { diff --git a/Dataflow/src/V1beta3/Client/JobsV1Beta3Client.php b/Dataflow/src/V1beta3/Client/JobsV1Beta3Client.php index 7866a42d36ba..a6b50f730d45 100644 --- a/Dataflow/src/V1beta3/Client/JobsV1Beta3Client.php +++ b/Dataflow/src/V1beta3/Client/JobsV1Beta3Client.php @@ -54,13 +54,13 @@ * * @experimental * - * @method PromiseInterface aggregatedListJobsAsync(ListJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface checkActiveJobsAsync(CheckActiveJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface snapshotJobAsync(SnapshotJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateJobAsync(UpdateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListJobsAsync(ListJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkActiveJobsAsync(CheckActiveJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface snapshotJobAsync(SnapshotJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateJobAsync(UpdateJobRequest $request, array $optionalArgs = []) */ final class JobsV1Beta3Client { diff --git a/Dataflow/src/V1beta3/Client/MessagesV1Beta3Client.php b/Dataflow/src/V1beta3/Client/MessagesV1Beta3Client.php index 3269e83a0372..d43eacce4def 100644 --- a/Dataflow/src/V1beta3/Client/MessagesV1Beta3Client.php +++ b/Dataflow/src/V1beta3/Client/MessagesV1Beta3Client.php @@ -46,7 +46,7 @@ * * @experimental * - * @method PromiseInterface listJobMessagesAsync(ListJobMessagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobMessagesAsync(ListJobMessagesRequest $request, array $optionalArgs = []) */ final class MessagesV1Beta3Client { diff --git a/Dataflow/src/V1beta3/Client/MetricsV1Beta3Client.php b/Dataflow/src/V1beta3/Client/MetricsV1Beta3Client.php index 321cdd94f614..f03d546addb9 100644 --- a/Dataflow/src/V1beta3/Client/MetricsV1Beta3Client.php +++ b/Dataflow/src/V1beta3/Client/MetricsV1Beta3Client.php @@ -49,9 +49,9 @@ * * @experimental * - * @method PromiseInterface getJobExecutionDetailsAsync(GetJobExecutionDetailsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobMetricsAsync(GetJobMetricsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStageExecutionDetailsAsync(GetStageExecutionDetailsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobExecutionDetailsAsync(GetJobExecutionDetailsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobMetricsAsync(GetJobMetricsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStageExecutionDetailsAsync(GetStageExecutionDetailsRequest $request, array $optionalArgs = []) */ final class MetricsV1Beta3Client { diff --git a/Dataflow/src/V1beta3/Client/SnapshotsV1Beta3Client.php b/Dataflow/src/V1beta3/Client/SnapshotsV1Beta3Client.php index a00228dcd950..57811b097b94 100644 --- a/Dataflow/src/V1beta3/Client/SnapshotsV1Beta3Client.php +++ b/Dataflow/src/V1beta3/Client/SnapshotsV1Beta3Client.php @@ -49,9 +49,9 @@ * * @experimental * - * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) */ final class SnapshotsV1Beta3Client { diff --git a/Dataflow/src/V1beta3/Client/TemplatesServiceClient.php b/Dataflow/src/V1beta3/Client/TemplatesServiceClient.php index b37ffa9cd3b0..79ffd65edd8b 100644 --- a/Dataflow/src/V1beta3/Client/TemplatesServiceClient.php +++ b/Dataflow/src/V1beta3/Client/TemplatesServiceClient.php @@ -49,9 +49,9 @@ * * @experimental * - * @method PromiseInterface createJobFromTemplateAsync(CreateJobFromTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTemplateAsync(GetTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface launchTemplateAsync(LaunchTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface createJobFromTemplateAsync(CreateJobFromTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTemplateAsync(GetTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface launchTemplateAsync(LaunchTemplateRequest $request, array $optionalArgs = []) */ final class TemplatesServiceClient { diff --git a/DataprocMetastore/src/V1/Client/DataprocMetastoreClient.php b/DataprocMetastore/src/V1/Client/DataprocMetastoreClient.php index 7d0f557f4f16..abb1d708f909 100644 --- a/DataprocMetastore/src/V1/Client/DataprocMetastoreClient.php +++ b/DataprocMetastore/src/V1/Client/DataprocMetastoreClient.php @@ -95,29 +95,29 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMetadataImportAsync(CreateMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportMetadataAsync(ExportMetadataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMetadataImportAsync(GetMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMetadataImportsAsync(ListMetadataImportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveTableToDatabaseAsync(MoveTableToDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryMetadataAsync(QueryMetadataRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreServiceAsync(RestoreServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMetadataImportAsync(UpdateMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMetadataImportAsync(CreateMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportMetadataAsync(ExportMetadataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetadataImportAsync(GetMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMetadataImportsAsync(ListMetadataImportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveTableToDatabaseAsync(MoveTableToDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryMetadataAsync(QueryMetadataRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreServiceAsync(RestoreServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMetadataImportAsync(UpdateMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DataprocMetastoreClient { diff --git a/DataprocMetastore/src/V1/Client/DataprocMetastoreFederationClient.php b/DataprocMetastore/src/V1/Client/DataprocMetastoreFederationClient.php index ac90828d88a2..09f13ab4d721 100644 --- a/DataprocMetastore/src/V1/Client/DataprocMetastoreFederationClient.php +++ b/DataprocMetastore/src/V1/Client/DataprocMetastoreFederationClient.php @@ -75,16 +75,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createFederationAsync(CreateFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFederationAsync(DeleteFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFederationAsync(GetFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFederationsAsync(ListFederationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFederationAsync(UpdateFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFederationAsync(CreateFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFederationAsync(DeleteFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFederationAsync(GetFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFederationsAsync(ListFederationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFederationAsync(UpdateFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DataprocMetastoreFederationClient { diff --git a/DataprocMetastore/src/V1alpha/Client/DataprocMetastoreClient.php b/DataprocMetastore/src/V1alpha/Client/DataprocMetastoreClient.php index f0caa084d55f..01f3fd546288 100644 --- a/DataprocMetastore/src/V1alpha/Client/DataprocMetastoreClient.php +++ b/DataprocMetastore/src/V1alpha/Client/DataprocMetastoreClient.php @@ -101,30 +101,30 @@ * * @experimental * - * @method PromiseInterface alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMetadataImportAsync(CreateMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportMetadataAsync(ExportMetadataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMetadataImportAsync(GetMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMetadataImportsAsync(ListMetadataImportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveTableToDatabaseAsync(MoveTableToDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryMetadataAsync(QueryMetadataRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeIamPolicyAsync(RemoveIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreServiceAsync(RestoreServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMetadataImportAsync(UpdateMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMetadataImportAsync(CreateMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportMetadataAsync(ExportMetadataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetadataImportAsync(GetMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMetadataImportsAsync(ListMetadataImportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveTableToDatabaseAsync(MoveTableToDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryMetadataAsync(QueryMetadataRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeIamPolicyAsync(RemoveIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreServiceAsync(RestoreServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMetadataImportAsync(UpdateMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DataprocMetastoreClient { diff --git a/DataprocMetastore/src/V1alpha/Client/DataprocMetastoreFederationClient.php b/DataprocMetastore/src/V1alpha/Client/DataprocMetastoreFederationClient.php index 31d74cee2139..64ef854e763f 100644 --- a/DataprocMetastore/src/V1alpha/Client/DataprocMetastoreFederationClient.php +++ b/DataprocMetastore/src/V1alpha/Client/DataprocMetastoreFederationClient.php @@ -79,16 +79,16 @@ * * @experimental * - * @method PromiseInterface createFederationAsync(CreateFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFederationAsync(DeleteFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFederationAsync(GetFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFederationsAsync(ListFederationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFederationAsync(UpdateFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFederationAsync(CreateFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFederationAsync(DeleteFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFederationAsync(GetFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFederationsAsync(ListFederationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFederationAsync(UpdateFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DataprocMetastoreFederationClient { diff --git a/DataprocMetastore/src/V1beta/Client/DataprocMetastoreClient.php b/DataprocMetastore/src/V1beta/Client/DataprocMetastoreClient.php index a7ce3eee4872..cb76af48a83b 100644 --- a/DataprocMetastore/src/V1beta/Client/DataprocMetastoreClient.php +++ b/DataprocMetastore/src/V1beta/Client/DataprocMetastoreClient.php @@ -101,30 +101,30 @@ * * @experimental * - * @method PromiseInterface alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMetadataImportAsync(CreateMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportMetadataAsync(ExportMetadataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMetadataImportAsync(GetMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMetadataImportsAsync(ListMetadataImportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveTableToDatabaseAsync(MoveTableToDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryMetadataAsync(QueryMetadataRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeIamPolicyAsync(RemoveIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreServiceAsync(RestoreServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMetadataImportAsync(UpdateMetadataImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMetadataImportAsync(CreateMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServiceAsync(CreateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportMetadataAsync(ExportMetadataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetadataImportAsync(GetMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServiceAsync(GetServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMetadataImportsAsync(ListMetadataImportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServicesAsync(ListServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveTableToDatabaseAsync(MoveTableToDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryMetadataAsync(QueryMetadataRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeIamPolicyAsync(RemoveIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreServiceAsync(RestoreServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMetadataImportAsync(UpdateMetadataImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServiceAsync(UpdateServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DataprocMetastoreClient { diff --git a/DataprocMetastore/src/V1beta/Client/DataprocMetastoreFederationClient.php b/DataprocMetastore/src/V1beta/Client/DataprocMetastoreFederationClient.php index 7e3d104b096f..ab7366cd2378 100644 --- a/DataprocMetastore/src/V1beta/Client/DataprocMetastoreFederationClient.php +++ b/DataprocMetastore/src/V1beta/Client/DataprocMetastoreFederationClient.php @@ -79,16 +79,16 @@ * * @experimental * - * @method PromiseInterface createFederationAsync(CreateFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFederationAsync(DeleteFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFederationAsync(GetFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFederationsAsync(ListFederationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFederationAsync(UpdateFederationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFederationAsync(CreateFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFederationAsync(DeleteFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFederationAsync(GetFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFederationsAsync(ListFederationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFederationAsync(UpdateFederationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DataprocMetastoreFederationClient { diff --git a/Datastore/src/V1/Client/DatastoreClient.php b/Datastore/src/V1/Client/DatastoreClient.php index fb29d1bbbbf3..9f70ddbfce01 100644 --- a/Datastore/src/V1/Client/DatastoreClient.php +++ b/Datastore/src/V1/Client/DatastoreClient.php @@ -62,14 +62,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface allocateIdsAsync(AllocateIdsRequest $request, array $optionalArgs = []) - * @method PromiseInterface beginTransactionAsync(BeginTransactionRequest $request, array $optionalArgs = []) - * @method PromiseInterface commitAsync(CommitRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupAsync(LookupRequest $request, array $optionalArgs = []) - * @method PromiseInterface reserveIdsAsync(ReserveIdsRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackAsync(RollbackRequest $request, array $optionalArgs = []) - * @method PromiseInterface runAggregationQueryAsync(RunAggregationQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface runQueryAsync(RunQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface allocateIdsAsync(AllocateIdsRequest $request, array $optionalArgs = []) + * @method PromiseInterface beginTransactionAsync(BeginTransactionRequest $request, array $optionalArgs = []) + * @method PromiseInterface commitAsync(CommitRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupAsync(LookupRequest $request, array $optionalArgs = []) + * @method PromiseInterface reserveIdsAsync(ReserveIdsRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackAsync(RollbackRequest $request, array $optionalArgs = []) + * @method PromiseInterface runAggregationQueryAsync(RunAggregationQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface runQueryAsync(RunQueryRequest $request, array $optionalArgs = []) */ final class DatastoreClient { diff --git a/DatastoreAdmin/src/V1/Client/DatastoreAdminClient.php b/DatastoreAdmin/src/V1/Client/DatastoreAdminClient.php index cf6a87538cfe..b468a999f5aa 100644 --- a/DatastoreAdmin/src/V1/Client/DatastoreAdminClient.php +++ b/DatastoreAdmin/src/V1/Client/DatastoreAdminClient.php @@ -96,12 +96,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createIndexAsync(CreateIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIndexAsync(DeleteIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportEntitiesAsync(ExportEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIndexAsync(GetIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface importEntitiesAsync(ImportEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIndexesAsync(ListIndexesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIndexAsync(CreateIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIndexAsync(DeleteIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportEntitiesAsync(ExportEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIndexAsync(GetIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface importEntitiesAsync(ImportEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIndexesAsync(ListIndexesRequest $request, array $optionalArgs = []) */ final class DatastoreAdminClient { diff --git a/Debugger/src/V2/Client/Controller2Client.php b/Debugger/src/V2/Client/Controller2Client.php index 1062343d8b49..f3717d781ca9 100644 --- a/Debugger/src/V2/Client/Controller2Client.php +++ b/Debugger/src/V2/Client/Controller2Client.php @@ -64,9 +64,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface listActiveBreakpointsAsync(ListActiveBreakpointsRequest $request, array $optionalArgs = []) - * @method PromiseInterface registerDebuggeeAsync(RegisterDebuggeeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateActiveBreakpointAsync(UpdateActiveBreakpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface listActiveBreakpointsAsync(ListActiveBreakpointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface registerDebuggeeAsync(RegisterDebuggeeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateActiveBreakpointAsync(UpdateActiveBreakpointRequest $request, array $optionalArgs = []) */ final class Controller2Client { diff --git a/Debugger/src/V2/Client/Debugger2Client.php b/Debugger/src/V2/Client/Debugger2Client.php index c03e7d26ad9a..e405da2b92ce 100644 --- a/Debugger/src/V2/Client/Debugger2Client.php +++ b/Debugger/src/V2/Client/Debugger2Client.php @@ -59,11 +59,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteBreakpointAsync(DeleteBreakpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBreakpointAsync(GetBreakpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBreakpointsAsync(ListBreakpointsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDebuggeesAsync(ListDebuggeesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setBreakpointAsync(SetBreakpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBreakpointAsync(DeleteBreakpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBreakpointAsync(GetBreakpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBreakpointsAsync(ListBreakpointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDebuggeesAsync(ListDebuggeesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setBreakpointAsync(SetBreakpointRequest $request, array $optionalArgs = []) */ final class Debugger2Client { diff --git a/DiscoveryEngine/src/V1/Client/CompletionServiceClient.php b/DiscoveryEngine/src/V1/Client/CompletionServiceClient.php index af999a9b198b..c53837de851a 100644 --- a/DiscoveryEngine/src/V1/Client/CompletionServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/CompletionServiceClient.php @@ -54,11 +54,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface completeQueryAsync(CompleteQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface importCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface importSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface completeQueryAsync(CompleteQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface importCompletionSuggestionsAsync(ImportCompletionSuggestionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface importSuggestionDenyListEntriesAsync(ImportSuggestionDenyListEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeCompletionSuggestionsAsync(PurgeCompletionSuggestionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeSuggestionDenyListEntriesAsync(PurgeSuggestionDenyListEntriesRequest $request, array $optionalArgs = []) */ final class CompletionServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/ControlServiceClient.php b/DiscoveryEngine/src/V1/Client/ControlServiceClient.php index d523e97742e3..bf97689be2fa 100644 --- a/DiscoveryEngine/src/V1/Client/ControlServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/ControlServiceClient.php @@ -55,11 +55,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createControlAsync(CreateControlRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteControlAsync(DeleteControlRequest $request, array $optionalArgs = []) - * @method PromiseInterface getControlAsync(GetControlRequest $request, array $optionalArgs = []) - * @method PromiseInterface listControlsAsync(ListControlsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateControlAsync(UpdateControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface createControlAsync(CreateControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteControlAsync(DeleteControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface getControlAsync(GetControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface listControlsAsync(ListControlsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateControlAsync(UpdateControlRequest $request, array $optionalArgs = []) */ final class ControlServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/ConversationalSearchServiceClient.php b/DiscoveryEngine/src/V1/Client/ConversationalSearchServiceClient.php index ea5758441b4d..f281eddeeb06 100644 --- a/DiscoveryEngine/src/V1/Client/ConversationalSearchServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/ConversationalSearchServiceClient.php @@ -64,19 +64,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface answerQueryAsync(AnswerQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface converseConversationAsync(ConverseConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConversationAsync(CreateConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSessionAsync(CreateSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConversationAsync(DeleteConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSessionAsync(DeleteSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAnswerAsync(GetAnswerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConversationAsync(GetConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSessionAsync(GetSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConversationsAsync(ListConversationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSessionsAsync(ListSessionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConversationAsync(UpdateConversationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSessionAsync(UpdateSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface answerQueryAsync(AnswerQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface converseConversationAsync(ConverseConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConversationAsync(CreateConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSessionAsync(CreateSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConversationAsync(DeleteConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSessionAsync(DeleteSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAnswerAsync(GetAnswerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConversationAsync(GetConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSessionAsync(GetSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConversationsAsync(ListConversationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSessionsAsync(ListSessionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConversationAsync(UpdateConversationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSessionAsync(UpdateSessionRequest $request, array $optionalArgs = []) */ final class ConversationalSearchServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/DataStoreServiceClient.php b/DiscoveryEngine/src/V1/Client/DataStoreServiceClient.php index 6009714e4cee..4c335d59f538 100644 --- a/DiscoveryEngine/src/V1/Client/DataStoreServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/DataStoreServiceClient.php @@ -56,11 +56,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDataStoreAsync(CreateDataStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataStoreAsync(DeleteDataStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataStoreAsync(GetDataStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataStoresAsync(ListDataStoresRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDataStoreAsync(UpdateDataStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataStoreAsync(CreateDataStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataStoreAsync(DeleteDataStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataStoreAsync(GetDataStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataStoresAsync(ListDataStoresRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDataStoreAsync(UpdateDataStoreRequest $request, array $optionalArgs = []) */ final class DataStoreServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/DocumentServiceClient.php b/DiscoveryEngine/src/V1/Client/DocumentServiceClient.php index c51bd037fcde..e116ea207943 100644 --- a/DiscoveryEngine/src/V1/Client/DocumentServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/DocumentServiceClient.php @@ -60,14 +60,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchGetDocumentsMetadataAsync(BatchGetDocumentsMetadataRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDocumentAsync(CreateDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDocumentAsync(DeleteDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDocumentAsync(GetDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface importDocumentsAsync(ImportDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDocumentsAsync(ListDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeDocumentsAsync(PurgeDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDocumentAsync(UpdateDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchGetDocumentsMetadataAsync(BatchGetDocumentsMetadataRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDocumentAsync(CreateDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDocumentAsync(DeleteDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDocumentAsync(GetDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface importDocumentsAsync(ImportDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDocumentsAsync(ListDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeDocumentsAsync(PurgeDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDocumentAsync(UpdateDocumentRequest $request, array $optionalArgs = []) */ final class DocumentServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/EngineServiceClient.php b/DiscoveryEngine/src/V1/Client/EngineServiceClient.php index 990f2790f9ea..6c22b0e26575 100644 --- a/DiscoveryEngine/src/V1/Client/EngineServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/EngineServiceClient.php @@ -56,11 +56,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEngineAsync(CreateEngineRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEngineAsync(DeleteEngineRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEngineAsync(GetEngineRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEnginesAsync(ListEnginesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEngineAsync(UpdateEngineRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEngineAsync(CreateEngineRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEngineAsync(DeleteEngineRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEngineAsync(GetEngineRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEnginesAsync(ListEnginesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEngineAsync(UpdateEngineRequest $request, array $optionalArgs = []) */ final class EngineServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/GroundedGenerationServiceClient.php b/DiscoveryEngine/src/V1/Client/GroundedGenerationServiceClient.php index 3db7e4412924..cbef26076282 100644 --- a/DiscoveryEngine/src/V1/Client/GroundedGenerationServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/GroundedGenerationServiceClient.php @@ -50,8 +50,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface checkGroundingAsync(CheckGroundingRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateGroundedContentAsync(GenerateGroundedContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkGroundingAsync(CheckGroundingRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateGroundedContentAsync(GenerateGroundedContentRequest $request, array $optionalArgs = []) */ final class GroundedGenerationServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/ProjectServiceClient.php b/DiscoveryEngine/src/V1/Client/ProjectServiceClient.php index 823048011f72..76486d858553 100644 --- a/DiscoveryEngine/src/V1/Client/ProjectServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/ProjectServiceClient.php @@ -51,7 +51,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface provisionProjectAsync(ProvisionProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface provisionProjectAsync(ProvisionProjectRequest $request, array $optionalArgs = []) */ final class ProjectServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/RankServiceClient.php b/DiscoveryEngine/src/V1/Client/RankServiceClient.php index c6e880be9f01..9f5a2dd191ef 100644 --- a/DiscoveryEngine/src/V1/Client/RankServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/RankServiceClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface rankAsync(RankRequest $request, array $optionalArgs = []) + * @method PromiseInterface rankAsync(RankRequest $request, array $optionalArgs = []) */ final class RankServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/RecommendationServiceClient.php b/DiscoveryEngine/src/V1/Client/RecommendationServiceClient.php index 463a8cf4b7ca..fd633d575aa6 100644 --- a/DiscoveryEngine/src/V1/Client/RecommendationServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/RecommendationServiceClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface recommendAsync(RecommendRequest $request, array $optionalArgs = []) + * @method PromiseInterface recommendAsync(RecommendRequest $request, array $optionalArgs = []) */ final class RecommendationServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/SchemaServiceClient.php b/DiscoveryEngine/src/V1/Client/SchemaServiceClient.php index 351e4eed67c4..686257062529 100644 --- a/DiscoveryEngine/src/V1/Client/SchemaServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/SchemaServiceClient.php @@ -55,11 +55,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSchemaAsync(CreateSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSchemaAsync(DeleteSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSchemaAsync(GetSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSchemasAsync(ListSchemasRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSchemaAsync(UpdateSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSchemaAsync(CreateSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSchemaAsync(DeleteSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSchemaAsync(GetSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSchemasAsync(ListSchemasRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSchemaAsync(UpdateSchemaRequest $request, array $optionalArgs = []) */ final class SchemaServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/SearchServiceClient.php b/DiscoveryEngine/src/V1/Client/SearchServiceClient.php index e7c1a1e368e2..0ea840586734 100644 --- a/DiscoveryEngine/src/V1/Client/SearchServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/SearchServiceClient.php @@ -47,8 +47,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface searchAsync(SearchRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchLiteAsync(SearchRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchAsync(SearchRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchLiteAsync(SearchRequest $request, array $optionalArgs = []) */ final class SearchServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/SearchTuningServiceClient.php b/DiscoveryEngine/src/V1/Client/SearchTuningServiceClient.php index 14e2d82cb606..4035eba73cea 100644 --- a/DiscoveryEngine/src/V1/Client/SearchTuningServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/SearchTuningServiceClient.php @@ -51,8 +51,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface listCustomModelsAsync(ListCustomModelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface trainCustomModelAsync(TrainCustomModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomModelsAsync(ListCustomModelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface trainCustomModelAsync(TrainCustomModelRequest $request, array $optionalArgs = []) */ final class SearchTuningServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/SiteSearchEngineServiceClient.php b/DiscoveryEngine/src/V1/Client/SiteSearchEngineServiceClient.php index 8352c0540ac4..c6e1c174295e 100644 --- a/DiscoveryEngine/src/V1/Client/SiteSearchEngineServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/SiteSearchEngineServiceClient.php @@ -63,18 +63,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateTargetSitesAsync(BatchCreateTargetSitesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTargetSiteAsync(CreateTargetSiteRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTargetSiteAsync(DeleteTargetSiteRequest $request, array $optionalArgs = []) - * @method PromiseInterface disableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchDomainVerificationStatusAsync(FetchDomainVerificationStatusRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSiteSearchEngineAsync(GetSiteSearchEngineRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTargetSiteAsync(GetTargetSiteRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTargetSitesAsync(ListTargetSitesRequest $request, array $optionalArgs = []) - * @method PromiseInterface recrawlUrisAsync(RecrawlUrisRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTargetSiteAsync(UpdateTargetSiteRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateTargetSitesAsync(BatchCreateTargetSitesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTargetSiteAsync(CreateTargetSiteRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTargetSiteAsync(DeleteTargetSiteRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchDomainVerificationStatusAsync(FetchDomainVerificationStatusRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSiteSearchEngineAsync(GetSiteSearchEngineRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTargetSiteAsync(GetTargetSiteRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTargetSitesAsync(ListTargetSitesRequest $request, array $optionalArgs = []) + * @method PromiseInterface recrawlUrisAsync(RecrawlUrisRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTargetSiteAsync(UpdateTargetSiteRequest $request, array $optionalArgs = []) */ final class SiteSearchEngineServiceClient { diff --git a/DiscoveryEngine/src/V1/Client/UserEventServiceClient.php b/DiscoveryEngine/src/V1/Client/UserEventServiceClient.php index 6434bb6e26f0..c846478561be 100644 --- a/DiscoveryEngine/src/V1/Client/UserEventServiceClient.php +++ b/DiscoveryEngine/src/V1/Client/UserEventServiceClient.php @@ -54,10 +54,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface collectUserEventAsync(CollectUserEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface importUserEventsAsync(ImportUserEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeUserEventsAsync(PurgeUserEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface writeUserEventAsync(WriteUserEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface collectUserEventAsync(CollectUserEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface importUserEventsAsync(ImportUserEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeUserEventsAsync(PurgeUserEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface writeUserEventAsync(WriteUserEventRequest $request, array $optionalArgs = []) */ final class UserEventServiceClient { diff --git a/Dlp/src/V2/Client/DlpServiceClient.php b/Dlp/src/V2/Client/DlpServiceClient.php index f90d8b555805..c0275f3e0932 100644 --- a/Dlp/src/V2/Client/DlpServiceClient.php +++ b/Dlp/src/V2/Client/DlpServiceClient.php @@ -122,61 +122,61 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface activateJobTriggerAsync(ActivateJobTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelDlpJobAsync(CancelDlpJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createConnectionAsync(CreateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDeidentifyTemplateAsync(CreateDeidentifyTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDiscoveryConfigAsync(CreateDiscoveryConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDlpJobAsync(CreateDlpJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInspectTemplateAsync(CreateInspectTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface createJobTriggerAsync(CreateJobTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface createStoredInfoTypeAsync(CreateStoredInfoTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deidentifyContentAsync(DeidentifyContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectionAsync(DeleteConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDeidentifyTemplateAsync(DeleteDeidentifyTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDiscoveryConfigAsync(DeleteDiscoveryConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDlpJobAsync(DeleteDlpJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFileStoreDataProfileAsync(DeleteFileStoreDataProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInspectTemplateAsync(DeleteInspectTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteJobTriggerAsync(DeleteJobTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteStoredInfoTypeAsync(DeleteStoredInfoTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTableDataProfileAsync(DeleteTableDataProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface finishDlpJobAsync(FinishDlpJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getColumnDataProfileAsync(GetColumnDataProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectionAsync(GetConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDeidentifyTemplateAsync(GetDeidentifyTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDiscoveryConfigAsync(GetDiscoveryConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDlpJobAsync(GetDlpJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFileStoreDataProfileAsync(GetFileStoreDataProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInspectTemplateAsync(GetInspectTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobTriggerAsync(GetJobTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProjectDataProfileAsync(GetProjectDataProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStoredInfoTypeAsync(GetStoredInfoTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTableDataProfileAsync(GetTableDataProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface hybridInspectDlpJobAsync(HybridInspectDlpJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface hybridInspectJobTriggerAsync(HybridInspectJobTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface inspectContentAsync(InspectContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listColumnDataProfilesAsync(ListColumnDataProfilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeidentifyTemplatesAsync(ListDeidentifyTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDiscoveryConfigsAsync(ListDiscoveryConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDlpJobsAsync(ListDlpJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFileStoreDataProfilesAsync(ListFileStoreDataProfilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInfoTypesAsync(ListInfoTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInspectTemplatesAsync(ListInspectTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobTriggersAsync(ListJobTriggersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProjectDataProfilesAsync(ListProjectDataProfilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listStoredInfoTypesAsync(ListStoredInfoTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTableDataProfilesAsync(ListTableDataProfilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface redactImageAsync(RedactImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface reidentifyContentAsync(ReidentifyContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchConnectionsAsync(SearchConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateConnectionAsync(UpdateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDeidentifyTemplateAsync(UpdateDeidentifyTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDiscoveryConfigAsync(UpdateDiscoveryConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInspectTemplateAsync(UpdateInspectTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateJobTriggerAsync(UpdateJobTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateStoredInfoTypeAsync(UpdateStoredInfoTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface activateJobTriggerAsync(ActivateJobTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelDlpJobAsync(CancelDlpJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectionAsync(CreateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeidentifyTemplateAsync(CreateDeidentifyTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDiscoveryConfigAsync(CreateDiscoveryConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDlpJobAsync(CreateDlpJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInspectTemplateAsync(CreateInspectTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface createJobTriggerAsync(CreateJobTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface createStoredInfoTypeAsync(CreateStoredInfoTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deidentifyContentAsync(DeidentifyContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectionAsync(DeleteConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDeidentifyTemplateAsync(DeleteDeidentifyTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDiscoveryConfigAsync(DeleteDiscoveryConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDlpJobAsync(DeleteDlpJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFileStoreDataProfileAsync(DeleteFileStoreDataProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInspectTemplateAsync(DeleteInspectTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteJobTriggerAsync(DeleteJobTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteStoredInfoTypeAsync(DeleteStoredInfoTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTableDataProfileAsync(DeleteTableDataProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface finishDlpJobAsync(FinishDlpJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getColumnDataProfileAsync(GetColumnDataProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectionAsync(GetConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeidentifyTemplateAsync(GetDeidentifyTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDiscoveryConfigAsync(GetDiscoveryConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDlpJobAsync(GetDlpJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFileStoreDataProfileAsync(GetFileStoreDataProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInspectTemplateAsync(GetInspectTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobTriggerAsync(GetJobTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProjectDataProfileAsync(GetProjectDataProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStoredInfoTypeAsync(GetStoredInfoTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTableDataProfileAsync(GetTableDataProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface hybridInspectDlpJobAsync(HybridInspectDlpJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface hybridInspectJobTriggerAsync(HybridInspectJobTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface inspectContentAsync(InspectContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listColumnDataProfilesAsync(ListColumnDataProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectionsAsync(ListConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeidentifyTemplatesAsync(ListDeidentifyTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDiscoveryConfigsAsync(ListDiscoveryConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDlpJobsAsync(ListDlpJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFileStoreDataProfilesAsync(ListFileStoreDataProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInfoTypesAsync(ListInfoTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInspectTemplatesAsync(ListInspectTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobTriggersAsync(ListJobTriggersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProjectDataProfilesAsync(ListProjectDataProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listStoredInfoTypesAsync(ListStoredInfoTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTableDataProfilesAsync(ListTableDataProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface redactImageAsync(RedactImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface reidentifyContentAsync(ReidentifyContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchConnectionsAsync(SearchConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateConnectionAsync(UpdateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDeidentifyTemplateAsync(UpdateDeidentifyTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDiscoveryConfigAsync(UpdateDiscoveryConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInspectTemplateAsync(UpdateInspectTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateJobTriggerAsync(UpdateJobTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateStoredInfoTypeAsync(UpdateStoredInfoTypeRequest $request, array $optionalArgs = []) */ final class DlpServiceClient { diff --git a/DocumentAi/src/V1/Client/DocumentProcessorServiceClient.php b/DocumentAi/src/V1/Client/DocumentProcessorServiceClient.php index 9eb2bbcbb5df..6cd7a4037ea3 100644 --- a/DocumentAi/src/V1/Client/DocumentProcessorServiceClient.php +++ b/DocumentAi/src/V1/Client/DocumentProcessorServiceClient.php @@ -84,30 +84,30 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchProcessDocumentsAsync(BatchProcessRequest $request, array $optionalArgs = []) - * @method PromiseInterface createProcessorAsync(CreateProcessorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteProcessorAsync(DeleteProcessorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteProcessorVersionAsync(DeleteProcessorVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deployProcessorVersionAsync(DeployProcessorVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface disableProcessorAsync(DisableProcessorRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableProcessorAsync(EnableProcessorRequest $request, array $optionalArgs = []) - * @method PromiseInterface evaluateProcessorVersionAsync(EvaluateProcessorVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchProcessorTypesAsync(FetchProcessorTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEvaluationAsync(GetEvaluationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProcessorAsync(GetProcessorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProcessorTypeAsync(GetProcessorTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProcessorVersionAsync(GetProcessorVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEvaluationsAsync(ListEvaluationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProcessorTypesAsync(ListProcessorTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProcessorVersionsAsync(ListProcessorVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProcessorsAsync(ListProcessorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface processDocumentAsync(ProcessRequest $request, array $optionalArgs = []) - * @method PromiseInterface reviewDocumentAsync(ReviewDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface setDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface trainProcessorVersionAsync(TrainProcessorVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeployProcessorVersionAsync(UndeployProcessorVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchProcessDocumentsAsync(BatchProcessRequest $request, array $optionalArgs = []) + * @method PromiseInterface createProcessorAsync(CreateProcessorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteProcessorAsync(DeleteProcessorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteProcessorVersionAsync(DeleteProcessorVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deployProcessorVersionAsync(DeployProcessorVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableProcessorAsync(DisableProcessorRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableProcessorAsync(EnableProcessorRequest $request, array $optionalArgs = []) + * @method PromiseInterface evaluateProcessorVersionAsync(EvaluateProcessorVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchProcessorTypesAsync(FetchProcessorTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEvaluationAsync(GetEvaluationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProcessorAsync(GetProcessorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProcessorTypeAsync(GetProcessorTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProcessorVersionAsync(GetProcessorVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEvaluationsAsync(ListEvaluationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProcessorTypesAsync(ListProcessorTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProcessorVersionsAsync(ListProcessorVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProcessorsAsync(ListProcessorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface processDocumentAsync(ProcessRequest $request, array $optionalArgs = []) + * @method PromiseInterface reviewDocumentAsync(ReviewDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface setDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface trainProcessorVersionAsync(TrainProcessorVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeployProcessorVersionAsync(UndeployProcessorVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class DocumentProcessorServiceClient { diff --git a/Domains/src/V1/Client/DomainsClient.php b/Domains/src/V1/Client/DomainsClient.php index ff35955ba299..b2c1303f298e 100644 --- a/Domains/src/V1/Client/DomainsClient.php +++ b/Domains/src/V1/Client/DomainsClient.php @@ -69,21 +69,21 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface configureContactSettingsAsync(ConfigureContactSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface configureDnsSettingsAsync(ConfigureDnsSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface configureManagementSettingsAsync(ConfigureManagementSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRegistrationAsync(DeleteRegistrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportRegistrationAsync(ExportRegistrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRegistrationAsync(GetRegistrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRegistrationsAsync(ListRegistrationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface registerDomainAsync(RegisterDomainRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetAuthorizationCodeAsync(ResetAuthorizationCodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface retrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface retrieveRegisterParametersAsync(RetrieveRegisterParametersRequest $request, array $optionalArgs = []) - * @method PromiseInterface retrieveTransferParametersAsync(RetrieveTransferParametersRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchDomainsAsync(SearchDomainsRequest $request, array $optionalArgs = []) - * @method PromiseInterface transferDomainAsync(TransferDomainRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRegistrationAsync(UpdateRegistrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface configureContactSettingsAsync(ConfigureContactSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface configureDnsSettingsAsync(ConfigureDnsSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface configureManagementSettingsAsync(ConfigureManagementSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRegistrationAsync(DeleteRegistrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportRegistrationAsync(ExportRegistrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRegistrationAsync(GetRegistrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRegistrationsAsync(ListRegistrationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface registerDomainAsync(RegisterDomainRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetAuthorizationCodeAsync(ResetAuthorizationCodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface retrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface retrieveRegisterParametersAsync(RetrieveRegisterParametersRequest $request, array $optionalArgs = []) + * @method PromiseInterface retrieveTransferParametersAsync(RetrieveTransferParametersRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchDomainsAsync(SearchDomainsRequest $request, array $optionalArgs = []) + * @method PromiseInterface transferDomainAsync(TransferDomainRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRegistrationAsync(UpdateRegistrationRequest $request, array $optionalArgs = []) */ final class DomainsClient { diff --git a/EdgeNetwork/src/V1/Client/EdgeNetworkClient.php b/EdgeNetwork/src/V1/Client/EdgeNetworkClient.php index 2f9698673548..b2a7980b3fdc 100644 --- a/EdgeNetwork/src/V1/Client/EdgeNetworkClient.php +++ b/EdgeNetwork/src/V1/Client/EdgeNetworkClient.php @@ -91,34 +91,34 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createInterconnectAttachmentAsync(CreateInterconnectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNetworkAsync(CreateNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRouterAsync(CreateRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSubnetAsync(CreateSubnetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInterconnectAttachmentAsync(DeleteInterconnectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNetworkAsync(DeleteNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRouterAsync(DeleteRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSubnetAsync(DeleteSubnetRequest $request, array $optionalArgs = []) - * @method PromiseInterface diagnoseInterconnectAsync(DiagnoseInterconnectRequest $request, array $optionalArgs = []) - * @method PromiseInterface diagnoseNetworkAsync(DiagnoseNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface diagnoseRouterAsync(DiagnoseRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInterconnectAsync(GetInterconnectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInterconnectAttachmentAsync(GetInterconnectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNetworkAsync(GetNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRouterAsync(GetRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSubnetAsync(GetSubnetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getZoneAsync(GetZoneRequest $request, array $optionalArgs = []) - * @method PromiseInterface initializeZoneAsync(InitializeZoneRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInterconnectAttachmentsAsync(ListInterconnectAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInterconnectsAsync(ListInterconnectsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworksAsync(ListNetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRoutersAsync(ListRoutersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSubnetsAsync(ListSubnetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listZonesAsync(ListZonesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRouterAsync(UpdateRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSubnetAsync(UpdateSubnetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInterconnectAttachmentAsync(CreateInterconnectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNetworkAsync(CreateNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRouterAsync(CreateRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSubnetAsync(CreateSubnetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInterconnectAttachmentAsync(DeleteInterconnectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNetworkAsync(DeleteNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRouterAsync(DeleteRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSubnetAsync(DeleteSubnetRequest $request, array $optionalArgs = []) + * @method PromiseInterface diagnoseInterconnectAsync(DiagnoseInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface diagnoseNetworkAsync(DiagnoseNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface diagnoseRouterAsync(DiagnoseRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInterconnectAsync(GetInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInterconnectAttachmentAsync(GetInterconnectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNetworkAsync(GetNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRouterAsync(GetRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSubnetAsync(GetSubnetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getZoneAsync(GetZoneRequest $request, array $optionalArgs = []) + * @method PromiseInterface initializeZoneAsync(InitializeZoneRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInterconnectAttachmentsAsync(ListInterconnectAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInterconnectsAsync(ListInterconnectsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworksAsync(ListNetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRoutersAsync(ListRoutersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSubnetsAsync(ListSubnetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listZonesAsync(ListZonesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRouterAsync(UpdateRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSubnetAsync(UpdateSubnetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class EdgeNetworkClient { diff --git a/ErrorReporting/src/V1beta1/Client/ErrorGroupServiceClient.php b/ErrorReporting/src/V1beta1/Client/ErrorGroupServiceClient.php index 0f1239705ae3..82b833935773 100644 --- a/ErrorReporting/src/V1beta1/Client/ErrorGroupServiceClient.php +++ b/ErrorReporting/src/V1beta1/Client/ErrorGroupServiceClient.php @@ -52,8 +52,8 @@ * * @experimental * - * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGroupAsync(UpdateGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGroupAsync(UpdateGroupRequest $request, array $optionalArgs = []) */ final class ErrorGroupServiceClient { diff --git a/ErrorReporting/src/V1beta1/Client/ErrorStatsServiceClient.php b/ErrorReporting/src/V1beta1/Client/ErrorStatsServiceClient.php index 58b77c53ff0d..9b621234b09a 100644 --- a/ErrorReporting/src/V1beta1/Client/ErrorStatsServiceClient.php +++ b/ErrorReporting/src/V1beta1/Client/ErrorStatsServiceClient.php @@ -55,9 +55,9 @@ * * @experimental * - * @method PromiseInterface deleteEventsAsync(DeleteEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEventsAsync(ListEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGroupStatsAsync(ListGroupStatsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEventsAsync(DeleteEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEventsAsync(ListEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGroupStatsAsync(ListGroupStatsRequest $request, array $optionalArgs = []) */ final class ErrorStatsServiceClient { diff --git a/ErrorReporting/src/V1beta1/Client/ReportErrorsServiceClient.php b/ErrorReporting/src/V1beta1/Client/ReportErrorsServiceClient.php index 2415de684475..c9177e5fef1a 100644 --- a/ErrorReporting/src/V1beta1/Client/ReportErrorsServiceClient.php +++ b/ErrorReporting/src/V1beta1/Client/ReportErrorsServiceClient.php @@ -51,7 +51,7 @@ * * @experimental * - * @method PromiseInterface reportErrorEventAsync(ReportErrorEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface reportErrorEventAsync(ReportErrorEventRequest $request, array $optionalArgs = []) */ final class ReportErrorsServiceClient { diff --git a/EssentialContacts/src/V1/Client/EssentialContactsServiceClient.php b/EssentialContacts/src/V1/Client/EssentialContactsServiceClient.php index b9a6ddbf1f35..71aa81debb17 100644 --- a/EssentialContacts/src/V1/Client/EssentialContactsServiceClient.php +++ b/EssentialContacts/src/V1/Client/EssentialContactsServiceClient.php @@ -54,13 +54,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface computeContactsAsync(ComputeContactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createContactAsync(CreateContactRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteContactAsync(DeleteContactRequest $request, array $optionalArgs = []) - * @method PromiseInterface getContactAsync(GetContactRequest $request, array $optionalArgs = []) - * @method PromiseInterface listContactsAsync(ListContactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface sendTestMessageAsync(SendTestMessageRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateContactAsync(UpdateContactRequest $request, array $optionalArgs = []) + * @method PromiseInterface computeContactsAsync(ComputeContactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createContactAsync(CreateContactRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteContactAsync(DeleteContactRequest $request, array $optionalArgs = []) + * @method PromiseInterface getContactAsync(GetContactRequest $request, array $optionalArgs = []) + * @method PromiseInterface listContactsAsync(ListContactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface sendTestMessageAsync(SendTestMessageRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateContactAsync(UpdateContactRequest $request, array $optionalArgs = []) */ final class EssentialContactsServiceClient { diff --git a/Eventarc/src/V1/Client/EventarcClient.php b/Eventarc/src/V1/Client/EventarcClient.php index 75b327f6e27c..1909e54d0b5f 100644 --- a/Eventarc/src/V1/Client/EventarcClient.php +++ b/Eventarc/src/V1/Client/EventarcClient.php @@ -106,50 +106,50 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createChannelAsync(CreateChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface createChannelConnectionAsync(CreateChannelConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEnrollmentAsync(CreateEnrollmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGoogleApiSourceAsync(CreateGoogleApiSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMessageBusAsync(CreateMessageBusRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPipelineAsync(CreatePipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTriggerAsync(CreateTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteChannelAsync(DeleteChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteChannelConnectionAsync(DeleteChannelConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEnrollmentAsync(DeleteEnrollmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGoogleApiSourceAsync(DeleteGoogleApiSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMessageBusAsync(DeleteMessageBusRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePipelineAsync(DeletePipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTriggerAsync(DeleteTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getChannelAsync(GetChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getChannelConnectionAsync(GetChannelConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEnrollmentAsync(GetEnrollmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGoogleApiSourceAsync(GetGoogleApiSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGoogleChannelConfigAsync(GetGoogleChannelConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMessageBusAsync(GetMessageBusRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPipelineAsync(GetPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProviderAsync(GetProviderRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTriggerAsync(GetTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface listChannelConnectionsAsync(ListChannelConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listChannelsAsync(ListChannelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEnrollmentsAsync(ListEnrollmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGoogleApiSourcesAsync(ListGoogleApiSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMessageBusEnrollmentsAsync(ListMessageBusEnrollmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMessageBusesAsync(ListMessageBusesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPipelinesAsync(ListPipelinesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProvidersAsync(ListProvidersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTriggersAsync(ListTriggersRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateChannelAsync(UpdateChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEnrollmentAsync(UpdateEnrollmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGoogleApiSourceAsync(UpdateGoogleApiSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGoogleChannelConfigAsync(UpdateGoogleChannelConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMessageBusAsync(UpdateMessageBusRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePipelineAsync(UpdatePipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTriggerAsync(UpdateTriggerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createChannelAsync(CreateChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createChannelConnectionAsync(CreateChannelConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEnrollmentAsync(CreateEnrollmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGoogleApiSourceAsync(CreateGoogleApiSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMessageBusAsync(CreateMessageBusRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPipelineAsync(CreatePipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTriggerAsync(CreateTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteChannelAsync(DeleteChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteChannelConnectionAsync(DeleteChannelConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEnrollmentAsync(DeleteEnrollmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGoogleApiSourceAsync(DeleteGoogleApiSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMessageBusAsync(DeleteMessageBusRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePipelineAsync(DeletePipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTriggerAsync(DeleteTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getChannelAsync(GetChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getChannelConnectionAsync(GetChannelConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEnrollmentAsync(GetEnrollmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGoogleApiSourceAsync(GetGoogleApiSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGoogleChannelConfigAsync(GetGoogleChannelConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMessageBusAsync(GetMessageBusRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPipelineAsync(GetPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProviderAsync(GetProviderRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTriggerAsync(GetTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listChannelConnectionsAsync(ListChannelConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listChannelsAsync(ListChannelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEnrollmentsAsync(ListEnrollmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGoogleApiSourcesAsync(ListGoogleApiSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMessageBusEnrollmentsAsync(ListMessageBusEnrollmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMessageBusesAsync(ListMessageBusesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPipelinesAsync(ListPipelinesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProvidersAsync(ListProvidersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTriggersAsync(ListTriggersRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateChannelAsync(UpdateChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEnrollmentAsync(UpdateEnrollmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGoogleApiSourceAsync(UpdateGoogleApiSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGoogleChannelConfigAsync(UpdateGoogleChannelConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMessageBusAsync(UpdateMessageBusRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePipelineAsync(UpdatePipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTriggerAsync(UpdateTriggerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class EventarcClient { diff --git a/EventarcPublishing/src/V1/Client/PublisherClient.php b/EventarcPublishing/src/V1/Client/PublisherClient.php index 5598ecb5fb68..08b94a2150dc 100644 --- a/EventarcPublishing/src/V1/Client/PublisherClient.php +++ b/EventarcPublishing/src/V1/Client/PublisherClient.php @@ -69,9 +69,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface publishAsync(PublishRequest $request, array $optionalArgs = []) - * @method PromiseInterface publishChannelConnectionEventsAsync(PublishChannelConnectionEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface publishEventsAsync(PublishEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface publishAsync(PublishRequest $request, array $optionalArgs = []) + * @method PromiseInterface publishChannelConnectionEventsAsync(PublishChannelConnectionEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface publishEventsAsync(PublishEventsRequest $request, array $optionalArgs = []) */ final class PublisherClient { From 8ae7f4345bb3338686b0d3f04afd4aed0740752c Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:17:55 -0800 Subject: [PATCH 075/157] chore: add types for async methods (#7800) PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiRmlsZXN0b3JlLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiRmlyZXN0b3JlLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiRnVuY3Rpb25zLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiR1N1aXRlQWRkT25zLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiR2tlQmFja3VwLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiR2tlQ29ubmVjdEdhdGV3YXkvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiR2tlSHViLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiR2tlTXVsdGlDbG91ZC8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiR3JhZmVhcy8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiSWFtLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiSWFtQ3JlZGVudGlhbHMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiSWFwLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiSWRzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiS21zLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiS21zSW52ZW50b3J5Ly5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTGFuZ3VhZ2UvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiTGlmZVNjaWVuY2VzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiTG9nZ2luZy8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiTG9uZ1J1bm5pbmcvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiTWFuYWdlZElkZW50aXRpZXMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== --- .../V1/Client/CloudFilestoreManagerClient.php | 34 +++++----- .../Admin/V1/Client/FirestoreAdminClient.php | 48 +++++++------- Firestore/src/V1/Client/FirestoreClient.php | 22 +++---- .../src/V2/Client/FunctionServiceClient.php | 24 +++---- .../src/V1/Client/GSuiteAddOnsClient.php | 18 ++--- .../src/V1/Client/BackupForGKEClient.php | 60 ++++++++--------- .../src/V1/Client/GatewayControlClient.php | 2 +- .../V1beta1/Client/GatewayControlClient.php | 2 +- GkeHub/src/V1/Client/GkeHubClient.php | 22 +++---- .../src/V1/Client/AttachedClustersClient.php | 18 ++--- .../src/V1/Client/AwsClustersClient.php | 32 ++++----- .../src/V1/Client/AzureClustersClient.php | 38 +++++------ Grafeas/src/V1/Client/GrafeasClient.php | 28 ++++---- Iam/src/V2/Client/PoliciesClient.php | 10 +-- .../src/V1/Client/IAMCredentialsClient.php | 8 +-- .../IdentityAwareProxyAdminServiceClient.php | 20 +++--- .../IdentityAwareProxyOAuthServiceClient.php | 16 ++--- Ids/src/V1/Client/IDSClient.php | 8 +-- Kms/src/V1/Client/AutokeyAdminClient.php | 16 ++--- Kms/src/V1/Client/AutokeyClient.php | 16 ++--- Kms/src/V1/Client/EkmServiceClient.php | 24 +++---- .../V1/Client/KeyManagementServiceClient.php | 66 +++++++++---------- .../V1/Client/KeyDashboardServiceClient.php | 2 +- .../V1/Client/KeyTrackingServiceClient.php | 4 +- .../src/V1/Client/LanguageServiceClient.php | 14 ++-- .../src/V2/Client/LanguageServiceClient.php | 10 +-- .../Client/WorkflowsServiceV2BetaClient.php | 6 +- .../src/V2/Client/ConfigServiceV2Client.php | 64 +++++++++--------- .../src/V2/Client/LoggingServiceV2Client.php | 10 +-- .../src/V2/Client/MetricsServiceV2Client.php | 10 +-- .../LongRunning/Client/OperationsClient.php | 10 +-- .../Client/ManagedIdentitiesServiceClient.php | 20 +++--- 32 files changed, 341 insertions(+), 341 deletions(-) diff --git a/Filestore/src/V1/Client/CloudFilestoreManagerClient.php b/Filestore/src/V1/Client/CloudFilestoreManagerClient.php index 7ad54976946d..0b16c2797297 100644 --- a/Filestore/src/V1/Client/CloudFilestoreManagerClient.php +++ b/Filestore/src/V1/Client/CloudFilestoreManagerClient.php @@ -87,23 +87,23 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSnapshotAsync(CreateSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreInstanceAsync(RestoreInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface revertInstanceAsync(RevertInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSnapshotAsync(UpdateSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSnapshotAsync(CreateSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreInstanceAsync(RestoreInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface revertInstanceAsync(RevertInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSnapshotAsync(UpdateSnapshotRequest $request, array $optionalArgs = []) */ final class CloudFilestoreManagerClient { diff --git a/Firestore/src/Admin/V1/Client/FirestoreAdminClient.php b/Firestore/src/Admin/V1/Client/FirestoreAdminClient.php index 25b77d4c3622..93557144d22f 100644 --- a/Firestore/src/Admin/V1/Client/FirestoreAdminClient.php +++ b/Firestore/src/Admin/V1/Client/FirestoreAdminClient.php @@ -111,30 +111,30 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface bulkDeleteDocumentsAsync(BulkDeleteDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupScheduleAsync(CreateBackupScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDatabaseAsync(CreateDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface createIndexAsync(CreateIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupScheduleAsync(DeleteBackupScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDatabaseAsync(DeleteDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIndexAsync(DeleteIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportDocumentsAsync(ExportDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupScheduleAsync(GetBackupScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDatabaseAsync(GetDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFieldAsync(GetFieldRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIndexAsync(GetIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface importDocumentsAsync(ImportDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupSchedulesAsync(ListBackupSchedulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatabasesAsync(ListDatabasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFieldsAsync(ListFieldsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIndexesAsync(ListIndexesRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreDatabaseAsync(RestoreDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupScheduleAsync(UpdateBackupScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDatabaseAsync(UpdateDatabaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFieldAsync(UpdateFieldRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkDeleteDocumentsAsync(BulkDeleteDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupScheduleAsync(CreateBackupScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDatabaseAsync(CreateDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIndexAsync(CreateIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupScheduleAsync(DeleteBackupScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDatabaseAsync(DeleteDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIndexAsync(DeleteIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportDocumentsAsync(ExportDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupScheduleAsync(GetBackupScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDatabaseAsync(GetDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFieldAsync(GetFieldRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIndexAsync(GetIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface importDocumentsAsync(ImportDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupSchedulesAsync(ListBackupSchedulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatabasesAsync(ListDatabasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFieldsAsync(ListFieldsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIndexesAsync(ListIndexesRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreDatabaseAsync(RestoreDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupScheduleAsync(UpdateBackupScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDatabaseAsync(UpdateDatabaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFieldAsync(UpdateFieldRequest $request, array $optionalArgs = []) */ final class FirestoreAdminClient { diff --git a/Firestore/src/V1/Client/FirestoreClient.php b/Firestore/src/V1/Client/FirestoreClient.php index dfaab45eb9ce..7d0cacc33b8e 100644 --- a/Firestore/src/V1/Client/FirestoreClient.php +++ b/Firestore/src/V1/Client/FirestoreClient.php @@ -68,17 +68,17 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface batchWriteAsync(BatchWriteRequest $request, array $optionalArgs = []) - * @method PromiseInterface beginTransactionAsync(BeginTransactionRequest $request, array $optionalArgs = []) - * @method PromiseInterface commitAsync(CommitRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDocumentAsync(CreateDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDocumentAsync(DeleteDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDocumentAsync(GetDocumentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCollectionIdsAsync(ListCollectionIdsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDocumentsAsync(ListDocumentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface partitionQueryAsync(PartitionQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackAsync(RollbackRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDocumentAsync(UpdateDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchWriteAsync(BatchWriteRequest $request, array $optionalArgs = []) + * @method PromiseInterface beginTransactionAsync(BeginTransactionRequest $request, array $optionalArgs = []) + * @method PromiseInterface commitAsync(CommitRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDocumentAsync(CreateDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDocumentAsync(DeleteDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDocumentAsync(GetDocumentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCollectionIdsAsync(ListCollectionIdsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDocumentsAsync(ListDocumentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface partitionQueryAsync(PartitionQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackAsync(RollbackRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDocumentAsync(UpdateDocumentRequest $request, array $optionalArgs = []) */ final class FirestoreClient { diff --git a/Functions/src/V2/Client/FunctionServiceClient.php b/Functions/src/V2/Client/FunctionServiceClient.php index 503c373304b9..503d78f08142 100644 --- a/Functions/src/V2/Client/FunctionServiceClient.php +++ b/Functions/src/V2/Client/FunctionServiceClient.php @@ -72,18 +72,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createFunctionAsync(CreateFunctionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFunctionAsync(DeleteFunctionRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateDownloadUrlAsync(GenerateDownloadUrlRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateUploadUrlAsync(GenerateUploadUrlRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFunctionAsync(GetFunctionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFunctionsAsync(ListFunctionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRuntimesAsync(ListRuntimesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFunctionAsync(UpdateFunctionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFunctionAsync(CreateFunctionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFunctionAsync(DeleteFunctionRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateDownloadUrlAsync(GenerateDownloadUrlRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateUploadUrlAsync(GenerateUploadUrlRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFunctionAsync(GetFunctionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFunctionsAsync(ListFunctionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRuntimesAsync(ListRuntimesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFunctionAsync(UpdateFunctionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class FunctionServiceClient { diff --git a/GSuiteAddOns/src/V1/Client/GSuiteAddOnsClient.php b/GSuiteAddOns/src/V1/Client/GSuiteAddOnsClient.php index 6ac57625641d..c62f07c0921d 100644 --- a/GSuiteAddOns/src/V1/Client/GSuiteAddOnsClient.php +++ b/GSuiteAddOns/src/V1/Client/GSuiteAddOnsClient.php @@ -85,15 +85,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDeploymentAsync(CreateDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDeploymentAsync(DeleteDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAuthorizationAsync(GetAuthorizationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstallStatusAsync(GetInstallStatusRequest $request, array $optionalArgs = []) - * @method PromiseInterface installDeploymentAsync(InstallDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface replaceDeploymentAsync(ReplaceDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface uninstallDeploymentAsync(UninstallDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeploymentAsync(CreateDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDeploymentAsync(DeleteDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAuthorizationAsync(GetAuthorizationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstallStatusAsync(GetInstallStatusRequest $request, array $optionalArgs = []) + * @method PromiseInterface installDeploymentAsync(InstallDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface replaceDeploymentAsync(ReplaceDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface uninstallDeploymentAsync(UninstallDeploymentRequest $request, array $optionalArgs = []) */ final class GSuiteAddOnsClient { diff --git a/GkeBackup/src/V1/Client/BackupForGKEClient.php b/GkeBackup/src/V1/Client/BackupForGKEClient.php index 1f4da97e25fc..4f63f25e443e 100644 --- a/GkeBackup/src/V1/Client/BackupForGKEClient.php +++ b/GkeBackup/src/V1/Client/BackupForGKEClient.php @@ -90,36 +90,36 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBackupPlanAsync(CreateBackupPlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRestoreAsync(CreateRestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRestorePlanAsync(CreateRestorePlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBackupPlanAsync(DeleteBackupPlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRestoreAsync(DeleteRestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRestorePlanAsync(DeleteRestorePlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupIndexDownloadUrlAsync(GetBackupIndexDownloadUrlRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBackupPlanAsync(GetBackupPlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRestoreAsync(GetRestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRestorePlanAsync(GetRestorePlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVolumeBackupAsync(GetVolumeBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVolumeRestoreAsync(GetVolumeRestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupPlansAsync(ListBackupPlansRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRestorePlansAsync(ListRestorePlansRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRestoresAsync(ListRestoresRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVolumeBackupsAsync(ListVolumeBackupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVolumeRestoresAsync(ListVolumeRestoresRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBackupPlanAsync(UpdateBackupPlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRestoreAsync(UpdateRestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRestorePlanAsync(UpdateRestorePlanRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupAsync(CreateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBackupPlanAsync(CreateBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRestoreAsync(CreateRestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRestorePlanAsync(CreateRestorePlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupAsync(DeleteBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBackupPlanAsync(DeleteBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRestoreAsync(DeleteRestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRestorePlanAsync(DeleteRestorePlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupAsync(GetBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupIndexDownloadUrlAsync(GetBackupIndexDownloadUrlRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBackupPlanAsync(GetBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRestoreAsync(GetRestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRestorePlanAsync(GetRestorePlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVolumeBackupAsync(GetVolumeBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVolumeRestoreAsync(GetVolumeRestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupPlansAsync(ListBackupPlansRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBackupsAsync(ListBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRestorePlansAsync(ListRestorePlansRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRestoresAsync(ListRestoresRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVolumeBackupsAsync(ListVolumeBackupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVolumeRestoresAsync(ListVolumeRestoresRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupAsync(UpdateBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBackupPlanAsync(UpdateBackupPlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRestoreAsync(UpdateRestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRestorePlanAsync(UpdateRestorePlanRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class BackupForGKEClient { diff --git a/GkeConnectGateway/src/V1/Client/GatewayControlClient.php b/GkeConnectGateway/src/V1/Client/GatewayControlClient.php index 5b22f3b5970b..cfc8803cd093 100644 --- a/GkeConnectGateway/src/V1/Client/GatewayControlClient.php +++ b/GkeConnectGateway/src/V1/Client/GatewayControlClient.php @@ -41,7 +41,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface generateCredentialsAsync(GenerateCredentialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateCredentialsAsync(GenerateCredentialsRequest $request, array $optionalArgs = []) */ final class GatewayControlClient { diff --git a/GkeConnectGateway/src/V1beta1/Client/GatewayControlClient.php b/GkeConnectGateway/src/V1beta1/Client/GatewayControlClient.php index f6e558fc9a6d..2f8bb55d8039 100644 --- a/GkeConnectGateway/src/V1beta1/Client/GatewayControlClient.php +++ b/GkeConnectGateway/src/V1beta1/Client/GatewayControlClient.php @@ -45,7 +45,7 @@ * * @experimental * - * @method PromiseInterface generateCredentialsAsync(GenerateCredentialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateCredentialsAsync(GenerateCredentialsRequest $request, array $optionalArgs = []) */ final class GatewayControlClient { diff --git a/GkeHub/src/V1/Client/GkeHubClient.php b/GkeHub/src/V1/Client/GkeHubClient.php index 3573d6693ee4..322bf25b0819 100644 --- a/GkeHub/src/V1/Client/GkeHubClient.php +++ b/GkeHub/src/V1/Client/GkeHubClient.php @@ -79,17 +79,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createFeatureAsync(CreateFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMembershipAsync(CreateMembershipRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeatureAsync(DeleteFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMembershipAsync(DeleteMembershipRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateConnectManifestAsync(GenerateConnectManifestRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeatureAsync(GetFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMembershipAsync(GetMembershipRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeaturesAsync(ListFeaturesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMembershipsAsync(ListMembershipsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFeatureAsync(UpdateFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMembershipAsync(UpdateMembershipRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFeatureAsync(CreateFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMembershipAsync(CreateMembershipRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeatureAsync(DeleteFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMembershipAsync(DeleteMembershipRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateConnectManifestAsync(GenerateConnectManifestRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeatureAsync(GetFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMembershipAsync(GetMembershipRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeaturesAsync(ListFeaturesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMembershipsAsync(ListMembershipsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFeatureAsync(UpdateFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMembershipAsync(UpdateMembershipRequest $request, array $optionalArgs = []) */ final class GkeHubClient { diff --git a/GkeMultiCloud/src/V1/Client/AttachedClustersClient.php b/GkeMultiCloud/src/V1/Client/AttachedClustersClient.php index cc065341d4a7..f36160558dbd 100644 --- a/GkeMultiCloud/src/V1/Client/AttachedClustersClient.php +++ b/GkeMultiCloud/src/V1/Client/AttachedClustersClient.php @@ -64,15 +64,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAttachedClusterAsync(CreateAttachedClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAttachedClusterAsync(DeleteAttachedClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateAttachedClusterAgentTokenAsync(GenerateAttachedClusterAgentTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateAttachedClusterInstallManifestAsync(GenerateAttachedClusterInstallManifestRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAttachedClusterAsync(GetAttachedClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAttachedServerConfigAsync(GetAttachedServerConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface importAttachedClusterAsync(ImportAttachedClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAttachedClustersAsync(ListAttachedClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAttachedClusterAsync(UpdateAttachedClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAttachedClusterAsync(CreateAttachedClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAttachedClusterAsync(DeleteAttachedClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateAttachedClusterAgentTokenAsync(GenerateAttachedClusterAgentTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateAttachedClusterInstallManifestAsync(GenerateAttachedClusterInstallManifestRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttachedClusterAsync(GetAttachedClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttachedServerConfigAsync(GetAttachedServerConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface importAttachedClusterAsync(ImportAttachedClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAttachedClustersAsync(ListAttachedClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAttachedClusterAsync(UpdateAttachedClusterRequest $request, array $optionalArgs = []) */ final class AttachedClustersClient { diff --git a/GkeMultiCloud/src/V1/Client/AwsClustersClient.php b/GkeMultiCloud/src/V1/Client/AwsClustersClient.php index 0872281ee076..31631c08b49d 100644 --- a/GkeMultiCloud/src/V1/Client/AwsClustersClient.php +++ b/GkeMultiCloud/src/V1/Client/AwsClustersClient.php @@ -73,22 +73,22 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAwsClusterAsync(CreateAwsClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAwsNodePoolAsync(CreateAwsNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAwsClusterAsync(DeleteAwsClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAwsNodePoolAsync(DeleteAwsNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateAwsClusterAgentTokenAsync(GenerateAwsClusterAgentTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAwsClusterAsync(GetAwsClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAwsJsonWebKeysAsync(GetAwsJsonWebKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAwsNodePoolAsync(GetAwsNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAwsOpenIdConfigAsync(GetAwsOpenIdConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAwsServerConfigAsync(GetAwsServerConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAwsClustersAsync(ListAwsClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAwsNodePoolsAsync(ListAwsNodePoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAwsClusterAsync(UpdateAwsClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAwsNodePoolAsync(UpdateAwsNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAwsClusterAsync(CreateAwsClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAwsNodePoolAsync(CreateAwsNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAwsClusterAsync(DeleteAwsClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAwsNodePoolAsync(DeleteAwsNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateAwsClusterAgentTokenAsync(GenerateAwsClusterAgentTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAwsClusterAsync(GetAwsClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAwsJsonWebKeysAsync(GetAwsJsonWebKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAwsNodePoolAsync(GetAwsNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAwsOpenIdConfigAsync(GetAwsOpenIdConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAwsServerConfigAsync(GetAwsServerConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAwsClustersAsync(ListAwsClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAwsNodePoolsAsync(ListAwsNodePoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAwsClusterAsync(UpdateAwsClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAwsNodePoolAsync(UpdateAwsNodePoolRequest $request, array $optionalArgs = []) */ final class AwsClustersClient { diff --git a/GkeMultiCloud/src/V1/Client/AzureClustersClient.php b/GkeMultiCloud/src/V1/Client/AzureClustersClient.php index e6759b576b27..3d33c75e4705 100644 --- a/GkeMultiCloud/src/V1/Client/AzureClustersClient.php +++ b/GkeMultiCloud/src/V1/Client/AzureClustersClient.php @@ -77,25 +77,25 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAzureClientAsync(CreateAzureClientRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAzureClusterAsync(CreateAzureClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAzureNodePoolAsync(CreateAzureNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAzureClientAsync(DeleteAzureClientRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAzureClusterAsync(DeleteAzureClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAzureNodePoolAsync(DeleteAzureNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateAzureAccessTokenAsync(GenerateAzureAccessTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateAzureClusterAgentTokenAsync(GenerateAzureClusterAgentTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAzureClientAsync(GetAzureClientRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAzureClusterAsync(GetAzureClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAzureJsonWebKeysAsync(GetAzureJsonWebKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAzureNodePoolAsync(GetAzureNodePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAzureOpenIdConfigAsync(GetAzureOpenIdConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAzureServerConfigAsync(GetAzureServerConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAzureClientsAsync(ListAzureClientsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAzureClustersAsync(ListAzureClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAzureNodePoolsAsync(ListAzureNodePoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAzureClusterAsync(UpdateAzureClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAzureNodePoolAsync(UpdateAzureNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAzureClientAsync(CreateAzureClientRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAzureClusterAsync(CreateAzureClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAzureNodePoolAsync(CreateAzureNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAzureClientAsync(DeleteAzureClientRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAzureClusterAsync(DeleteAzureClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAzureNodePoolAsync(DeleteAzureNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateAzureAccessTokenAsync(GenerateAzureAccessTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateAzureClusterAgentTokenAsync(GenerateAzureClusterAgentTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAzureClientAsync(GetAzureClientRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAzureClusterAsync(GetAzureClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAzureJsonWebKeysAsync(GetAzureJsonWebKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAzureNodePoolAsync(GetAzureNodePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAzureOpenIdConfigAsync(GetAzureOpenIdConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAzureServerConfigAsync(GetAzureServerConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAzureClientsAsync(ListAzureClientsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAzureClustersAsync(ListAzureClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAzureNodePoolsAsync(ListAzureNodePoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAzureClusterAsync(UpdateAzureClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAzureNodePoolAsync(UpdateAzureNodePoolRequest $request, array $optionalArgs = []) */ final class AzureClustersClient { diff --git a/Grafeas/src/V1/Client/GrafeasClient.php b/Grafeas/src/V1/Client/GrafeasClient.php index 8c0eb7c2c613..9373677f819e 100644 --- a/Grafeas/src/V1/Client/GrafeasClient.php +++ b/Grafeas/src/V1/Client/GrafeasClient.php @@ -77,20 +77,20 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateNotesAsync(BatchCreateNotesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchCreateOccurrencesAsync(BatchCreateOccurrencesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNoteAsync(CreateNoteRequest $request, array $optionalArgs = []) - * @method PromiseInterface createOccurrenceAsync(CreateOccurrenceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNoteAsync(DeleteNoteRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteOccurrenceAsync(DeleteOccurrenceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNoteAsync(GetNoteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOccurrenceAsync(GetOccurrenceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOccurrenceNoteAsync(GetOccurrenceNoteRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNoteOccurrencesAsync(ListNoteOccurrencesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotesAsync(ListNotesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOccurrencesAsync(ListOccurrencesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNoteAsync(UpdateNoteRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateOccurrenceAsync(UpdateOccurrenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateNotesAsync(BatchCreateNotesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateOccurrencesAsync(BatchCreateOccurrencesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNoteAsync(CreateNoteRequest $request, array $optionalArgs = []) + * @method PromiseInterface createOccurrenceAsync(CreateOccurrenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNoteAsync(DeleteNoteRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteOccurrenceAsync(DeleteOccurrenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNoteAsync(GetNoteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOccurrenceAsync(GetOccurrenceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOccurrenceNoteAsync(GetOccurrenceNoteRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNoteOccurrencesAsync(ListNoteOccurrencesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotesAsync(ListNotesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOccurrencesAsync(ListOccurrencesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNoteAsync(UpdateNoteRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateOccurrenceAsync(UpdateOccurrenceRequest $request, array $optionalArgs = []) */ final class GrafeasClient { diff --git a/Iam/src/V2/Client/PoliciesClient.php b/Iam/src/V2/Client/PoliciesClient.php index 2d34439b6319..24297fc04026 100644 --- a/Iam/src/V2/Client/PoliciesClient.php +++ b/Iam/src/V2/Client/PoliciesClient.php @@ -49,11 +49,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createPolicyAsync(CreatePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePolicyAsync(DeletePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPolicyAsync(GetPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPoliciesAsync(ListPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePolicyAsync(UpdatePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPolicyAsync(CreatePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePolicyAsync(DeletePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPolicyAsync(GetPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPoliciesAsync(ListPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePolicyAsync(UpdatePolicyRequest $request, array $optionalArgs = []) */ final class PoliciesClient { diff --git a/IamCredentials/src/V1/Client/IAMCredentialsClient.php b/IamCredentials/src/V1/Client/IAMCredentialsClient.php index 5f8a2a46fa98..f4ea4fbd637d 100644 --- a/IamCredentials/src/V1/Client/IAMCredentialsClient.php +++ b/IamCredentials/src/V1/Client/IAMCredentialsClient.php @@ -61,10 +61,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface generateAccessTokenAsync(GenerateAccessTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateIdTokenAsync(GenerateIdTokenRequest $request, array $optionalArgs = []) - * @method PromiseInterface signBlobAsync(SignBlobRequest $request, array $optionalArgs = []) - * @method PromiseInterface signJwtAsync(SignJwtRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateAccessTokenAsync(GenerateAccessTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateIdTokenAsync(GenerateIdTokenRequest $request, array $optionalArgs = []) + * @method PromiseInterface signBlobAsync(SignBlobRequest $request, array $optionalArgs = []) + * @method PromiseInterface signJwtAsync(SignJwtRequest $request, array $optionalArgs = []) */ final class IAMCredentialsClient { diff --git a/Iap/src/V1/Client/IdentityAwareProxyAdminServiceClient.php b/Iap/src/V1/Client/IdentityAwareProxyAdminServiceClient.php index cbf922ebbdbc..bb3922da0569 100644 --- a/Iap/src/V1/Client/IdentityAwareProxyAdminServiceClient.php +++ b/Iap/src/V1/Client/IdentityAwareProxyAdminServiceClient.php @@ -60,16 +60,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTunnelDestGroupAsync(CreateTunnelDestGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTunnelDestGroupAsync(DeleteTunnelDestGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIapSettingsAsync(GetIapSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTunnelDestGroupAsync(GetTunnelDestGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTunnelDestGroupsAsync(ListTunnelDestGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateIapSettingsAsync(UpdateIapSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTunnelDestGroupAsync(UpdateTunnelDestGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTunnelDestGroupAsync(CreateTunnelDestGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTunnelDestGroupAsync(DeleteTunnelDestGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIapSettingsAsync(GetIapSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTunnelDestGroupAsync(GetTunnelDestGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTunnelDestGroupsAsync(ListTunnelDestGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateIapSettingsAsync(UpdateIapSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTunnelDestGroupAsync(UpdateTunnelDestGroupRequest $request, array $optionalArgs = []) */ final class IdentityAwareProxyAdminServiceClient { diff --git a/Iap/src/V1/Client/IdentityAwareProxyOAuthServiceClient.php b/Iap/src/V1/Client/IdentityAwareProxyOAuthServiceClient.php index 77cef6d877c5..c16b9e5590da 100644 --- a/Iap/src/V1/Client/IdentityAwareProxyOAuthServiceClient.php +++ b/Iap/src/V1/Client/IdentityAwareProxyOAuthServiceClient.php @@ -53,14 +53,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createBrandAsync(CreateBrandRequest $request, array $optionalArgs = []) - * @method PromiseInterface createIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBrandAsync(GetBrandRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBrandsAsync(ListBrandsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBrandAsync(CreateBrandRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBrandAsync(GetBrandRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBrandsAsync(ListBrandsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest $request, array $optionalArgs = []) */ final class IdentityAwareProxyOAuthServiceClient { diff --git a/Ids/src/V1/Client/IDSClient.php b/Ids/src/V1/Client/IDSClient.php index 1588e03eed83..55bb0b19957d 100644 --- a/Ids/src/V1/Client/IDSClient.php +++ b/Ids/src/V1/Client/IDSClient.php @@ -54,10 +54,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEndpointAsync(CreateEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEndpointAsync(DeleteEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEndpointAsync(GetEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEndpointsAsync(ListEndpointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEndpointAsync(CreateEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEndpointAsync(DeleteEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEndpointAsync(GetEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEndpointsAsync(ListEndpointsRequest $request, array $optionalArgs = []) */ final class IDSClient { diff --git a/Kms/src/V1/Client/AutokeyAdminClient.php b/Kms/src/V1/Client/AutokeyAdminClient.php index 76274d56a805..6909717f73ce 100644 --- a/Kms/src/V1/Client/AutokeyAdminClient.php +++ b/Kms/src/V1/Client/AutokeyAdminClient.php @@ -66,14 +66,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getAutokeyConfigAsync(GetAutokeyConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface showEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAutokeyConfigAsync(UpdateAutokeyConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAutokeyConfigAsync(GetAutokeyConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface showEffectiveAutokeyConfigAsync(ShowEffectiveAutokeyConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAutokeyConfigAsync(UpdateAutokeyConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class AutokeyAdminClient { diff --git a/Kms/src/V1/Client/AutokeyClient.php b/Kms/src/V1/Client/AutokeyClient.php index 11480a761d57..61e914cf9132 100644 --- a/Kms/src/V1/Client/AutokeyClient.php +++ b/Kms/src/V1/Client/AutokeyClient.php @@ -78,14 +78,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createKeyHandleAsync(CreateKeyHandleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKeyHandleAsync(GetKeyHandleRequest $request, array $optionalArgs = []) - * @method PromiseInterface listKeyHandlesAsync(ListKeyHandlesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createKeyHandleAsync(CreateKeyHandleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKeyHandleAsync(GetKeyHandleRequest $request, array $optionalArgs = []) + * @method PromiseInterface listKeyHandlesAsync(ListKeyHandlesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class AutokeyClient { diff --git a/Kms/src/V1/Client/EkmServiceClient.php b/Kms/src/V1/Client/EkmServiceClient.php index fabe018a2fbb..d926157f8c31 100644 --- a/Kms/src/V1/Client/EkmServiceClient.php +++ b/Kms/src/V1/Client/EkmServiceClient.php @@ -68,18 +68,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEkmConnectionAsync(CreateEkmConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEkmConfigAsync(GetEkmConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEkmConnectionAsync(GetEkmConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEkmConnectionsAsync(ListEkmConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEkmConfigAsync(UpdateEkmConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEkmConnectionAsync(UpdateEkmConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface verifyConnectivityAsync(VerifyConnectivityRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEkmConnectionAsync(CreateEkmConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEkmConfigAsync(GetEkmConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEkmConnectionAsync(GetEkmConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEkmConnectionsAsync(ListEkmConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEkmConfigAsync(UpdateEkmConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEkmConnectionAsync(UpdateEkmConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface verifyConnectivityAsync(VerifyConnectivityRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class EkmServiceClient { diff --git a/Kms/src/V1/Client/KeyManagementServiceClient.php b/Kms/src/V1/Client/KeyManagementServiceClient.php index 2737132a0f72..1a3f40e60d09 100644 --- a/Kms/src/V1/Client/KeyManagementServiceClient.php +++ b/Kms/src/V1/Client/KeyManagementServiceClient.php @@ -107,39 +107,39 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface asymmetricDecryptAsync(AsymmetricDecryptRequest $request, array $optionalArgs = []) - * @method PromiseInterface asymmetricSignAsync(AsymmetricSignRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCryptoKeyAsync(CreateCryptoKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCryptoKeyVersionAsync(CreateCryptoKeyVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createImportJobAsync(CreateImportJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createKeyRingAsync(CreateKeyRingRequest $request, array $optionalArgs = []) - * @method PromiseInterface decryptAsync(DecryptRequest $request, array $optionalArgs = []) - * @method PromiseInterface destroyCryptoKeyVersionAsync(DestroyCryptoKeyVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface encryptAsync(EncryptRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateRandomBytesAsync(GenerateRandomBytesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCryptoKeyAsync(GetCryptoKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCryptoKeyVersionAsync(GetCryptoKeyVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getImportJobAsync(GetImportJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKeyRingAsync(GetKeyRingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPublicKeyAsync(GetPublicKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface importCryptoKeyVersionAsync(ImportCryptoKeyVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCryptoKeyVersionsAsync(ListCryptoKeyVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCryptoKeysAsync(ListCryptoKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface listImportJobsAsync(ListImportJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listKeyRingsAsync(ListKeyRingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface macSignAsync(MacSignRequest $request, array $optionalArgs = []) - * @method PromiseInterface macVerifyAsync(MacVerifyRequest $request, array $optionalArgs = []) - * @method PromiseInterface rawDecryptAsync(RawDecryptRequest $request, array $optionalArgs = []) - * @method PromiseInterface rawEncryptAsync(RawEncryptRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreCryptoKeyVersionAsync(RestoreCryptoKeyVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCryptoKeyAsync(UpdateCryptoKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCryptoKeyPrimaryVersionAsync(UpdateCryptoKeyPrimaryVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCryptoKeyVersionAsync(UpdateCryptoKeyVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface asymmetricDecryptAsync(AsymmetricDecryptRequest $request, array $optionalArgs = []) + * @method PromiseInterface asymmetricSignAsync(AsymmetricSignRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCryptoKeyAsync(CreateCryptoKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCryptoKeyVersionAsync(CreateCryptoKeyVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createImportJobAsync(CreateImportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createKeyRingAsync(CreateKeyRingRequest $request, array $optionalArgs = []) + * @method PromiseInterface decryptAsync(DecryptRequest $request, array $optionalArgs = []) + * @method PromiseInterface destroyCryptoKeyVersionAsync(DestroyCryptoKeyVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface encryptAsync(EncryptRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateRandomBytesAsync(GenerateRandomBytesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCryptoKeyAsync(GetCryptoKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCryptoKeyVersionAsync(GetCryptoKeyVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getImportJobAsync(GetImportJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKeyRingAsync(GetKeyRingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPublicKeyAsync(GetPublicKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface importCryptoKeyVersionAsync(ImportCryptoKeyVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCryptoKeyVersionsAsync(ListCryptoKeyVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCryptoKeysAsync(ListCryptoKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface listImportJobsAsync(ListImportJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listKeyRingsAsync(ListKeyRingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface macSignAsync(MacSignRequest $request, array $optionalArgs = []) + * @method PromiseInterface macVerifyAsync(MacVerifyRequest $request, array $optionalArgs = []) + * @method PromiseInterface rawDecryptAsync(RawDecryptRequest $request, array $optionalArgs = []) + * @method PromiseInterface rawEncryptAsync(RawEncryptRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreCryptoKeyVersionAsync(RestoreCryptoKeyVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCryptoKeyAsync(UpdateCryptoKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCryptoKeyPrimaryVersionAsync(UpdateCryptoKeyPrimaryVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCryptoKeyVersionAsync(UpdateCryptoKeyVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class KeyManagementServiceClient { diff --git a/KmsInventory/src/V1/Client/KeyDashboardServiceClient.php b/KmsInventory/src/V1/Client/KeyDashboardServiceClient.php index 1820b7f9aa9a..624254c73990 100644 --- a/KmsInventory/src/V1/Client/KeyDashboardServiceClient.php +++ b/KmsInventory/src/V1/Client/KeyDashboardServiceClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface listCryptoKeysAsync(ListCryptoKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCryptoKeysAsync(ListCryptoKeysRequest $request, array $optionalArgs = []) */ final class KeyDashboardServiceClient { diff --git a/KmsInventory/src/V1/Client/KeyTrackingServiceClient.php b/KmsInventory/src/V1/Client/KeyTrackingServiceClient.php index 228a49eef416..f9c2d67300ef 100644 --- a/KmsInventory/src/V1/Client/KeyTrackingServiceClient.php +++ b/KmsInventory/src/V1/Client/KeyTrackingServiceClient.php @@ -50,8 +50,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getProtectedResourcesSummaryAsync(GetProtectedResourcesSummaryRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchProtectedResourcesAsync(SearchProtectedResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProtectedResourcesSummaryAsync(GetProtectedResourcesSummaryRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchProtectedResourcesAsync(SearchProtectedResourcesRequest $request, array $optionalArgs = []) */ final class KeyTrackingServiceClient { diff --git a/Language/src/V1/Client/LanguageServiceClient.php b/Language/src/V1/Client/LanguageServiceClient.php index 750c75853a59..16b7bf1935f2 100644 --- a/Language/src/V1/Client/LanguageServiceClient.php +++ b/Language/src/V1/Client/LanguageServiceClient.php @@ -54,13 +54,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface analyzeEntitiesAsync(AnalyzeEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeEntitySentimentAsync(AnalyzeEntitySentimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeSentimentAsync(AnalyzeSentimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeSyntaxAsync(AnalyzeSyntaxRequest $request, array $optionalArgs = []) - * @method PromiseInterface annotateTextAsync(AnnotateTextRequest $request, array $optionalArgs = []) - * @method PromiseInterface classifyTextAsync(ClassifyTextRequest $request, array $optionalArgs = []) - * @method PromiseInterface moderateTextAsync(ModerateTextRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeEntitiesAsync(AnalyzeEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeEntitySentimentAsync(AnalyzeEntitySentimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeSentimentAsync(AnalyzeSentimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeSyntaxAsync(AnalyzeSyntaxRequest $request, array $optionalArgs = []) + * @method PromiseInterface annotateTextAsync(AnnotateTextRequest $request, array $optionalArgs = []) + * @method PromiseInterface classifyTextAsync(ClassifyTextRequest $request, array $optionalArgs = []) + * @method PromiseInterface moderateTextAsync(ModerateTextRequest $request, array $optionalArgs = []) */ final class LanguageServiceClient { diff --git a/Language/src/V2/Client/LanguageServiceClient.php b/Language/src/V2/Client/LanguageServiceClient.php index 695aa44d6b7c..72c51e9835c1 100644 --- a/Language/src/V2/Client/LanguageServiceClient.php +++ b/Language/src/V2/Client/LanguageServiceClient.php @@ -50,11 +50,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface analyzeEntitiesAsync(AnalyzeEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface analyzeSentimentAsync(AnalyzeSentimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface annotateTextAsync(AnnotateTextRequest $request, array $optionalArgs = []) - * @method PromiseInterface classifyTextAsync(ClassifyTextRequest $request, array $optionalArgs = []) - * @method PromiseInterface moderateTextAsync(ModerateTextRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeEntitiesAsync(AnalyzeEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface analyzeSentimentAsync(AnalyzeSentimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface annotateTextAsync(AnnotateTextRequest $request, array $optionalArgs = []) + * @method PromiseInterface classifyTextAsync(ClassifyTextRequest $request, array $optionalArgs = []) + * @method PromiseInterface moderateTextAsync(ModerateTextRequest $request, array $optionalArgs = []) */ final class LanguageServiceClient { diff --git a/LifeSciences/src/V2beta/Client/WorkflowsServiceV2BetaClient.php b/LifeSciences/src/V2beta/Client/WorkflowsServiceV2BetaClient.php index ea06ce4d49d8..e5406b35ed64 100644 --- a/LifeSciences/src/V2beta/Client/WorkflowsServiceV2BetaClient.php +++ b/LifeSciences/src/V2beta/Client/WorkflowsServiceV2BetaClient.php @@ -54,9 +54,9 @@ * * @experimental * - * @method PromiseInterface runPipelineAsync(RunPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface runPipelineAsync(RunPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class WorkflowsServiceV2BetaClient { diff --git a/Logging/src/V2/Client/ConfigServiceV2Client.php b/Logging/src/V2/Client/ConfigServiceV2Client.php index 9e2cf87a4822..3a3d8d103770 100644 --- a/Logging/src/V2/Client/ConfigServiceV2Client.php +++ b/Logging/src/V2/Client/ConfigServiceV2Client.php @@ -86,38 +86,38 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface copyLogEntriesAsync(CopyLogEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBucketAsync(CreateBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBucketAsyncAsync(CreateBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface createExclusionAsync(CreateExclusionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createLinkAsync(CreateLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSinkAsync(CreateSinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface createViewAsync(CreateViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBucketAsync(DeleteBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteExclusionAsync(DeleteExclusionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteLinkAsync(DeleteLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSinkAsync(DeleteSinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteViewAsync(DeleteViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBucketAsync(GetBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCmekSettingsAsync(GetCmekSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExclusionAsync(GetExclusionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLinkAsync(GetLinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSinkAsync(GetSinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getViewAsync(GetViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBucketsAsync(ListBucketsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExclusionsAsync(ListExclusionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLinksAsync(ListLinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSinksAsync(ListSinksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listViewsAsync(ListViewsRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteBucketAsync(UndeleteBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBucketAsync(UpdateBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBucketAsyncAsync(UpdateBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCmekSettingsAsync(UpdateCmekSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExclusionAsync(UpdateExclusionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSettingsAsync(UpdateSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSinkAsync(UpdateSinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateViewAsync(UpdateViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface copyLogEntriesAsync(CopyLogEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBucketAsync(CreateBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBucketAsyncAsync(CreateBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExclusionAsync(CreateExclusionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLinkAsync(CreateLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSinkAsync(CreateSinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface createViewAsync(CreateViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBucketAsync(DeleteBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteExclusionAsync(DeleteExclusionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLinkAsync(DeleteLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSinkAsync(DeleteSinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteViewAsync(DeleteViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBucketAsync(GetBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCmekSettingsAsync(GetCmekSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExclusionAsync(GetExclusionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLinkAsync(GetLinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSettingsAsync(GetSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSinkAsync(GetSinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getViewAsync(GetViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBucketsAsync(ListBucketsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExclusionsAsync(ListExclusionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLinksAsync(ListLinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSinksAsync(ListSinksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listViewsAsync(ListViewsRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteBucketAsync(UndeleteBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBucketAsync(UpdateBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBucketAsyncAsync(UpdateBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCmekSettingsAsync(UpdateCmekSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExclusionAsync(UpdateExclusionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSettingsAsync(UpdateSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSinkAsync(UpdateSinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateViewAsync(UpdateViewRequest $request, array $optionalArgs = []) */ final class ConfigServiceV2Client { diff --git a/Logging/src/V2/Client/LoggingServiceV2Client.php b/Logging/src/V2/Client/LoggingServiceV2Client.php index ecb9a2084df6..580f47194275 100644 --- a/Logging/src/V2/Client/LoggingServiceV2Client.php +++ b/Logging/src/V2/Client/LoggingServiceV2Client.php @@ -53,11 +53,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface deleteLogAsync(DeleteLogRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLogEntriesAsync(ListLogEntriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLogsAsync(ListLogsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMonitoredResourceDescriptorsAsync(ListMonitoredResourceDescriptorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface writeLogEntriesAsync(WriteLogEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLogAsync(DeleteLogRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLogEntriesAsync(ListLogEntriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLogsAsync(ListLogsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMonitoredResourceDescriptorsAsync(ListMonitoredResourceDescriptorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface writeLogEntriesAsync(WriteLogEntriesRequest $request, array $optionalArgs = []) */ final class LoggingServiceV2Client { diff --git a/Logging/src/V2/Client/MetricsServiceV2Client.php b/Logging/src/V2/Client/MetricsServiceV2Client.php index fda16a0bb939..375766ac34e8 100644 --- a/Logging/src/V2/Client/MetricsServiceV2Client.php +++ b/Logging/src/V2/Client/MetricsServiceV2Client.php @@ -52,11 +52,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createLogMetricAsync(CreateLogMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteLogMetricAsync(DeleteLogMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLogMetricAsync(GetLogMetricRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLogMetricsAsync(ListLogMetricsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateLogMetricAsync(UpdateLogMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLogMetricAsync(CreateLogMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLogMetricAsync(DeleteLogMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLogMetricAsync(GetLogMetricRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLogMetricsAsync(ListLogMetricsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateLogMetricAsync(UpdateLogMetricRequest $request, array $optionalArgs = []) */ final class MetricsServiceV2Client { diff --git a/LongRunning/src/LongRunning/Client/OperationsClient.php b/LongRunning/src/LongRunning/Client/OperationsClient.php index d3697fc93b40..b49d58ed1ea9 100644 --- a/LongRunning/src/LongRunning/Client/OperationsClient.php +++ b/LongRunning/src/LongRunning/Client/OperationsClient.php @@ -54,11 +54,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface cancelOperationAsync(CancelOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteOperationAsync(DeleteOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOperationAsync(GetOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOperationsAsync(ListOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface waitOperationAsync(WaitOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelOperationAsync(CancelOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteOperationAsync(DeleteOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOperationAsync(GetOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOperationsAsync(ListOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface waitOperationAsync(WaitOperationRequest $request, array $optionalArgs = []) */ class OperationsClient { diff --git a/ManagedIdentities/src/V1/Client/ManagedIdentitiesServiceClient.php b/ManagedIdentities/src/V1/Client/ManagedIdentitiesServiceClient.php index 0aa736767382..622860c2894c 100644 --- a/ManagedIdentities/src/V1/Client/ManagedIdentitiesServiceClient.php +++ b/ManagedIdentities/src/V1/Client/ManagedIdentitiesServiceClient.php @@ -92,16 +92,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface attachTrustAsync(AttachTrustRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMicrosoftAdDomainAsync(CreateMicrosoftAdDomainRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDomainAsync(DeleteDomainRequest $request, array $optionalArgs = []) - * @method PromiseInterface detachTrustAsync(DetachTrustRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDomainAsync(GetDomainRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDomainsAsync(ListDomainsRequest $request, array $optionalArgs = []) - * @method PromiseInterface reconfigureTrustAsync(ReconfigureTrustRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetAdminPasswordAsync(ResetAdminPasswordRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDomainAsync(UpdateDomainRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateTrustAsync(ValidateTrustRequest $request, array $optionalArgs = []) + * @method PromiseInterface attachTrustAsync(AttachTrustRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMicrosoftAdDomainAsync(CreateMicrosoftAdDomainRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDomainAsync(DeleteDomainRequest $request, array $optionalArgs = []) + * @method PromiseInterface detachTrustAsync(DetachTrustRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDomainAsync(GetDomainRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDomainsAsync(ListDomainsRequest $request, array $optionalArgs = []) + * @method PromiseInterface reconfigureTrustAsync(ReconfigureTrustRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetAdminPasswordAsync(ResetAdminPasswordRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDomainAsync(UpdateDomainRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateTrustAsync(ValidateTrustRequest $request, array $optionalArgs = []) */ final class ManagedIdentitiesServiceClient { From f8b75005d93f0be80d99ee231c9179d4109b85cb Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:18:24 -0800 Subject: [PATCH 076/157] chore: add types for async methods (#7805) PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiV2ViUmlzay8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiV2ViU2VjdXJpdHlTY2FubmVyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiV29ya2Zsb3dzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= --- .../src/V1/Client/WebRiskServiceClient.php | 10 +++---- .../V1/Client/WebSecurityScannerClient.php | 26 +++++++++---------- .../Executions/V1/Client/ExecutionsClient.php | 8 +++--- Workflows/src/V1/Client/WorkflowsClient.php | 14 +++++----- 4 files changed, 29 insertions(+), 29 deletions(-) diff --git a/WebRisk/src/V1/Client/WebRiskServiceClient.php b/WebRisk/src/V1/Client/WebRiskServiceClient.php index 87ede68c0a42..6767c1192be5 100644 --- a/WebRisk/src/V1/Client/WebRiskServiceClient.php +++ b/WebRisk/src/V1/Client/WebRiskServiceClient.php @@ -58,11 +58,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface computeThreatListDiffAsync(ComputeThreatListDiffRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSubmissionAsync(CreateSubmissionRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchHashesAsync(SearchHashesRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchUrisAsync(SearchUrisRequest $request, array $optionalArgs = []) - * @method PromiseInterface submitUriAsync(SubmitUriRequest $request, array $optionalArgs = []) + * @method PromiseInterface computeThreatListDiffAsync(ComputeThreatListDiffRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSubmissionAsync(CreateSubmissionRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchHashesAsync(SearchHashesRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchUrisAsync(SearchUrisRequest $request, array $optionalArgs = []) + * @method PromiseInterface submitUriAsync(SubmitUriRequest $request, array $optionalArgs = []) */ final class WebRiskServiceClient { diff --git a/WebSecurityScanner/src/V1/Client/WebSecurityScannerClient.php b/WebSecurityScanner/src/V1/Client/WebSecurityScannerClient.php index e6b2d9c7b769..53c1cca0820c 100644 --- a/WebSecurityScanner/src/V1/Client/WebSecurityScannerClient.php +++ b/WebSecurityScanner/src/V1/Client/WebSecurityScannerClient.php @@ -59,19 +59,19 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface createScanConfigAsync(CreateScanConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteScanConfigAsync(DeleteScanConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFindingAsync(GetFindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getScanConfigAsync(GetScanConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getScanRunAsync(GetScanRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCrawledUrlsAsync(ListCrawledUrlsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFindingTypeStatsAsync(ListFindingTypeStatsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFindingsAsync(ListFindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listScanConfigsAsync(ListScanConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listScanRunsAsync(ListScanRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface startScanRunAsync(StartScanRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopScanRunAsync(StopScanRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateScanConfigAsync(UpdateScanConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createScanConfigAsync(CreateScanConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteScanConfigAsync(DeleteScanConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFindingAsync(GetFindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getScanConfigAsync(GetScanConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getScanRunAsync(GetScanRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCrawledUrlsAsync(ListCrawledUrlsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFindingTypeStatsAsync(ListFindingTypeStatsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFindingsAsync(ListFindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listScanConfigsAsync(ListScanConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listScanRunsAsync(ListScanRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface startScanRunAsync(StartScanRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopScanRunAsync(StopScanRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateScanConfigAsync(UpdateScanConfigRequest $request, array $optionalArgs = []) */ final class WebSecurityScannerClient { diff --git a/Workflows/src/Executions/V1/Client/ExecutionsClient.php b/Workflows/src/Executions/V1/Client/ExecutionsClient.php index 4986f4827c69..cd9f465a0902 100644 --- a/Workflows/src/Executions/V1/Client/ExecutionsClient.php +++ b/Workflows/src/Executions/V1/Client/ExecutionsClient.php @@ -52,10 +52,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface cancelExecutionAsync(CancelExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createExecutionAsync(CreateExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExecutionAsync(GetExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExecutionsAsync(ListExecutionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelExecutionAsync(CancelExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExecutionAsync(CreateExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExecutionAsync(GetExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExecutionsAsync(ListExecutionsRequest $request, array $optionalArgs = []) */ final class ExecutionsClient { diff --git a/Workflows/src/V1/Client/WorkflowsClient.php b/Workflows/src/V1/Client/WorkflowsClient.php index e1557a7556e2..876d6a87a1c6 100644 --- a/Workflows/src/V1/Client/WorkflowsClient.php +++ b/Workflows/src/V1/Client/WorkflowsClient.php @@ -60,13 +60,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createWorkflowAsync(CreateWorkflowRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteWorkflowAsync(DeleteWorkflowRequest $request, array $optionalArgs = []) - * @method PromiseInterface getWorkflowAsync(GetWorkflowRequest $request, array $optionalArgs = []) - * @method PromiseInterface listWorkflowsAsync(ListWorkflowsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateWorkflowAsync(UpdateWorkflowRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createWorkflowAsync(CreateWorkflowRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteWorkflowAsync(DeleteWorkflowRequest $request, array $optionalArgs = []) + * @method PromiseInterface getWorkflowAsync(GetWorkflowRequest $request, array $optionalArgs = []) + * @method PromiseInterface listWorkflowsAsync(ListWorkflowsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateWorkflowAsync(UpdateWorkflowRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class WorkflowsClient { From fdd455964ef36a18c9a7021a14c2e6b1f0e6c042 Mon Sep 17 00:00:00 2001 From: Mend Renovate Date: Tue, 5 Nov 2024 22:00:23 +0100 Subject: [PATCH 077/157] chore(deps): update gcr.io/cloud-spanner-emulator/emulator docker tag to v1.5.25 (#7783) --- .github/workflows/system-tests-spanner-emulator.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/system-tests-spanner-emulator.yaml b/.github/workflows/system-tests-spanner-emulator.yaml index 7b3689b6dfd7..ffde133af921 100644 --- a/.github/workflows/system-tests-spanner-emulator.yaml +++ b/.github/workflows/system-tests-spanner-emulator.yaml @@ -18,7 +18,7 @@ jobs: services: emulator: - image: gcr.io/cloud-spanner-emulator/emulator:1.5.24 + image: gcr.io/cloud-spanner-emulator/emulator:1.5.25 ports: - 9010:9010 - 9020:9020 From 2319433fbc948fa0d419f49daabfa8bb20f0b399 Mon Sep 17 00:00:00 2001 From: Mend Renovate Date: Tue, 5 Nov 2024 22:00:32 +0100 Subject: [PATCH 078/157] chore(deps): update gcr.io/cloud-devrel-public-resources/storage-testbench docker tag to v0.49.0 (#7750) --- .github/workflows/conformance-tests-storage-emulator.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/conformance-tests-storage-emulator.yaml b/.github/workflows/conformance-tests-storage-emulator.yaml index fe5d0d6fb59f..1ff1e98fb60d 100644 --- a/.github/workflows/conformance-tests-storage-emulator.yaml +++ b/.github/workflows/conformance-tests-storage-emulator.yaml @@ -16,7 +16,7 @@ jobs: services: emulator: - image: gcr.io/cloud-devrel-public-resources/storage-testbench:v0.45.0 + image: gcr.io/cloud-devrel-public-resources/storage-testbench:v0.49.0 ports: - 9000:9000 From 21fcebc65a0ed743fb8bcb62c7842b46e0ccb75a Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 13:02:25 -0800 Subject: [PATCH 079/157] feat: added support for specifying function response type in FunctionDeclaration (#7791) feat: add system labels field to model garden deployments PiperOrigin-RevId: 692254608 Source-Link: https://github.com/googleapis/googleapis/commit/cac70e2890e210fc5f9b50d054983e802b0af611 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4e5dda3b7c635912221b204a08a261d744a582ee Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiNGU1ZGRhM2I3YzYzNTkxMjIyMWIyMDRhMDhhMjYxZDc0NGE1ODJlZSJ9 feat: added support for specifying function response type in `FunctionDeclaration` docs: updated the maximum number of function declarations from 64 to 128 PiperOrigin-RevId: 692287251 Source-Link: https://github.com/googleapis/googleapis/commit/d54f4e947e77b86ea2e0e243c92a174032098a54 Source-Link: https://github.com/googleapis/googleapis-gen/commit/14376d331369c5dd04e419421dbf3076f5d42fc4 Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiMTQzNzZkMzMxMzY5YzVkZDA0ZTQxOTQyMWRiZjMwNzZmNWQ0MmZjNCJ9 chore: add types to async methods PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 --- AiPlatform/metadata/V1/Endpoint.php | Bin 4043 -> 4180 bytes .../metadata/V1/FeatureRegistryService.php | 8 +- .../metadata/V1/FeaturestoreService.php | Bin 16109 -> 16106 bytes AiPlatform/metadata/V1/Tool.php | Bin 2491 -> 2551 bytes .../batch_create_features.php | 123 +++++++++++++ .../create_feature_group.php | 2 +- .../batch_create_features.php | 5 +- .../src/V1/BatchCreateFeaturesRequest.php | 67 +++---- .../src/V1/Client/DatasetServiceClient.php | 48 ++--- .../DeploymentResourcePoolServiceClient.php | 22 +-- .../src/V1/Client/EndpointServiceClient.php | 26 +-- .../src/V1/Client/EvaluationServiceClient.php | 12 +- .../FeatureOnlineStoreAdminServiceClient.php | 36 ++-- .../FeatureOnlineStoreServiceClient.php | 14 +- .../Client/FeatureRegistryServiceClient.php | 59 ++++-- ...FeaturestoreOnlineServingServiceClient.php | 14 +- .../V1/Client/FeaturestoreServiceClient.php | 52 +++--- .../V1/Client/GenAiTuningServiceClient.php | 20 +-- .../V1/Client/IndexEndpointServiceClient.php | 26 +-- .../src/V1/Client/IndexServiceClient.php | 24 +-- AiPlatform/src/V1/Client/JobServiceClient.php | 80 ++++----- .../src/V1/Client/LlmUtilityServiceClient.php | 14 +- .../src/V1/Client/MatchServiceClient.php | 14 +- .../src/V1/Client/MetadataServiceClient.php | 74 ++++---- .../src/V1/Client/MigrationServiceClient.php | 14 +- .../V1/Client/ModelGardenServiceClient.php | 12 +- .../src/V1/Client/ModelServiceClient.php | 46 ++--- .../src/V1/Client/NotebookServiceClient.php | 42 ++--- .../PersistentResourceServiceClient.php | 22 +-- .../src/V1/Client/PipelineServiceClient.php | 34 ++-- .../src/V1/Client/PredictionServiceClient.php | 22 +-- .../src/V1/Client/ScheduleServiceClient.php | 24 +-- .../V1/Client/SpecialistPoolServiceClient.php | 20 +-- .../V1/Client/TensorboardServiceClient.php | 68 +++---- .../src/V1/Client/VizierServiceClient.php | 40 ++--- .../src/V1/CreateFeatureGroupRequest.php | 10 +- AiPlatform/src/V1/DeployedModel.php | 38 ++++ AiPlatform/src/V1/FunctionDeclaration.php | 58 +++++- AiPlatform/src/V1/FunctionResponse.php | 12 ++ AiPlatform/src/V1/Schema.php | 36 ++-- AiPlatform/src/V1/Tool.php | 8 +- AiPlatform/src/V1/gapic_metadata.json | 5 + ...eature_registry_service_client_config.json | 5 + ...ure_registry_service_descriptor_config.php | 19 ++ ...re_registry_service_rest_client_config.php | 12 ++ .../FeatureRegistryServiceClientTest.php | 168 +++++++++++++++--- 46 files changed, 941 insertions(+), 514 deletions(-) create mode 100644 AiPlatform/samples/V1/FeatureRegistryServiceClient/batch_create_features.php diff --git a/AiPlatform/metadata/V1/Endpoint.php b/AiPlatform/metadata/V1/Endpoint.php index be17963e74f728165d187fd6dd8d3c259e040d05..a316ceabb952a57f39e47e81e771a25bd3d2e871 100644 GIT binary patch delta 94 zcmX>te??)#KW3&biA^l?*_a-)ZC=QAm`PG7h>N$lvbZEQH$EpZDK)29LPmjEgWJe@ ovH`oyinternalAddGeneratedFile( ' -Œ" +©$ 9google/cloud/aiplatform/v1/feature_registry_service.protogoogle.cloud.aiplatform.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto(google/cloud/aiplatform/v1/feature.proto.google/cloud/aiplatform/v1/feature_group.proto5google/cloud/aiplatform/v1/featurestore_service.proto*google/cloud/aiplatform/v1/operation.proto#google/longrunning/operations.protogoogle/protobuf/empty.proto google/protobuf/field_mask.proto"À CreateFeatureGroupRequest> parent ( B.àAúA(&aiplatform.googleapis.com/FeatureGroupD @@ -60,7 +60,7 @@ public static function initOnce() { &CreateRegistryFeatureOperationMetadataN generic_metadata ( 24.google.cloud.aiplatform.v1.GenericOperationMetadata"p UpdateFeatureOperationMetadataN -generic_metadata ( 24.google.cloud.aiplatform.v1.GenericOperationMetadata2Æ +generic_metadata ( 24.google.cloud.aiplatform.v1.GenericOperationMetadata2ã FeatureRegistryService“ CreateFeatureGroup5.google.cloud.aiplatform.v1.CreateFeatureGroupRequest.google.longrunning.Operation"¦ÊA3 FeatureGroup#CreateFeatureGroupOperationMetadataÚA%parent,feature_group,feature_group_id‚Óä“B"1/v1/{parent=projects/*/locations/*}/featureGroups: feature_group± @@ -72,7 +72,9 @@ public static function initOnce() { google.protobuf.EmptyDeleteOperationMetadataÚA name,force‚Óä“3*1/v1/{name=projects/*/locations/*/featureGroups/*}ø CreateFeature0.google.cloud.aiplatform.v1.CreateFeatureRequest.google.longrunning.Operation"•ÊA) -FeatureCreateFeatureOperationMetadataÚAparent,feature,feature_id‚Óä“G"L%sRab|aSAn);07nN)CI2;51;`G8bV=oV`xKiWnpw>lhqqbv)~#H EB-Aw$eE-Ndg3DQomV|^%@HRy9Emf diff --git a/AiPlatform/samples/V1/FeatureRegistryServiceClient/batch_create_features.php b/AiPlatform/samples/V1/FeatureRegistryServiceClient/batch_create_features.php new file mode 100644 index 000000000000..bef5269676e3 --- /dev/null +++ b/AiPlatform/samples/V1/FeatureRegistryServiceClient/batch_create_features.php @@ -0,0 +1,123 @@ +setParent($formattedRequestsParent) + ->setFeature($requestsFeature) + ->setFeatureId($requestsFeatureId); + $requests = [$createFeatureRequest,]; + $request = (new BatchCreateFeaturesRequest()) + ->setParent($formattedParent) + ->setRequests($requests); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $featureRegistryServiceClient->batchCreateFeatures($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var BatchCreateFeaturesResponse $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 +{ + $formattedParent = FeatureRegistryServiceClient::entityTypeName( + '[PROJECT]', + '[LOCATION]', + '[FEATURESTORE]', + '[ENTITY_TYPE]' + ); + $formattedRequestsParent = FeatureRegistryServiceClient::entityTypeName( + '[PROJECT]', + '[LOCATION]', + '[FEATURESTORE]', + '[ENTITY_TYPE]' + ); + $requestsFeatureId = '[FEATURE_ID]'; + + batch_create_features_sample($formattedParent, $formattedRequestsParent, $requestsFeatureId); +} +// [END aiplatform_v1_generated_FeatureRegistryService_BatchCreateFeatures_sync] diff --git a/AiPlatform/samples/V1/FeatureRegistryServiceClient/create_feature_group.php b/AiPlatform/samples/V1/FeatureRegistryServiceClient/create_feature_group.php index 5a8f53f07ef9..e3eb00aca6c0 100644 --- a/AiPlatform/samples/V1/FeatureRegistryServiceClient/create_feature_group.php +++ b/AiPlatform/samples/V1/FeatureRegistryServiceClient/create_feature_group.php @@ -40,7 +40,7 @@ * @param string $featureGroupId The ID to use for this FeatureGroup, which will become the final * component of the FeatureGroup's resource name. * - * This value may be up to 60 characters, and valid characters are + * This value may be up to 128 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. * * The value must be unique within the project and location. diff --git a/AiPlatform/samples/V1/FeaturestoreServiceClient/batch_create_features.php b/AiPlatform/samples/V1/FeaturestoreServiceClient/batch_create_features.php index 2f5a4359b324..18a2d06a45c4 100644 --- a/AiPlatform/samples/V1/FeaturestoreServiceClient/batch_create_features.php +++ b/AiPlatform/samples/V1/FeaturestoreServiceClient/batch_create_features.php @@ -35,9 +35,10 @@ /** * Creates a batch of Features in a given EntityType. * - * @param string $formattedParent The resource name of the EntityType to create the batch of - * Features under. Format: + * @param string $formattedParent The resource name of the EntityType/FeatureGroup to create the + * batch of Features under. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + * `projects/{project}/locations/{location}/featureGroups/{feature_group}` * Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field. * @param string $formattedRequestsParent The resource name of the EntityType or FeatureGroup to create a * Feature. Format for entity_type as parent: diff --git a/AiPlatform/src/V1/BatchCreateFeaturesRequest.php b/AiPlatform/src/V1/BatchCreateFeaturesRequest.php index f2115669730b..66c50253b0ca 100644 --- a/AiPlatform/src/V1/BatchCreateFeaturesRequest.php +++ b/AiPlatform/src/V1/BatchCreateFeaturesRequest.php @@ -11,40 +11,44 @@ /** * Request message for * [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures]. + * Request message for + * [FeatureRegistryService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.BatchCreateFeatures]. * * Generated from protobuf message google.cloud.aiplatform.v1.BatchCreateFeaturesRequest */ class BatchCreateFeaturesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the EntityType to create the batch of - * Features under. Format: + * Required. The resource name of the EntityType/FeatureGroup to create the + * batch of Features under. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + * `projects/{project}/locations/{location}/featureGroups/{feature_group}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Required. The request message specifying the Features to create. All - * Features must be created under the same parent EntityType. The `parent` - * field in each child request message can be omitted. If `parent` is set in a - * child request, then the value must match the `parent` value in this request - * message. + * Features must be created under the same parent EntityType / FeatureGroup. + * The `parent` field in each child request message can be omitted. If + * `parent` is set in a child request, then the value must match the `parent` + * value in this request message. * * Generated from protobuf field repeated .google.cloud.aiplatform.v1.CreateFeatureRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; */ private $requests; /** - * @param string $parent Required. The resource name of the EntityType to create the batch of - * Features under. Format: + * @param string $parent Required. The resource name of the EntityType/FeatureGroup to create the + * batch of Features under. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + * `projects/{project}/locations/{location}/featureGroups/{feature_group}` * Please see {@see FeaturestoreServiceClient::entityTypeName()} for help formatting this field. * @param \Google\Cloud\AIPlatform\V1\CreateFeatureRequest[] $requests Required. The request message specifying the Features to create. All - * Features must be created under the same parent EntityType. The `parent` - * field in each child request message can be omitted. If `parent` is set in a - * child request, then the value must match the `parent` value in this request - * message. + * Features must be created under the same parent EntityType / FeatureGroup. + * The `parent` field in each child request message can be omitted. If + * `parent` is set in a child request, then the value must match the `parent` + * value in this request message. * * @return \Google\Cloud\AIPlatform\V1\BatchCreateFeaturesRequest * @@ -64,15 +68,16 @@ public static function build(string $parent, array $requests): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. The resource name of the EntityType to create the batch of - * Features under. Format: + * Required. The resource name of the EntityType/FeatureGroup to create the + * batch of Features under. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + * `projects/{project}/locations/{location}/featureGroups/{feature_group}` * @type array<\Google\Cloud\AIPlatform\V1\CreateFeatureRequest>|\Google\Protobuf\Internal\RepeatedField $requests * Required. The request message specifying the Features to create. All - * Features must be created under the same parent EntityType. The `parent` - * field in each child request message can be omitted. If `parent` is set in a - * child request, then the value must match the `parent` value in this request - * message. + * Features must be created under the same parent EntityType / FeatureGroup. + * The `parent` field in each child request message can be omitted. If + * `parent` is set in a child request, then the value must match the `parent` + * value in this request message. * } */ public function __construct($data = NULL) { @@ -81,9 +86,10 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the EntityType to create the batch of - * Features under. Format: + * Required. The resource name of the EntityType/FeatureGroup to create the + * batch of Features under. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + * `projects/{project}/locations/{location}/featureGroups/{feature_group}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -94,9 +100,10 @@ public function getParent() } /** - * Required. The resource name of the EntityType to create the batch of - * Features under. Format: + * Required. The resource name of the EntityType/FeatureGroup to create the + * batch of Features under. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + * `projects/{project}/locations/{location}/featureGroups/{feature_group}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -112,10 +119,10 @@ public function setParent($var) /** * Required. The request message specifying the Features to create. All - * Features must be created under the same parent EntityType. The `parent` - * field in each child request message can be omitted. If `parent` is set in a - * child request, then the value must match the `parent` value in this request - * message. + * Features must be created under the same parent EntityType / FeatureGroup. + * The `parent` field in each child request message can be omitted. If + * `parent` is set in a child request, then the value must match the `parent` + * value in this request message. * * Generated from protobuf field repeated .google.cloud.aiplatform.v1.CreateFeatureRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\Internal\RepeatedField @@ -127,10 +134,10 @@ public function getRequests() /** * Required. The request message specifying the Features to create. All - * Features must be created under the same parent EntityType. The `parent` - * field in each child request message can be omitted. If `parent` is set in a - * child request, then the value must match the `parent` value in this request - * message. + * Features must be created under the same parent EntityType / FeatureGroup. + * The `parent` field in each child request message can be omitted. If + * `parent` is set in a child request, then the value must match the `parent` + * value in this request message. * * Generated from protobuf field repeated .google.cloud.aiplatform.v1.CreateFeatureRequest requests = 2 [(.google.api.field_behavior) = REQUIRED]; * @param array<\Google\Cloud\AIPlatform\V1\CreateFeatureRequest>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/AiPlatform/src/V1/Client/DatasetServiceClient.php b/AiPlatform/src/V1/Client/DatasetServiceClient.php index 77f9b2213f5b..3b71beec0cf9 100644 --- a/AiPlatform/src/V1/Client/DatasetServiceClient.php +++ b/AiPlatform/src/V1/Client/DatasetServiceClient.php @@ -79,30 +79,30 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDatasetAsync(CreateDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDatasetVersionAsync(CreateDatasetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDatasetAsync(DeleteDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDatasetVersionAsync(DeleteDatasetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSavedQueryAsync(DeleteSavedQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAnnotationSpecAsync(GetAnnotationSpecRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDatasetAsync(GetDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDatasetVersionAsync(GetDatasetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAnnotationsAsync(ListAnnotationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataItemsAsync(ListDataItemsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatasetVersionsAsync(ListDatasetVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatasetsAsync(ListDatasetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSavedQueriesAsync(ListSavedQueriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreDatasetVersionAsync(RestoreDatasetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchDataItemsAsync(SearchDataItemsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDatasetAsync(UpdateDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDatasetVersionAsync(UpdateDatasetVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDatasetAsync(CreateDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDatasetVersionAsync(CreateDatasetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDatasetAsync(DeleteDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDatasetVersionAsync(DeleteDatasetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSavedQueryAsync(DeleteSavedQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportDataAsync(ExportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAnnotationSpecAsync(GetAnnotationSpecRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDatasetAsync(GetDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDatasetVersionAsync(GetDatasetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface importDataAsync(ImportDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAnnotationsAsync(ListAnnotationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataItemsAsync(ListDataItemsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatasetVersionsAsync(ListDatasetVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatasetsAsync(ListDatasetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSavedQueriesAsync(ListSavedQueriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreDatasetVersionAsync(RestoreDatasetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchDataItemsAsync(SearchDataItemsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDatasetAsync(UpdateDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDatasetVersionAsync(UpdateDatasetVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DatasetServiceClient { diff --git a/AiPlatform/src/V1/Client/DeploymentResourcePoolServiceClient.php b/AiPlatform/src/V1/Client/DeploymentResourcePoolServiceClient.php index 06ed4ee3b4e0..fcb483d629a1 100644 --- a/AiPlatform/src/V1/Client/DeploymentResourcePoolServiceClient.php +++ b/AiPlatform/src/V1/Client/DeploymentResourcePoolServiceClient.php @@ -64,17 +64,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createDeploymentResourcePoolAsync(CreateDeploymentResourcePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDeploymentResourcePoolAsync(DeleteDeploymentResourcePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDeploymentResourcePoolAsync(GetDeploymentResourcePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeploymentResourcePoolsAsync(ListDeploymentResourcePoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryDeployedModelsAsync(QueryDeployedModelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDeploymentResourcePoolAsync(UpdateDeploymentResourcePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeploymentResourcePoolAsync(CreateDeploymentResourcePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDeploymentResourcePoolAsync(DeleteDeploymentResourcePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeploymentResourcePoolAsync(GetDeploymentResourcePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeploymentResourcePoolsAsync(ListDeploymentResourcePoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryDeployedModelsAsync(QueryDeployedModelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDeploymentResourcePoolAsync(UpdateDeploymentResourcePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class DeploymentResourcePoolServiceClient { diff --git a/AiPlatform/src/V1/Client/EndpointServiceClient.php b/AiPlatform/src/V1/Client/EndpointServiceClient.php index 42ca14637f1c..eb059776a5c8 100644 --- a/AiPlatform/src/V1/Client/EndpointServiceClient.php +++ b/AiPlatform/src/V1/Client/EndpointServiceClient.php @@ -66,19 +66,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createEndpointAsync(CreateEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEndpointAsync(DeleteEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface deployModelAsync(DeployModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEndpointAsync(GetEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEndpointsAsync(ListEndpointsRequest $request, array $optionalArgs = []) - * @method PromiseInterface mutateDeployedModelAsync(MutateDeployedModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeployModelAsync(UndeployModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEndpointAsync(UpdateEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEndpointAsync(CreateEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEndpointAsync(DeleteEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface deployModelAsync(DeployModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEndpointAsync(GetEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEndpointsAsync(ListEndpointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface mutateDeployedModelAsync(MutateDeployedModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeployModelAsync(UndeployModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEndpointAsync(UpdateEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class EndpointServiceClient { diff --git a/AiPlatform/src/V1/Client/EvaluationServiceClient.php b/AiPlatform/src/V1/Client/EvaluationServiceClient.php index 2bfaad2291a9..a45b4e6859e7 100644 --- a/AiPlatform/src/V1/Client/EvaluationServiceClient.php +++ b/AiPlatform/src/V1/Client/EvaluationServiceClient.php @@ -56,12 +56,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface evaluateInstancesAsync(EvaluateInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface evaluateInstancesAsync(EvaluateInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class EvaluationServiceClient { diff --git a/AiPlatform/src/V1/Client/FeatureOnlineStoreAdminServiceClient.php b/AiPlatform/src/V1/Client/FeatureOnlineStoreAdminServiceClient.php index 229d9b445503..3697dff88bb4 100644 --- a/AiPlatform/src/V1/Client/FeatureOnlineStoreAdminServiceClient.php +++ b/AiPlatform/src/V1/Client/FeatureOnlineStoreAdminServiceClient.php @@ -75,24 +75,24 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createFeatureOnlineStoreAsync(CreateFeatureOnlineStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFeatureViewAsync(CreateFeatureViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeatureOnlineStoreAsync(DeleteFeatureOnlineStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeatureViewAsync(DeleteFeatureViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeatureOnlineStoreAsync(GetFeatureOnlineStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeatureViewAsync(GetFeatureViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeatureViewSyncAsync(GetFeatureViewSyncRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeatureOnlineStoresAsync(ListFeatureOnlineStoresRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeatureViewSyncsAsync(ListFeatureViewSyncsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeatureViewsAsync(ListFeatureViewsRequest $request, array $optionalArgs = []) - * @method PromiseInterface syncFeatureViewAsync(SyncFeatureViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFeatureOnlineStoreAsync(UpdateFeatureOnlineStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFeatureViewAsync(UpdateFeatureViewRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFeatureOnlineStoreAsync(CreateFeatureOnlineStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFeatureViewAsync(CreateFeatureViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeatureOnlineStoreAsync(DeleteFeatureOnlineStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeatureViewAsync(DeleteFeatureViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeatureOnlineStoreAsync(GetFeatureOnlineStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeatureViewAsync(GetFeatureViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeatureViewSyncAsync(GetFeatureViewSyncRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeatureOnlineStoresAsync(ListFeatureOnlineStoresRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeatureViewSyncsAsync(ListFeatureViewSyncsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeatureViewsAsync(ListFeatureViewsRequest $request, array $optionalArgs = []) + * @method PromiseInterface syncFeatureViewAsync(SyncFeatureViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFeatureOnlineStoreAsync(UpdateFeatureOnlineStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFeatureViewAsync(UpdateFeatureViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class FeatureOnlineStoreAdminServiceClient { diff --git a/AiPlatform/src/V1/Client/FeatureOnlineStoreServiceClient.php b/AiPlatform/src/V1/Client/FeatureOnlineStoreServiceClient.php index 500d0fddeeb6..e2dda47e05a3 100644 --- a/AiPlatform/src/V1/Client/FeatureOnlineStoreServiceClient.php +++ b/AiPlatform/src/V1/Client/FeatureOnlineStoreServiceClient.php @@ -58,13 +58,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface fetchFeatureValuesAsync(FetchFeatureValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchNearestEntitiesAsync(SearchNearestEntitiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchFeatureValuesAsync(FetchFeatureValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchNearestEntitiesAsync(SearchNearestEntitiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class FeatureOnlineStoreServiceClient { diff --git a/AiPlatform/src/V1/Client/FeatureRegistryServiceClient.php b/AiPlatform/src/V1/Client/FeatureRegistryServiceClient.php index 3fce584de365..2fdce0cea6c3 100644 --- a/AiPlatform/src/V1/Client/FeatureRegistryServiceClient.php +++ b/AiPlatform/src/V1/Client/FeatureRegistryServiceClient.php @@ -34,6 +34,7 @@ use Google\ApiCore\Transport\TransportInterface; use Google\ApiCore\ValidationException; use Google\Auth\FetchAuthTokenInterface; +use Google\Cloud\AIPlatform\V1\BatchCreateFeaturesRequest; use Google\Cloud\AIPlatform\V1\CreateFeatureGroupRequest; use Google\Cloud\AIPlatform\V1\CreateFeatureRequest; use Google\Cloud\AIPlatform\V1\DeleteFeatureGroupRequest; @@ -70,21 +71,22 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createFeatureAsync(CreateFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFeatureGroupAsync(CreateFeatureGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeatureAsync(DeleteFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeatureGroupAsync(DeleteFeatureGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeatureAsync(GetFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeatureGroupAsync(GetFeatureGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeatureGroupsAsync(ListFeatureGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeaturesAsync(ListFeaturesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFeatureAsync(UpdateFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFeatureGroupAsync(UpdateFeatureGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateFeaturesAsync(BatchCreateFeaturesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFeatureAsync(CreateFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFeatureGroupAsync(CreateFeatureGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeatureAsync(DeleteFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeatureGroupAsync(DeleteFeatureGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeatureAsync(GetFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeatureGroupAsync(GetFeatureGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeatureGroupsAsync(ListFeatureGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeaturesAsync(ListFeaturesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFeatureAsync(UpdateFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFeatureGroupAsync(UpdateFeatureGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class FeatureRegistryServiceClient { @@ -427,6 +429,33 @@ public function __call($method, $args) return call_user_func_array([$this, 'startAsyncCall'], $args); } + /** + * Creates a batch of Features in a given FeatureGroup. + * + * The async variant is + * {@see FeatureRegistryServiceClient::batchCreateFeaturesAsync()} . + * + * @example samples/V1/FeatureRegistryServiceClient/batch_create_features.php + * + * @param BatchCreateFeaturesRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function batchCreateFeatures(BatchCreateFeaturesRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('BatchCreateFeatures', $request, $callOptions)->wait(); + } + /** * Creates a new Feature in a given FeatureGroup. * diff --git a/AiPlatform/src/V1/Client/FeaturestoreOnlineServingServiceClient.php b/AiPlatform/src/V1/Client/FeaturestoreOnlineServingServiceClient.php index 9093868c0b76..d08581cf9157 100644 --- a/AiPlatform/src/V1/Client/FeaturestoreOnlineServingServiceClient.php +++ b/AiPlatform/src/V1/Client/FeaturestoreOnlineServingServiceClient.php @@ -60,13 +60,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface readFeatureValuesAsync(ReadFeatureValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface writeFeatureValuesAsync(WriteFeatureValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface readFeatureValuesAsync(ReadFeatureValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface writeFeatureValuesAsync(WriteFeatureValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class FeaturestoreOnlineServingServiceClient { diff --git a/AiPlatform/src/V1/Client/FeaturestoreServiceClient.php b/AiPlatform/src/V1/Client/FeaturestoreServiceClient.php index e09cb7bd6c86..9ee04d6f42f3 100644 --- a/AiPlatform/src/V1/Client/FeaturestoreServiceClient.php +++ b/AiPlatform/src/V1/Client/FeaturestoreServiceClient.php @@ -81,32 +81,32 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateFeaturesAsync(BatchCreateFeaturesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchReadFeatureValuesAsync(BatchReadFeatureValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntityTypeAsync(CreateEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFeatureAsync(CreateFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFeaturestoreAsync(CreateFeaturestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntityTypeAsync(DeleteEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeatureAsync(DeleteFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeatureValuesAsync(DeleteFeatureValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFeaturestoreAsync(DeleteFeaturestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportFeatureValuesAsync(ExportFeatureValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntityTypeAsync(GetEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeatureAsync(GetFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFeaturestoreAsync(GetFeaturestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface importFeatureValuesAsync(ImportFeatureValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntityTypesAsync(ListEntityTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeaturesAsync(ListFeaturesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFeaturestoresAsync(ListFeaturestoresRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchFeaturesAsync(SearchFeaturesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntityTypeAsync(UpdateEntityTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFeatureAsync(UpdateFeatureRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFeaturestoreAsync(UpdateFeaturestoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateFeaturesAsync(BatchCreateFeaturesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchReadFeatureValuesAsync(BatchReadFeatureValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntityTypeAsync(CreateEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFeatureAsync(CreateFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFeaturestoreAsync(CreateFeaturestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntityTypeAsync(DeleteEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeatureAsync(DeleteFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeatureValuesAsync(DeleteFeatureValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFeaturestoreAsync(DeleteFeaturestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportFeatureValuesAsync(ExportFeatureValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntityTypeAsync(GetEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeatureAsync(GetFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFeaturestoreAsync(GetFeaturestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface importFeatureValuesAsync(ImportFeatureValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntityTypesAsync(ListEntityTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeaturesAsync(ListFeaturesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFeaturestoresAsync(ListFeaturestoresRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchFeaturesAsync(SearchFeaturesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntityTypeAsync(UpdateEntityTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFeatureAsync(UpdateFeatureRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFeaturestoreAsync(UpdateFeaturestoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class FeaturestoreServiceClient { diff --git a/AiPlatform/src/V1/Client/GenAiTuningServiceClient.php b/AiPlatform/src/V1/Client/GenAiTuningServiceClient.php index 100038b5446c..ff4c08034ea6 100644 --- a/AiPlatform/src/V1/Client/GenAiTuningServiceClient.php +++ b/AiPlatform/src/V1/Client/GenAiTuningServiceClient.php @@ -63,16 +63,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface cancelTuningJobAsync(CancelTuningJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTuningJobAsync(CreateTuningJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTuningJobAsync(GetTuningJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTuningJobsAsync(ListTuningJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface rebaseTunedModelAsync(RebaseTunedModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelTuningJobAsync(CancelTuningJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTuningJobAsync(CreateTuningJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTuningJobAsync(GetTuningJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTuningJobsAsync(ListTuningJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface rebaseTunedModelAsync(RebaseTunedModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class GenAiTuningServiceClient { diff --git a/AiPlatform/src/V1/Client/IndexEndpointServiceClient.php b/AiPlatform/src/V1/Client/IndexEndpointServiceClient.php index 006557862e02..06af4a88b683 100644 --- a/AiPlatform/src/V1/Client/IndexEndpointServiceClient.php +++ b/AiPlatform/src/V1/Client/IndexEndpointServiceClient.php @@ -66,19 +66,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createIndexEndpointAsync(CreateIndexEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIndexEndpointAsync(DeleteIndexEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface deployIndexAsync(DeployIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIndexEndpointAsync(GetIndexEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIndexEndpointsAsync(ListIndexEndpointsRequest $request, array $optionalArgs = []) - * @method PromiseInterface mutateDeployedIndexAsync(MutateDeployedIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeployIndexAsync(UndeployIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateIndexEndpointAsync(UpdateIndexEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIndexEndpointAsync(CreateIndexEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIndexEndpointAsync(DeleteIndexEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface deployIndexAsync(DeployIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIndexEndpointAsync(GetIndexEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIndexEndpointsAsync(ListIndexEndpointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface mutateDeployedIndexAsync(MutateDeployedIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeployIndexAsync(UndeployIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateIndexEndpointAsync(UpdateIndexEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class IndexEndpointServiceClient { diff --git a/AiPlatform/src/V1/Client/IndexServiceClient.php b/AiPlatform/src/V1/Client/IndexServiceClient.php index b5069701c87f..75b14a5062b4 100644 --- a/AiPlatform/src/V1/Client/IndexServiceClient.php +++ b/AiPlatform/src/V1/Client/IndexServiceClient.php @@ -67,18 +67,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createIndexAsync(CreateIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteIndexAsync(DeleteIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIndexAsync(GetIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIndexesAsync(ListIndexesRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeDatapointsAsync(RemoveDatapointsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateIndexAsync(UpdateIndexRequest $request, array $optionalArgs = []) - * @method PromiseInterface upsertDatapointsAsync(UpsertDatapointsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createIndexAsync(CreateIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteIndexAsync(DeleteIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIndexAsync(GetIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIndexesAsync(ListIndexesRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeDatapointsAsync(RemoveDatapointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateIndexAsync(UpdateIndexRequest $request, array $optionalArgs = []) + * @method PromiseInterface upsertDatapointsAsync(UpsertDatapointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class IndexServiceClient { diff --git a/AiPlatform/src/V1/Client/JobServiceClient.php b/AiPlatform/src/V1/Client/JobServiceClient.php index 53f0c09b104c..96b27c184d7e 100644 --- a/AiPlatform/src/V1/Client/JobServiceClient.php +++ b/AiPlatform/src/V1/Client/JobServiceClient.php @@ -99,46 +99,46 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface cancelBatchPredictionJobAsync(CancelBatchPredictionJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelCustomJobAsync(CancelCustomJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelDataLabelingJobAsync(CancelDataLabelingJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelHyperparameterTuningJobAsync(CancelHyperparameterTuningJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelNasJobAsync(CancelNasJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBatchPredictionJobAsync(CreateBatchPredictionJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCustomJobAsync(CreateCustomJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDataLabelingJobAsync(CreateDataLabelingJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createHyperparameterTuningJobAsync(CreateHyperparameterTuningJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createModelDeploymentMonitoringJobAsync(CreateModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNasJobAsync(CreateNasJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCustomJobAsync(DeleteCustomJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNasJobAsync(DeleteNasJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBatchPredictionJobAsync(GetBatchPredictionJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCustomJobAsync(GetCustomJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDataLabelingJobAsync(GetDataLabelingJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHyperparameterTuningJobAsync(GetHyperparameterTuningJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getModelDeploymentMonitoringJobAsync(GetModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNasJobAsync(GetNasJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNasTrialDetailAsync(GetNasTrialDetailRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBatchPredictionJobsAsync(ListBatchPredictionJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCustomJobsAsync(ListCustomJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDataLabelingJobsAsync(ListDataLabelingJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listHyperparameterTuningJobsAsync(ListHyperparameterTuningJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listModelDeploymentMonitoringJobsAsync(ListModelDeploymentMonitoringJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNasJobsAsync(ListNasJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNasTrialDetailsAsync(ListNasTrialDetailsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseModelDeploymentMonitoringJobAsync(PauseModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeModelDeploymentMonitoringJobAsync(ResumeModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchModelDeploymentMonitoringStatsAnomaliesAsync(SearchModelDeploymentMonitoringStatsAnomaliesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelBatchPredictionJobAsync(CancelBatchPredictionJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelCustomJobAsync(CancelCustomJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelDataLabelingJobAsync(CancelDataLabelingJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelHyperparameterTuningJobAsync(CancelHyperparameterTuningJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelNasJobAsync(CancelNasJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBatchPredictionJobAsync(CreateBatchPredictionJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCustomJobAsync(CreateCustomJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDataLabelingJobAsync(CreateDataLabelingJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createHyperparameterTuningJobAsync(CreateHyperparameterTuningJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createModelDeploymentMonitoringJobAsync(CreateModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNasJobAsync(CreateNasJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCustomJobAsync(DeleteCustomJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNasJobAsync(DeleteNasJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBatchPredictionJobAsync(GetBatchPredictionJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCustomJobAsync(GetCustomJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDataLabelingJobAsync(GetDataLabelingJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHyperparameterTuningJobAsync(GetHyperparameterTuningJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getModelDeploymentMonitoringJobAsync(GetModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNasJobAsync(GetNasJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNasTrialDetailAsync(GetNasTrialDetailRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBatchPredictionJobsAsync(ListBatchPredictionJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCustomJobsAsync(ListCustomJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDataLabelingJobsAsync(ListDataLabelingJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listHyperparameterTuningJobsAsync(ListHyperparameterTuningJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listModelDeploymentMonitoringJobsAsync(ListModelDeploymentMonitoringJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNasJobsAsync(ListNasJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNasTrialDetailsAsync(ListNasTrialDetailsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseModelDeploymentMonitoringJobAsync(PauseModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeModelDeploymentMonitoringJobAsync(ResumeModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchModelDeploymentMonitoringStatsAnomaliesAsync(SearchModelDeploymentMonitoringStatsAnomaliesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class JobServiceClient { diff --git a/AiPlatform/src/V1/Client/LlmUtilityServiceClient.php b/AiPlatform/src/V1/Client/LlmUtilityServiceClient.php index 8091d6feb51d..32f053ca38cb 100644 --- a/AiPlatform/src/V1/Client/LlmUtilityServiceClient.php +++ b/AiPlatform/src/V1/Client/LlmUtilityServiceClient.php @@ -58,13 +58,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface computeTokensAsync(ComputeTokensRequest $request, array $optionalArgs = []) - * @method PromiseInterface countTokensAsync(CountTokensRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface computeTokensAsync(ComputeTokensRequest $request, array $optionalArgs = []) + * @method PromiseInterface countTokensAsync(CountTokensRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class LlmUtilityServiceClient { diff --git a/AiPlatform/src/V1/Client/MatchServiceClient.php b/AiPlatform/src/V1/Client/MatchServiceClient.php index 54271fc6b982..b7147a329bd7 100644 --- a/AiPlatform/src/V1/Client/MatchServiceClient.php +++ b/AiPlatform/src/V1/Client/MatchServiceClient.php @@ -59,13 +59,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface findNeighborsAsync(FindNeighborsRequest $request, array $optionalArgs = []) - * @method PromiseInterface readIndexDatapointsAsync(ReadIndexDatapointsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface findNeighborsAsync(FindNeighborsRequest $request, array $optionalArgs = []) + * @method PromiseInterface readIndexDatapointsAsync(ReadIndexDatapointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class MatchServiceClient { diff --git a/AiPlatform/src/V1/Client/MetadataServiceClient.php b/AiPlatform/src/V1/Client/MetadataServiceClient.php index 3217207f6bfe..91b8ac21dba4 100644 --- a/AiPlatform/src/V1/Client/MetadataServiceClient.php +++ b/AiPlatform/src/V1/Client/MetadataServiceClient.php @@ -100,43 +100,43 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addContextArtifactsAndExecutionsAsync(AddContextArtifactsAndExecutionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface addContextChildrenAsync(AddContextChildrenRequest $request, array $optionalArgs = []) - * @method PromiseInterface addExecutionEventsAsync(AddExecutionEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createArtifactAsync(CreateArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface createContextAsync(CreateContextRequest $request, array $optionalArgs = []) - * @method PromiseInterface createExecutionAsync(CreateExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMetadataSchemaAsync(CreateMetadataSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMetadataStoreAsync(CreateMetadataStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteArtifactAsync(DeleteArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteContextAsync(DeleteContextRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteExecutionAsync(DeleteExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMetadataStoreAsync(DeleteMetadataStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface getArtifactAsync(GetArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface getContextAsync(GetContextRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExecutionAsync(GetExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMetadataSchemaAsync(GetMetadataSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMetadataStoreAsync(GetMetadataStoreRequest $request, array $optionalArgs = []) - * @method PromiseInterface listArtifactsAsync(ListArtifactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listContextsAsync(ListContextsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExecutionsAsync(ListExecutionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMetadataSchemasAsync(ListMetadataSchemasRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMetadataStoresAsync(ListMetadataStoresRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeArtifactsAsync(PurgeArtifactsRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeContextsAsync(PurgeContextsRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeExecutionsAsync(PurgeExecutionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryArtifactLineageSubgraphAsync(QueryArtifactLineageSubgraphRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryContextLineageSubgraphAsync(QueryContextLineageSubgraphRequest $request, array $optionalArgs = []) - * @method PromiseInterface queryExecutionInputsAndOutputsAsync(QueryExecutionInputsAndOutputsRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeContextChildrenAsync(RemoveContextChildrenRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateArtifactAsync(UpdateArtifactRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateContextAsync(UpdateContextRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExecutionAsync(UpdateExecutionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface addContextArtifactsAndExecutionsAsync(AddContextArtifactsAndExecutionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface addContextChildrenAsync(AddContextChildrenRequest $request, array $optionalArgs = []) + * @method PromiseInterface addExecutionEventsAsync(AddExecutionEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createArtifactAsync(CreateArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface createContextAsync(CreateContextRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExecutionAsync(CreateExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMetadataSchemaAsync(CreateMetadataSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMetadataStoreAsync(CreateMetadataStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteArtifactAsync(DeleteArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteContextAsync(DeleteContextRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteExecutionAsync(DeleteExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMetadataStoreAsync(DeleteMetadataStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface getArtifactAsync(GetArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface getContextAsync(GetContextRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExecutionAsync(GetExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetadataSchemaAsync(GetMetadataSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetadataStoreAsync(GetMetadataStoreRequest $request, array $optionalArgs = []) + * @method PromiseInterface listArtifactsAsync(ListArtifactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listContextsAsync(ListContextsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExecutionsAsync(ListExecutionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMetadataSchemasAsync(ListMetadataSchemasRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMetadataStoresAsync(ListMetadataStoresRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeArtifactsAsync(PurgeArtifactsRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeContextsAsync(PurgeContextsRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeExecutionsAsync(PurgeExecutionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryArtifactLineageSubgraphAsync(QueryArtifactLineageSubgraphRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryContextLineageSubgraphAsync(QueryContextLineageSubgraphRequest $request, array $optionalArgs = []) + * @method PromiseInterface queryExecutionInputsAndOutputsAsync(QueryExecutionInputsAndOutputsRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeContextChildrenAsync(RemoveContextChildrenRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateArtifactAsync(UpdateArtifactRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateContextAsync(UpdateContextRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExecutionAsync(UpdateExecutionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class MetadataServiceClient { diff --git a/AiPlatform/src/V1/Client/MigrationServiceClient.php b/AiPlatform/src/V1/Client/MigrationServiceClient.php index 3cc077ea428d..c12c71540438 100644 --- a/AiPlatform/src/V1/Client/MigrationServiceClient.php +++ b/AiPlatform/src/V1/Client/MigrationServiceClient.php @@ -60,13 +60,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchMigrateResourcesAsync(BatchMigrateResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchMigratableResourcesAsync(SearchMigratableResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchMigrateResourcesAsync(BatchMigrateResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchMigratableResourcesAsync(SearchMigratableResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class MigrationServiceClient { diff --git a/AiPlatform/src/V1/Client/ModelGardenServiceClient.php b/AiPlatform/src/V1/Client/ModelGardenServiceClient.php index 67e757a1faca..3824a60a1566 100644 --- a/AiPlatform/src/V1/Client/ModelGardenServiceClient.php +++ b/AiPlatform/src/V1/Client/ModelGardenServiceClient.php @@ -56,12 +56,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getPublisherModelAsync(GetPublisherModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPublisherModelAsync(GetPublisherModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ModelGardenServiceClient { diff --git a/AiPlatform/src/V1/Client/ModelServiceClient.php b/AiPlatform/src/V1/Client/ModelServiceClient.php index 93678b94d53a..e93bd9a9fb05 100644 --- a/AiPlatform/src/V1/Client/ModelServiceClient.php +++ b/AiPlatform/src/V1/Client/ModelServiceClient.php @@ -80,29 +80,29 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchImportEvaluatedAnnotationsAsync(BatchImportEvaluatedAnnotationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchImportModelEvaluationSlicesAsync(BatchImportModelEvaluationSlicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface copyModelAsync(CopyModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteModelAsync(DeleteModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteModelVersionAsync(DeleteModelVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportModelAsync(ExportModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getModelAsync(GetModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getModelEvaluationAsync(GetModelEvaluationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getModelEvaluationSliceAsync(GetModelEvaluationSliceRequest $request, array $optionalArgs = []) - * @method PromiseInterface importModelEvaluationAsync(ImportModelEvaluationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listModelEvaluationSlicesAsync(ListModelEvaluationSlicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listModelEvaluationsAsync(ListModelEvaluationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listModelVersionsAsync(ListModelVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listModelsAsync(ListModelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface mergeVersionAliasesAsync(MergeVersionAliasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExplanationDatasetAsync(UpdateExplanationDatasetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateModelAsync(UpdateModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface uploadModelAsync(UploadModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchImportEvaluatedAnnotationsAsync(BatchImportEvaluatedAnnotationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchImportModelEvaluationSlicesAsync(BatchImportModelEvaluationSlicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface copyModelAsync(CopyModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteModelAsync(DeleteModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteModelVersionAsync(DeleteModelVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportModelAsync(ExportModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getModelAsync(GetModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getModelEvaluationAsync(GetModelEvaluationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getModelEvaluationSliceAsync(GetModelEvaluationSliceRequest $request, array $optionalArgs = []) + * @method PromiseInterface importModelEvaluationAsync(ImportModelEvaluationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listModelEvaluationSlicesAsync(ListModelEvaluationSlicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listModelEvaluationsAsync(ListModelEvaluationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listModelVersionsAsync(ListModelVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listModelsAsync(ListModelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface mergeVersionAliasesAsync(MergeVersionAliasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExplanationDatasetAsync(UpdateExplanationDatasetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateModelAsync(UpdateModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface uploadModelAsync(UploadModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ModelServiceClient { diff --git a/AiPlatform/src/V1/Client/NotebookServiceClient.php b/AiPlatform/src/V1/Client/NotebookServiceClient.php index 9d8cb349ac75..8ddb7f69f638 100644 --- a/AiPlatform/src/V1/Client/NotebookServiceClient.php +++ b/AiPlatform/src/V1/Client/NotebookServiceClient.php @@ -76,27 +76,27 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface assignNotebookRuntimeAsync(AssignNotebookRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotebookExecutionJobAsync(GetNotebookExecutionJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotebookRuntimeAsync(GetNotebookRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNotebookRuntimesAsync(ListNotebookRuntimesRequest $request, array $optionalArgs = []) - * @method PromiseInterface startNotebookRuntimeAsync(StartNotebookRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopNotebookRuntimeAsync(StopNotebookRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface upgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface assignNotebookRuntimeAsync(AssignNotebookRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotebookExecutionJobAsync(GetNotebookExecutionJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotebookRuntimeAsync(GetNotebookRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotebookRuntimesAsync(ListNotebookRuntimesRequest $request, array $optionalArgs = []) + * @method PromiseInterface startNotebookRuntimeAsync(StartNotebookRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopNotebookRuntimeAsync(StopNotebookRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface upgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class NotebookServiceClient { diff --git a/AiPlatform/src/V1/Client/PersistentResourceServiceClient.php b/AiPlatform/src/V1/Client/PersistentResourceServiceClient.php index ada16e3ce842..a48aeae0bfa9 100644 --- a/AiPlatform/src/V1/Client/PersistentResourceServiceClient.php +++ b/AiPlatform/src/V1/Client/PersistentResourceServiceClient.php @@ -64,17 +64,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createPersistentResourceAsync(CreatePersistentResourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePersistentResourceAsync(DeletePersistentResourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPersistentResourceAsync(GetPersistentResourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPersistentResourcesAsync(ListPersistentResourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface rebootPersistentResourceAsync(RebootPersistentResourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePersistentResourceAsync(UpdatePersistentResourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPersistentResourceAsync(CreatePersistentResourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePersistentResourceAsync(DeletePersistentResourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPersistentResourceAsync(GetPersistentResourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPersistentResourcesAsync(ListPersistentResourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface rebootPersistentResourceAsync(RebootPersistentResourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePersistentResourceAsync(UpdatePersistentResourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class PersistentResourceServiceClient { diff --git a/AiPlatform/src/V1/Client/PipelineServiceClient.php b/AiPlatform/src/V1/Client/PipelineServiceClient.php index c28e22b2305a..5ea3c862f664 100644 --- a/AiPlatform/src/V1/Client/PipelineServiceClient.php +++ b/AiPlatform/src/V1/Client/PipelineServiceClient.php @@ -73,23 +73,23 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCancelPipelineJobsAsync(BatchCancelPipelineJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchDeletePipelineJobsAsync(BatchDeletePipelineJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelPipelineJobAsync(CancelPipelineJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelTrainingPipelineAsync(CancelTrainingPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPipelineJobAsync(CreatePipelineJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTrainingPipelineAsync(CreateTrainingPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePipelineJobAsync(DeletePipelineJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPipelineJobAsync(GetPipelineJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTrainingPipelineAsync(GetTrainingPipelineRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPipelineJobsAsync(ListPipelineJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTrainingPipelinesAsync(ListTrainingPipelinesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCancelPipelineJobsAsync(BatchCancelPipelineJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeletePipelineJobsAsync(BatchDeletePipelineJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelPipelineJobAsync(CancelPipelineJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelTrainingPipelineAsync(CancelTrainingPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPipelineJobAsync(CreatePipelineJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTrainingPipelineAsync(CreateTrainingPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePipelineJobAsync(DeletePipelineJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPipelineJobAsync(GetPipelineJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTrainingPipelineAsync(GetTrainingPipelineRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPipelineJobsAsync(ListPipelineJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTrainingPipelinesAsync(ListTrainingPipelinesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class PipelineServiceClient { diff --git a/AiPlatform/src/V1/Client/PredictionServiceClient.php b/AiPlatform/src/V1/Client/PredictionServiceClient.php index 4d2425cdeda3..2228dd15d978 100644 --- a/AiPlatform/src/V1/Client/PredictionServiceClient.php +++ b/AiPlatform/src/V1/Client/PredictionServiceClient.php @@ -71,17 +71,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface directPredictAsync(DirectPredictRequest $request, array $optionalArgs = []) - * @method PromiseInterface directRawPredictAsync(DirectRawPredictRequest $request, array $optionalArgs = []) - * @method PromiseInterface explainAsync(ExplainRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateContentAsync(GenerateContentRequest $request, array $optionalArgs = []) - * @method PromiseInterface predictAsync(PredictRequest $request, array $optionalArgs = []) - * @method PromiseInterface rawPredictAsync(RawPredictRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface directPredictAsync(DirectPredictRequest $request, array $optionalArgs = []) + * @method PromiseInterface directRawPredictAsync(DirectRawPredictRequest $request, array $optionalArgs = []) + * @method PromiseInterface explainAsync(ExplainRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateContentAsync(GenerateContentRequest $request, array $optionalArgs = []) + * @method PromiseInterface predictAsync(PredictRequest $request, array $optionalArgs = []) + * @method PromiseInterface rawPredictAsync(RawPredictRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class PredictionServiceClient { diff --git a/AiPlatform/src/V1/Client/ScheduleServiceClient.php b/AiPlatform/src/V1/Client/ScheduleServiceClient.php index a1a97e653fba..9fd3b439007e 100644 --- a/AiPlatform/src/V1/Client/ScheduleServiceClient.php +++ b/AiPlatform/src/V1/Client/ScheduleServiceClient.php @@ -66,18 +66,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createScheduleAsync(CreateScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteScheduleAsync(DeleteScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getScheduleAsync(GetScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSchedulesAsync(ListSchedulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseScheduleAsync(PauseScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeScheduleAsync(ResumeScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateScheduleAsync(UpdateScheduleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createScheduleAsync(CreateScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteScheduleAsync(DeleteScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getScheduleAsync(GetScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSchedulesAsync(ListSchedulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseScheduleAsync(PauseScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeScheduleAsync(ResumeScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateScheduleAsync(UpdateScheduleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class ScheduleServiceClient { diff --git a/AiPlatform/src/V1/Client/SpecialistPoolServiceClient.php b/AiPlatform/src/V1/Client/SpecialistPoolServiceClient.php index 5c49591a6a63..79ba4b252c3d 100644 --- a/AiPlatform/src/V1/Client/SpecialistPoolServiceClient.php +++ b/AiPlatform/src/V1/Client/SpecialistPoolServiceClient.php @@ -68,16 +68,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createSpecialistPoolAsync(CreateSpecialistPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSpecialistPoolAsync(DeleteSpecialistPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSpecialistPoolAsync(GetSpecialistPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSpecialistPoolsAsync(ListSpecialistPoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSpecialistPoolAsync(UpdateSpecialistPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSpecialistPoolAsync(CreateSpecialistPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSpecialistPoolAsync(DeleteSpecialistPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSpecialistPoolAsync(GetSpecialistPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSpecialistPoolsAsync(ListSpecialistPoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSpecialistPoolAsync(UpdateSpecialistPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class SpecialistPoolServiceClient { diff --git a/AiPlatform/src/V1/Client/TensorboardServiceClient.php b/AiPlatform/src/V1/Client/TensorboardServiceClient.php index 5b50c06fd7b0..706e00f78777 100644 --- a/AiPlatform/src/V1/Client/TensorboardServiceClient.php +++ b/AiPlatform/src/V1/Client/TensorboardServiceClient.php @@ -100,40 +100,40 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateTensorboardRunsAsync(BatchCreateTensorboardRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchCreateTensorboardTimeSeriesAsync(BatchCreateTensorboardTimeSeriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchReadTensorboardTimeSeriesDataAsync(BatchReadTensorboardTimeSeriesDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTensorboardAsync(CreateTensorboardRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTensorboardExperimentAsync(CreateTensorboardExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTensorboardRunAsync(CreateTensorboardRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTensorboardTimeSeriesAsync(CreateTensorboardTimeSeriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTensorboardAsync(DeleteTensorboardRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTensorboardRunAsync(DeleteTensorboardRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportTensorboardTimeSeriesDataAsync(ExportTensorboardTimeSeriesDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTensorboardAsync(GetTensorboardRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTensorboardExperimentAsync(GetTensorboardExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTensorboardRunAsync(GetTensorboardRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTensorboardTimeSeriesAsync(GetTensorboardTimeSeriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTensorboardExperimentsAsync(ListTensorboardExperimentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTensorboardRunsAsync(ListTensorboardRunsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTensorboardTimeSeriesAsync(ListTensorboardTimeSeriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTensorboardsAsync(ListTensorboardsRequest $request, array $optionalArgs = []) - * @method PromiseInterface readTensorboardSizeAsync(ReadTensorboardSizeRequest $request, array $optionalArgs = []) - * @method PromiseInterface readTensorboardTimeSeriesDataAsync(ReadTensorboardTimeSeriesDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface readTensorboardUsageAsync(ReadTensorboardUsageRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTensorboardAsync(UpdateTensorboardRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTensorboardRunAsync(UpdateTensorboardRunRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface writeTensorboardExperimentDataAsync(WriteTensorboardExperimentDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface writeTensorboardRunDataAsync(WriteTensorboardRunDataRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateTensorboardRunsAsync(BatchCreateTensorboardRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateTensorboardTimeSeriesAsync(BatchCreateTensorboardTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchReadTensorboardTimeSeriesDataAsync(BatchReadTensorboardTimeSeriesDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTensorboardAsync(CreateTensorboardRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTensorboardExperimentAsync(CreateTensorboardExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTensorboardRunAsync(CreateTensorboardRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTensorboardTimeSeriesAsync(CreateTensorboardTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTensorboardAsync(DeleteTensorboardRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTensorboardRunAsync(DeleteTensorboardRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportTensorboardTimeSeriesDataAsync(ExportTensorboardTimeSeriesDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTensorboardAsync(GetTensorboardRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTensorboardExperimentAsync(GetTensorboardExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTensorboardRunAsync(GetTensorboardRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTensorboardTimeSeriesAsync(GetTensorboardTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTensorboardExperimentsAsync(ListTensorboardExperimentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTensorboardRunsAsync(ListTensorboardRunsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTensorboardTimeSeriesAsync(ListTensorboardTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTensorboardsAsync(ListTensorboardsRequest $request, array $optionalArgs = []) + * @method PromiseInterface readTensorboardSizeAsync(ReadTensorboardSizeRequest $request, array $optionalArgs = []) + * @method PromiseInterface readTensorboardTimeSeriesDataAsync(ReadTensorboardTimeSeriesDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface readTensorboardUsageAsync(ReadTensorboardUsageRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTensorboardAsync(UpdateTensorboardRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTensorboardRunAsync(UpdateTensorboardRunRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface writeTensorboardExperimentDataAsync(WriteTensorboardExperimentDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface writeTensorboardRunDataAsync(WriteTensorboardRunDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class TensorboardServiceClient { diff --git a/AiPlatform/src/V1/Client/VizierServiceClient.php b/AiPlatform/src/V1/Client/VizierServiceClient.php index a252778d3fd1..601be9a843cc 100644 --- a/AiPlatform/src/V1/Client/VizierServiceClient.php +++ b/AiPlatform/src/V1/Client/VizierServiceClient.php @@ -81,26 +81,26 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addTrialMeasurementAsync(AddTrialMeasurementRequest $request, array $optionalArgs = []) - * @method PromiseInterface checkTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest $request, array $optionalArgs = []) - * @method PromiseInterface completeTrialAsync(CompleteTrialRequest $request, array $optionalArgs = []) - * @method PromiseInterface createStudyAsync(CreateStudyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTrialAsync(CreateTrialRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteStudyAsync(DeleteStudyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTrialAsync(DeleteTrialRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStudyAsync(GetStudyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTrialAsync(GetTrialRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOptimalTrialsAsync(ListOptimalTrialsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listStudiesAsync(ListStudiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTrialsAsync(ListTrialsRequest $request, array $optionalArgs = []) - * @method PromiseInterface lookupStudyAsync(LookupStudyRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopTrialAsync(StopTrialRequest $request, array $optionalArgs = []) - * @method PromiseInterface suggestTrialsAsync(SuggestTrialsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface addTrialMeasurementAsync(AddTrialMeasurementRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest $request, array $optionalArgs = []) + * @method PromiseInterface completeTrialAsync(CompleteTrialRequest $request, array $optionalArgs = []) + * @method PromiseInterface createStudyAsync(CreateStudyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTrialAsync(CreateTrialRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteStudyAsync(DeleteStudyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTrialAsync(DeleteTrialRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStudyAsync(GetStudyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTrialAsync(GetTrialRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOptimalTrialsAsync(ListOptimalTrialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listStudiesAsync(ListStudiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTrialsAsync(ListTrialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface lookupStudyAsync(LookupStudyRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopTrialAsync(StopTrialRequest $request, array $optionalArgs = []) + * @method PromiseInterface suggestTrialsAsync(SuggestTrialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class VizierServiceClient { diff --git a/AiPlatform/src/V1/CreateFeatureGroupRequest.php b/AiPlatform/src/V1/CreateFeatureGroupRequest.php index 499466d08850..80472a85baf4 100644 --- a/AiPlatform/src/V1/CreateFeatureGroupRequest.php +++ b/AiPlatform/src/V1/CreateFeatureGroupRequest.php @@ -33,7 +33,7 @@ class CreateFeatureGroupRequest extends \Google\Protobuf\Internal\Message /** * Required. The ID to use for this FeatureGroup, which will become the final * component of the FeatureGroup's resource name. - * This value may be up to 60 characters, and valid characters are + * This value may be up to 128 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. * The value must be unique within the project and location. * @@ -50,7 +50,7 @@ class CreateFeatureGroupRequest extends \Google\Protobuf\Internal\Message * @param string $featureGroupId Required. The ID to use for this FeatureGroup, which will become the final * component of the FeatureGroup's resource name. * - * This value may be up to 60 characters, and valid characters are + * This value may be up to 128 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. * * The value must be unique within the project and location. @@ -82,7 +82,7 @@ public static function build(string $parent, \Google\Cloud\AIPlatform\V1\Feature * @type string $feature_group_id * Required. The ID to use for this FeatureGroup, which will become the final * component of the FeatureGroup's resource name. - * This value may be up to 60 characters, and valid characters are + * This value may be up to 128 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. * The value must be unique within the project and location. * } @@ -161,7 +161,7 @@ public function setFeatureGroup($var) /** * Required. The ID to use for this FeatureGroup, which will become the final * component of the FeatureGroup's resource name. - * This value may be up to 60 characters, and valid characters are + * This value may be up to 128 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. * The value must be unique within the project and location. * @@ -176,7 +176,7 @@ public function getFeatureGroupId() /** * Required. The ID to use for this FeatureGroup, which will become the final * component of the FeatureGroup's resource name. - * This value may be up to 60 characters, and valid characters are + * This value may be up to 128 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. * The value must be unique within the project and location. * diff --git a/AiPlatform/src/V1/DeployedModel.php b/AiPlatform/src/V1/DeployedModel.php index 13ddf1690b1d..d419f06649d2 100644 --- a/AiPlatform/src/V1/DeployedModel.php +++ b/AiPlatform/src/V1/DeployedModel.php @@ -130,6 +130,13 @@ class DeployedModel extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.aiplatform.v1.PrivateEndpoints private_endpoints = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $private_endpoints = null; + /** + * System labels to apply to Model Garden deployments. + * System labels are managed by Google for internal use only. + * + * Generated from protobuf field map system_labels = 28; + */ + private $system_labels; protected $prediction_resources; /** @@ -219,6 +226,9 @@ class DeployedModel extends \Google\Protobuf\Internal\Message * requests directly to the deployed model services running on Cloud via * private services access. This field is populated if * [network][google.cloud.aiplatform.v1.Endpoint.network] is configured. + * @type array|\Google\Protobuf\Internal\MapField $system_labels + * System labels to apply to Model Garden deployments. + * System labels are managed by Google for internal use only. * } */ public function __construct($data = NULL) { @@ -741,6 +751,34 @@ public function setPrivateEndpoints($var) return $this; } + /** + * System labels to apply to Model Garden deployments. + * System labels are managed by Google for internal use only. + * + * Generated from protobuf field map system_labels = 28; + * @return \Google\Protobuf\Internal\MapField + */ + public function getSystemLabels() + { + return $this->system_labels; + } + + /** + * System labels to apply to Model Garden deployments. + * System labels are managed by Google for internal use only. + * + * Generated from protobuf field map system_labels = 28; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setSystemLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->system_labels = $arr; + + return $this; + } + /** * @return string */ diff --git a/AiPlatform/src/V1/FunctionDeclaration.php b/AiPlatform/src/V1/FunctionDeclaration.php index 8499695959db..2d4ce5fff309 100644 --- a/AiPlatform/src/V1/FunctionDeclaration.php +++ b/AiPlatform/src/V1/FunctionDeclaration.php @@ -11,9 +11,9 @@ /** * Structured representation of a function declaration as defined by the * [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included - * in this declaration are the function name and parameters. This - * FunctionDeclaration is a representation of a block of code that can be used - * as a `Tool` by the model and executed by the client. + * in this declaration are the function name, description, parameters and + * response type. This FunctionDeclaration is a representation of a block of + * code that can be used as a `Tool` by the model and executed by the client. * * Generated from protobuf message google.cloud.aiplatform.v1.FunctionDeclaration */ @@ -54,6 +54,14 @@ class FunctionDeclaration extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.aiplatform.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $parameters = null; + /** + * Optional. Describes the output from this function in JSON Schema format. + * Reflects the Open API 3.03 Response Object. The Schema defines the type + * used for the response value of the function. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $response = null; /** * Constructor. @@ -84,6 +92,10 @@ class FunctionDeclaration extends \Google\Protobuf\Internal\Message * type: INTEGER * required: * - param1 + * @type \Google\Cloud\AIPlatform\V1\Schema $response + * Optional. Describes the output from this function in JSON Schema format. + * Reflects the Open API 3.03 Response Object. The Schema defines the type + * used for the response value of the function. * } */ public function __construct($data = NULL) { @@ -213,5 +225,45 @@ public function setParameters($var) return $this; } + /** + * Optional. Describes the output from this function in JSON Schema format. + * Reflects the Open API 3.03 Response Object. The Schema defines the type + * used for the response value of the function. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\AIPlatform\V1\Schema|null + */ + public function getResponse() + { + return $this->response; + } + + public function hasResponse() + { + return isset($this->response); + } + + public function clearResponse() + { + unset($this->response); + } + + /** + * Optional. Describes the output from this function in JSON Schema format. + * Reflects the Open API 3.03 Response Object. The Schema defines the type + * used for the response value of the function. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\AIPlatform\V1\Schema $var + * @return $this + */ + public function setResponse($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\Schema::class); + $this->response = $var; + + return $this; + } + } diff --git a/AiPlatform/src/V1/FunctionResponse.php b/AiPlatform/src/V1/FunctionResponse.php index 0d62db7ae42d..a2c1a859382a 100644 --- a/AiPlatform/src/V1/FunctionResponse.php +++ b/AiPlatform/src/V1/FunctionResponse.php @@ -27,6 +27,9 @@ class FunctionResponse extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Required. The function response in JSON object format. + * Use "output" key to specify function output and "error" key to specify + * error details (if any). If "output" and "error" keys are not specified, + * then whole "response" is treated as function output. * * Generated from protobuf field .google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED]; */ @@ -43,6 +46,9 @@ class FunctionResponse extends \Google\Protobuf\Internal\Message * Matches [FunctionDeclaration.name] and [FunctionCall.name]. * @type \Google\Protobuf\Struct $response * Required. The function response in JSON object format. + * Use "output" key to specify function output and "error" key to specify + * error details (if any). If "output" and "error" keys are not specified, + * then whole "response" is treated as function output. * } */ public function __construct($data = NULL) { @@ -80,6 +86,9 @@ public function setName($var) /** * Required. The function response in JSON object format. + * Use "output" key to specify function output and "error" key to specify + * error details (if any). If "output" and "error" keys are not specified, + * then whole "response" is treated as function output. * * Generated from protobuf field .google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\Struct|null @@ -101,6 +110,9 @@ public function clearResponse() /** * Required. The function response in JSON object format. + * Use "output" key to specify function output and "error" key to specify + * error details (if any). If "output" and "error" keys are not specified, + * then whole "response" is treated as function output. * * Generated from protobuf field .google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\Struct $var diff --git a/AiPlatform/src/V1/Schema.php b/AiPlatform/src/V1/Schema.php index 2bdb1b7f96c6..9a241c96c8bd 100644 --- a/AiPlatform/src/V1/Schema.php +++ b/AiPlatform/src/V1/Schema.php @@ -78,9 +78,12 @@ class Schema extends \Google\Protobuf\Internal\Message */ protected $max_items = 0; /** - * Optional. Possible values of the element of Type.STRING with enum format. - * For example we can define an Enum Direction as : - * {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + * Optional. Possible values of the element of primitive type with enum + * format. Examples: + * 1. We can define direction as : + * ```{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}``` + * 2. We can define apartment number as : + * ```{type:INTEGER, format:enum, enum:["101", "201", "301"]}``` * * Generated from protobuf field repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -196,9 +199,12 @@ class Schema extends \Google\Protobuf\Internal\Message * @type int|string $max_items * Optional. Maximum number of the elements for Type.ARRAY. * @type array|\Google\Protobuf\Internal\RepeatedField $enum - * Optional. Possible values of the element of Type.STRING with enum format. - * For example we can define an Enum Direction as : - * {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + * Optional. Possible values of the element of primitive type with enum + * format. Examples: + * 1. We can define direction as : + * ```{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}``` + * 2. We can define apartment number as : + * ```{type:INTEGER, format:enum, enum:["101", "201", "301"]}``` * @type array|\Google\Protobuf\Internal\MapField $properties * Optional. SCHEMA FIELDS FOR TYPE OBJECT * Properties of Type.OBJECT. @@ -503,9 +509,12 @@ public function setMaxItems($var) } /** - * Optional. Possible values of the element of Type.STRING with enum format. - * For example we can define an Enum Direction as : - * {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + * Optional. Possible values of the element of primitive type with enum + * format. Examples: + * 1. We can define direction as : + * ```{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}``` + * 2. We can define apartment number as : + * ```{type:INTEGER, format:enum, enum:["101", "201", "301"]}``` * * Generated from protobuf field repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -516,9 +525,12 @@ public function getEnum() } /** - * Optional. Possible values of the element of Type.STRING with enum format. - * For example we can define an Enum Direction as : - * {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + * Optional. Possible values of the element of primitive type with enum + * format. Examples: + * 1. We can define direction as : + * ```{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}``` + * 2. We can define apartment number as : + * ```{type:INTEGER, format:enum, enum:["101", "201", "301"]}``` * * Generated from protobuf field repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/AiPlatform/src/V1/Tool.php b/AiPlatform/src/V1/Tool.php index 45c00a030c0a..706defcb3900 100644 --- a/AiPlatform/src/V1/Tool.php +++ b/AiPlatform/src/V1/Tool.php @@ -28,7 +28,7 @@ class Tool extends \Google\Protobuf\Internal\Message * User should provide a [FunctionResponse][content.part.function_response] * for each function call in the next turn. Based on the function responses, * Model will generate the final response back to the user. - * Maximum 64 function declarations can be provided. + * Maximum 128 function declarations can be provided. * * Generated from protobuf field repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -64,7 +64,7 @@ class Tool extends \Google\Protobuf\Internal\Message * User should provide a [FunctionResponse][content.part.function_response] * for each function call in the next turn. Based on the function responses, * Model will generate the final response back to the user. - * Maximum 64 function declarations can be provided. + * Maximum 128 function declarations can be provided. * @type \Google\Cloud\AIPlatform\V1\Retrieval $retrieval * Optional. Retrieval tool type. * System will always execute the provided retrieval tool(s) to get external @@ -88,7 +88,7 @@ public function __construct($data = NULL) { * User should provide a [FunctionResponse][content.part.function_response] * for each function call in the next turn. Based on the function responses, * Model will generate the final response back to the user. - * Maximum 64 function declarations can be provided. + * Maximum 128 function declarations can be provided. * * Generated from protobuf field repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -106,7 +106,7 @@ public function getFunctionDeclarations() * User should provide a [FunctionResponse][content.part.function_response] * for each function call in the next turn. Based on the function responses, * Model will generate the final response back to the user. - * Maximum 64 function declarations can be provided. + * Maximum 128 function declarations can be provided. * * Generated from protobuf field repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\AIPlatform\V1\FunctionDeclaration>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/AiPlatform/src/V1/gapic_metadata.json b/AiPlatform/src/V1/gapic_metadata.json index 57e0a62d4c97..ab7dc0755506 100644 --- a/AiPlatform/src/V1/gapic_metadata.json +++ b/AiPlatform/src/V1/gapic_metadata.json @@ -647,6 +647,11 @@ "grpc": { "libraryClient": "FeatureRegistryServiceGapicClient", "rpcs": { + "BatchCreateFeatures": { + "methods": [ + "batchCreateFeatures" + ] + }, "CreateFeature": { "methods": [ "createFeature" diff --git a/AiPlatform/src/V1/resources/feature_registry_service_client_config.json b/AiPlatform/src/V1/resources/feature_registry_service_client_config.json index 2f8b1c192b2d..60e0a320f1c1 100644 --- a/AiPlatform/src/V1/resources/feature_registry_service_client_config.json +++ b/AiPlatform/src/V1/resources/feature_registry_service_client_config.json @@ -16,6 +16,11 @@ } }, "methods": { + "BatchCreateFeatures": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "CreateFeature": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", diff --git a/AiPlatform/src/V1/resources/feature_registry_service_descriptor_config.php b/AiPlatform/src/V1/resources/feature_registry_service_descriptor_config.php index 50e8960d13ae..29a468be0b0f 100644 --- a/AiPlatform/src/V1/resources/feature_registry_service_descriptor_config.php +++ b/AiPlatform/src/V1/resources/feature_registry_service_descriptor_config.php @@ -23,6 +23,25 @@ return [ 'interfaces' => [ 'google.cloud.aiplatform.v1.FeatureRegistryService' => [ + 'BatchCreateFeatures' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\AIPlatform\V1\BatchCreateFeaturesResponse', + 'metadataReturnType' => '\Google\Cloud\AIPlatform\V1\BatchCreateFeaturesOperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'CreateFeature' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\AIPlatform\V1\Feature', diff --git a/AiPlatform/src/V1/resources/feature_registry_service_rest_client_config.php b/AiPlatform/src/V1/resources/feature_registry_service_rest_client_config.php index 60a969666c64..46cdfd036967 100644 --- a/AiPlatform/src/V1/resources/feature_registry_service_rest_client_config.php +++ b/AiPlatform/src/V1/resources/feature_registry_service_rest_client_config.php @@ -23,6 +23,18 @@ return [ 'interfaces' => [ 'google.cloud.aiplatform.v1.FeatureRegistryService' => [ + 'BatchCreateFeatures' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*/featureGroups/*}/features:batchCreate', + 'body' => '*', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'CreateFeature' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*/featureGroups/*}/features', diff --git a/AiPlatform/tests/Unit/V1/Client/FeatureRegistryServiceClientTest.php b/AiPlatform/tests/Unit/V1/Client/FeatureRegistryServiceClientTest.php index 78a1713fd026..a759a823c5df 100644 --- a/AiPlatform/tests/Unit/V1/Client/FeatureRegistryServiceClientTest.php +++ b/AiPlatform/tests/Unit/V1/Client/FeatureRegistryServiceClientTest.php @@ -26,6 +26,8 @@ use Google\ApiCore\CredentialsWrapper; use Google\ApiCore\Testing\GeneratedTest; use Google\ApiCore\Testing\MockTransport; +use Google\Cloud\AIPlatform\V1\BatchCreateFeaturesRequest; +use Google\Cloud\AIPlatform\V1\BatchCreateFeaturesResponse; use Google\Cloud\AIPlatform\V1\Client\FeatureRegistryServiceClient; use Google\Cloud\AIPlatform\V1\CreateFeatureGroupRequest; use Google\Cloud\AIPlatform\V1\CreateFeatureRequest; @@ -88,6 +90,132 @@ private function createClient(array $options = []) return new FeatureRegistryServiceClient($options); } + /** @test */ + public function batchCreateFeaturesTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/batchCreateFeaturesTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new BatchCreateFeaturesResponse(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/batchCreateFeaturesTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->entityTypeName('[PROJECT]', '[LOCATION]', '[FEATURESTORE]', '[ENTITY_TYPE]'); + $requests = []; + $request = (new BatchCreateFeaturesRequest())->setParent($formattedParent)->setRequests($requests); + $response = $gapicClient->batchCreateFeatures($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.aiplatform.v1.FeatureRegistryService/BatchCreateFeatures', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getRequests(); + $this->assertProtobufEquals($requests, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/batchCreateFeaturesTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function batchCreateFeaturesExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/batchCreateFeaturesTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->entityTypeName('[PROJECT]', '[LOCATION]', '[FEATURESTORE]', '[ENTITY_TYPE]'); + $requests = []; + $request = (new BatchCreateFeaturesRequest())->setParent($formattedParent)->setRequests($requests); + $response = $gapicClient->batchCreateFeatures($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/batchCreateFeaturesTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function createFeatureTest() { @@ -1528,7 +1656,7 @@ public function testIamPermissionsExceptionTest() } /** @test */ - public function createFeatureAsyncTest() + public function batchCreateFeaturesAsyncTest() { $operationsTransport = $this->createTransport(); $operationsClient = new OperationsClient([ @@ -1545,38 +1673,22 @@ public function createFeatureAsyncTest() $this->assertTrue($operationsTransport->isExhausted()); // Mock response $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/createFeatureTest'); + $incompleteOperation->setName('operations/batchCreateFeaturesTest'); $incompleteOperation->setDone(false); $transport->addResponse($incompleteOperation); - $name = 'name3373707'; - $description = 'description-1724546052'; - $etag = 'etag3123477'; - $disableMonitoring = false; - $versionColumnName = 'versionColumnName-1981743891'; - $pointOfContact = 'pointOfContact1207498695'; - $expectedResponse = new Feature(); - $expectedResponse->setName($name); - $expectedResponse->setDescription($description); - $expectedResponse->setEtag($etag); - $expectedResponse->setDisableMonitoring($disableMonitoring); - $expectedResponse->setVersionColumnName($versionColumnName); - $expectedResponse->setPointOfContact($pointOfContact); + $expectedResponse = new BatchCreateFeaturesResponse(); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); - $completeOperation->setName('operations/createFeatureTest'); + $completeOperation->setName('operations/batchCreateFeaturesTest'); $completeOperation->setDone(true); $completeOperation->setResponse($anyResponse); $operationsTransport->addResponse($completeOperation); // Mock request $formattedParent = $gapicClient->entityTypeName('[PROJECT]', '[LOCATION]', '[FEATURESTORE]', '[ENTITY_TYPE]'); - $feature = new Feature(); - $featureId = 'featureId-150697212'; - $request = (new CreateFeatureRequest()) - ->setParent($formattedParent) - ->setFeature($feature) - ->setFeatureId($featureId); - $response = $gapicClient->createFeatureAsync($request)->wait(); + $requests = []; + $request = (new BatchCreateFeaturesRequest())->setParent($formattedParent)->setRequests($requests); + $response = $gapicClient->batchCreateFeaturesAsync($request)->wait(); $this->assertFalse($response->isDone()); $this->assertNull($response->getResult()); $apiRequests = $transport->popReceivedCalls(); @@ -1585,15 +1697,13 @@ public function createFeatureAsyncTest() $this->assertSame(0, count($operationsRequestsEmpty)); $actualApiFuncCall = $apiRequests[0]->getFuncCall(); $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.aiplatform.v1.FeatureRegistryService/CreateFeature', $actualApiFuncCall); + $this->assertSame('/google.cloud.aiplatform.v1.FeatureRegistryService/BatchCreateFeatures', $actualApiFuncCall); $actualValue = $actualApiRequestObject->getParent(); $this->assertProtobufEquals($formattedParent, $actualValue); - $actualValue = $actualApiRequestObject->getFeature(); - $this->assertProtobufEquals($feature, $actualValue); - $actualValue = $actualApiRequestObject->getFeatureId(); - $this->assertProtobufEquals($featureId, $actualValue); + $actualValue = $actualApiRequestObject->getRequests(); + $this->assertProtobufEquals($requests, $actualValue); $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/createFeatureTest'); + $expectedOperationsRequestObject->setName('operations/batchCreateFeaturesTest'); $response->pollUntilComplete([ 'initialPollDelayMillis' => 1, ]); From 28c817f8d16c1436fb9560781bab54310db43a07 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 13:10:47 -0800 Subject: [PATCH 080/157] chore: add types for async methods (#7802) PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiUG9saWN5U2ltdWxhdG9yLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiUG9saWN5VHJvdWJsZXNob290ZXIvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiUG9saWN5VHJvdWJsZXNob290ZXJJYW0vLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiUHJpdmF0ZUNhdGFsb2cvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiUHJpdmlsZWdlZEFjY2Vzc01hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiUHJvZmlsZXIvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiUHViU3ViLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiUmFwaWRNaWdyYXRpb25Bc3Nlc3NtZW50Ly5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiUmVjYXB0Y2hhRW50ZXJwcmlzZS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiUmVjb21tZW5kYXRpb25FbmdpbmUvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiUmVjb21tZW5kZXIvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiUmVkaXMvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiUmVkaXNDbHVzdGVyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiUmVzb3VyY2VNYW5hZ2VyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiUmVzb3VyY2VTZXR0aW5ncy8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiUmV0YWlsLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiUnVuLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2NoZWR1bGVyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU2VjcmV0TWFuYWdlci8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiU2VjdXJlU291cmNlTWFuYWdlci8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 * Revert "feat: add GCSVolumeSource.php.mount_options" This reverts commit 44407b46ef88a624ed7f481a90baa7063414d896. Co-authored-by: Brent Shaffer --- .../src/V1/Client/SimulatorClient.php | 6 +-- .../src/V1/Client/IamCheckerClient.php | 2 +- .../V3/Client/PolicyTroubleshooterClient.php | 2 +- .../V1beta1/Client/PrivateCatalogClient.php | 6 +-- .../Client/PrivilegedAccessManagerClient.php | 32 +++++++------- .../src/V2/Client/ExportServiceClient.php | 2 +- .../src/V2/Client/ProfilerServiceClient.php | 6 +-- PubSub/src/V1/Client/PublisherClient.php | 24 +++++----- PubSub/src/V1/Client/SchemaServiceClient.php | 26 +++++------ PubSub/src/V1/Client/SubscriberClient.php | 36 +++++++-------- .../Client/RapidMigrationAssessmentClient.php | 24 +++++----- .../RecaptchaEnterpriseServiceClient.php | 44 +++++++++---------- .../V1beta1/Client/CatalogServiceClient.php | 12 ++--- .../Client/PredictionApiKeyRegistryClient.php | 6 +-- .../Client/PredictionServiceClient.php | 2 +- .../V1beta1/Client/UserEventServiceClient.php | 10 ++--- .../src/V1/Client/RecommenderClient.php | 26 +++++------ Redis/src/V1/Client/CloudRedisClient.php | 26 +++++------ .../src/V1/Client/CloudRedisClusterClient.php | 16 +++---- .../src/V3/Client/FoldersClient.php | 22 +++++----- .../src/V3/Client/OrganizationsClient.php | 10 ++--- .../src/V3/Client/ProjectsClient.php | 22 +++++----- .../src/V3/Client/TagBindingsClient.php | 8 ++-- .../src/V3/Client/TagHoldsClient.php | 6 +-- .../src/V3/Client/TagKeysClient.php | 18 ++++---- .../src/V3/Client/TagValuesClient.php | 18 ++++---- .../Client/ResourceSettingsServiceClient.php | 6 +-- .../src/V2/Client/AnalyticsServiceClient.php | 2 +- Retail/src/V2/Client/CatalogServiceClient.php | 22 +++++----- .../src/V2/Client/CompletionServiceClient.php | 4 +- Retail/src/V2/Client/ControlServiceClient.php | 10 ++--- .../GenerativeQuestionServiceClient.php | 10 ++--- Retail/src/V2/Client/ModelServiceClient.php | 16 +++---- .../src/V2/Client/PredictionServiceClient.php | 2 +- Retail/src/V2/Client/ProductServiceClient.php | 24 +++++----- Retail/src/V2/Client/SearchServiceClient.php | 2 +- .../V2/Client/ServingConfigServiceClient.php | 14 +++--- .../src/V2/Client/UserEventServiceClient.php | 10 ++--- .../src/V1/Client/CloudSchedulerClient.php | 20 ++++----- .../V1/Client/SecretManagerServiceClient.php | 30 ++++++------- .../Client/SecretManagerServiceClient.php | 34 +++++++------- .../V1/Client/SecureSourceManagerClient.php | 42 +++++++++--------- 42 files changed, 330 insertions(+), 330 deletions(-) diff --git a/PolicySimulator/src/V1/Client/SimulatorClient.php b/PolicySimulator/src/V1/Client/SimulatorClient.php index bc08103461f1..b06626f31f47 100644 --- a/PolicySimulator/src/V1/Client/SimulatorClient.php +++ b/PolicySimulator/src/V1/Client/SimulatorClient.php @@ -64,9 +64,9 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createReplayAsync(CreateReplayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReplayAsync(GetReplayRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReplayResultsAsync(ListReplayResultsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReplayAsync(CreateReplayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReplayAsync(GetReplayRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReplayResultsAsync(ListReplayResultsRequest $request, array $optionalArgs = []) */ final class SimulatorClient { diff --git a/PolicyTroubleshooter/src/V1/Client/IamCheckerClient.php b/PolicyTroubleshooter/src/V1/Client/IamCheckerClient.php index 4efb3aee4a27..efde54a95c3d 100644 --- a/PolicyTroubleshooter/src/V1/Client/IamCheckerClient.php +++ b/PolicyTroubleshooter/src/V1/Client/IamCheckerClient.php @@ -43,7 +43,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface troubleshootIamPolicyAsync(TroubleshootIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface troubleshootIamPolicyAsync(TroubleshootIamPolicyRequest $request, array $optionalArgs = []) */ final class IamCheckerClient { diff --git a/PolicyTroubleshooterIam/src/V3/Client/PolicyTroubleshooterClient.php b/PolicyTroubleshooterIam/src/V3/Client/PolicyTroubleshooterClient.php index c42d44c26977..d7c816cfbcae 100644 --- a/PolicyTroubleshooterIam/src/V3/Client/PolicyTroubleshooterClient.php +++ b/PolicyTroubleshooterIam/src/V3/Client/PolicyTroubleshooterClient.php @@ -43,7 +43,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface troubleshootIamPolicyAsync(TroubleshootIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface troubleshootIamPolicyAsync(TroubleshootIamPolicyRequest $request, array $optionalArgs = []) */ final class PolicyTroubleshooterClient { diff --git a/PrivateCatalog/src/V1beta1/Client/PrivateCatalogClient.php b/PrivateCatalog/src/V1beta1/Client/PrivateCatalogClient.php index 875be0ed546e..c9ad2cb74280 100644 --- a/PrivateCatalog/src/V1beta1/Client/PrivateCatalogClient.php +++ b/PrivateCatalog/src/V1beta1/Client/PrivateCatalogClient.php @@ -67,9 +67,9 @@ * * @experimental * - * @method PromiseInterface searchCatalogsAsync(SearchCatalogsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchProductsAsync(SearchProductsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchVersionsAsync(SearchVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchCatalogsAsync(SearchCatalogsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchProductsAsync(SearchProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchVersionsAsync(SearchVersionsRequest $request, array $optionalArgs = []) */ final class PrivateCatalogClient { diff --git a/PrivilegedAccessManager/src/V1/Client/PrivilegedAccessManagerClient.php b/PrivilegedAccessManager/src/V1/Client/PrivilegedAccessManagerClient.php index ebdf5dba4daa..20a78d8b3685 100644 --- a/PrivilegedAccessManager/src/V1/Client/PrivilegedAccessManagerClient.php +++ b/PrivilegedAccessManager/src/V1/Client/PrivilegedAccessManagerClient.php @@ -88,22 +88,22 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface approveGrantAsync(ApproveGrantRequest $request, array $optionalArgs = []) - * @method PromiseInterface checkOnboardingStatusAsync(CheckOnboardingStatusRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEntitlementAsync(CreateEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGrantAsync(CreateGrantRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEntitlementAsync(DeleteEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface denyGrantAsync(DenyGrantRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEntitlementAsync(GetEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGrantAsync(GetGrantRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEntitlementsAsync(ListEntitlementsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGrantsAsync(ListGrantsRequest $request, array $optionalArgs = []) - * @method PromiseInterface revokeGrantAsync(RevokeGrantRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchEntitlementsAsync(SearchEntitlementsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchGrantsAsync(SearchGrantsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateEntitlementAsync(UpdateEntitlementRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface approveGrantAsync(ApproveGrantRequest $request, array $optionalArgs = []) + * @method PromiseInterface checkOnboardingStatusAsync(CheckOnboardingStatusRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEntitlementAsync(CreateEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGrantAsync(CreateGrantRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEntitlementAsync(DeleteEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface denyGrantAsync(DenyGrantRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEntitlementAsync(GetEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGrantAsync(GetGrantRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEntitlementsAsync(ListEntitlementsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGrantsAsync(ListGrantsRequest $request, array $optionalArgs = []) + * @method PromiseInterface revokeGrantAsync(RevokeGrantRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchEntitlementsAsync(SearchEntitlementsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchGrantsAsync(SearchGrantsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateEntitlementAsync(UpdateEntitlementRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class PrivilegedAccessManagerClient { diff --git a/Profiler/src/V2/Client/ExportServiceClient.php b/Profiler/src/V2/Client/ExportServiceClient.php index d57b72df683a..93c55f70d2dc 100644 --- a/Profiler/src/V2/Client/ExportServiceClient.php +++ b/Profiler/src/V2/Client/ExportServiceClient.php @@ -48,7 +48,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface listProfilesAsync(ListProfilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProfilesAsync(ListProfilesRequest $request, array $optionalArgs = []) */ final class ExportServiceClient { diff --git a/Profiler/src/V2/Client/ProfilerServiceClient.php b/Profiler/src/V2/Client/ProfilerServiceClient.php index 6a5889cb8f31..7746d3cdb12d 100644 --- a/Profiler/src/V2/Client/ProfilerServiceClient.php +++ b/Profiler/src/V2/Client/ProfilerServiceClient.php @@ -53,9 +53,9 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createOfflineProfileAsync(CreateOfflineProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface createProfileAsync(CreateProfileRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProfileAsync(UpdateProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface createOfflineProfileAsync(CreateOfflineProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface createProfileAsync(CreateProfileRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProfileAsync(UpdateProfileRequest $request, array $optionalArgs = []) */ final class ProfilerServiceClient { diff --git a/PubSub/src/V1/Client/PublisherClient.php b/PubSub/src/V1/Client/PublisherClient.php index 179d1ccd4abd..6780e7ddc0ac 100644 --- a/PubSub/src/V1/Client/PublisherClient.php +++ b/PubSub/src/V1/Client/PublisherClient.php @@ -63,18 +63,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTopicAsync(Topic $request, array $optionalArgs = []) - * @method PromiseInterface deleteTopicAsync(DeleteTopicRequest $request, array $optionalArgs = []) - * @method PromiseInterface detachSubscriptionAsync(DetachSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTopicAsync(GetTopicRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTopicSnapshotsAsync(ListTopicSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTopicSubscriptionsAsync(ListTopicSubscriptionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTopicsAsync(ListTopicsRequest $request, array $optionalArgs = []) - * @method PromiseInterface publishAsync(PublishRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTopicAsync(UpdateTopicRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTopicAsync(Topic $request, array $optionalArgs = []) + * @method PromiseInterface deleteTopicAsync(DeleteTopicRequest $request, array $optionalArgs = []) + * @method PromiseInterface detachSubscriptionAsync(DetachSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTopicAsync(GetTopicRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTopicSnapshotsAsync(ListTopicSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTopicSubscriptionsAsync(ListTopicSubscriptionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTopicsAsync(ListTopicsRequest $request, array $optionalArgs = []) + * @method PromiseInterface publishAsync(PublishRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTopicAsync(UpdateTopicRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class PublisherClient { diff --git a/PubSub/src/V1/Client/SchemaServiceClient.php b/PubSub/src/V1/Client/SchemaServiceClient.php index 5c320496d9cb..db2bfc181b2b 100644 --- a/PubSub/src/V1/Client/SchemaServiceClient.php +++ b/PubSub/src/V1/Client/SchemaServiceClient.php @@ -64,19 +64,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface commitSchemaAsync(CommitSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSchemaAsync(CreateSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSchemaAsync(DeleteSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSchemaRevisionAsync(DeleteSchemaRevisionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSchemaAsync(GetSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSchemaRevisionsAsync(ListSchemaRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSchemasAsync(ListSchemasRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackSchemaAsync(RollbackSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateMessageAsync(ValidateMessageRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateSchemaAsync(ValidateSchemaRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface commitSchemaAsync(CommitSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSchemaAsync(CreateSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSchemaAsync(DeleteSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSchemaRevisionAsync(DeleteSchemaRevisionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSchemaAsync(GetSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSchemaRevisionsAsync(ListSchemaRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSchemasAsync(ListSchemasRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackSchemaAsync(RollbackSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateMessageAsync(ValidateMessageRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateSchemaAsync(ValidateSchemaRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class SchemaServiceClient { diff --git a/PubSub/src/V1/Client/SubscriberClient.php b/PubSub/src/V1/Client/SubscriberClient.php index 97e628a8c42b..bcccf61d29d9 100644 --- a/PubSub/src/V1/Client/SubscriberClient.php +++ b/PubSub/src/V1/Client/SubscriberClient.php @@ -72,24 +72,24 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface acknowledgeAsync(AcknowledgeRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSnapshotAsync(CreateSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSubscriptionAsync(Subscription $request, array $optionalArgs = []) - * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSubscriptionAsync(DeleteSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSubscriptionAsync(GetSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSubscriptionsAsync(ListSubscriptionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface modifyAckDeadlineAsync(ModifyAckDeadlineRequest $request, array $optionalArgs = []) - * @method PromiseInterface modifyPushConfigAsync(ModifyPushConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface pullAsync(PullRequest $request, array $optionalArgs = []) - * @method PromiseInterface seekAsync(SeekRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSnapshotAsync(UpdateSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSubscriptionAsync(UpdateSubscriptionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface acknowledgeAsync(AcknowledgeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSnapshotAsync(CreateSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSubscriptionAsync(Subscription $request, array $optionalArgs = []) + * @method PromiseInterface deleteSnapshotAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSubscriptionAsync(DeleteSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSnapshotAsync(GetSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSubscriptionAsync(GetSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSnapshotsAsync(ListSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSubscriptionsAsync(ListSubscriptionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface modifyAckDeadlineAsync(ModifyAckDeadlineRequest $request, array $optionalArgs = []) + * @method PromiseInterface modifyPushConfigAsync(ModifyPushConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface pullAsync(PullRequest $request, array $optionalArgs = []) + * @method PromiseInterface seekAsync(SeekRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSnapshotAsync(UpdateSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSubscriptionAsync(UpdateSubscriptionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class SubscriberClient { diff --git a/RapidMigrationAssessment/src/V1/Client/RapidMigrationAssessmentClient.php b/RapidMigrationAssessment/src/V1/Client/RapidMigrationAssessmentClient.php index 2ee650ace77d..d94b570735b3 100644 --- a/RapidMigrationAssessment/src/V1/Client/RapidMigrationAssessmentClient.php +++ b/RapidMigrationAssessment/src/V1/Client/RapidMigrationAssessmentClient.php @@ -64,18 +64,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAnnotationAsync(CreateAnnotationRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCollectorAsync(CreateCollectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCollectorAsync(DeleteCollectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAnnotationAsync(GetAnnotationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCollectorAsync(GetCollectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCollectorsAsync(ListCollectorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseCollectorAsync(PauseCollectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface registerCollectorAsync(RegisterCollectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeCollectorAsync(ResumeCollectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCollectorAsync(UpdateCollectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAnnotationAsync(CreateAnnotationRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCollectorAsync(CreateCollectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCollectorAsync(DeleteCollectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAnnotationAsync(GetAnnotationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCollectorAsync(GetCollectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCollectorsAsync(ListCollectorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseCollectorAsync(PauseCollectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface registerCollectorAsync(RegisterCollectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeCollectorAsync(ResumeCollectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCollectorAsync(UpdateCollectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class RapidMigrationAssessmentClient { diff --git a/RecaptchaEnterprise/src/V1/Client/RecaptchaEnterpriseServiceClient.php b/RecaptchaEnterprise/src/V1/Client/RecaptchaEnterpriseServiceClient.php index 4d8c34088512..0fbe05520791 100644 --- a/RecaptchaEnterprise/src/V1/Client/RecaptchaEnterpriseServiceClient.php +++ b/RecaptchaEnterprise/src/V1/Client/RecaptchaEnterpriseServiceClient.php @@ -77,28 +77,28 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addIpOverrideAsync(AddIpOverrideRequest $request, array $optionalArgs = []) - * @method PromiseInterface annotateAssessmentAsync(AnnotateAssessmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createAssessmentAsync(CreateAssessmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createFirewallPolicyAsync(CreateFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createKeyAsync(CreateKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFirewallPolicyAsync(DeleteFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteKeyAsync(DeleteKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFirewallPolicyAsync(GetFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getKeyAsync(GetKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMetricsAsync(GetMetricsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFirewallPoliciesAsync(ListFirewallPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listIpOverridesAsync(ListIpOverridesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listKeysAsync(ListKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface migrateKeyAsync(MigrateKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeIpOverrideAsync(RemoveIpOverrideRequest $request, array $optionalArgs = []) - * @method PromiseInterface reorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface retrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFirewallPolicyAsync(UpdateFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateKeyAsync(UpdateKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addIpOverrideAsync(AddIpOverrideRequest $request, array $optionalArgs = []) + * @method PromiseInterface annotateAssessmentAsync(AnnotateAssessmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAssessmentAsync(CreateAssessmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFirewallPolicyAsync(CreateFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createKeyAsync(CreateKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFirewallPolicyAsync(DeleteFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteKeyAsync(DeleteKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFirewallPolicyAsync(GetFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getKeyAsync(GetKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetricsAsync(GetMetricsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFirewallPoliciesAsync(ListFirewallPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listIpOverridesAsync(ListIpOverridesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listKeysAsync(ListKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface migrateKeyAsync(MigrateKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeIpOverrideAsync(RemoveIpOverrideRequest $request, array $optionalArgs = []) + * @method PromiseInterface reorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface retrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFirewallPolicyAsync(UpdateFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateKeyAsync(UpdateKeyRequest $request, array $optionalArgs = []) */ final class RecaptchaEnterpriseServiceClient { diff --git a/RecommendationEngine/src/V1beta1/Client/CatalogServiceClient.php b/RecommendationEngine/src/V1beta1/Client/CatalogServiceClient.php index 54de938985f9..d8336568540b 100644 --- a/RecommendationEngine/src/V1beta1/Client/CatalogServiceClient.php +++ b/RecommendationEngine/src/V1beta1/Client/CatalogServiceClient.php @@ -60,12 +60,12 @@ * * @experimental * - * @method PromiseInterface createCatalogItemAsync(CreateCatalogItemRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCatalogItemAsync(DeleteCatalogItemRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCatalogItemAsync(GetCatalogItemRequest $request, array $optionalArgs = []) - * @method PromiseInterface importCatalogItemsAsync(ImportCatalogItemsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCatalogItemsAsync(ListCatalogItemsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCatalogItemAsync(UpdateCatalogItemRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCatalogItemAsync(CreateCatalogItemRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCatalogItemAsync(DeleteCatalogItemRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCatalogItemAsync(GetCatalogItemRequest $request, array $optionalArgs = []) + * @method PromiseInterface importCatalogItemsAsync(ImportCatalogItemsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCatalogItemsAsync(ListCatalogItemsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCatalogItemAsync(UpdateCatalogItemRequest $request, array $optionalArgs = []) */ final class CatalogServiceClient { diff --git a/RecommendationEngine/src/V1beta1/Client/PredictionApiKeyRegistryClient.php b/RecommendationEngine/src/V1beta1/Client/PredictionApiKeyRegistryClient.php index b35a126d1c28..876ec23c5774 100644 --- a/RecommendationEngine/src/V1beta1/Client/PredictionApiKeyRegistryClient.php +++ b/RecommendationEngine/src/V1beta1/Client/PredictionApiKeyRegistryClient.php @@ -58,9 +58,9 @@ * * @experimental * - * @method PromiseInterface createPredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest $request, array $optionalArgs = []) */ final class PredictionApiKeyRegistryClient { diff --git a/RecommendationEngine/src/V1beta1/Client/PredictionServiceClient.php b/RecommendationEngine/src/V1beta1/Client/PredictionServiceClient.php index 342d4437880a..2ebe94e21500 100644 --- a/RecommendationEngine/src/V1beta1/Client/PredictionServiceClient.php +++ b/RecommendationEngine/src/V1beta1/Client/PredictionServiceClient.php @@ -51,7 +51,7 @@ * * @experimental * - * @method PromiseInterface predictAsync(PredictRequest $request, array $optionalArgs = []) + * @method PromiseInterface predictAsync(PredictRequest $request, array $optionalArgs = []) */ final class PredictionServiceClient { diff --git a/RecommendationEngine/src/V1beta1/Client/UserEventServiceClient.php b/RecommendationEngine/src/V1beta1/Client/UserEventServiceClient.php index 5e440dc891d9..9a48f572ffc4 100644 --- a/RecommendationEngine/src/V1beta1/Client/UserEventServiceClient.php +++ b/RecommendationEngine/src/V1beta1/Client/UserEventServiceClient.php @@ -61,11 +61,11 @@ * * @experimental * - * @method PromiseInterface collectUserEventAsync(CollectUserEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface importUserEventsAsync(ImportUserEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUserEventsAsync(ListUserEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeUserEventsAsync(PurgeUserEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface writeUserEventAsync(WriteUserEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface collectUserEventAsync(CollectUserEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface importUserEventsAsync(ImportUserEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUserEventsAsync(ListUserEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeUserEventsAsync(PurgeUserEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface writeUserEventAsync(WriteUserEventRequest $request, array $optionalArgs = []) */ final class UserEventServiceClient { diff --git a/Recommender/src/V1/Client/RecommenderClient.php b/Recommender/src/V1/Client/RecommenderClient.php index b17f951041fe..14d42c299a4b 100644 --- a/Recommender/src/V1/Client/RecommenderClient.php +++ b/Recommender/src/V1/Client/RecommenderClient.php @@ -66,19 +66,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getInsightAsync(GetInsightRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInsightTypeConfigAsync(GetInsightTypeConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRecommendationAsync(GetRecommendationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRecommenderConfigAsync(GetRecommenderConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInsightsAsync(ListInsightsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRecommendationsAsync(ListRecommendationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface markInsightAcceptedAsync(MarkInsightAcceptedRequest $request, array $optionalArgs = []) - * @method PromiseInterface markRecommendationClaimedAsync(MarkRecommendationClaimedRequest $request, array $optionalArgs = []) - * @method PromiseInterface markRecommendationDismissedAsync(MarkRecommendationDismissedRequest $request, array $optionalArgs = []) - * @method PromiseInterface markRecommendationFailedAsync(MarkRecommendationFailedRequest $request, array $optionalArgs = []) - * @method PromiseInterface markRecommendationSucceededAsync(MarkRecommendationSucceededRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInsightTypeConfigAsync(UpdateInsightTypeConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateRecommenderConfigAsync(UpdateRecommenderConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInsightAsync(GetInsightRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInsightTypeConfigAsync(GetInsightTypeConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRecommendationAsync(GetRecommendationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRecommenderConfigAsync(GetRecommenderConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInsightsAsync(ListInsightsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRecommendationsAsync(ListRecommendationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface markInsightAcceptedAsync(MarkInsightAcceptedRequest $request, array $optionalArgs = []) + * @method PromiseInterface markRecommendationClaimedAsync(MarkRecommendationClaimedRequest $request, array $optionalArgs = []) + * @method PromiseInterface markRecommendationDismissedAsync(MarkRecommendationDismissedRequest $request, array $optionalArgs = []) + * @method PromiseInterface markRecommendationFailedAsync(MarkRecommendationFailedRequest $request, array $optionalArgs = []) + * @method PromiseInterface markRecommendationSucceededAsync(MarkRecommendationSucceededRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInsightTypeConfigAsync(UpdateInsightTypeConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateRecommenderConfigAsync(UpdateRecommenderConfigRequest $request, array $optionalArgs = []) */ final class RecommenderClient { diff --git a/Redis/src/V1/Client/CloudRedisClient.php b/Redis/src/V1/Client/CloudRedisClient.php index df3ea7b82a41..79096ee15bba 100644 --- a/Redis/src/V1/Client/CloudRedisClient.php +++ b/Redis/src/V1/Client/CloudRedisClient.php @@ -79,19 +79,19 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportInstanceAsync(ExportInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface failoverInstanceAsync(FailoverInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAuthStringAsync(GetInstanceAuthStringRequest $request, array $optionalArgs = []) - * @method PromiseInterface importInstanceAsync(ImportInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface rescheduleMaintenanceAsync(RescheduleMaintenanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface upgradeInstanceAsync(UpgradeInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportInstanceAsync(ExportInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface failoverInstanceAsync(FailoverInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAuthStringAsync(GetInstanceAuthStringRequest $request, array $optionalArgs = []) + * @method PromiseInterface importInstanceAsync(ImportInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface rescheduleMaintenanceAsync(RescheduleMaintenanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInstanceAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface upgradeInstanceAsync(UpgradeInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class CloudRedisClient { diff --git a/RedisCluster/src/V1/Client/CloudRedisClusterClient.php b/RedisCluster/src/V1/Client/CloudRedisClusterClient.php index 9522b09bc6b2..787355029549 100644 --- a/RedisCluster/src/V1/Client/CloudRedisClusterClient.php +++ b/RedisCluster/src/V1/Client/CloudRedisClusterClient.php @@ -81,14 +81,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class CloudRedisClusterClient { diff --git a/ResourceManager/src/V3/Client/FoldersClient.php b/ResourceManager/src/V3/Client/FoldersClient.php index 6c26347051f8..883d73582277 100644 --- a/ResourceManager/src/V3/Client/FoldersClient.php +++ b/ResourceManager/src/V3/Client/FoldersClient.php @@ -65,17 +65,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createFolderAsync(CreateFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFolderAsync(DeleteFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFolderAsync(GetFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFoldersAsync(ListFoldersRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveFolderAsync(MoveFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchFoldersAsync(SearchFoldersRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteFolderAsync(UndeleteFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateFolderAsync(UpdateFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFolderAsync(CreateFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFolderAsync(DeleteFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFolderAsync(GetFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFoldersAsync(ListFoldersRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveFolderAsync(MoveFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchFoldersAsync(SearchFoldersRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteFolderAsync(UndeleteFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateFolderAsync(UpdateFolderRequest $request, array $optionalArgs = []) */ final class FoldersClient { diff --git a/ResourceManager/src/V3/Client/OrganizationsClient.php b/ResourceManager/src/V3/Client/OrganizationsClient.php index 82bb43156220..99117c81acfa 100644 --- a/ResourceManager/src/V3/Client/OrganizationsClient.php +++ b/ResourceManager/src/V3/Client/OrganizationsClient.php @@ -54,11 +54,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOrganizationAsync(GetOrganizationRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchOrganizationsAsync(SearchOrganizationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOrganizationAsync(GetOrganizationRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchOrganizationsAsync(SearchOrganizationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class OrganizationsClient { diff --git a/ResourceManager/src/V3/Client/ProjectsClient.php b/ResourceManager/src/V3/Client/ProjectsClient.php index 2bcc4d121873..83a8159cbb0b 100644 --- a/ResourceManager/src/V3/Client/ProjectsClient.php +++ b/ResourceManager/src/V3/Client/ProjectsClient.php @@ -63,17 +63,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createProjectAsync(CreateProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteProjectAsync(DeleteProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProjectAsync(GetProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProjectsAsync(ListProjectsRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveProjectAsync(MoveProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchProjectsAsync(SearchProjectsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeleteProjectAsync(UndeleteProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProjectAsync(UpdateProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface createProjectAsync(CreateProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteProjectAsync(DeleteProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProjectAsync(GetProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProjectsAsync(ListProjectsRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveProjectAsync(MoveProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchProjectsAsync(SearchProjectsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeleteProjectAsync(UndeleteProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProjectAsync(UpdateProjectRequest $request, array $optionalArgs = []) */ final class ProjectsClient { diff --git a/ResourceManager/src/V3/Client/TagBindingsClient.php b/ResourceManager/src/V3/Client/TagBindingsClient.php index 54f12952c255..57fd974a33c6 100644 --- a/ResourceManager/src/V3/Client/TagBindingsClient.php +++ b/ResourceManager/src/V3/Client/TagBindingsClient.php @@ -55,10 +55,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTagBindingAsync(CreateTagBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTagBindingAsync(DeleteTagBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEffectiveTagsAsync(ListEffectiveTagsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTagBindingsAsync(ListTagBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTagBindingAsync(CreateTagBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTagBindingAsync(DeleteTagBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEffectiveTagsAsync(ListEffectiveTagsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTagBindingsAsync(ListTagBindingsRequest $request, array $optionalArgs = []) */ final class TagBindingsClient { diff --git a/ResourceManager/src/V3/Client/TagHoldsClient.php b/ResourceManager/src/V3/Client/TagHoldsClient.php index d5474a6da701..709a1fb2f960 100644 --- a/ResourceManager/src/V3/Client/TagHoldsClient.php +++ b/ResourceManager/src/V3/Client/TagHoldsClient.php @@ -57,9 +57,9 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTagHoldAsync(CreateTagHoldRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTagHoldAsync(DeleteTagHoldRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTagHoldsAsync(ListTagHoldsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTagHoldAsync(CreateTagHoldRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTagHoldAsync(DeleteTagHoldRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTagHoldsAsync(ListTagHoldsRequest $request, array $optionalArgs = []) */ final class TagHoldsClient { diff --git a/ResourceManager/src/V3/Client/TagKeysClient.php b/ResourceManager/src/V3/Client/TagKeysClient.php index 0b37596e9c06..39c31b7bae75 100644 --- a/ResourceManager/src/V3/Client/TagKeysClient.php +++ b/ResourceManager/src/V3/Client/TagKeysClient.php @@ -61,15 +61,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTagKeyAsync(CreateTagKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTagKeyAsync(DeleteTagKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNamespacedTagKeyAsync(GetNamespacedTagKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTagKeyAsync(GetTagKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTagKeysAsync(ListTagKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTagKeyAsync(UpdateTagKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTagKeyAsync(CreateTagKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTagKeyAsync(DeleteTagKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNamespacedTagKeyAsync(GetNamespacedTagKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTagKeyAsync(GetTagKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTagKeysAsync(ListTagKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTagKeyAsync(UpdateTagKeyRequest $request, array $optionalArgs = []) */ final class TagKeysClient { diff --git a/ResourceManager/src/V3/Client/TagValuesClient.php b/ResourceManager/src/V3/Client/TagValuesClient.php index 64e114ff6b2b..9be63d52e825 100644 --- a/ResourceManager/src/V3/Client/TagValuesClient.php +++ b/ResourceManager/src/V3/Client/TagValuesClient.php @@ -61,15 +61,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTagValueAsync(CreateTagValueRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTagValueAsync(DeleteTagValueRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNamespacedTagValueAsync(GetNamespacedTagValueRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTagValueAsync(GetTagValueRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTagValuesAsync(ListTagValuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTagValueAsync(UpdateTagValueRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTagValueAsync(CreateTagValueRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTagValueAsync(DeleteTagValueRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNamespacedTagValueAsync(GetNamespacedTagValueRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTagValueAsync(GetTagValueRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTagValuesAsync(ListTagValuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTagValueAsync(UpdateTagValueRequest $request, array $optionalArgs = []) */ final class TagValuesClient { diff --git a/ResourceSettings/src/V1/Client/ResourceSettingsServiceClient.php b/ResourceSettings/src/V1/Client/ResourceSettingsServiceClient.php index 937f4200a1ad..7abe165785bc 100644 --- a/ResourceSettings/src/V1/Client/ResourceSettingsServiceClient.php +++ b/ResourceSettings/src/V1/Client/ResourceSettingsServiceClient.php @@ -66,9 +66,9 @@ * * @deprecated This class will be removed in the next major version update. * - * @method PromiseInterface getSettingAsync(GetSettingRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSettingsAsync(ListSettingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSettingAsync(UpdateSettingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSettingAsync(GetSettingRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSettingsAsync(ListSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSettingAsync(UpdateSettingRequest $request, array $optionalArgs = []) */ final class ResourceSettingsServiceClient { diff --git a/Retail/src/V2/Client/AnalyticsServiceClient.php b/Retail/src/V2/Client/AnalyticsServiceClient.php index 45bb1d623016..5ff4deb39b95 100644 --- a/Retail/src/V2/Client/AnalyticsServiceClient.php +++ b/Retail/src/V2/Client/AnalyticsServiceClient.php @@ -46,7 +46,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface exportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest $request, array $optionalArgs = []) */ final class AnalyticsServiceClient { diff --git a/Retail/src/V2/Client/CatalogServiceClient.php b/Retail/src/V2/Client/CatalogServiceClient.php index 3865ce7d98db..9c01921682b5 100644 --- a/Retail/src/V2/Client/CatalogServiceClient.php +++ b/Retail/src/V2/Client/CatalogServiceClient.php @@ -61,17 +61,17 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addCatalogAttributeAsync(AddCatalogAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAttributesConfigAsync(GetAttributesConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCompletionConfigAsync(GetCompletionConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDefaultBranchAsync(GetDefaultBranchRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCatalogsAsync(ListCatalogsRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeCatalogAttributeAsync(RemoveCatalogAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface replaceCatalogAttributeAsync(ReplaceCatalogAttributeRequest $request, array $optionalArgs = []) - * @method PromiseInterface setDefaultBranchAsync(SetDefaultBranchRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAttributesConfigAsync(UpdateAttributesConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCatalogAsync(UpdateCatalogRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCompletionConfigAsync(UpdateCompletionConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface addCatalogAttributeAsync(AddCatalogAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAttributesConfigAsync(GetAttributesConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCompletionConfigAsync(GetCompletionConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDefaultBranchAsync(GetDefaultBranchRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCatalogsAsync(ListCatalogsRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeCatalogAttributeAsync(RemoveCatalogAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface replaceCatalogAttributeAsync(ReplaceCatalogAttributeRequest $request, array $optionalArgs = []) + * @method PromiseInterface setDefaultBranchAsync(SetDefaultBranchRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAttributesConfigAsync(UpdateAttributesConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCatalogAsync(UpdateCatalogRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCompletionConfigAsync(UpdateCompletionConfigRequest $request, array $optionalArgs = []) */ final class CatalogServiceClient { diff --git a/Retail/src/V2/Client/CompletionServiceClient.php b/Retail/src/V2/Client/CompletionServiceClient.php index deb9c3b64368..a82da0990a59 100644 --- a/Retail/src/V2/Client/CompletionServiceClient.php +++ b/Retail/src/V2/Client/CompletionServiceClient.php @@ -54,8 +54,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface completeQueryAsync(CompleteQueryRequest $request, array $optionalArgs = []) - * @method PromiseInterface importCompletionDataAsync(ImportCompletionDataRequest $request, array $optionalArgs = []) + * @method PromiseInterface completeQueryAsync(CompleteQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface importCompletionDataAsync(ImportCompletionDataRequest $request, array $optionalArgs = []) */ final class CompletionServiceClient { diff --git a/Retail/src/V2/Client/ControlServiceClient.php b/Retail/src/V2/Client/ControlServiceClient.php index 2d19cdfc591c..80831c870742 100644 --- a/Retail/src/V2/Client/ControlServiceClient.php +++ b/Retail/src/V2/Client/ControlServiceClient.php @@ -52,11 +52,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createControlAsync(CreateControlRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteControlAsync(DeleteControlRequest $request, array $optionalArgs = []) - * @method PromiseInterface getControlAsync(GetControlRequest $request, array $optionalArgs = []) - * @method PromiseInterface listControlsAsync(ListControlsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateControlAsync(UpdateControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface createControlAsync(CreateControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteControlAsync(DeleteControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface getControlAsync(GetControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface listControlsAsync(ListControlsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateControlAsync(UpdateControlRequest $request, array $optionalArgs = []) */ final class ControlServiceClient { diff --git a/Retail/src/V2/Client/GenerativeQuestionServiceClient.php b/Retail/src/V2/Client/GenerativeQuestionServiceClient.php index d7023d8f0d52..ee224493cf35 100644 --- a/Retail/src/V2/Client/GenerativeQuestionServiceClient.php +++ b/Retail/src/V2/Client/GenerativeQuestionServiceClient.php @@ -54,11 +54,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchUpdateGenerativeQuestionConfigsAsync(BatchUpdateGenerativeQuestionConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGenerativeQuestionsFeatureConfigAsync(GetGenerativeQuestionsFeatureConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGenerativeQuestionConfigsAsync(ListGenerativeQuestionConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGenerativeQuestionConfigAsync(UpdateGenerativeQuestionConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGenerativeQuestionsFeatureConfigAsync(UpdateGenerativeQuestionsFeatureConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateGenerativeQuestionConfigsAsync(BatchUpdateGenerativeQuestionConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGenerativeQuestionsFeatureConfigAsync(GetGenerativeQuestionsFeatureConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGenerativeQuestionConfigsAsync(ListGenerativeQuestionConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGenerativeQuestionConfigAsync(UpdateGenerativeQuestionConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGenerativeQuestionsFeatureConfigAsync(UpdateGenerativeQuestionsFeatureConfigRequest $request, array $optionalArgs = []) */ final class GenerativeQuestionServiceClient { diff --git a/Retail/src/V2/Client/ModelServiceClient.php b/Retail/src/V2/Client/ModelServiceClient.php index 2f95b651ddb1..587253bddbfb 100644 --- a/Retail/src/V2/Client/ModelServiceClient.php +++ b/Retail/src/V2/Client/ModelServiceClient.php @@ -69,14 +69,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createModelAsync(CreateModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteModelAsync(DeleteModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getModelAsync(GetModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface listModelsAsync(ListModelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseModelAsync(PauseModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeModelAsync(ResumeModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface tuneModelAsync(TuneModelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateModelAsync(UpdateModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createModelAsync(CreateModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteModelAsync(DeleteModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getModelAsync(GetModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface listModelsAsync(ListModelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseModelAsync(PauseModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeModelAsync(ResumeModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface tuneModelAsync(TuneModelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateModelAsync(UpdateModelRequest $request, array $optionalArgs = []) */ final class ModelServiceClient { diff --git a/Retail/src/V2/Client/PredictionServiceClient.php b/Retail/src/V2/Client/PredictionServiceClient.php index 043f7a768226..101211dc0bed 100644 --- a/Retail/src/V2/Client/PredictionServiceClient.php +++ b/Retail/src/V2/Client/PredictionServiceClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface predictAsync(PredictRequest $request, array $optionalArgs = []) + * @method PromiseInterface predictAsync(PredictRequest $request, array $optionalArgs = []) */ final class PredictionServiceClient { diff --git a/Retail/src/V2/Client/ProductServiceClient.php b/Retail/src/V2/Client/ProductServiceClient.php index f0946bbf2a96..038b91bc862f 100644 --- a/Retail/src/V2/Client/ProductServiceClient.php +++ b/Retail/src/V2/Client/ProductServiceClient.php @@ -63,18 +63,18 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addFulfillmentPlacesAsync(AddFulfillmentPlacesRequest $request, array $optionalArgs = []) - * @method PromiseInterface addLocalInventoriesAsync(AddLocalInventoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface createProductAsync(CreateProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteProductAsync(DeleteProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProductAsync(GetProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface importProductsAsync(ImportProductsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProductsAsync(ListProductsRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeProductsAsync(PurgeProductsRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeFulfillmentPlacesAsync(RemoveFulfillmentPlacesRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeLocalInventoriesAsync(RemoveLocalInventoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setInventoryAsync(SetInventoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProductAsync(UpdateProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface addFulfillmentPlacesAsync(AddFulfillmentPlacesRequest $request, array $optionalArgs = []) + * @method PromiseInterface addLocalInventoriesAsync(AddLocalInventoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface createProductAsync(CreateProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteProductAsync(DeleteProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProductAsync(GetProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface importProductsAsync(ImportProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProductsAsync(ListProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeProductsAsync(PurgeProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeFulfillmentPlacesAsync(RemoveFulfillmentPlacesRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeLocalInventoriesAsync(RemoveLocalInventoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setInventoryAsync(SetInventoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProductAsync(UpdateProductRequest $request, array $optionalArgs = []) */ final class ProductServiceClient { diff --git a/Retail/src/V2/Client/SearchServiceClient.php b/Retail/src/V2/Client/SearchServiceClient.php index a8c0956ce1ed..62b12dab7de6 100644 --- a/Retail/src/V2/Client/SearchServiceClient.php +++ b/Retail/src/V2/Client/SearchServiceClient.php @@ -50,7 +50,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface searchAsync(SearchRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchAsync(SearchRequest $request, array $optionalArgs = []) */ final class SearchServiceClient { diff --git a/Retail/src/V2/Client/ServingConfigServiceClient.php b/Retail/src/V2/Client/ServingConfigServiceClient.php index 0979b35510a8..6bc6d0d4aa50 100644 --- a/Retail/src/V2/Client/ServingConfigServiceClient.php +++ b/Retail/src/V2/Client/ServingConfigServiceClient.php @@ -54,13 +54,13 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addControlAsync(AddControlRequest $request, array $optionalArgs = []) - * @method PromiseInterface createServingConfigAsync(CreateServingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteServingConfigAsync(DeleteServingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getServingConfigAsync(GetServingConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServingConfigsAsync(ListServingConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeControlAsync(RemoveControlRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateServingConfigAsync(UpdateServingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface addControlAsync(AddControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface createServingConfigAsync(CreateServingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteServingConfigAsync(DeleteServingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getServingConfigAsync(GetServingConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServingConfigsAsync(ListServingConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeControlAsync(RemoveControlRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateServingConfigAsync(UpdateServingConfigRequest $request, array $optionalArgs = []) */ final class ServingConfigServiceClient { diff --git a/Retail/src/V2/Client/UserEventServiceClient.php b/Retail/src/V2/Client/UserEventServiceClient.php index 1423c1372569..a5207e1776f2 100644 --- a/Retail/src/V2/Client/UserEventServiceClient.php +++ b/Retail/src/V2/Client/UserEventServiceClient.php @@ -56,11 +56,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface collectUserEventAsync(CollectUserEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface importUserEventsAsync(ImportUserEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeUserEventsAsync(PurgeUserEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface rejoinUserEventsAsync(RejoinUserEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface writeUserEventAsync(WriteUserEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface collectUserEventAsync(CollectUserEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface importUserEventsAsync(ImportUserEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeUserEventsAsync(PurgeUserEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface rejoinUserEventsAsync(RejoinUserEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface writeUserEventAsync(WriteUserEventRequest $request, array $optionalArgs = []) */ final class UserEventServiceClient { diff --git a/Scheduler/src/V1/Client/CloudSchedulerClient.php b/Scheduler/src/V1/Client/CloudSchedulerClient.php index e07e8acde5e8..cf7183a60128 100644 --- a/Scheduler/src/V1/Client/CloudSchedulerClient.php +++ b/Scheduler/src/V1/Client/CloudSchedulerClient.php @@ -59,16 +59,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseJobAsync(PauseJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeJobAsync(ResumeJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface runJobAsync(RunJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateJobAsync(UpdateJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseJobAsync(PauseJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeJobAsync(ResumeJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface runJobAsync(RunJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateJobAsync(UpdateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class CloudSchedulerClient { diff --git a/SecretManager/src/V1/Client/SecretManagerServiceClient.php b/SecretManager/src/V1/Client/SecretManagerServiceClient.php index d7041c336da1..7631b5dbeeaf 100644 --- a/SecretManager/src/V1/Client/SecretManagerServiceClient.php +++ b/SecretManager/src/V1/Client/SecretManagerServiceClient.php @@ -72,21 +72,21 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface accessSecretVersionAsync(AccessSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface addSecretVersionAsync(AddSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSecretAsync(CreateSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSecretAsync(DeleteSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface destroySecretVersionAsync(DestroySecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface disableSecretVersionAsync(DisableSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableSecretVersionAsync(EnableSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSecretAsync(GetSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSecretVersionAsync(GetSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSecretVersionsAsync(ListSecretVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSecretsAsync(ListSecretsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSecretAsync(UpdateSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface accessSecretVersionAsync(AccessSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface addSecretVersionAsync(AddSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSecretAsync(CreateSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSecretAsync(DeleteSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface destroySecretVersionAsync(DestroySecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableSecretVersionAsync(DisableSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableSecretVersionAsync(EnableSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSecretAsync(GetSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSecretVersionAsync(GetSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSecretVersionsAsync(ListSecretVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSecretsAsync(ListSecretsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSecretAsync(UpdateSecretRequest $request, array $optionalArgs = []) */ final class SecretManagerServiceClient { diff --git a/SecretManager/src/V1beta2/Client/SecretManagerServiceClient.php b/SecretManager/src/V1beta2/Client/SecretManagerServiceClient.php index 527891f1e765..4a7f5f06cd42 100644 --- a/SecretManager/src/V1beta2/Client/SecretManagerServiceClient.php +++ b/SecretManager/src/V1beta2/Client/SecretManagerServiceClient.php @@ -79,23 +79,23 @@ * * @experimental * - * @method PromiseInterface accessSecretVersionAsync(AccessSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface addSecretVersionAsync(AddSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSecretAsync(CreateSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSecretAsync(DeleteSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface destroySecretVersionAsync(DestroySecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface disableSecretVersionAsync(DisableSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableSecretVersionAsync(EnableSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSecretAsync(GetSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSecretVersionAsync(GetSecretVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSecretVersionsAsync(ListSecretVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSecretsAsync(ListSecretsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSecretAsync(UpdateSecretRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface accessSecretVersionAsync(AccessSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface addSecretVersionAsync(AddSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSecretAsync(CreateSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSecretAsync(DeleteSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface destroySecretVersionAsync(DestroySecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableSecretVersionAsync(DisableSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableSecretVersionAsync(EnableSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSecretAsync(GetSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSecretVersionAsync(GetSecretVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSecretVersionsAsync(ListSecretVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSecretsAsync(ListSecretsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSecretAsync(UpdateSecretRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SecretManagerServiceClient { diff --git a/SecureSourceManager/src/V1/Client/SecureSourceManagerClient.php b/SecureSourceManager/src/V1/Client/SecureSourceManagerClient.php index 74d9b8633cd0..0392f3d648ea 100644 --- a/SecureSourceManager/src/V1/Client/SecureSourceManagerClient.php +++ b/SecureSourceManager/src/V1/Client/SecureSourceManagerClient.php @@ -92,27 +92,27 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createBranchRuleAsync(CreateBranchRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBranchRuleAsync(DeleteBranchRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBranchRuleAsync(GetBranchRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyRepoAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBranchRulesAsync(ListBranchRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyRepoAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsRepoAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBranchRuleAsync(UpdateBranchRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBranchRuleAsync(CreateBranchRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstanceAsync(CreateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createRepositoryAsync(CreateRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBranchRuleAsync(DeleteBranchRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstanceAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteRepositoryAsync(DeleteRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBranchRuleAsync(GetBranchRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyRepoAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInstanceAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRepositoryAsync(GetRepositoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBranchRulesAsync(ListBranchRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRepositoriesAsync(ListRepositoriesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyRepoAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsRepoAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBranchRuleAsync(UpdateBranchRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class SecureSourceManagerClient { From 8c386538b0a2337be70fbdf874a337951a2ed9e7 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 13:11:15 -0800 Subject: [PATCH 081/157] chore: add types for async methods (#7804) PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiU3FsQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU3RvcmFnZUNvbnRyb2wvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiU3RvcmFnZUluc2lnaHRzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU3RvcmFnZVRyYW5zZmVyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiU3VwcG9ydC8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiVGFsZW50Ly5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVGFza3MvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiVGVsY29BdXRvbWF0aW9uLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVGV4dFRvU3BlZWNoLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVHB1Ly5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVHJhY2UvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiVHJhbnNsYXRlLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVmlkZW9JbnRlbGxpZ2VuY2UvLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiVmlkZW9MaXZlU3RyZWFtLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVmlkZW9TdGl0Y2hlci8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 Copy-Tag: eyJwIjoiVmlkZW9UcmFuc2NvZGVyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVmlzaW9uLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVm1NaWdyYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImRiOGI1YTkzNDg0YWQ0NDA1NWIyYmFjYzRjN2NmODdlOTcwZmUwZWQifQ== Copy-Tag: eyJwIjoiVm13YXJlRW5naW5lLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= Copy-Tag: eyJwIjoiVnBjQWNjZXNzLy5Pd2xCb3QueWFtbCIsImgiOiJkYjhiNWE5MzQ4NGFkNDQwNTViMmJhY2M0YzdjZjg3ZTk3MGZlMGVkIn0= * Revert "feat: add GlossaryConfig contextual translate" This reverts commit 3df5e59ae3cabe612aa49952ec89d79606ec3896. Co-authored-by: Brent Shaffer --- .../V1/Client/SqlBackupRunsServiceClient.php | 8 +- .../src/V1/Client/SqlConnectServiceClient.php | 4 +- .../V1/Client/SqlDatabasesServiceClient.php | 12 +- .../src/V1/Client/SqlFlagsServiceClient.php | 2 +- .../V1/Client/SqlInstancesServiceClient.php | 68 ++++---- .../V1/Client/SqlOperationsServiceClient.php | 6 +- .../V1/Client/SqlSslCertsServiceClient.php | 8 +- .../src/V1/Client/SqlTiersServiceClient.php | 2 +- .../src/V1/Client/SqlUsersServiceClient.php | 10 +- .../src/V2/Client/StorageControlClient.php | 20 +-- .../src/V1/Client/StorageInsightsClient.php | 18 +- .../Client/StorageTransferServiceClient.php | 28 ++-- .../V2/Client/CaseAttachmentServiceClient.php | 2 +- Support/src/V2/Client/CaseServiceClient.php | 16 +- .../src/V2/Client/CommentServiceClient.php | 4 +- Talent/src/V4/Client/CompanyServiceClient.php | 10 +- Talent/src/V4/Client/CompletionClient.php | 2 +- Talent/src/V4/Client/EventServiceClient.php | 2 +- Talent/src/V4/Client/JobServiceClient.php | 20 +-- Talent/src/V4/Client/TenantServiceClient.php | 10 +- Tasks/src/V2/Client/CloudTasksClient.php | 36 ++-- .../src/V1/Client/TelcoAutomationClient.php | 76 ++++----- .../src/V1/Client/TextToSpeechClient.php | 4 +- .../TextToSpeechLongAudioSynthesizeClient.php | 2 +- Tpu/src/V2/Client/TpuClient.php | 30 ++-- Trace/src/V2/Client/TraceServiceClient.php | 4 +- .../Client/VideoIntelligenceServiceClient.php | 2 +- .../src/V1/Client/LivestreamServiceClient.php | 56 +++---- .../V1/Client/VideoStitcherServiceClient.php | 60 +++---- .../src/V1/Client/TranscoderServiceClient.php | 16 +- Vision/src/V1/Client/ImageAnnotatorClient.php | 8 +- Vision/src/V1/Client/ProductSearchClient.php | 38 ++--- .../src/V1/Client/VmMigrationClient.php | 96 +++++------ .../src/V1/Client/VmwareEngineClient.php | 158 +++++++++--------- .../src/V1/Client/VpcAccessServiceClient.php | 10 +- 35 files changed, 424 insertions(+), 424 deletions(-) diff --git a/SqlAdmin/src/V1/Client/SqlBackupRunsServiceClient.php b/SqlAdmin/src/V1/Client/SqlBackupRunsServiceClient.php index 18245ffda299..ab9cb33a1785 100644 --- a/SqlAdmin/src/V1/Client/SqlBackupRunsServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlBackupRunsServiceClient.php @@ -46,10 +46,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(SqlBackupRunsDeleteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(SqlBackupRunsGetRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(SqlBackupRunsInsertRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(SqlBackupRunsListRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(SqlBackupRunsDeleteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(SqlBackupRunsGetRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(SqlBackupRunsInsertRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(SqlBackupRunsListRequest $request, array $optionalArgs = []) */ final class SqlBackupRunsServiceClient { diff --git a/SqlAdmin/src/V1/Client/SqlConnectServiceClient.php b/SqlAdmin/src/V1/Client/SqlConnectServiceClient.php index 2a690a9a7e89..5edf163a47f4 100644 --- a/SqlAdmin/src/V1/Client/SqlConnectServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlConnectServiceClient.php @@ -43,8 +43,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface generateEphemeralCertAsync(GenerateEphemeralCertRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectSettingsAsync(GetConnectSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateEphemeralCertAsync(GenerateEphemeralCertRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectSettingsAsync(GetConnectSettingsRequest $request, array $optionalArgs = []) */ final class SqlConnectServiceClient { diff --git a/SqlAdmin/src/V1/Client/SqlDatabasesServiceClient.php b/SqlAdmin/src/V1/Client/SqlDatabasesServiceClient.php index 30e27179fc91..8c56e22a30e8 100644 --- a/SqlAdmin/src/V1/Client/SqlDatabasesServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlDatabasesServiceClient.php @@ -47,12 +47,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(SqlDatabasesDeleteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(SqlDatabasesGetRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(SqlDatabasesInsertRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(SqlDatabasesListRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(SqlDatabasesUpdateRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(SqlDatabasesUpdateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(SqlDatabasesDeleteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(SqlDatabasesGetRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(SqlDatabasesInsertRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(SqlDatabasesListRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(SqlDatabasesUpdateRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(SqlDatabasesUpdateRequest $request, array $optionalArgs = []) */ final class SqlDatabasesServiceClient { diff --git a/SqlAdmin/src/V1/Client/SqlFlagsServiceClient.php b/SqlAdmin/src/V1/Client/SqlFlagsServiceClient.php index 6b2f951b8d37..0cc81d7d1d91 100644 --- a/SqlAdmin/src/V1/Client/SqlFlagsServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlFlagsServiceClient.php @@ -41,7 +41,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface listAsync(SqlFlagsListRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(SqlFlagsListRequest $request, array $optionalArgs = []) */ final class SqlFlagsServiceClient { diff --git a/SqlAdmin/src/V1/Client/SqlInstancesServiceClient.php b/SqlAdmin/src/V1/Client/SqlInstancesServiceClient.php index d77cdccb41c7..bd944af1ab4f 100644 --- a/SqlAdmin/src/V1/Client/SqlInstancesServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlInstancesServiceClient.php @@ -83,40 +83,40 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface acquireSsrsLeaseAsync(SqlInstancesAcquireSsrsLeaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface addServerCaAsync(SqlInstancesAddServerCaRequest $request, array $optionalArgs = []) - * @method PromiseInterface cloneAsync(SqlInstancesCloneRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEphemeralAsync(SqlInstancesCreateEphemeralCertRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(SqlInstancesDeleteRequest $request, array $optionalArgs = []) - * @method PromiseInterface demoteAsync(SqlInstancesDemoteRequest $request, array $optionalArgs = []) - * @method PromiseInterface demoteMasterAsync(SqlInstancesDemoteMasterRequest $request, array $optionalArgs = []) - * @method PromiseInterface exportAsync(SqlInstancesExportRequest $request, array $optionalArgs = []) - * @method PromiseInterface failoverAsync(SqlInstancesFailoverRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(SqlInstancesGetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDiskShrinkConfigAsync(SqlInstancesGetDiskShrinkConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLatestRecoveryTimeAsync(SqlInstancesGetLatestRecoveryTimeRequest $request, array $optionalArgs = []) - * @method PromiseInterface importAsync(SqlInstancesImportRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(SqlInstancesInsertRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(SqlInstancesListRequest $request, array $optionalArgs = []) - * @method PromiseInterface listServerCasAsync(SqlInstancesListServerCasRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(SqlInstancesPatchRequest $request, array $optionalArgs = []) - * @method PromiseInterface performDiskShrinkAsync(SqlInstancesPerformDiskShrinkRequest $request, array $optionalArgs = []) - * @method PromiseInterface promoteReplicaAsync(SqlInstancesPromoteReplicaRequest $request, array $optionalArgs = []) - * @method PromiseInterface reencryptAsync(SqlInstancesReencryptRequest $request, array $optionalArgs = []) - * @method PromiseInterface releaseSsrsLeaseAsync(SqlInstancesReleaseSsrsLeaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface rescheduleMaintenanceAsync(SqlInstancesRescheduleMaintenanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetReplicaSizeAsync(SqlInstancesResetReplicaSizeRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetSslConfigAsync(SqlInstancesResetSslConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface restartAsync(SqlInstancesRestartRequest $request, array $optionalArgs = []) - * @method PromiseInterface restoreBackupAsync(SqlInstancesRestoreBackupRequest $request, array $optionalArgs = []) - * @method PromiseInterface rotateServerCaAsync(SqlInstancesRotateServerCaRequest $request, array $optionalArgs = []) - * @method PromiseInterface startExternalSyncAsync(SqlInstancesStartExternalSyncRequest $request, array $optionalArgs = []) - * @method PromiseInterface startReplicaAsync(SqlInstancesStartReplicaRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopReplicaAsync(SqlInstancesStopReplicaRequest $request, array $optionalArgs = []) - * @method PromiseInterface switchoverAsync(SqlInstancesSwitchoverRequest $request, array $optionalArgs = []) - * @method PromiseInterface truncateLogAsync(SqlInstancesTruncateLogRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(SqlInstancesUpdateRequest $request, array $optionalArgs = []) - * @method PromiseInterface verifyExternalSyncSettingsAsync(SqlInstancesVerifyExternalSyncSettingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface acquireSsrsLeaseAsync(SqlInstancesAcquireSsrsLeaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface addServerCaAsync(SqlInstancesAddServerCaRequest $request, array $optionalArgs = []) + * @method PromiseInterface cloneAsync(SqlInstancesCloneRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEphemeralAsync(SqlInstancesCreateEphemeralCertRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(SqlInstancesDeleteRequest $request, array $optionalArgs = []) + * @method PromiseInterface demoteAsync(SqlInstancesDemoteRequest $request, array $optionalArgs = []) + * @method PromiseInterface demoteMasterAsync(SqlInstancesDemoteMasterRequest $request, array $optionalArgs = []) + * @method PromiseInterface exportAsync(SqlInstancesExportRequest $request, array $optionalArgs = []) + * @method PromiseInterface failoverAsync(SqlInstancesFailoverRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(SqlInstancesGetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDiskShrinkConfigAsync(SqlInstancesGetDiskShrinkConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLatestRecoveryTimeAsync(SqlInstancesGetLatestRecoveryTimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface importAsync(SqlInstancesImportRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(SqlInstancesInsertRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(SqlInstancesListRequest $request, array $optionalArgs = []) + * @method PromiseInterface listServerCasAsync(SqlInstancesListServerCasRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(SqlInstancesPatchRequest $request, array $optionalArgs = []) + * @method PromiseInterface performDiskShrinkAsync(SqlInstancesPerformDiskShrinkRequest $request, array $optionalArgs = []) + * @method PromiseInterface promoteReplicaAsync(SqlInstancesPromoteReplicaRequest $request, array $optionalArgs = []) + * @method PromiseInterface reencryptAsync(SqlInstancesReencryptRequest $request, array $optionalArgs = []) + * @method PromiseInterface releaseSsrsLeaseAsync(SqlInstancesReleaseSsrsLeaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface rescheduleMaintenanceAsync(SqlInstancesRescheduleMaintenanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetReplicaSizeAsync(SqlInstancesResetReplicaSizeRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetSslConfigAsync(SqlInstancesResetSslConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface restartAsync(SqlInstancesRestartRequest $request, array $optionalArgs = []) + * @method PromiseInterface restoreBackupAsync(SqlInstancesRestoreBackupRequest $request, array $optionalArgs = []) + * @method PromiseInterface rotateServerCaAsync(SqlInstancesRotateServerCaRequest $request, array $optionalArgs = []) + * @method PromiseInterface startExternalSyncAsync(SqlInstancesStartExternalSyncRequest $request, array $optionalArgs = []) + * @method PromiseInterface startReplicaAsync(SqlInstancesStartReplicaRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopReplicaAsync(SqlInstancesStopReplicaRequest $request, array $optionalArgs = []) + * @method PromiseInterface switchoverAsync(SqlInstancesSwitchoverRequest $request, array $optionalArgs = []) + * @method PromiseInterface truncateLogAsync(SqlInstancesTruncateLogRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(SqlInstancesUpdateRequest $request, array $optionalArgs = []) + * @method PromiseInterface verifyExternalSyncSettingsAsync(SqlInstancesVerifyExternalSyncSettingsRequest $request, array $optionalArgs = []) */ final class SqlInstancesServiceClient { diff --git a/SqlAdmin/src/V1/Client/SqlOperationsServiceClient.php b/SqlAdmin/src/V1/Client/SqlOperationsServiceClient.php index 076b9c0fbbd4..cbe526e53a0c 100644 --- a/SqlAdmin/src/V1/Client/SqlOperationsServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlOperationsServiceClient.php @@ -44,9 +44,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface cancelAsync(SqlOperationsCancelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(SqlOperationsGetRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(SqlOperationsListRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelAsync(SqlOperationsCancelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(SqlOperationsGetRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(SqlOperationsListRequest $request, array $optionalArgs = []) */ final class SqlOperationsServiceClient { diff --git a/SqlAdmin/src/V1/Client/SqlSslCertsServiceClient.php b/SqlAdmin/src/V1/Client/SqlSslCertsServiceClient.php index a9773610c7b4..4068aa262cae 100644 --- a/SqlAdmin/src/V1/Client/SqlSslCertsServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlSslCertsServiceClient.php @@ -47,10 +47,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(SqlSslCertsDeleteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(SqlSslCertsGetRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(SqlSslCertsInsertRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(SqlSslCertsListRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(SqlSslCertsDeleteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(SqlSslCertsGetRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(SqlSslCertsInsertRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(SqlSslCertsListRequest $request, array $optionalArgs = []) */ final class SqlSslCertsServiceClient { diff --git a/SqlAdmin/src/V1/Client/SqlTiersServiceClient.php b/SqlAdmin/src/V1/Client/SqlTiersServiceClient.php index 0b502852ef6f..20912c5f9e76 100644 --- a/SqlAdmin/src/V1/Client/SqlTiersServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlTiersServiceClient.php @@ -41,7 +41,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface listAsync(SqlTiersListRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(SqlTiersListRequest $request, array $optionalArgs = []) */ final class SqlTiersServiceClient { diff --git a/SqlAdmin/src/V1/Client/SqlUsersServiceClient.php b/SqlAdmin/src/V1/Client/SqlUsersServiceClient.php index 52302bb14f97..2374a4d2b7dc 100644 --- a/SqlAdmin/src/V1/Client/SqlUsersServiceClient.php +++ b/SqlAdmin/src/V1/Client/SqlUsersServiceClient.php @@ -47,11 +47,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(SqlUsersDeleteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(SqlUsersGetRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(SqlUsersInsertRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(SqlUsersListRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(SqlUsersUpdateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(SqlUsersDeleteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(SqlUsersGetRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(SqlUsersInsertRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(SqlUsersListRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(SqlUsersUpdateRequest $request, array $optionalArgs = []) */ final class SqlUsersServiceClient { diff --git a/StorageControl/src/V2/Client/StorageControlClient.php b/StorageControl/src/V2/Client/StorageControlClient.php index f7358c653c9a..f013661f907c 100644 --- a/StorageControl/src/V2/Client/StorageControlClient.php +++ b/StorageControl/src/V2/Client/StorageControlClient.php @@ -62,16 +62,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createFolderAsync(CreateFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface createManagedFolderAsync(CreateManagedFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteFolderAsync(DeleteFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteManagedFolderAsync(DeleteManagedFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFolderAsync(GetFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface getManagedFolderAsync(GetManagedFolderRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStorageLayoutAsync(GetStorageLayoutRequest $request, array $optionalArgs = []) - * @method PromiseInterface listFoldersAsync(ListFoldersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listManagedFoldersAsync(ListManagedFoldersRequest $request, array $optionalArgs = []) - * @method PromiseInterface renameFolderAsync(RenameFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface createFolderAsync(CreateFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface createManagedFolderAsync(CreateManagedFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteFolderAsync(DeleteFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteManagedFolderAsync(DeleteManagedFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFolderAsync(GetFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface getManagedFolderAsync(GetManagedFolderRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStorageLayoutAsync(GetStorageLayoutRequest $request, array $optionalArgs = []) + * @method PromiseInterface listFoldersAsync(ListFoldersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listManagedFoldersAsync(ListManagedFoldersRequest $request, array $optionalArgs = []) + * @method PromiseInterface renameFolderAsync(RenameFolderRequest $request, array $optionalArgs = []) */ final class StorageControlClient { diff --git a/StorageInsights/src/V1/Client/StorageInsightsClient.php b/StorageInsights/src/V1/Client/StorageInsightsClient.php index 3150e1978763..a338ec885d75 100644 --- a/StorageInsights/src/V1/Client/StorageInsightsClient.php +++ b/StorageInsights/src/V1/Client/StorageInsightsClient.php @@ -58,15 +58,15 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createReportConfigAsync(CreateReportConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteReportConfigAsync(DeleteReportConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReportConfigAsync(GetReportConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReportDetailAsync(GetReportDetailRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReportConfigsAsync(ListReportConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReportDetailsAsync(ListReportDetailsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateReportConfigAsync(UpdateReportConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReportConfigAsync(CreateReportConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteReportConfigAsync(DeleteReportConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReportConfigAsync(GetReportConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReportDetailAsync(GetReportDetailRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReportConfigsAsync(ListReportConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReportDetailsAsync(ListReportDetailsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateReportConfigAsync(UpdateReportConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class StorageInsightsClient { diff --git a/StorageTransfer/src/V1/Client/StorageTransferServiceClient.php b/StorageTransfer/src/V1/Client/StorageTransferServiceClient.php index f1b24e46836a..41d1ff627a69 100644 --- a/StorageTransfer/src/V1/Client/StorageTransferServiceClient.php +++ b/StorageTransfer/src/V1/Client/StorageTransferServiceClient.php @@ -69,20 +69,20 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAgentPoolAsync(CreateAgentPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTransferJobAsync(CreateTransferJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAgentPoolAsync(DeleteAgentPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTransferJobAsync(DeleteTransferJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAgentPoolAsync(GetAgentPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGoogleServiceAccountAsync(GetGoogleServiceAccountRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTransferJobAsync(GetTransferJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAgentPoolsAsync(ListAgentPoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTransferJobsAsync(ListTransferJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseTransferOperationAsync(PauseTransferOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeTransferOperationAsync(ResumeTransferOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface runTransferJobAsync(RunTransferJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAgentPoolAsync(UpdateAgentPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTransferJobAsync(UpdateTransferJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAgentPoolAsync(CreateAgentPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTransferJobAsync(CreateTransferJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAgentPoolAsync(DeleteAgentPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTransferJobAsync(DeleteTransferJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAgentPoolAsync(GetAgentPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGoogleServiceAccountAsync(GetGoogleServiceAccountRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTransferJobAsync(GetTransferJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAgentPoolsAsync(ListAgentPoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTransferJobsAsync(ListTransferJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseTransferOperationAsync(PauseTransferOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeTransferOperationAsync(ResumeTransferOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface runTransferJobAsync(RunTransferJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAgentPoolAsync(UpdateAgentPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTransferJobAsync(UpdateTransferJobRequest $request, array $optionalArgs = []) */ final class StorageTransferServiceClient { diff --git a/Support/src/V2/Client/CaseAttachmentServiceClient.php b/Support/src/V2/Client/CaseAttachmentServiceClient.php index aeada38595be..d44adc2032d8 100644 --- a/Support/src/V2/Client/CaseAttachmentServiceClient.php +++ b/Support/src/V2/Client/CaseAttachmentServiceClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface listAttachmentsAsync(ListAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAttachmentsAsync(ListAttachmentsRequest $request, array $optionalArgs = []) */ final class CaseAttachmentServiceClient { diff --git a/Support/src/V2/Client/CaseServiceClient.php b/Support/src/V2/Client/CaseServiceClient.php index a4a95e040f38..6bab4803cc29 100644 --- a/Support/src/V2/Client/CaseServiceClient.php +++ b/Support/src/V2/Client/CaseServiceClient.php @@ -55,14 +55,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface closeCaseAsync(CloseCaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCaseAsync(CreateCaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface escalateCaseAsync(EscalateCaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCaseAsync(GetCaseRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCasesAsync(ListCasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchCaseClassificationsAsync(SearchCaseClassificationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchCasesAsync(SearchCasesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCaseAsync(UpdateCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface closeCaseAsync(CloseCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCaseAsync(CreateCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface escalateCaseAsync(EscalateCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCaseAsync(GetCaseRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCasesAsync(ListCasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchCaseClassificationsAsync(SearchCaseClassificationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchCasesAsync(SearchCasesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCaseAsync(UpdateCaseRequest $request, array $optionalArgs = []) */ final class CaseServiceClient { diff --git a/Support/src/V2/Client/CommentServiceClient.php b/Support/src/V2/Client/CommentServiceClient.php index 96e991fd6df9..a17ec076bf06 100644 --- a/Support/src/V2/Client/CommentServiceClient.php +++ b/Support/src/V2/Client/CommentServiceClient.php @@ -49,8 +49,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createCommentAsync(CreateCommentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCommentsAsync(ListCommentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCommentAsync(CreateCommentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCommentsAsync(ListCommentsRequest $request, array $optionalArgs = []) */ final class CommentServiceClient { diff --git a/Talent/src/V4/Client/CompanyServiceClient.php b/Talent/src/V4/Client/CompanyServiceClient.php index 9485e66d45d8..63c14c67a5c3 100644 --- a/Talent/src/V4/Client/CompanyServiceClient.php +++ b/Talent/src/V4/Client/CompanyServiceClient.php @@ -52,11 +52,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createCompanyAsync(CreateCompanyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCompanyAsync(DeleteCompanyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCompanyAsync(GetCompanyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCompaniesAsync(ListCompaniesRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCompanyAsync(UpdateCompanyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCompanyAsync(CreateCompanyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCompanyAsync(DeleteCompanyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCompanyAsync(GetCompanyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCompaniesAsync(ListCompaniesRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCompanyAsync(UpdateCompanyRequest $request, array $optionalArgs = []) */ final class CompanyServiceClient { diff --git a/Talent/src/V4/Client/CompletionClient.php b/Talent/src/V4/Client/CompletionClient.php index 9bcf4e0f9c53..7a5b0f9a965a 100644 --- a/Talent/src/V4/Client/CompletionClient.php +++ b/Talent/src/V4/Client/CompletionClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface completeQueryAsync(CompleteQueryRequest $request, array $optionalArgs = []) + * @method PromiseInterface completeQueryAsync(CompleteQueryRequest $request, array $optionalArgs = []) */ final class CompletionClient { diff --git a/Talent/src/V4/Client/EventServiceClient.php b/Talent/src/V4/Client/EventServiceClient.php index ec2d0703ea89..0b6fb7a5b45a 100644 --- a/Talent/src/V4/Client/EventServiceClient.php +++ b/Talent/src/V4/Client/EventServiceClient.php @@ -47,7 +47,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createClientEventAsync(CreateClientEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClientEventAsync(CreateClientEventRequest $request, array $optionalArgs = []) */ final class EventServiceClient { diff --git a/Talent/src/V4/Client/JobServiceClient.php b/Talent/src/V4/Client/JobServiceClient.php index c2ff40443c47..3fbb37f9737d 100644 --- a/Talent/src/V4/Client/JobServiceClient.php +++ b/Talent/src/V4/Client/JobServiceClient.php @@ -60,16 +60,16 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchCreateJobsAsync(BatchCreateJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchDeleteJobsAsync(BatchDeleteJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchUpdateJobsAsync(BatchUpdateJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchJobsAsync(SearchJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchJobsForAlertAsync(SearchJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateJobAsync(UpdateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchCreateJobsAsync(BatchCreateJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchDeleteJobsAsync(BatchDeleteJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchUpdateJobsAsync(BatchUpdateJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchJobsAsync(SearchJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchJobsForAlertAsync(SearchJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateJobAsync(UpdateJobRequest $request, array $optionalArgs = []) */ final class JobServiceClient { diff --git a/Talent/src/V4/Client/TenantServiceClient.php b/Talent/src/V4/Client/TenantServiceClient.php index bdacc9264e57..70c200a761fd 100644 --- a/Talent/src/V4/Client/TenantServiceClient.php +++ b/Talent/src/V4/Client/TenantServiceClient.php @@ -52,11 +52,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createTenantAsync(CreateTenantRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTenantAsync(DeleteTenantRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTenantAsync(GetTenantRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTenantsAsync(ListTenantsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTenantAsync(UpdateTenantRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTenantAsync(CreateTenantRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTenantAsync(DeleteTenantRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTenantAsync(GetTenantRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTenantsAsync(ListTenantsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTenantAsync(UpdateTenantRequest $request, array $optionalArgs = []) */ final class TenantServiceClient { diff --git a/Tasks/src/V2/Client/CloudTasksClient.php b/Tasks/src/V2/Client/CloudTasksClient.php index c235b01cbd71..63e400a68607 100644 --- a/Tasks/src/V2/Client/CloudTasksClient.php +++ b/Tasks/src/V2/Client/CloudTasksClient.php @@ -70,24 +70,24 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createQueueAsync(CreateQueueRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTaskAsync(CreateTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteQueueAsync(DeleteQueueRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTaskAsync(DeleteTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getQueueAsync(GetQueueRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTaskAsync(GetTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface listQueuesAsync(ListQueuesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTasksAsync(ListTasksRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseQueueAsync(PauseQueueRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeQueueAsync(PurgeQueueRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeQueueAsync(ResumeQueueRequest $request, array $optionalArgs = []) - * @method PromiseInterface runTaskAsync(RunTaskRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateQueueAsync(UpdateQueueRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createQueueAsync(CreateQueueRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTaskAsync(CreateTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteQueueAsync(DeleteQueueRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTaskAsync(DeleteTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getQueueAsync(GetQueueRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTaskAsync(GetTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface listQueuesAsync(ListQueuesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTasksAsync(ListTasksRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseQueueAsync(PauseQueueRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeQueueAsync(PurgeQueueRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeQueueAsync(ResumeQueueRequest $request, array $optionalArgs = []) + * @method PromiseInterface runTaskAsync(RunTaskRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateQueueAsync(UpdateQueueRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class CloudTasksClient { diff --git a/TelcoAutomation/src/V1/Client/TelcoAutomationClient.php b/TelcoAutomation/src/V1/Client/TelcoAutomationClient.php index c575a40978b9..dfbfcaee607b 100644 --- a/TelcoAutomation/src/V1/Client/TelcoAutomationClient.php +++ b/TelcoAutomation/src/V1/Client/TelcoAutomationClient.php @@ -101,44 +101,44 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface applyDeploymentAsync(ApplyDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface applyHydratedDeploymentAsync(ApplyHydratedDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface approveBlueprintAsync(ApproveBlueprintRequest $request, array $optionalArgs = []) - * @method PromiseInterface computeDeploymentStatusAsync(ComputeDeploymentStatusRequest $request, array $optionalArgs = []) - * @method PromiseInterface createBlueprintAsync(CreateBlueprintRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDeploymentAsync(CreateDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEdgeSlmAsync(CreateEdgeSlmRequest $request, array $optionalArgs = []) - * @method PromiseInterface createOrchestrationClusterAsync(CreateOrchestrationClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteBlueprintAsync(DeleteBlueprintRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEdgeSlmAsync(DeleteEdgeSlmRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteOrchestrationClusterAsync(DeleteOrchestrationClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface discardBlueprintChangesAsync(DiscardBlueprintChangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface discardDeploymentChangesAsync(DiscardDeploymentChangesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getBlueprintAsync(GetBlueprintRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEdgeSlmAsync(GetEdgeSlmRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHydratedDeploymentAsync(GetHydratedDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getOrchestrationClusterAsync(GetOrchestrationClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPublicBlueprintAsync(GetPublicBlueprintRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBlueprintRevisionsAsync(ListBlueprintRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listBlueprintsAsync(ListBlueprintsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeploymentRevisionsAsync(ListDeploymentRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEdgeSlmsAsync(ListEdgeSlmsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listHydratedDeploymentsAsync(ListHydratedDeploymentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listOrchestrationClustersAsync(ListOrchestrationClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPublicBlueprintsAsync(ListPublicBlueprintsRequest $request, array $optionalArgs = []) - * @method PromiseInterface proposeBlueprintAsync(ProposeBlueprintRequest $request, array $optionalArgs = []) - * @method PromiseInterface rejectBlueprintAsync(RejectBlueprintRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeDeploymentAsync(RemoveDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface rollbackDeploymentAsync(RollbackDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchBlueprintRevisionsAsync(SearchBlueprintRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface searchDeploymentRevisionsAsync(SearchDeploymentRevisionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateBlueprintAsync(UpdateBlueprintRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDeploymentAsync(UpdateDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateHydratedDeploymentAsync(UpdateHydratedDeploymentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface applyDeploymentAsync(ApplyDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface applyHydratedDeploymentAsync(ApplyHydratedDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface approveBlueprintAsync(ApproveBlueprintRequest $request, array $optionalArgs = []) + * @method PromiseInterface computeDeploymentStatusAsync(ComputeDeploymentStatusRequest $request, array $optionalArgs = []) + * @method PromiseInterface createBlueprintAsync(CreateBlueprintRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDeploymentAsync(CreateDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEdgeSlmAsync(CreateEdgeSlmRequest $request, array $optionalArgs = []) + * @method PromiseInterface createOrchestrationClusterAsync(CreateOrchestrationClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteBlueprintAsync(DeleteBlueprintRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEdgeSlmAsync(DeleteEdgeSlmRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteOrchestrationClusterAsync(DeleteOrchestrationClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface discardBlueprintChangesAsync(DiscardBlueprintChangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface discardDeploymentChangesAsync(DiscardDeploymentChangesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getBlueprintAsync(GetBlueprintRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDeploymentAsync(GetDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEdgeSlmAsync(GetEdgeSlmRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHydratedDeploymentAsync(GetHydratedDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getOrchestrationClusterAsync(GetOrchestrationClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPublicBlueprintAsync(GetPublicBlueprintRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBlueprintRevisionsAsync(ListBlueprintRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listBlueprintsAsync(ListBlueprintsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeploymentRevisionsAsync(ListDeploymentRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDeploymentsAsync(ListDeploymentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEdgeSlmsAsync(ListEdgeSlmsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listHydratedDeploymentsAsync(ListHydratedDeploymentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listOrchestrationClustersAsync(ListOrchestrationClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPublicBlueprintsAsync(ListPublicBlueprintsRequest $request, array $optionalArgs = []) + * @method PromiseInterface proposeBlueprintAsync(ProposeBlueprintRequest $request, array $optionalArgs = []) + * @method PromiseInterface rejectBlueprintAsync(RejectBlueprintRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeDeploymentAsync(RemoveDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface rollbackDeploymentAsync(RollbackDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchBlueprintRevisionsAsync(SearchBlueprintRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface searchDeploymentRevisionsAsync(SearchDeploymentRevisionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateBlueprintAsync(UpdateBlueprintRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDeploymentAsync(UpdateDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateHydratedDeploymentAsync(UpdateHydratedDeploymentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class TelcoAutomationClient { diff --git a/TextToSpeech/src/V1/Client/TextToSpeechClient.php b/TextToSpeech/src/V1/Client/TextToSpeechClient.php index de30a4de55b1..fee05b775d9e 100644 --- a/TextToSpeech/src/V1/Client/TextToSpeechClient.php +++ b/TextToSpeech/src/V1/Client/TextToSpeechClient.php @@ -50,8 +50,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface listVoicesAsync(ListVoicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface synthesizeSpeechAsync(SynthesizeSpeechRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVoicesAsync(ListVoicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface synthesizeSpeechAsync(SynthesizeSpeechRequest $request, array $optionalArgs = []) */ final class TextToSpeechClient { diff --git a/TextToSpeech/src/V1/Client/TextToSpeechLongAudioSynthesizeClient.php b/TextToSpeech/src/V1/Client/TextToSpeechLongAudioSynthesizeClient.php index 4cba6f089c1d..41093acd73df 100644 --- a/TextToSpeech/src/V1/Client/TextToSpeechLongAudioSynthesizeClient.php +++ b/TextToSpeech/src/V1/Client/TextToSpeechLongAudioSynthesizeClient.php @@ -49,7 +49,7 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface synthesizeLongAudioAsync(SynthesizeLongAudioRequest $request, array $optionalArgs = []) + * @method PromiseInterface synthesizeLongAudioAsync(SynthesizeLongAudioRequest $request, array $optionalArgs = []) */ final class TextToSpeechLongAudioSynthesizeClient { diff --git a/Tpu/src/V2/Client/TpuClient.php b/Tpu/src/V2/Client/TpuClient.php index 024bf050a566..be4f90160919 100644 --- a/Tpu/src/V2/Client/TpuClient.php +++ b/Tpu/src/V2/Client/TpuClient.php @@ -72,21 +72,21 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createNodeAsync(CreateNodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNodeAsync(DeleteNodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface generateServiceIdentityAsync(GenerateServiceIdentityRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAcceleratorTypeAsync(GetAcceleratorTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGuestAttributesAsync(GetGuestAttributesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNodeAsync(GetNodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuntimeVersionAsync(GetRuntimeVersionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAcceleratorTypesAsync(ListAcceleratorTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNodesAsync(ListNodesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listRuntimeVersionsAsync(ListRuntimeVersionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface startNodeAsync(StartNodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopNodeAsync(StopNodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNodeAsync(UpdateNodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNodeAsync(CreateNodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNodeAsync(DeleteNodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface generateServiceIdentityAsync(GenerateServiceIdentityRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAcceleratorTypeAsync(GetAcceleratorTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGuestAttributesAsync(GetGuestAttributesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNodeAsync(GetNodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuntimeVersionAsync(GetRuntimeVersionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAcceleratorTypesAsync(ListAcceleratorTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNodesAsync(ListNodesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listRuntimeVersionsAsync(ListRuntimeVersionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface startNodeAsync(StartNodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopNodeAsync(StopNodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNodeAsync(UpdateNodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class TpuClient { diff --git a/Trace/src/V2/Client/TraceServiceClient.php b/Trace/src/V2/Client/TraceServiceClient.php index 93a656aa45ea..da8c98f524a0 100644 --- a/Trace/src/V2/Client/TraceServiceClient.php +++ b/Trace/src/V2/Client/TraceServiceClient.php @@ -53,8 +53,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface batchWriteSpansAsync(BatchWriteSpansRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSpanAsync(Span $request, array $optionalArgs = []) + * @method PromiseInterface batchWriteSpansAsync(BatchWriteSpansRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSpanAsync(Span $request, array $optionalArgs = []) */ final class TraceServiceClient { diff --git a/VideoIntelligence/src/V1/Client/VideoIntelligenceServiceClient.php b/VideoIntelligence/src/V1/Client/VideoIntelligenceServiceClient.php index dd3dc22d8d16..3cae5880936d 100644 --- a/VideoIntelligence/src/V1/Client/VideoIntelligenceServiceClient.php +++ b/VideoIntelligence/src/V1/Client/VideoIntelligenceServiceClient.php @@ -45,7 +45,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface annotateVideoAsync(AnnotateVideoRequest $request, array $optionalArgs = []) + * @method PromiseInterface annotateVideoAsync(AnnotateVideoRequest $request, array $optionalArgs = []) */ final class VideoIntelligenceServiceClient { diff --git a/VideoLiveStream/src/V1/Client/LivestreamServiceClient.php b/VideoLiveStream/src/V1/Client/LivestreamServiceClient.php index 548cd8a08028..bea00f58aad0 100644 --- a/VideoLiveStream/src/V1/Client/LivestreamServiceClient.php +++ b/VideoLiveStream/src/V1/Client/LivestreamServiceClient.php @@ -88,34 +88,34 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createAssetAsync(CreateAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createChannelAsync(CreateChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface createClipAsync(CreateClipRequest $request, array $optionalArgs = []) - * @method PromiseInterface createEventAsync(CreateEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInputAsync(CreateInputRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAssetAsync(DeleteAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteChannelAsync(DeleteChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClipAsync(DeleteClipRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteEventAsync(DeleteEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInputAsync(DeleteInputRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAssetAsync(GetAssetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getChannelAsync(GetChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClipAsync(GetClipRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEventAsync(GetEventRequest $request, array $optionalArgs = []) - * @method PromiseInterface getInputAsync(GetInputRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPoolAsync(GetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listChannelsAsync(ListChannelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClipsAsync(ListClipsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listEventsAsync(ListEventsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInputsAsync(ListInputsRequest $request, array $optionalArgs = []) - * @method PromiseInterface startChannelAsync(StartChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopChannelAsync(StopChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateChannelAsync(UpdateChannelRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateInputAsync(UpdateInputRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePoolAsync(UpdatePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createAssetAsync(CreateAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createChannelAsync(CreateChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClipAsync(CreateClipRequest $request, array $optionalArgs = []) + * @method PromiseInterface createEventAsync(CreateEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInputAsync(CreateInputRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAssetAsync(DeleteAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteChannelAsync(DeleteChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClipAsync(DeleteClipRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteEventAsync(DeleteEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInputAsync(DeleteInputRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAssetAsync(GetAssetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getChannelAsync(GetChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClipAsync(GetClipRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEventAsync(GetEventRequest $request, array $optionalArgs = []) + * @method PromiseInterface getInputAsync(GetInputRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPoolAsync(GetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAssetsAsync(ListAssetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listChannelsAsync(ListChannelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClipsAsync(ListClipsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listEventsAsync(ListEventsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInputsAsync(ListInputsRequest $request, array $optionalArgs = []) + * @method PromiseInterface startChannelAsync(StartChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopChannelAsync(StopChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateChannelAsync(UpdateChannelRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateInputAsync(UpdateInputRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePoolAsync(UpdatePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class LivestreamServiceClient { diff --git a/VideoStitcher/src/V1/Client/VideoStitcherServiceClient.php b/VideoStitcher/src/V1/Client/VideoStitcherServiceClient.php index 6deadb0b97f5..b2b8b48ad5ee 100644 --- a/VideoStitcher/src/V1/Client/VideoStitcherServiceClient.php +++ b/VideoStitcher/src/V1/Client/VideoStitcherServiceClient.php @@ -92,36 +92,36 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createCdnKeyAsync(CreateCdnKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createLiveConfigAsync(CreateLiveConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createLiveSessionAsync(CreateLiveSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSlateAsync(CreateSlateRequest $request, array $optionalArgs = []) - * @method PromiseInterface createVodConfigAsync(CreateVodConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface createVodSessionAsync(CreateVodSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteCdnKeyAsync(DeleteCdnKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteLiveConfigAsync(DeleteLiveConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSlateAsync(DeleteSlateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVodConfigAsync(DeleteVodConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCdnKeyAsync(GetCdnKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLiveAdTagDetailAsync(GetLiveAdTagDetailRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLiveConfigAsync(GetLiveConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLiveSessionAsync(GetLiveSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSlateAsync(GetSlateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVodAdTagDetailAsync(GetVodAdTagDetailRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVodConfigAsync(GetVodConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVodSessionAsync(GetVodSessionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVodStitchDetailAsync(GetVodStitchDetailRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCdnKeysAsync(ListCdnKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLiveAdTagDetailsAsync(ListLiveAdTagDetailsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLiveConfigsAsync(ListLiveConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSlatesAsync(ListSlatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVodAdTagDetailsAsync(ListVodAdTagDetailsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVodConfigsAsync(ListVodConfigsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVodStitchDetailsAsync(ListVodStitchDetailsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateCdnKeyAsync(UpdateCdnKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateLiveConfigAsync(UpdateLiveConfigRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSlateAsync(UpdateSlateRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVodConfigAsync(UpdateVodConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCdnKeyAsync(CreateCdnKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLiveConfigAsync(CreateLiveConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLiveSessionAsync(CreateLiveSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSlateAsync(CreateSlateRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVodConfigAsync(CreateVodConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVodSessionAsync(CreateVodSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteCdnKeyAsync(DeleteCdnKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLiveConfigAsync(DeleteLiveConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSlateAsync(DeleteSlateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVodConfigAsync(DeleteVodConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCdnKeyAsync(GetCdnKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLiveAdTagDetailAsync(GetLiveAdTagDetailRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLiveConfigAsync(GetLiveConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLiveSessionAsync(GetLiveSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSlateAsync(GetSlateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVodAdTagDetailAsync(GetVodAdTagDetailRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVodConfigAsync(GetVodConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVodSessionAsync(GetVodSessionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVodStitchDetailAsync(GetVodStitchDetailRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCdnKeysAsync(ListCdnKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLiveAdTagDetailsAsync(ListLiveAdTagDetailsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLiveConfigsAsync(ListLiveConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSlatesAsync(ListSlatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVodAdTagDetailsAsync(ListVodAdTagDetailsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVodConfigsAsync(ListVodConfigsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVodStitchDetailsAsync(ListVodStitchDetailsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateCdnKeyAsync(UpdateCdnKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateLiveConfigAsync(UpdateLiveConfigRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSlateAsync(UpdateSlateRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVodConfigAsync(UpdateVodConfigRequest $request, array $optionalArgs = []) */ final class VideoStitcherServiceClient { diff --git a/VideoTranscoder/src/V1/Client/TranscoderServiceClient.php b/VideoTranscoder/src/V1/Client/TranscoderServiceClient.php index 92e40fb9dd7b..428937a678a6 100644 --- a/VideoTranscoder/src/V1/Client/TranscoderServiceClient.php +++ b/VideoTranscoder/src/V1/Client/TranscoderServiceClient.php @@ -61,14 +61,14 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createJobTemplateAsync(CreateJobTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteJobTemplateAsync(DeleteJobTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getJobTemplateAsync(GetJobTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobTemplatesAsync(ListJobTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createJobAsync(CreateJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createJobTemplateAsync(CreateJobTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteJobAsync(DeleteJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteJobTemplateAsync(DeleteJobTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobAsync(GetJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getJobTemplateAsync(GetJobTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobTemplatesAsync(ListJobTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listJobsAsync(ListJobsRequest $request, array $optionalArgs = []) */ final class TranscoderServiceClient { diff --git a/Vision/src/V1/Client/ImageAnnotatorClient.php b/Vision/src/V1/Client/ImageAnnotatorClient.php index 316bf7bb6068..2c72737cf8c0 100644 --- a/Vision/src/V1/Client/ImageAnnotatorClient.php +++ b/Vision/src/V1/Client/ImageAnnotatorClient.php @@ -60,10 +60,10 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface asyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface asyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchAnnotateFilesAsync(BatchAnnotateFilesRequest $request, array $optionalArgs = []) - * @method PromiseInterface batchAnnotateImagesAsync(BatchAnnotateImagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface asyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface asyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchAnnotateFilesAsync(BatchAnnotateFilesRequest $request, array $optionalArgs = []) + * @method PromiseInterface batchAnnotateImagesAsync(BatchAnnotateImagesRequest $request, array $optionalArgs = []) */ final class ImageAnnotatorClient { diff --git a/Vision/src/V1/Client/ProductSearchClient.php b/Vision/src/V1/Client/ProductSearchClient.php index cac9c44240b6..0a21d64767ce 100644 --- a/Vision/src/V1/Client/ProductSearchClient.php +++ b/Vision/src/V1/Client/ProductSearchClient.php @@ -88,25 +88,25 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addProductToProductSetAsync(AddProductToProductSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createProductAsync(CreateProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface createProductSetAsync(CreateProductSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface createReferenceImageAsync(CreateReferenceImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteProductAsync(DeleteProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteProductSetAsync(DeleteProductSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteReferenceImageAsync(DeleteReferenceImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProductAsync(GetProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface getProductSetAsync(GetProductSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReferenceImageAsync(GetReferenceImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface importProductSetsAsync(ImportProductSetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProductSetsAsync(ListProductSetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProductsAsync(ListProductsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listProductsInProductSetAsync(ListProductsInProductSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReferenceImagesAsync(ListReferenceImagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface purgeProductsAsync(PurgeProductsRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeProductFromProductSetAsync(RemoveProductFromProductSetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProductAsync(UpdateProductRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateProductSetAsync(UpdateProductSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface addProductToProductSetAsync(AddProductToProductSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createProductAsync(CreateProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface createProductSetAsync(CreateProductSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface createReferenceImageAsync(CreateReferenceImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteProductAsync(DeleteProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteProductSetAsync(DeleteProductSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteReferenceImageAsync(DeleteReferenceImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProductAsync(GetProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface getProductSetAsync(GetProductSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReferenceImageAsync(GetReferenceImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface importProductSetsAsync(ImportProductSetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProductSetsAsync(ListProductSetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProductsAsync(ListProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listProductsInProductSetAsync(ListProductsInProductSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReferenceImagesAsync(ListReferenceImagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface purgeProductsAsync(PurgeProductsRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeProductFromProductSetAsync(RemoveProductFromProductSetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProductAsync(UpdateProductRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateProductSetAsync(UpdateProductSetRequest $request, array $optionalArgs = []) */ final class ProductSearchClient { diff --git a/VmMigration/src/V1/Client/VmMigrationClient.php b/VmMigration/src/V1/Client/VmMigrationClient.php index 6770977e510e..78823152c534 100644 --- a/VmMigration/src/V1/Client/VmMigrationClient.php +++ b/VmMigration/src/V1/Client/VmMigrationClient.php @@ -108,54 +108,54 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface addGroupMigrationAsync(AddGroupMigrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelCloneJobAsync(CancelCloneJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface cancelCutoverJobAsync(CancelCutoverJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCloneJobAsync(CreateCloneJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createCutoverJobAsync(CreateCutoverJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface createDatacenterConnectorAsync(CreateDatacenterConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface createGroupAsync(CreateGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface createMigratingVmAsync(CreateMigratingVmRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSourceAsync(CreateSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface createTargetProjectAsync(CreateTargetProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface createUtilizationReportAsync(CreateUtilizationReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteDatacenterConnectorAsync(DeleteDatacenterConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteGroupAsync(DeleteGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteMigratingVmAsync(DeleteMigratingVmRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSourceAsync(DeleteSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteTargetProjectAsync(DeleteTargetProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteUtilizationReportAsync(DeleteUtilizationReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchInventoryAsync(FetchInventoryRequest $request, array $optionalArgs = []) - * @method PromiseInterface finalizeMigrationAsync(FinalizeMigrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCloneJobAsync(GetCloneJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getCutoverJobAsync(GetCutoverJobRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDatacenterConnectorAsync(GetDatacenterConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMigratingVmAsync(GetMigratingVmRequest $request, array $optionalArgs = []) - * @method PromiseInterface getReplicationCycleAsync(GetReplicationCycleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSourceAsync(GetSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getTargetProjectAsync(GetTargetProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getUtilizationReportAsync(GetUtilizationReportRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCloneJobsAsync(ListCloneJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listCutoverJobsAsync(ListCutoverJobsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDatacenterConnectorsAsync(ListDatacenterConnectorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listGroupsAsync(ListGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listMigratingVmsAsync(ListMigratingVmsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReplicationCyclesAsync(ListReplicationCyclesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSourcesAsync(ListSourcesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listTargetProjectsAsync(ListTargetProjectsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUtilizationReportsAsync(ListUtilizationReportsRequest $request, array $optionalArgs = []) - * @method PromiseInterface pauseMigrationAsync(PauseMigrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeGroupMigrationAsync(RemoveGroupMigrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeMigrationAsync(ResumeMigrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface startMigrationAsync(StartMigrationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateGroupAsync(UpdateGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateMigratingVmAsync(UpdateMigratingVmRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSourceAsync(UpdateSourceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateTargetProjectAsync(UpdateTargetProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface upgradeApplianceAsync(UpgradeApplianceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface addGroupMigrationAsync(AddGroupMigrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelCloneJobAsync(CancelCloneJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelCutoverJobAsync(CancelCutoverJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCloneJobAsync(CreateCloneJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createCutoverJobAsync(CreateCutoverJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface createDatacenterConnectorAsync(CreateDatacenterConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface createGroupAsync(CreateGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMigratingVmAsync(CreateMigratingVmRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSourceAsync(CreateSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface createTargetProjectAsync(CreateTargetProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface createUtilizationReportAsync(CreateUtilizationReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteDatacenterConnectorAsync(DeleteDatacenterConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteGroupAsync(DeleteGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteMigratingVmAsync(DeleteMigratingVmRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSourceAsync(DeleteSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteTargetProjectAsync(DeleteTargetProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteUtilizationReportAsync(DeleteUtilizationReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchInventoryAsync(FetchInventoryRequest $request, array $optionalArgs = []) + * @method PromiseInterface finalizeMigrationAsync(FinalizeMigrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCloneJobAsync(GetCloneJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getCutoverJobAsync(GetCutoverJobRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDatacenterConnectorAsync(GetDatacenterConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGroupAsync(GetGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMigratingVmAsync(GetMigratingVmRequest $request, array $optionalArgs = []) + * @method PromiseInterface getReplicationCycleAsync(GetReplicationCycleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSourceAsync(GetSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getTargetProjectAsync(GetTargetProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getUtilizationReportAsync(GetUtilizationReportRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCloneJobsAsync(ListCloneJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listCutoverJobsAsync(ListCutoverJobsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDatacenterConnectorsAsync(ListDatacenterConnectorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listGroupsAsync(ListGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMigratingVmsAsync(ListMigratingVmsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReplicationCyclesAsync(ListReplicationCyclesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSourcesAsync(ListSourcesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listTargetProjectsAsync(ListTargetProjectsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUtilizationReportsAsync(ListUtilizationReportsRequest $request, array $optionalArgs = []) + * @method PromiseInterface pauseMigrationAsync(PauseMigrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeGroupMigrationAsync(RemoveGroupMigrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeMigrationAsync(ResumeMigrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface startMigrationAsync(StartMigrationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateGroupAsync(UpdateGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateMigratingVmAsync(UpdateMigratingVmRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSourceAsync(UpdateSourceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateTargetProjectAsync(UpdateTargetProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface upgradeApplianceAsync(UpgradeApplianceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class VmMigrationClient { diff --git a/VmwareEngine/src/V1/Client/VmwareEngineClient.php b/VmwareEngine/src/V1/Client/VmwareEngineClient.php index 22767cf25bf9..bec62a14f57c 100644 --- a/VmwareEngine/src/V1/Client/VmwareEngineClient.php +++ b/VmwareEngine/src/V1/Client/VmwareEngineClient.php @@ -148,85 +148,85 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface createExternalAccessRuleAsync(CreateExternalAccessRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface createExternalAddressAsync(CreateExternalAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface createHcxActivationKeyAsync(CreateHcxActivationKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createLoggingServerAsync(CreateLoggingServerRequest $request, array $optionalArgs = []) - * @method PromiseInterface createManagementDnsZoneBindingAsync(CreateManagementDnsZoneBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNetworkPeeringAsync(CreateNetworkPeeringRequest $request, array $optionalArgs = []) - * @method PromiseInterface createNetworkPolicyAsync(CreateNetworkPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPrivateCloudAsync(CreatePrivateCloudRequest $request, array $optionalArgs = []) - * @method PromiseInterface createPrivateConnectionAsync(CreatePrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface createVmwareEngineNetworkAsync(CreateVmwareEngineNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteExternalAccessRuleAsync(DeleteExternalAccessRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteExternalAddressAsync(DeleteExternalAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteLoggingServerAsync(DeleteLoggingServerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteManagementDnsZoneBindingAsync(DeleteManagementDnsZoneBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNetworkPeeringAsync(DeleteNetworkPeeringRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNetworkPolicyAsync(DeleteNetworkPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePrivateCloudAsync(DeletePrivateCloudRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePrivateConnectionAsync(DeletePrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteVmwareEngineNetworkAsync(DeleteVmwareEngineNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface fetchNetworkPolicyExternalAddressesAsync(FetchNetworkPolicyExternalAddressesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDnsBindPermissionAsync(GetDnsBindPermissionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDnsForwardingAsync(GetDnsForwardingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExternalAccessRuleAsync(GetExternalAccessRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getExternalAddressAsync(GetExternalAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHcxActivationKeyAsync(GetHcxActivationKeyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLoggingServerAsync(GetLoggingServerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getManagementDnsZoneBindingAsync(GetManagementDnsZoneBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNetworkPeeringAsync(GetNetworkPeeringRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNetworkPolicyAsync(GetNetworkPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNodeAsync(GetNodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNodeTypeAsync(GetNodeTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPrivateCloudAsync(GetPrivateCloudRequest $request, array $optionalArgs = []) - * @method PromiseInterface getPrivateConnectionAsync(GetPrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSubnetAsync(GetSubnetRequest $request, array $optionalArgs = []) - * @method PromiseInterface getVmwareEngineNetworkAsync(GetVmwareEngineNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface grantDnsBindPermissionAsync(GrantDnsBindPermissionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExternalAccessRulesAsync(ListExternalAccessRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listExternalAddressesAsync(ListExternalAddressesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listHcxActivationKeysAsync(ListHcxActivationKeysRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLoggingServersAsync(ListLoggingServersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listManagementDnsZoneBindingsAsync(ListManagementDnsZoneBindingsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworkPeeringsAsync(ListNetworkPeeringsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworkPoliciesAsync(ListNetworkPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNodeTypesAsync(ListNodeTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNodesAsync(ListNodesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPeeringRoutesAsync(ListPeeringRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPrivateCloudsAsync(ListPrivateCloudsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPrivateConnectionPeeringRoutesAsync(ListPrivateConnectionPeeringRoutesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPrivateConnectionsAsync(ListPrivateConnectionsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listSubnetsAsync(ListSubnetsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listVmwareEngineNetworksAsync(ListVmwareEngineNetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface repairManagementDnsZoneBindingAsync(RepairManagementDnsZoneBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetNsxCredentialsAsync(ResetNsxCredentialsRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetVcenterCredentialsAsync(ResetVcenterCredentialsRequest $request, array $optionalArgs = []) - * @method PromiseInterface revokeDnsBindPermissionAsync(RevokeDnsBindPermissionRequest $request, array $optionalArgs = []) - * @method PromiseInterface showNsxCredentialsAsync(ShowNsxCredentialsRequest $request, array $optionalArgs = []) - * @method PromiseInterface showVcenterCredentialsAsync(ShowVcenterCredentialsRequest $request, array $optionalArgs = []) - * @method PromiseInterface undeletePrivateCloudAsync(UndeletePrivateCloudRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDnsForwardingAsync(UpdateDnsForwardingRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExternalAccessRuleAsync(UpdateExternalAccessRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateExternalAddressAsync(UpdateExternalAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateLoggingServerAsync(UpdateLoggingServerRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateManagementDnsZoneBindingAsync(UpdateManagementDnsZoneBindingRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNetworkPeeringAsync(UpdateNetworkPeeringRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNetworkPolicyAsync(UpdateNetworkPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePrivateCloudAsync(UpdatePrivateCloudRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePrivateConnectionAsync(UpdatePrivateConnectionRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateSubnetAsync(UpdateSubnetRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateVmwareEngineNetworkAsync(UpdateVmwareEngineNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createClusterAsync(CreateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExternalAccessRuleAsync(CreateExternalAccessRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface createExternalAddressAsync(CreateExternalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface createHcxActivationKeyAsync(CreateHcxActivationKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createLoggingServerAsync(CreateLoggingServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface createManagementDnsZoneBindingAsync(CreateManagementDnsZoneBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNetworkPeeringAsync(CreateNetworkPeeringRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNetworkPolicyAsync(CreateNetworkPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPrivateCloudAsync(CreatePrivateCloudRequest $request, array $optionalArgs = []) + * @method PromiseInterface createPrivateConnectionAsync(CreatePrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface createVmwareEngineNetworkAsync(CreateVmwareEngineNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteClusterAsync(DeleteClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteExternalAccessRuleAsync(DeleteExternalAccessRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteExternalAddressAsync(DeleteExternalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteLoggingServerAsync(DeleteLoggingServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteManagementDnsZoneBindingAsync(DeleteManagementDnsZoneBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNetworkPeeringAsync(DeleteNetworkPeeringRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNetworkPolicyAsync(DeleteNetworkPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePrivateCloudAsync(DeletePrivateCloudRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePrivateConnectionAsync(DeletePrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteVmwareEngineNetworkAsync(DeleteVmwareEngineNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface fetchNetworkPolicyExternalAddressesAsync(FetchNetworkPolicyExternalAddressesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getClusterAsync(GetClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDnsBindPermissionAsync(GetDnsBindPermissionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDnsForwardingAsync(GetDnsForwardingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExternalAccessRuleAsync(GetExternalAccessRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getExternalAddressAsync(GetExternalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHcxActivationKeyAsync(GetHcxActivationKeyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLoggingServerAsync(GetLoggingServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getManagementDnsZoneBindingAsync(GetManagementDnsZoneBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNetworkPeeringAsync(GetNetworkPeeringRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNetworkPolicyAsync(GetNetworkPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNodeAsync(GetNodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNodeTypeAsync(GetNodeTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPrivateCloudAsync(GetPrivateCloudRequest $request, array $optionalArgs = []) + * @method PromiseInterface getPrivateConnectionAsync(GetPrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSubnetAsync(GetSubnetRequest $request, array $optionalArgs = []) + * @method PromiseInterface getVmwareEngineNetworkAsync(GetVmwareEngineNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface grantDnsBindPermissionAsync(GrantDnsBindPermissionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listClustersAsync(ListClustersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExternalAccessRulesAsync(ListExternalAccessRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listExternalAddressesAsync(ListExternalAddressesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listHcxActivationKeysAsync(ListHcxActivationKeysRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLoggingServersAsync(ListLoggingServersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listManagementDnsZoneBindingsAsync(ListManagementDnsZoneBindingsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworkPeeringsAsync(ListNetworkPeeringsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworkPoliciesAsync(ListNetworkPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNodeTypesAsync(ListNodeTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNodesAsync(ListNodesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPeeringRoutesAsync(ListPeeringRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPrivateCloudsAsync(ListPrivateCloudsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPrivateConnectionPeeringRoutesAsync(ListPrivateConnectionPeeringRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPrivateConnectionsAsync(ListPrivateConnectionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listSubnetsAsync(ListSubnetsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listVmwareEngineNetworksAsync(ListVmwareEngineNetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface repairManagementDnsZoneBindingAsync(RepairManagementDnsZoneBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetNsxCredentialsAsync(ResetNsxCredentialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetVcenterCredentialsAsync(ResetVcenterCredentialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface revokeDnsBindPermissionAsync(RevokeDnsBindPermissionRequest $request, array $optionalArgs = []) + * @method PromiseInterface showNsxCredentialsAsync(ShowNsxCredentialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface showVcenterCredentialsAsync(ShowVcenterCredentialsRequest $request, array $optionalArgs = []) + * @method PromiseInterface undeletePrivateCloudAsync(UndeletePrivateCloudRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateClusterAsync(UpdateClusterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDnsForwardingAsync(UpdateDnsForwardingRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExternalAccessRuleAsync(UpdateExternalAccessRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateExternalAddressAsync(UpdateExternalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateLoggingServerAsync(UpdateLoggingServerRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateManagementDnsZoneBindingAsync(UpdateManagementDnsZoneBindingRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNetworkPeeringAsync(UpdateNetworkPeeringRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNetworkPolicyAsync(UpdateNetworkPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePrivateCloudAsync(UpdatePrivateCloudRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePrivateConnectionAsync(UpdatePrivateConnectionRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateSubnetAsync(UpdateSubnetRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateVmwareEngineNetworkAsync(UpdateVmwareEngineNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getLocationAsync(GetLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = []) */ final class VmwareEngineClient { diff --git a/VpcAccess/src/V1/Client/VpcAccessServiceClient.php b/VpcAccess/src/V1/Client/VpcAccessServiceClient.php index 0cb7eca0b92a..64e2986d4c7d 100644 --- a/VpcAccess/src/V1/Client/VpcAccessServiceClient.php +++ b/VpcAccess/src/V1/Client/VpcAccessServiceClient.php @@ -57,11 +57,11 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * @method PromiseInterface createConnectorAsync(CreateConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteConnectorAsync(DeleteConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface getConnectorAsync(GetConnectorRequest $request, array $optionalArgs = []) - * @method PromiseInterface listConnectorsAsync(ListConnectorsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface createConnectorAsync(CreateConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteConnectorAsync(DeleteConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface getConnectorAsync(GetConnectorRequest $request, array $optionalArgs = []) + * @method PromiseInterface listConnectorsAsync(ListConnectorsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = []) */ final class VpcAccessServiceClient { From 8217b597684f1c27afd633e8a928ad77ba36279d Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 21:18:54 +0000 Subject: [PATCH 082/157] feat: update log entry proto for backup plan for gkebackup platform logging to include rpo_risk_level in the json payload (#7796) PiperOrigin-RevId: 693038696 Source-Link: https://github.com/googleapis/googleapis/commit/fa2a502a78cee29c851b47e8f33af6b7abb03d28 Source-Link: https://github.com/googleapis/googleapis-gen/commit/fc0e48d56cbd9e255fe1748ca0e2e36e51497980 Copy-Tag: eyJwIjoiQ29tcHV0ZS8uT3dsQm90LnlhbWwiLCJoIjoiZmMwZTQ4ZDU2Y2JkOWUyNTVmZTE3NDhjYTBlMmUzNmU1MTQ5Nzk4MCJ9 chore: add types for async methods PiperOrigin-RevId: 693215877 Source-Link: https://github.com/googleapis/googleapis/commit/bb6b53e326ce2db403d18be7158c265e07948920 Source-Link: https://github.com/googleapis/googleapis-gen/commit/db8b5a93484ad44055b2bacc4c7cf87e970fe0ed Copy-Tag: eyJwIjoiQ29tcHV0ZS8uT3dsQm90LnlhbWwiLCJoIjoiZGI4YjVhOTM0ODRhZDQ0MDU1YjJiYWNjNGM3Y2Y4N2U5NzBmZTBlZCJ9 --- Compute/metadata/V1/Compute.php | Bin 666288 -> 670279 bytes .../V1/BackendServicesClient/list_usable.php | 2 +- .../V1/GlobalOperationsClient/delete.php | 2 +- .../samples/V1/GlobalOperationsClient/get.php | 2 +- .../V1/GlobalOperationsClient/wait.php | 2 +- .../delete.php | 2 +- .../get.php | 2 +- Compute/samples/V1/NetworksClient/patch.php | 2 +- .../list_usable.php | 2 +- .../V1/RegionOperationsClient/delete.php | 2 +- .../samples/V1/RegionOperationsClient/get.php | 2 +- .../V1/RegionOperationsClient/wait.php | 2 +- Compute/samples/V1/RegionsClient/get.php | 2 +- Compute/samples/V1/RegionsClient/list.php | 2 +- .../samples/V1/StoragePoolsClient/update.php | 2 +- .../V1/ZoneOperationsClient/delete.php | 2 +- .../samples/V1/ZoneOperationsClient/get.php | 2 +- .../samples/V1/ZoneOperationsClient/wait.php | 2 +- Compute/src/V1/AdvancedMachineFeatures.php | 92 ++++++++++ .../PerformanceMonitoringUnit.php | 74 ++++++++ .../VmFamily.php | 10 ++ Compute/src/V1/AttachedDisk.php | 16 +- .../src/V1/AttachedDiskInitializeParams.php | 16 +- Compute/src/V1/AuditConfig.php | 9 +- Compute/src/V1/AuditLogConfig.php | 7 - Compute/src/V1/BackendBucket.php | 34 ++++ Compute/src/V1/BackendBucketUsedBy.php | 76 ++++++++ Compute/src/V1/BackendService.php | 107 ++++++++++- .../IpAddressSelectionPolicy.php | 76 ++++++++ .../V1/BackendService/LocalityLbPolicy.php | 2 +- .../src/V1/BackendService/SessionAffinity.php | 7 + Compute/src/V1/BackendServiceHttpCookie.php | 165 +++++++++++++++++ Compute/src/V1/BackendServiceUsedBy.php | 7 + Compute/src/V1/Binding.php | 7 - Compute/src/V1/BulkInsertInstanceResource.php | 8 +- .../src/V1/Client/AcceleratorTypesClient.php | 6 +- Compute/src/V1/Client/AddressesClient.php | 14 +- Compute/src/V1/Client/AutoscalersClient.php | 14 +- .../src/V1/Client/BackendBucketsClient.php | 24 +-- .../src/V1/Client/BackendServicesClient.php | 34 ++-- Compute/src/V1/Client/DiskTypesClient.php | 6 +- Compute/src/V1/Client/DisksClient.php | 36 ++-- .../V1/Client/ExternalVpnGatewaysClient.php | 12 +- .../src/V1/Client/FirewallPoliciesClient.php | 36 ++-- Compute/src/V1/Client/FirewallsClient.php | 12 +- .../src/V1/Client/ForwardingRulesClient.php | 16 +- .../src/V1/Client/GlobalAddressesClient.php | 12 +- .../V1/Client/GlobalForwardingRulesClient.php | 14 +- .../GlobalNetworkEndpointGroupsClient.php | 14 +- .../src/V1/Client/GlobalOperationsClient.php | 10 +- .../GlobalOrganizationOperationsClient.php | 6 +- .../GlobalPublicDelegatedPrefixesClient.php | 10 +- Compute/src/V1/Client/HealthChecksClient.php | 14 +- .../src/V1/Client/ImageFamilyViewsClient.php | 2 +- Compute/src/V1/Client/ImagesClient.php | 22 +-- ...stanceGroupManagerResizeRequestsClient.php | 10 +- .../V1/Client/InstanceGroupManagersClient.php | 40 ++--- .../src/V1/Client/InstanceGroupsClient.php | 18 +- .../Client/InstanceSettingsServiceClient.php | 4 +- .../src/V1/Client/InstanceTemplatesClient.php | 16 +- Compute/src/V1/Client/InstancesClient.php | 96 +++++----- .../src/V1/Client/InstantSnapshotsClient.php | 18 +- .../Client/InterconnectAttachmentsClient.php | 14 +- .../V1/Client/InterconnectLocationsClient.php | 4 +- .../InterconnectRemoteLocationsClient.php | 4 +- Compute/src/V1/Client/InterconnectsClient.php | 16 +- Compute/src/V1/Client/LicenseCodesClient.php | 4 +- Compute/src/V1/Client/LicensesClient.php | 14 +- Compute/src/V1/Client/MachineImagesClient.php | 14 +- Compute/src/V1/Client/MachineTypesClient.php | 6 +- .../V1/Client/NetworkAttachmentsClient.php | 18 +- .../NetworkEdgeSecurityServicesClient.php | 10 +- .../V1/Client/NetworkEndpointGroupsClient.php | 18 +- .../Client/NetworkFirewallPoliciesClient.php | 32 ++-- Compute/src/V1/Client/NetworksClient.php | 24 +-- Compute/src/V1/Client/NodeGroupsClient.php | 30 ++-- Compute/src/V1/Client/NodeTemplatesClient.php | 16 +- Compute/src/V1/Client/NodeTypesClient.php | 6 +- .../src/V1/Client/PacketMirroringsClient.php | 14 +- Compute/src/V1/Client/ProjectsClient.php | 28 +-- .../Client/PublicAdvertisedPrefixesClient.php | 14 +- .../Client/PublicDelegatedPrefixesClient.php | 16 +- .../src/V1/Client/RegionAutoscalersClient.php | 12 +- .../V1/Client/RegionBackendServicesClient.php | 26 +-- .../src/V1/Client/RegionCommitmentsClient.php | 10 +- .../src/V1/Client/RegionDiskTypesClient.php | 4 +- Compute/src/V1/Client/RegionDisksClient.php | 34 ++-- .../RegionHealthCheckServicesClient.php | 10 +- .../V1/Client/RegionHealthChecksClient.php | 12 +- .../RegionInstanceGroupManagersClient.php | 38 ++-- .../V1/Client/RegionInstanceGroupsClient.php | 8 +- .../Client/RegionInstanceTemplatesClient.php | 8 +- .../src/V1/Client/RegionInstancesClient.php | 2 +- .../Client/RegionInstantSnapshotsClient.php | 16 +- .../RegionNetworkEndpointGroupsClient.php | 14 +- .../RegionNetworkFirewallPoliciesClient.php | 34 ++-- .../RegionNotificationEndpointsClient.php | 8 +- .../src/V1/Client/RegionOperationsClient.php | 8 +- .../Client/RegionSecurityPoliciesClient.php | 18 +- .../V1/Client/RegionSslCertificatesClient.php | 8 +- .../src/V1/Client/RegionSslPoliciesClient.php | 12 +- .../Client/RegionTargetHttpProxiesClient.php | 10 +- .../Client/RegionTargetHttpsProxiesClient.php | 14 +- .../Client/RegionTargetTcpProxiesClient.php | 8 +- Compute/src/V1/Client/RegionUrlMapsClient.php | 14 +- Compute/src/V1/Client/RegionZonesClient.php | 2 +- Compute/src/V1/Client/RegionsClient.php | 8 +- Compute/src/V1/Client/ReservationsClient.php | 20 +-- .../src/V1/Client/ResourcePoliciesClient.php | 18 +- Compute/src/V1/Client/RoutersClient.php | 22 +-- Compute/src/V1/Client/RoutesClient.php | 8 +- .../src/V1/Client/SecurityPoliciesClient.php | 24 +-- .../V1/Client/ServiceAttachmentsClient.php | 18 +- .../Client/SnapshotSettingsServiceClient.php | 4 +- Compute/src/V1/Client/SnapshotsClient.php | 16 +- .../src/V1/Client/SslCertificatesClient.php | 10 +- Compute/src/V1/Client/SslPoliciesClient.php | 14 +- .../src/V1/Client/StoragePoolTypesClient.php | 6 +- Compute/src/V1/Client/StoragePoolsClient.php | 22 +-- Compute/src/V1/Client/SubnetworksClient.php | 24 +-- .../src/V1/Client/TargetGrpcProxiesClient.php | 10 +- .../src/V1/Client/TargetHttpProxiesClient.php | 14 +- .../V1/Client/TargetHttpsProxiesClient.php | 22 +-- .../src/V1/Client/TargetInstancesClient.php | 12 +- Compute/src/V1/Client/TargetPoolsClient.php | 24 +-- .../src/V1/Client/TargetSslProxiesClient.php | 18 +- .../src/V1/Client/TargetTcpProxiesClient.php | 14 +- .../src/V1/Client/TargetVpnGatewaysClient.php | 12 +- Compute/src/V1/Client/UrlMapsClient.php | 18 +- Compute/src/V1/Client/VpnGatewaysClient.php | 16 +- Compute/src/V1/Client/VpnTunnelsClient.php | 12 +- .../src/V1/Client/ZoneOperationsClient.php | 8 +- Compute/src/V1/Client/ZonesClient.php | 4 +- Compute/src/V1/Commitment.php | 88 +++++++++ Compute/src/V1/Commitment/Type.php | 5 + Compute/src/V1/CommitmentResourceStatus.php | 77 ++++++++ Compute/src/V1/ConfidentialInstanceConfig.php | 48 +++++ .../ConfidentialInstanceType.php | 76 ++++++++ Compute/src/V1/CustomErrorResponsePolicy.php | 111 ++++++++++++ ...rResponsePolicyCustomErrorResponseRule.php | 155 ++++++++++++++++ .../src/V1/DeleteGlobalOperationRequest.php | 10 +- ...leteGlobalOrganizationOperationRequest.php | 10 +- .../src/V1/DeleteRegionOperationRequest.php | 10 +- Compute/src/V1/DeleteZoneOperationRequest.php | 10 +- Compute/src/V1/Disk.php | 48 +++++ Compute/src/V1/Disk/AccessMode.php | 69 +++++++ .../PerformanceMonitoringUnit.php | 44 +++++ .../VmFamily.php | 4 + .../IpAddressSelectionPolicy.php | 43 +++++ .../Enums/BackendService/SessionAffinity.php | 2 + Compute/src/V1/Enums/Commitment/Type.php | 2 + .../ConfidentialInstanceType.php | 44 +++++ Compute/src/V1/Enums/Disk/AccessMode.php | 40 +++++ Compute/src/V1/Enums/GuestOsFeature/Type.php | 2 + .../V1/Enums/HealthStatus/Ipv6HealthState.php | 34 ++++ .../Ipv6HealthState.php | 35 ++++ .../Type.php | 4 + .../src/V1/Enums/MachineType/Architecture.php | 40 +++++ .../NetworkEndpointType.php | 2 + .../src/V1/Enums/NetworkInterface/NicType.php | 2 + .../V1/Enums/NetworkInterface/StackType.php | 2 + .../Type.php | 2 + .../Type.php | 41 +++++ Compute/src/V1/Enums/Subnetwork/StackType.php | 2 + .../Enums/TargetHttpsProxy/TlsEarlyData.php | 40 +++++ .../V1/Enums/TargetPool/SessionAffinity.php | 2 + .../V1/Enums/UsableSubnetwork/StackType.php | 2 + Compute/src/V1/Enums/VpnGateway/StackType.php | 2 + Compute/src/V1/FirewallPolicyRule.php | 32 ++-- .../V1/Gapic/BackendServicesGapicClient.php | 2 +- .../V1/Gapic/GlobalOperationsGapicClient.php | 6 +- ...lobalOrganizationOperationsGapicClient.php | 4 +- Compute/src/V1/Gapic/NetworksGapicClient.php | 2 +- .../RegionBackendServicesGapicClient.php | 2 +- .../V1/Gapic/RegionOperationsGapicClient.php | 6 +- Compute/src/V1/Gapic/RegionsGapicClient.php | 4 +- .../src/V1/Gapic/StoragePoolsGapicClient.php | 2 +- .../V1/Gapic/ZoneOperationsGapicClient.php | 6 +- Compute/src/V1/GetGlobalOperationRequest.php | 10 +- .../GetGlobalOrganizationOperationRequest.php | 10 +- Compute/src/V1/GetRegionOperationRequest.php | 10 +- Compute/src/V1/GetZoneOperationRequest.php | 10 +- Compute/src/V1/GuestOsFeature/Type.php | 5 + Compute/src/V1/HealthCheck.php | 34 ++++ Compute/src/V1/HealthStatus.php | 85 +++++++++ Compute/src/V1/HealthStatus/HealthState.php | 3 + .../src/V1/HealthStatus/Ipv6HealthState.php | 51 ++++++ .../src/V1/HealthStatusForNetworkEndpoint.php | 48 +++++ .../HealthState.php | 13 +- .../Ipv6HealthState.php | 53 ++++++ Compute/src/V1/HttpRouteRule.php | 44 +++++ Compute/src/V1/InstanceGroupManager.php | 148 ++++++++++++++- ...eGroupManagerInstanceFlexibilityPolicy.php | 66 +++++++ ...anceFlexibilityPolicyInstanceSelection.php | 110 ++++++++++++ .../V1/InstanceGroupManagerResizeRequest.php | 8 +- Compute/src/V1/InstanceProperties.php | 8 +- ...InstancesGetEffectiveFirewallsResponse.php | 8 +- ...rewallsResponseEffectiveFirewallPolicy.php | 52 +++++- .../Type.php | 10 ++ Compute/src/V1/Interconnect.php | 16 +- Compute/src/V1/MachineType.php | 48 +++++ Compute/src/V1/MachineType/Architecture.php | 69 +++++++ Compute/src/V1/ManagedInstance.php | 44 +++++ ...nstancePropertiesFromFlexibilityPolicy.php | 76 ++++++++ Compute/src/V1/NetworkEndpoint.php | 88 +++++++++ .../NetworkEndpointType.php | 7 + .../src/V1/NetworkEndpointGroupPscData.php | 44 +++++ Compute/src/V1/NetworkInterface/NicType.php | 7 + Compute/src/V1/NetworkInterface/StackType.php | 9 +- .../NetworksGetEffectiveFirewallsResponse.php | 8 +- ...rewallsResponseEffectiveFirewallPolicy.php | 52 +++++- .../Type.php | 5 + Compute/src/V1/Operation.php | 8 +- Compute/src/V1/PathMatcher.php | 44 +++++ Compute/src/V1/PathRule.php | 44 +++++ Compute/src/V1/Policy.php | 34 ---- ...lPoliciesGetEffectiveFirewallsResponse.php | 8 +- ...rewallsResponseEffectiveFirewallPolicy.php | 8 +- Compute/src/V1/Reservation.php | 8 +- Compute/src/V1/Reservation/Status.php | 10 +- Compute/src/V1/ResourceStatus.php | 37 ++++ Compute/src/V1/ResourceStatusScheduling.php | 76 ++++++++ Compute/src/V1/Route.php | 8 +- Compute/src/V1/RouterNatRule.php | 8 +- Compute/src/V1/RouterStatus.php | 16 +- Compute/src/V1/Scheduling.php | 169 ++++++++++++++++++ .../src/V1/SchedulingOnInstanceStopAction.php | 77 ++++++++ ...Layer7DdosDefenseConfigThresholdConfig.php | 145 +++++++++++++++ ...hresholdConfigTrafficGranularityConfig.php | 169 ++++++++++++++++++ .../Type.php | 63 +++++++ Compute/src/V1/ServiceAttachment.php | 44 +++++ .../V1/ServiceAttachmentConnectedEndpoint.php | 44 +++++ Compute/src/V1/StoragePool.php | 8 +- Compute/src/V1/StoragePoolResourceStatus.php | 8 +- Compute/src/V1/Subnetwork.php | 8 +- Compute/src/V1/Subnetwork/StackType.php | 7 + Compute/src/V1/TargetHttpsProxy.php | 64 ++++++- .../src/V1/TargetHttpsProxy/TlsEarlyData.php | 69 +++++++ Compute/src/V1/TargetPool/SessionAffinity.php | 7 + Compute/src/V1/UrlMap.php | 54 +++++- Compute/src/V1/UsableSubnetwork/StackType.php | 7 + Compute/src/V1/VpnGateway.php | 8 +- Compute/src/V1/VpnGateway/StackType.php | 9 +- Compute/src/V1/VpnTunnel.php | 32 ++-- Compute/src/V1/WaitGlobalOperationRequest.php | 10 +- Compute/src/V1/WaitRegionOperationRequest.php | 10 +- Compute/src/V1/WaitZoneOperationRequest.php | 10 +- Compute/src/V1/WeightedBackendService.php | 8 +- Compute/src/V1/Zone.php | 2 +- .../Unit/V1/BackendServicesClientTest.php | 2 + .../V1/Client/BackendServicesClientTest.php | 2 + .../tests/Unit/V1/Client/DisksClientTest.php | 2 + .../InstanceGroupManagersClientTest.php | 4 + .../Unit/V1/Client/MachineTypesClientTest.php | 2 + .../RegionBackendServicesClientTest.php | 2 + .../V1/Client/RegionCommitmentsClientTest.php | 2 + .../Unit/V1/Client/RegionDisksClientTest.php | 2 + .../RegionInstanceGroupManagersClientTest.php | 4 + .../RegionTargetHttpsProxiesClientTest.php | 2 + .../Client/ServiceAttachmentsClientTest.php | 2 + .../Client/TargetHttpsProxiesClientTest.php | 2 + Compute/tests/Unit/V1/DisksClientTest.php | 2 + .../V1/InstanceGroupManagersClientTest.php | 4 + .../tests/Unit/V1/MachineTypesClientTest.php | 2 + .../V1/RegionBackendServicesClientTest.php | 2 + .../Unit/V1/RegionCommitmentsClientTest.php | 2 + .../tests/Unit/V1/RegionDisksClientTest.php | 2 + .../RegionInstanceGroupManagersClientTest.php | 4 + .../V1/RegionTargetHttpsProxiesClientTest.php | 2 + .../Unit/V1/ServiceAttachmentsClientTest.php | 2 + .../Unit/V1/TargetHttpsProxiesClientTest.php | 2 + 271 files changed, 5023 insertions(+), 1096 deletions(-) create mode 100644 Compute/src/V1/AdvancedMachineFeatures/PerformanceMonitoringUnit.php create mode 100644 Compute/src/V1/BackendBucketUsedBy.php create mode 100644 Compute/src/V1/BackendService/IpAddressSelectionPolicy.php create mode 100644 Compute/src/V1/BackendServiceHttpCookie.php create mode 100644 Compute/src/V1/CommitmentResourceStatus.php create mode 100644 Compute/src/V1/ConfidentialInstanceConfig/ConfidentialInstanceType.php create mode 100644 Compute/src/V1/CustomErrorResponsePolicy.php create mode 100644 Compute/src/V1/CustomErrorResponsePolicyCustomErrorResponseRule.php create mode 100644 Compute/src/V1/Disk/AccessMode.php create mode 100644 Compute/src/V1/Enums/AdvancedMachineFeatures/PerformanceMonitoringUnit.php create mode 100644 Compute/src/V1/Enums/BackendService/IpAddressSelectionPolicy.php create mode 100644 Compute/src/V1/Enums/ConfidentialInstanceConfig/ConfidentialInstanceType.php create mode 100644 Compute/src/V1/Enums/Disk/AccessMode.php create mode 100644 Compute/src/V1/Enums/HealthStatus/Ipv6HealthState.php create mode 100644 Compute/src/V1/Enums/HealthStatusForNetworkEndpoint/Ipv6HealthState.php create mode 100644 Compute/src/V1/Enums/MachineType/Architecture.php create mode 100644 Compute/src/V1/Enums/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig/Type.php create mode 100644 Compute/src/V1/Enums/TargetHttpsProxy/TlsEarlyData.php create mode 100644 Compute/src/V1/HealthStatus/Ipv6HealthState.php create mode 100644 Compute/src/V1/HealthStatusForNetworkEndpoint/Ipv6HealthState.php create mode 100644 Compute/src/V1/InstanceGroupManagerInstanceFlexibilityPolicy.php create mode 100644 Compute/src/V1/InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection.php create mode 100644 Compute/src/V1/MachineType/Architecture.php create mode 100644 Compute/src/V1/ManagedInstancePropertiesFromFlexibilityPolicy.php create mode 100644 Compute/src/V1/ResourceStatusScheduling.php create mode 100644 Compute/src/V1/SchedulingOnInstanceStopAction.php create mode 100644 Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig.php create mode 100644 Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig/Type.php create mode 100644 Compute/src/V1/TargetHttpsProxy/TlsEarlyData.php diff --git a/Compute/metadata/V1/Compute.php b/Compute/metadata/V1/Compute.php index b0aa8f042ee2cda06ea4797f5d36e7f341013519..427bfb24129d998e8741bb75e65f490516fe966a 100644 GIT binary patch delta 7010 zcmbVRd3;k<_V?bmG`-!@bjj=9rYoDY;1BsZsHABifi58pV1@BDq$!Q0Nt&dLj39_? z$|CxdtEdc!%n!#w!~&0Tw6ZFSC?L2oEXC#HG9ox5Bm129Qd%kn=Qn?(&F8&)&b{|+ z-|snj9Q)9)S0<(#+Ce-~J>c;0`wWgUwE#%PltheV(vC=09gS5~}< zYYW^z7~xr1S~I<%sE}ljs}e^TtE`oEqN%cGY=!8sjTI}*Y4^5jq^D&+q7)?12cJjj8EJ}~Ks14%KkRq; zy~0z^{i#IVB%PvcR*y31RyUi2Et%3Y+pFpGCvd(LyW@XR4qb2O4gGQzaVNWRPCkk%{u9 z-8=Trd>IkJ8Zbs|PgVJgfjTIGkb8W3yYp#UYv({9Lwwg+-sSbitOQNl| zakq#y)s=PHKkhk1I-d-QJo#eXg+krU5RkvnQg*eP9szlL;q!^QBobq@n@5=KA}AlC z{b=rY+uP{QDvTFm`iY(YE=QM5QfnRd8psY)P0eVlSu~D-9I`s`6t))`W@?%-69%T3>jLJQj1Lx=M5i(2XM&rP`n zB-zy(3j3Qy2s|S=Xr=! zUEB8acOra@rK`@PjJE8HMJUR2i}v9a=O1kwcxg0>*OL^n`+C%f*bG{q&9c&x%QpJ@ zJt(>D=w%x-b2<@B{^n*+xY_Ls_dK6&2r2B;5OxQ_N?y-o&m@mm3E`d=JO9$#>mnz< z32steLW-_zePcnxvveSXR^WY@e#)UNrY}jS@mp|eLU>xhEv#E~G+9l$n-oA zZFm|SYx4UVJq>VPkJD@Qfztp093TNEEa)!Jrkd&z)(UgA!)mM)t<|*-wNN|iY-UJ= z0i>w6_w@8BlyvjlSN=Xk7fqO2^EmC!S)4AOM8Q|Fw%Vrs?8theymD0BrTuz7SDr;O zXxtX8XO$Dvbq1U(m-FbSs9{?GM@(vTnS()p5G)(;`$F!{l)aZEyOqZx)HLr zL&DN^7x-L;8vCIvTHk{CnY{@2qSX$WgJkmP1(*wxg1bQgeWNI0=z{-9i@Bw9DIn56or!dBp-o{NN^KR$Iq zi4)GE#EF_b&Tx~kX7~O`^e7%KPa}HqihO2I1?5qM69XV(codTq#X>2vEgmg27k-dV z*a}Z*3P5~})8$f-LdEzM|N0=Q%LdXIDFY#Txfa_l;{^!m-rn>QH7$kDdc+?LPxn9rbQRgQ(g+6EC30ix=Ms2$br2$4Az6+J2G#Xon2Gh;CIDuBzp#;FBA3C^P zlu2jSp)8aoZFuq?lub|NK+VXZ+7nzKjfzYCAjdjHlpZVm^TVYNN6wc=6LVpiK`L8T zkMil6yHP$Wpy?A(5h{!npQ2?Z$WP0};z;!=kvd9J=nE5&j_(8aPj9A6n@|az@Br>Z zPdO1whdbb!c@xplnJt7ERfkkTnCQ|-N_U1DO(q4Ws%k2fluRMsmSxS+vk0w;B(?tFKU5$RhqT?pMH6u;a(DJ47!>;VPFbUe_Bs> zO+*V5;z_J{RcO%RAK+Bk{abXqgwE2{r%(xg8>_{XetinD4m@uou` z2IVcMk&8#iw;H5;goQ-WRXi4uhQ7w*Y!pqMN10oxHVWGY z4G5?meKbrSh4f|tY&`I;qh3IVeFTf=U( z%+!-iS0_04ER>zJ@4KHrtCv>ka?~=J)JvJ9iB7(N&e7u$2-7`!T#p#qU%(a!&OZd$ zG|2Hs1w6Wt2d|XpkgO|!6)BNjWjV4NO$f00GD^d-lkqaGoG=Ub!TBNJrJdj-HhSIn zU4h2V1I}LZ_gI?H#tx?IW@Am#i0&1U0&CIG<~x~eY>B3h*|>!zN*(DKgn(7XM3`*s zvWIXfildL+541LZ*>+q(7e0iwP)5|+ppDdqM71{P=$41@D5xIH99#+2!!`#G0b|df zgX>T#?U;k>HG0^<-~+tczdTA$>*wNA5z2M_JJ6bWcmdsa4;n--zkxaV+j)2yhj(IH zx*Dgd*BWrmwR8`Vq%N~`k@b+Uf6iG#0}paJ@CPTW!oRsj_~t8U-bHakW?wisE&Xvs z^gZ55`wj})M#4>XdRyHB)UJ}4LF4JR$MFDFb>C}L_mEcV^KE!2GE5_P(9`K)FU3a_ zeq9KPPF%ASN{i1eDu^Ev9z613kqUdj1cOfB6yeWL9qNWS6|j`Y^2|l}(ol4mKClb7 zQg#rV%y1S=f7pd5KwK(}E{awB^E8T-Am3hg*Z^oDYwKzq<|=VyWlcG>kZtr}rY@Bv zbUwA4M*_Qt=j#_eUPX;3*%aEom(7TcA<<$W=z(rHJWc-YE&To$^3nCommK~oitgIP z)JS$IhYAU70o|!*m(lk(GZ~1d-)?4d=%B?w6ANUf2+GcAnJEL5oAG-Lh%pZE1^8z?9e4-lSBhvKy0nAOktc3p%q;$q$g5vxzDIrUCkE)Apz92K+##_s2rRp? zI|Z&ZZ`*b~F^bk4#X0oNb|yjk&1|9{0ZXrO1SHF%c4iccmOpN19>Y0>Bp+^gUG;MP zHfAN#h~(xfr_VWADx000+?!sy|5cnpz3<@E%{!Q9((ww0K6iw1-v$&$@A7(pVTwR) z!XBTqv*Qegg?S5R|E33pX>4im2~V!sszNF4c%8|mL8W{%^ztq~8_JE+S<;m}W@*Dw z=6?V-1o1k`=~G9UBDGe>N2rcJ7&bf{Ly~F7ODI`Bc9faK;72euonRW%0RKipKMt)r zbZfR6yQ9iz({B3w6p`1SV21PT8w}*SBDd@tW?*_Yi35W*w7Osp5CFBplFzp7Py>}t zoXYj3Uo1lg28JZ`Ps`CJI^bI-Em2{NJ!I$)&!SSf^;^clqLuQyCz<0IHPe?)Go@5G z4S{j^Gz853H17;!)m__IQsV$VSDyMKGeg5Z&yZm>`y5k9GtV=Xz2*b2=EJ0}bjSw) z=OclyUH{%2PonDtJcWQylj|=qPqz#^z(HpUbg@bytnQ$$i4-)r8=bA*@D0no@Z!Sb zMK=bQ*wy@Z5pdxm^_i!m{p`#>5IKbqGrztEUA~4NPjdroM%e{SG|DOe|F|dgf_o~p zrXvIFc)$}C>9C4)1RsRS<2n^FHX{d}2duP%Rb0j`dsiQk05srqBK!E7i5!$OVg|l;uvMhhdQC z3hcrF0;XH)NK1HU@gb!@qGcCx7G2rSky~nfUBCtFjOsFrMp2VVVgf<8yBV5|NnW?G z>dQULm2}nspZL(o8446W0bEY2bl_JCm@?xK)-GB4o?5FcG4dHBHwiJFR!U)&5e!{C zoXeoUGjW5GmHFW>Z${UexPEF4yUr!(0TWl85}7^zVrzQV#O=wun`C#pvA6rtjq$+T zsuTEBc}E5JX$;=a%PVYL3Yw|3mJM!&)~oZhNg=-%_@dYn2nksSZPo$@8TrT~73^&EAw7}hGa$a@M@(hx8)vKO2D_3B#Tkd*yQK7}> zY<3&=VbVZX+PKO)u6HsRE(&g+6CzA>1Mg90>n*KrF+#g`J#zGzViFDAa4*D6(t0L| zSF+nsuU2h9D6Pfeuqh2m1q=r*HMI`y=U=wJis%>*mpoEWv{%ixMRhWB;^g5p^^Vuu zR6V>xy~;I&SI;4fb}l~)ot7W+bHlOvy8ti)=VWM(8WeZW{5fhm`8Y4?XKlrzUc zp1j$@DQ$dQkSjtlYWqzWpF?@n8|2baygWb1-5wcBDpcb-3gsOkZWzWp8H%QI&g<{) z^0)fJ!hsJzSFTHjt%cpX0sC>Nly;N}pfAw!Cs!j0*m@ z{SA{ytiu~JD=RBtA(R@SyTx==){17M9ex_9FglF%6+M$;&=CSZVN_XbYpvtV+CO~R zehR_RjE9l0)#T8=vu2e8o!#iLH8)G=JUW)53c5G>GMZnNVIDaD?m-3 zrH7U)icWZeucQ~x0zv-U1?Y=Dd4YG((LpYcR;}Ty|8qtl10xs|jlPoizRdpvqX{aH z(qGG?%9Y73T~*8{%lWVJ_e8S?ctYs(>8MIR@K>I{BH0TAlUjC{%pcXx!zT(p8hKQE Hbffp*J48qL delta 4154 zcmai1dstN0wa?n;F*6$&hQkaDj4&`Dl7~f;Ha0ON3^2+lGlL9heU2lH$W<6%hFVQ3 zLbTdyMLjpJ*l4Y3VrrVy$Ald3jS`j6B$~u%6O(*5sWJ7@#z&>`RSMF5W_;z#cklgU zzB6ayq}!drNj^v|R^k zvA2fj1zYMD`@{9Y#`0iYU43Jnr%8PYNm(?J`Dv&Rh1jbvyr?N)ei_g9Ll)%g%I;YS zV0#{@zT)m0a`N!OByA!KRLY|!x%03|t~d|}26@JTHDZ!F z?80>`Ayw8Kd=Mmj(?Z5WvfOd728?*3TQq}79y;iT6g+SZOpuC$FF`t(<+h$QNWl?yLz&~A|LBl_qwxJLt9ezcOOx{_dHZM|A9EQ?&dzrpifXFiw}04q2_!Q$lvFxO9quZpz1$nC$$h7n zZv!cnCaN=DpWW+qR5B-RZo^-X?EN)JX;hj}?X7Z-bC%du=P|1lTer=TQmEeRD5+LA zVD)S-cNup6^LjtnS}5@}u_)v31n#Mb6@RJITT*7P9PcPKd^I$*MAB2yF{zpbV|erI zg<~LTC~>+CFG^Ay>lC-A%6D`2aBoB>B~VcvVheWdJy$NpQ^D==G0$5%4(8Zgl=ChM zefzq+Q@w0k)n|p_B}s~-yxZ<_7*?HL2dcA5$9VO&E_a<*1JSU9Pj;3#49~o{Pg`sg zDeq$mEfy%}3pN$2uPk%1=c16Uo~GmHO(Y$+YT;g9MFY&dEMzI$b#O()cM@vC_I|;n zJdg~l9Q=+n%46F&Ar}XJ1a7u=;#63IfBq|hkr8ubbu9^-WR>AhoCM+lr1-vqyHDm(D&49;1k7YC9epber8?sq%7j3u~caIS> zy}8 zPmMTf3o$CQR*+?I`*uh+2g zlY`CDFlwxJdn+6z4E&jzx$WlSg%dqcoJBKP0`HPf>ap%VRdF2EsbkStZCyZ9S#+@y zDEU^Zq-vT_(;5l~8+>td>jMjFL*}=;moLP`PdV$T|HY;xx_+FxS~5`~YG&>~@ZaB) zO|RI-7Hg^Ki;flRsK(b22)ESN*lMZm|Mw;z`6Lzput&VFZ8O}J)$ddZBgSYV8iKU} zbN4rEZYCnC3#UXA;bJr2O@zx+stQ3yxaxh5vpdUuCFLG3BgFMD_x&Cu3pJ_}E>Bje z!*|#98(zP>?7rJqs_v?AuXASva!AB;Z*U$w78G;kptcTA?d8n)1DBYJ$@@49gP4MS zoK?;mv|#-{E)TT0b{{vIk<0vSJ{_paDiDX??BizQ5e+9`bvKv9$fckYEXq(fSId(R zbV{Iyy8swc7^G;Gls|Ioi1NWZ+_S(n(-geX%cUq^9^yLE$##OZr@25p6J>LoYa7ka zytp6GqmW$8Im0oeh-pbq1>7HE?-_1*f`$sdreI6h_IFB+vi+AvW!PD64o5BlF8!LD z`}#TV36WubQ6D!BAKS!e18~MBMjHe#^l=|5NB+S*%|pB5y~ce>7`=SIpBshE{p^7C zs2?j%P=@-sO55FX3NHD4;?MGYFZlt-JCNCd~&cAET46j7nJ>e|Zhr z0r#f01rG}%F;Pgt1S6lO+XU2983?sDFxn9B$08fdR~!bRWR!L-N26Y_NFiy` zBb3(M(ySr#o(pSB(f%jSdPm4cxvQuH1X}`Aw2dM2#T{Z6m#>o^rEzLAGi!$7A@kMa z|0s)^K61OKq-3gT42FHGRmaxnu0hl;g~r|aUJ03({q68Db=>we;C_WzYnhC*mzR5{ z7`7k(a|Y{Wee}&Y#aUIRLXM&R0 zO)eoFPdSB=G4Af34#R-MqwU1Xi2KDaoxKv1o1f^i9PzcKEc3~{xuM(!) z%6}^4;Kiqf$8cL8mx~{1xMUXh+GWB%WQ~%dJiT1#-l1P_pw!zsr!f#-7;Kr3M}uOC zvi=9+lfuoOLDn-?<>zC?&r-=HQK|KcR{*;Lypfb8VrR8D6DuZ*gUakF;(jeGSF&e| zVYu}%r#wGL%<|9^A{DD!7P$OPs{7&SUC5tCXSI+K?G|=zFGR$0d}|u}c+_{LVD@Wb z6@w!63o;JZzb01VjV6d!(!0drI`~K_>K4BtIQVxmLFqgoF4Vz(MRQo392>%Q1AP99 Tlkbb{r(r*>a`JuM+y(yzraMi* diff --git a/Compute/samples/V1/BackendServicesClient/list_usable.php b/Compute/samples/V1/BackendServicesClient/list_usable.php index 58a3033ef9ee..f67af07cc528 100644 --- a/Compute/samples/V1/BackendServicesClient/list_usable.php +++ b/Compute/samples/V1/BackendServicesClient/list_usable.php @@ -28,7 +28,7 @@ use Google\Cloud\Compute\V1\BackendServicesClient; /** - * Retrieves an aggregated list of all usable backend services in the specified project. + * Retrieves a list of all usable backend services in the specified project. * * @param string $project Project ID for this request. */ diff --git a/Compute/samples/V1/GlobalOperationsClient/delete.php b/Compute/samples/V1/GlobalOperationsClient/delete.php index 78df80381769..dd5116e43278 100644 --- a/Compute/samples/V1/GlobalOperationsClient/delete.php +++ b/Compute/samples/V1/GlobalOperationsClient/delete.php @@ -30,7 +30,7 @@ /** * Deletes the specified Operations resource. * - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * @param string $project Project ID for this request. */ function delete_sample(string $operation, string $project): void diff --git a/Compute/samples/V1/GlobalOperationsClient/get.php b/Compute/samples/V1/GlobalOperationsClient/get.php index 88816d9fc9cc..0e1932a36d11 100644 --- a/Compute/samples/V1/GlobalOperationsClient/get.php +++ b/Compute/samples/V1/GlobalOperationsClient/get.php @@ -30,7 +30,7 @@ /** * Retrieves the specified Operations resource. * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. */ function get_sample(string $operation, string $project): void diff --git a/Compute/samples/V1/GlobalOperationsClient/wait.php b/Compute/samples/V1/GlobalOperationsClient/wait.php index d2927ecaa938..e88cf06035ae 100644 --- a/Compute/samples/V1/GlobalOperationsClient/wait.php +++ b/Compute/samples/V1/GlobalOperationsClient/wait.php @@ -30,7 +30,7 @@ /** * Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. */ function wait_sample(string $operation, string $project): void diff --git a/Compute/samples/V1/GlobalOrganizationOperationsClient/delete.php b/Compute/samples/V1/GlobalOrganizationOperationsClient/delete.php index 48d6d73799b0..09e886c3e585 100644 --- a/Compute/samples/V1/GlobalOrganizationOperationsClient/delete.php +++ b/Compute/samples/V1/GlobalOrganizationOperationsClient/delete.php @@ -30,7 +30,7 @@ /** * Deletes the specified Operations resource. * - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. */ function delete_sample(string $operation): void { diff --git a/Compute/samples/V1/GlobalOrganizationOperationsClient/get.php b/Compute/samples/V1/GlobalOrganizationOperationsClient/get.php index 468eeda3623e..c7a1aa66d9f2 100644 --- a/Compute/samples/V1/GlobalOrganizationOperationsClient/get.php +++ b/Compute/samples/V1/GlobalOrganizationOperationsClient/get.php @@ -30,7 +30,7 @@ /** * Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request. * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. */ function get_sample(string $operation): void { diff --git a/Compute/samples/V1/NetworksClient/patch.php b/Compute/samples/V1/NetworksClient/patch.php index 9f52fba183cd..968158961685 100644 --- a/Compute/samples/V1/NetworksClient/patch.php +++ b/Compute/samples/V1/NetworksClient/patch.php @@ -30,7 +30,7 @@ use Google\Rpc\Status; /** - * Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. + * Patches the specified network with the data included in the request. Only routingConfig can be modified. * * @param string $network Name of the network to update. * @param string $project Project ID for this request. diff --git a/Compute/samples/V1/RegionBackendServicesClient/list_usable.php b/Compute/samples/V1/RegionBackendServicesClient/list_usable.php index a4af94665682..1b660bf98b9d 100644 --- a/Compute/samples/V1/RegionBackendServicesClient/list_usable.php +++ b/Compute/samples/V1/RegionBackendServicesClient/list_usable.php @@ -28,7 +28,7 @@ use Google\Cloud\Compute\V1\RegionBackendServicesClient; /** - * Retrieves an aggregated list of all usable backend services in the specified project in the given region. + * Retrieves a list of all usable backend services in the specified project in the given region. * * @param string $project Project ID for this request. * @param string $region Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. diff --git a/Compute/samples/V1/RegionOperationsClient/delete.php b/Compute/samples/V1/RegionOperationsClient/delete.php index 344d97c5ba50..e0f85d05834e 100644 --- a/Compute/samples/V1/RegionOperationsClient/delete.php +++ b/Compute/samples/V1/RegionOperationsClient/delete.php @@ -30,7 +30,7 @@ /** * Deletes the specified region-specific Operations resource. * - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $region Name of the region for this request. */ diff --git a/Compute/samples/V1/RegionOperationsClient/get.php b/Compute/samples/V1/RegionOperationsClient/get.php index 065855fc97d5..3b858fedc40b 100644 --- a/Compute/samples/V1/RegionOperationsClient/get.php +++ b/Compute/samples/V1/RegionOperationsClient/get.php @@ -30,7 +30,7 @@ /** * Retrieves the specified region-specific Operations resource. * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $region Name of the region for this request. */ diff --git a/Compute/samples/V1/RegionOperationsClient/wait.php b/Compute/samples/V1/RegionOperationsClient/wait.php index dbc1ec9db37c..219c32e75e79 100644 --- a/Compute/samples/V1/RegionOperationsClient/wait.php +++ b/Compute/samples/V1/RegionOperationsClient/wait.php @@ -30,7 +30,7 @@ /** * Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $region Name of the region for this request. */ diff --git a/Compute/samples/V1/RegionsClient/get.php b/Compute/samples/V1/RegionsClient/get.php index 55e67b5cbd9d..dbc454ca89ab 100644 --- a/Compute/samples/V1/RegionsClient/get.php +++ b/Compute/samples/V1/RegionsClient/get.php @@ -28,7 +28,7 @@ use Google\Cloud\Compute\V1\RegionsClient; /** - * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * @param string $project Project ID for this request. * @param string $region Name of the region resource to return. diff --git a/Compute/samples/V1/RegionsClient/list.php b/Compute/samples/V1/RegionsClient/list.php index 5437b2f3cb5e..672c61610261 100644 --- a/Compute/samples/V1/RegionsClient/list.php +++ b/Compute/samples/V1/RegionsClient/list.php @@ -28,7 +28,7 @@ use Google\Cloud\Compute\V1\RegionsClient; /** - * Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * @param string $project Project ID for this request. */ diff --git a/Compute/samples/V1/StoragePoolsClient/update.php b/Compute/samples/V1/StoragePoolsClient/update.php index 0056fd9dac69..c5164b5ce673 100644 --- a/Compute/samples/V1/StoragePoolsClient/update.php +++ b/Compute/samples/V1/StoragePoolsClient/update.php @@ -30,7 +30,7 @@ use Google\Rpc\Status; /** - * Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: size_tb and provisioned_iops. + * Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: pool_provisioned_capacity_gb, pool_provisioned_iops and pool_provisioned_throughput. * * @param string $project Project ID for this request. * @param string $storagePool The storagePool name for this request. diff --git a/Compute/samples/V1/ZoneOperationsClient/delete.php b/Compute/samples/V1/ZoneOperationsClient/delete.php index e3d60a024f02..9073a802d33e 100644 --- a/Compute/samples/V1/ZoneOperationsClient/delete.php +++ b/Compute/samples/V1/ZoneOperationsClient/delete.php @@ -30,7 +30,7 @@ /** * Deletes the specified zone-specific Operations resource. * - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. */ diff --git a/Compute/samples/V1/ZoneOperationsClient/get.php b/Compute/samples/V1/ZoneOperationsClient/get.php index 6bf95ec078ec..dba46936b3c1 100644 --- a/Compute/samples/V1/ZoneOperationsClient/get.php +++ b/Compute/samples/V1/ZoneOperationsClient/get.php @@ -30,7 +30,7 @@ /** * Retrieves the specified zone-specific Operations resource. * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. */ diff --git a/Compute/samples/V1/ZoneOperationsClient/wait.php b/Compute/samples/V1/ZoneOperationsClient/wait.php index e195997fdb00..e9194cd815ef 100644 --- a/Compute/samples/V1/ZoneOperationsClient/wait.php +++ b/Compute/samples/V1/ZoneOperationsClient/wait.php @@ -30,7 +30,7 @@ /** * Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. */ diff --git a/Compute/src/V1/AdvancedMachineFeatures.php b/Compute/src/V1/AdvancedMachineFeatures.php index c25030e2b154..f5e5bc75166d 100644 --- a/Compute/src/V1/AdvancedMachineFeatures.php +++ b/Compute/src/V1/AdvancedMachineFeatures.php @@ -27,12 +27,25 @@ class AdvancedMachineFeatures extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional bool enable_uefi_networking = 334485668; */ private $enable_uefi_networking = null; + /** + * Type of Performance Monitoring Unit requested on instance. + * Check the PerformanceMonitoringUnit enum for the list of possible values. + * + * Generated from protobuf field optional string performance_monitoring_unit = 533618956; + */ + private $performance_monitoring_unit = null; /** * The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. * * Generated from protobuf field optional int32 threads_per_core = 352611671; */ private $threads_per_core = null; + /** + * Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode. + * + * Generated from protobuf field optional string turbo_mode = 432965412; + */ + private $turbo_mode = null; /** * The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. * @@ -50,8 +63,13 @@ class AdvancedMachineFeatures extends \Google\Protobuf\Internal\Message * Whether to enable nested virtualization or not (default is false). * @type bool $enable_uefi_networking * Whether to enable UEFI networking for instance creation. + * @type string $performance_monitoring_unit + * Type of Performance Monitoring Unit requested on instance. + * Check the PerformanceMonitoringUnit enum for the list of possible values. * @type int $threads_per_core * The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. + * @type string $turbo_mode + * Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode. * @type int $visible_core_count * The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. * } @@ -133,6 +151,44 @@ public function setEnableUefiNetworking($var) return $this; } + /** + * Type of Performance Monitoring Unit requested on instance. + * Check the PerformanceMonitoringUnit enum for the list of possible values. + * + * Generated from protobuf field optional string performance_monitoring_unit = 533618956; + * @return string + */ + public function getPerformanceMonitoringUnit() + { + return isset($this->performance_monitoring_unit) ? $this->performance_monitoring_unit : ''; + } + + public function hasPerformanceMonitoringUnit() + { + return isset($this->performance_monitoring_unit); + } + + public function clearPerformanceMonitoringUnit() + { + unset($this->performance_monitoring_unit); + } + + /** + * Type of Performance Monitoring Unit requested on instance. + * Check the PerformanceMonitoringUnit enum for the list of possible values. + * + * Generated from protobuf field optional string performance_monitoring_unit = 533618956; + * @param string $var + * @return $this + */ + public function setPerformanceMonitoringUnit($var) + { + GPBUtil::checkString($var, True); + $this->performance_monitoring_unit = $var; + + return $this; + } + /** * The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. * @@ -169,6 +225,42 @@ public function setThreadsPerCore($var) return $this; } + /** + * Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode. + * + * Generated from protobuf field optional string turbo_mode = 432965412; + * @return string + */ + public function getTurboMode() + { + return isset($this->turbo_mode) ? $this->turbo_mode : ''; + } + + public function hasTurboMode() + { + return isset($this->turbo_mode); + } + + public function clearTurboMode() + { + unset($this->turbo_mode); + } + + /** + * Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode. + * + * Generated from protobuf field optional string turbo_mode = 432965412; + * @param string $var + * @return $this + */ + public function setTurboMode($var) + { + GPBUtil::checkString($var, True); + $this->turbo_mode = $var; + + return $this; + } + /** * The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. * diff --git a/Compute/src/V1/AdvancedMachineFeatures/PerformanceMonitoringUnit.php b/Compute/src/V1/AdvancedMachineFeatures/PerformanceMonitoringUnit.php new file mode 100644 index 000000000000..010ae28ce5e8 --- /dev/null +++ b/Compute/src/V1/AdvancedMachineFeatures/PerformanceMonitoringUnit.php @@ -0,0 +1,74 @@ +google.cloud.compute.v1.AdvancedMachineFeatures.PerformanceMonitoringUnit + */ +class PerformanceMonitoringUnit +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_PERFORMANCE_MONITORING_UNIT = 0; + */ + const UNDEFINED_PERFORMANCE_MONITORING_UNIT = 0; + /** + * Architecturally defined non-LLC events. + * + * Generated from protobuf enum ARCHITECTURAL = 155113693; + */ + const ARCHITECTURAL = 155113693; + /** + * Most documented core/L2 and LLC events. + * + * Generated from protobuf enum ENHANCED = 476873590; + */ + const ENHANCED = 476873590; + /** + * Generated from protobuf enum PERFORMANCE_MONITORING_UNIT_UNSPECIFIED = 429210692; + */ + const PERFORMANCE_MONITORING_UNIT_UNSPECIFIED = 429210692; + /** + * Most documented core/L2 events. + * + * Generated from protobuf enum STANDARD = 484642493; + */ + const STANDARD = 484642493; + + private static $valueToName = [ + self::UNDEFINED_PERFORMANCE_MONITORING_UNIT => 'UNDEFINED_PERFORMANCE_MONITORING_UNIT', + self::ARCHITECTURAL => 'ARCHITECTURAL', + self::ENHANCED => 'ENHANCED', + self::PERFORMANCE_MONITORING_UNIT_UNSPECIFIED => 'PERFORMANCE_MONITORING_UNIT_UNSPECIFIED', + self::STANDARD => 'STANDARD', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/AllocationAggregateReservation/VmFamily.php b/Compute/src/V1/AllocationAggregateReservation/VmFamily.php index b74d774eac04..079a4083cca7 100644 --- a/Compute/src/V1/AllocationAggregateReservation/VmFamily.php +++ b/Compute/src/V1/AllocationAggregateReservation/VmFamily.php @@ -19,6 +19,10 @@ class VmFamily * Generated from protobuf enum UNDEFINED_VM_FAMILY = 0; */ const UNDEFINED_VM_FAMILY = 0; + /** + * Generated from protobuf enum VM_FAMILY_CLOUD_TPU_DEVICE_CT3 = 42845948; + */ + const VM_FAMILY_CLOUD_TPU_DEVICE_CT3 = 42845948; /** * Generated from protobuf enum VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L = 108020067; */ @@ -27,6 +31,10 @@ class VmFamily * Generated from protobuf enum VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP = 18705267; */ const VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP = 18705267; + /** + * Generated from protobuf enum VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P = 517384376; + */ + const VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P = 517384376; /** * Generated from protobuf enum VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P = 517384407; */ @@ -34,8 +42,10 @@ class VmFamily private static $valueToName = [ self::UNDEFINED_VM_FAMILY => 'UNDEFINED_VM_FAMILY', + self::VM_FAMILY_CLOUD_TPU_DEVICE_CT3 => 'VM_FAMILY_CLOUD_TPU_DEVICE_CT3', self::VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L => 'VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L', self::VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP => 'VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP', + self::VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P => 'VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P', self::VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P => 'VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P', ]; diff --git a/Compute/src/V1/AttachedDisk.php b/Compute/src/V1/AttachedDisk.php index f348c871d198..3c4aa1303feb 100644 --- a/Compute/src/V1/AttachedDisk.php +++ b/Compute/src/V1/AttachedDisk.php @@ -41,7 +41,7 @@ class AttachedDisk extends \Google\Protobuf\Internal\Message */ private $device_name = null; /** - * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Note: Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method. * * Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677; */ @@ -116,7 +116,7 @@ class AttachedDisk extends \Google\Protobuf\Internal\Message */ private $shielded_instance_initial_state = null; /** - * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. * * Generated from protobuf field optional string source = 177235995; */ @@ -145,7 +145,7 @@ class AttachedDisk extends \Google\Protobuf\Internal\Message * @type string $device_name * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. * @type \Google\Cloud\Compute\V1\CustomerEncryptionKey $disk_encryption_key - * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Note: Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method. * @type int|string $disk_size_gb * The size of the disk in GB. * @type bool $force_attach @@ -172,7 +172,7 @@ class AttachedDisk extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\Compute\V1\InitialStateConfig $shielded_instance_initial_state * [Output Only] shielded vm initial state stored on disk * @type string $source - * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. * @type string $type * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. * Check the Type enum for the list of possible values. @@ -330,7 +330,7 @@ public function setDeviceName($var) } /** - * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Note: Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method. * * Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677; * @return \Google\Cloud\Compute\V1\CustomerEncryptionKey|null @@ -351,7 +351,7 @@ public function clearDiskEncryptionKey() } /** - * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Note: Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method. * * Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677; * @param \Google\Cloud\Compute\V1\CustomerEncryptionKey $var @@ -748,7 +748,7 @@ public function setShieldedInstanceInitialState($var) } /** - * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. * * Generated from protobuf field optional string source = 177235995; * @return string @@ -769,7 +769,7 @@ public function clearSource() } /** - * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. * * Generated from protobuf field optional string source = 177235995; * @param string $var diff --git a/Compute/src/V1/AttachedDiskInitializeParams.php b/Compute/src/V1/AttachedDiskInitializeParams.php index ebe91f0c690f..887d399d0383 100644 --- a/Compute/src/V1/AttachedDiskInitializeParams.php +++ b/Compute/src/V1/AttachedDiskInitializeParams.php @@ -102,7 +102,7 @@ class AttachedDiskInitializeParams extends \Google\Protobuf\Internal\Message */ private $resource_policies; /** - * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. * * Generated from protobuf field optional string source_image = 50443319; */ @@ -114,7 +114,7 @@ class AttachedDiskInitializeParams extends \Google\Protobuf\Internal\Message */ private $source_image_encryption_key = null; /** - * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. + * The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. * * Generated from protobuf field optional string source_snapshot = 126061928; */ @@ -169,11 +169,11 @@ class AttachedDiskInitializeParams extends \Google\Protobuf\Internal\Message * @type array|\Google\Protobuf\Internal\RepeatedField $resource_policies * Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. * @type string $source_image - * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. * @type \Google\Cloud\Compute\V1\CustomerEncryptionKey $source_image_encryption_key * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. * @type string $source_snapshot - * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. + * The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. * @type \Google\Cloud\Compute\V1\CustomerEncryptionKey $source_snapshot_encryption_key * The customer-supplied encryption key of the source snapshot. * @type string $storage_pool @@ -644,7 +644,7 @@ public function setResourcePolicies($var) } /** - * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. * * Generated from protobuf field optional string source_image = 50443319; * @return string @@ -665,7 +665,7 @@ public function clearSourceImage() } /** - * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. * * Generated from protobuf field optional string source_image = 50443319; * @param string $var @@ -716,7 +716,7 @@ public function setSourceImageEncryptionKey($var) } /** - * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. + * The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. * * Generated from protobuf field optional string source_snapshot = 126061928; * @return string @@ -737,7 +737,7 @@ public function clearSourceSnapshot() } /** - * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. + * The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. * * Generated from protobuf field optional string source_snapshot = 126061928; * @param string $var diff --git a/Compute/src/V1/AuditConfig.php b/Compute/src/V1/AuditConfig.php index 67bdd64fd30e..16871baa2945 100644 --- a/Compute/src/V1/AuditConfig.php +++ b/Compute/src/V1/AuditConfig.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. * * Generated from protobuf message google.cloud.compute.v1.AuditConfig */ @@ -22,8 +22,6 @@ class AuditConfig extends \Google\Protobuf\Internal\Message */ private $audit_log_configs; /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field repeated string exempted_members = 232615576; */ private $exempted_members; @@ -43,7 +41,6 @@ class AuditConfig extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\Compute\V1\AuditLogConfig>|\Google\Protobuf\Internal\RepeatedField $audit_log_configs * The configuration for logging of each type of permission. * @type array|\Google\Protobuf\Internal\RepeatedField $exempted_members - * This is deprecated and has no effect. Do not use. * @type string $service * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. * } @@ -80,8 +77,6 @@ public function setAuditLogConfigs($var) } /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field repeated string exempted_members = 232615576; * @return \Google\Protobuf\Internal\RepeatedField */ @@ -91,8 +86,6 @@ public function getExemptedMembers() } /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field repeated string exempted_members = 232615576; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this diff --git a/Compute/src/V1/AuditLogConfig.php b/Compute/src/V1/AuditLogConfig.php index 7bfebc4632c4..afed92390ee5 100644 --- a/Compute/src/V1/AuditLogConfig.php +++ b/Compute/src/V1/AuditLogConfig.php @@ -22,8 +22,6 @@ class AuditLogConfig extends \Google\Protobuf\Internal\Message */ private $exempted_members; /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field optional bool ignore_child_exemptions = 70141850; */ private $ignore_child_exemptions = null; @@ -44,7 +42,6 @@ class AuditLogConfig extends \Google\Protobuf\Internal\Message * @type array|\Google\Protobuf\Internal\RepeatedField $exempted_members * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. * @type bool $ignore_child_exemptions - * This is deprecated and has no effect. Do not use. * @type string $log_type * The log type that this config enables. * Check the LogType enum for the list of possible values. @@ -82,8 +79,6 @@ public function setExemptedMembers($var) } /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field optional bool ignore_child_exemptions = 70141850; * @return bool */ @@ -103,8 +98,6 @@ public function clearIgnoreChildExemptions() } /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field optional bool ignore_child_exemptions = 70141850; * @param bool $var * @return $this diff --git a/Compute/src/V1/BackendBucket.php b/Compute/src/V1/BackendBucket.php index 6c6af0b4490d..50d2ec434559 100644 --- a/Compute/src/V1/BackendBucket.php +++ b/Compute/src/V1/BackendBucket.php @@ -88,6 +88,12 @@ class BackendBucket extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string self_link = 456214797; */ private $self_link = null; + /** + * [Output Only] List of resources referencing that backend bucket. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.BackendBucketUsedBy used_by = 389320729; + */ + private $used_by; /** * Constructor. @@ -120,6 +126,8 @@ class BackendBucket extends \Google\Protobuf\Internal\Message * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. * @type string $self_link * [Output Only] Server-defined URL for the resource. + * @type array<\Google\Cloud\Compute\V1\BackendBucketUsedBy>|\Google\Protobuf\Internal\RepeatedField $used_by + * [Output Only] List of resources referencing that backend bucket. * } */ public function __construct($data = NULL) { @@ -551,5 +559,31 @@ public function setSelfLink($var) return $this; } + /** + * [Output Only] List of resources referencing that backend bucket. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.BackendBucketUsedBy used_by = 389320729; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUsedBy() + { + return $this->used_by; + } + + /** + * [Output Only] List of resources referencing that backend bucket. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.BackendBucketUsedBy used_by = 389320729; + * @param array<\Google\Cloud\Compute\V1\BackendBucketUsedBy>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUsedBy($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Compute\V1\BackendBucketUsedBy::class); + $this->used_by = $arr; + + return $this; + } + } diff --git a/Compute/src/V1/BackendBucketUsedBy.php b/Compute/src/V1/BackendBucketUsedBy.php new file mode 100644 index 000000000000..6f365f302095 --- /dev/null +++ b/Compute/src/V1/BackendBucketUsedBy.php @@ -0,0 +1,76 @@ +google.cloud.compute.v1.BackendBucketUsedBy + */ +class BackendBucketUsedBy extends \Google\Protobuf\Internal\Message +{ + /** + * [Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. + * + * Generated from protobuf field optional string reference = 148586315; + */ + private $reference = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $reference + * [Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * [Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. + * + * Generated from protobuf field optional string reference = 148586315; + * @return string + */ + public function getReference() + { + return isset($this->reference) ? $this->reference : ''; + } + + public function hasReference() + { + return isset($this->reference); + } + + public function clearReference() + { + unset($this->reference); + } + + /** + * [Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. + * + * Generated from protobuf field optional string reference = 148586315; + * @param string $var + * @return $this + */ + public function setReference($var) + { + GPBUtil::checkString($var, True); + $this->reference = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/BackendService.php b/Compute/src/V1/BackendService.php index be6c0f8dba9e..8d2f2d94ceb6 100644 --- a/Compute/src/V1/BackendService.php +++ b/Compute/src/V1/BackendService.php @@ -126,6 +126,13 @@ class BackendService extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional uint64 id = 3355; */ private $id = null; + /** + * Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). + * Check the IpAddressSelectionPolicy enum for the list of possible values. + * + * Generated from protobuf field optional string ip_address_selection_policy = 77600840; + */ + private $ip_address_selection_policy = null; /** * [Output Only] Type of resource. Always compute#backendService for backend services. * @@ -146,7 +153,7 @@ class BackendService extends \Google\Protobuf\Internal\Message */ private $locality_lb_policies; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. * Check the LocalityLbPolicy enum for the list of possible values. * * Generated from protobuf field optional string locality_lb_policy = 131431487; @@ -250,6 +257,12 @@ class BackendService extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string session_affinity = 463888561; */ private $session_affinity = null; + /** + * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + * + * Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722; + */ + private $strong_session_affinity_cookie = null; /** * Generated from protobuf field optional .google.cloud.compute.v1.Subsetting subsetting = 450283536; */ @@ -261,6 +274,8 @@ class BackendService extends \Google\Protobuf\Internal\Message */ private $timeout_sec = null; /** + * [Output Only] List of resources referencing given backend service. + * * Generated from protobuf field repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729; */ private $used_by; @@ -308,6 +323,9 @@ class BackendService extends \Google\Protobuf\Internal\Message * The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers. * @type int|string $id * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + * @type string $ip_address_selection_policy + * Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). + * Check the IpAddressSelectionPolicy enum for the list of possible values. * @type string $kind * [Output Only] Type of resource. Always compute#backendService for backend services. * @type string $load_balancing_scheme @@ -316,7 +334,7 @@ class BackendService extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\Compute\V1\BackendServiceLocalityLoadBalancingPolicyConfig>|\Google\Protobuf\Internal\RepeatedField $locality_lb_policies * A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. * @type string $locality_lb_policy - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. * Check the LocalityLbPolicy enum for the list of possible values. * @type \Google\Cloud\Compute\V1\BackendServiceLogConfig $log_config * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. @@ -352,10 +370,13 @@ class BackendService extends \Google\Protobuf\Internal\Message * @type string $session_affinity * Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). * Check the SessionAffinity enum for the list of possible values. + * @type \Google\Cloud\Compute\V1\BackendServiceHttpCookie $strong_session_affinity_cookie + * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. * @type \Google\Cloud\Compute\V1\Subsetting $subsetting * @type int $timeout_sec * The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. * @type array<\Google\Cloud\Compute\V1\BackendServiceUsedBy>|\Google\Protobuf\Internal\RepeatedField $used_by + * [Output Only] List of resources referencing given backend service. * } */ public function __construct($data = NULL) { @@ -1001,6 +1022,44 @@ public function setId($var) return $this; } + /** + * Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). + * Check the IpAddressSelectionPolicy enum for the list of possible values. + * + * Generated from protobuf field optional string ip_address_selection_policy = 77600840; + * @return string + */ + public function getIpAddressSelectionPolicy() + { + return isset($this->ip_address_selection_policy) ? $this->ip_address_selection_policy : ''; + } + + public function hasIpAddressSelectionPolicy() + { + return isset($this->ip_address_selection_policy); + } + + public function clearIpAddressSelectionPolicy() + { + unset($this->ip_address_selection_policy); + } + + /** + * Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). + * Check the IpAddressSelectionPolicy enum for the list of possible values. + * + * Generated from protobuf field optional string ip_address_selection_policy = 77600840; + * @param string $var + * @return $this + */ + public function setIpAddressSelectionPolicy($var) + { + GPBUtil::checkString($var, True); + $this->ip_address_selection_policy = $var; + + return $this; + } + /** * [Output Only] Type of resource. Always compute#backendService for backend services. * @@ -1102,7 +1161,7 @@ public function setLocalityLbPolicies($var) } /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. * Check the LocalityLbPolicy enum for the list of possible values. * * Generated from protobuf field optional string locality_lb_policy = 131431487; @@ -1124,7 +1183,7 @@ public function clearLocalityLbPolicy() } /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. * Check the LocalityLbPolicy enum for the list of possible values. * * Generated from protobuf field optional string locality_lb_policy = 131431487; @@ -1699,6 +1758,42 @@ public function setSessionAffinity($var) return $this; } + /** + * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + * + * Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722; + * @return \Google\Cloud\Compute\V1\BackendServiceHttpCookie|null + */ + public function getStrongSessionAffinityCookie() + { + return $this->strong_session_affinity_cookie; + } + + public function hasStrongSessionAffinityCookie() + { + return isset($this->strong_session_affinity_cookie); + } + + public function clearStrongSessionAffinityCookie() + { + unset($this->strong_session_affinity_cookie); + } + + /** + * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + * + * Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722; + * @param \Google\Cloud\Compute\V1\BackendServiceHttpCookie $var + * @return $this + */ + public function setStrongSessionAffinityCookie($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\BackendServiceHttpCookie::class); + $this->strong_session_affinity_cookie = $var; + + return $this; + } + /** * Generated from protobuf field optional .google.cloud.compute.v1.Subsetting subsetting = 450283536; * @return \Google\Cloud\Compute\V1\Subsetting|null @@ -1768,6 +1863,8 @@ public function setTimeoutSec($var) } /** + * [Output Only] List of resources referencing given backend service. + * * Generated from protobuf field repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729; * @return \Google\Protobuf\Internal\RepeatedField */ @@ -1777,6 +1874,8 @@ public function getUsedBy() } /** + * [Output Only] List of resources referencing given backend service. + * * Generated from protobuf field repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729; * @param array<\Google\Cloud\Compute\V1\BackendServiceUsedBy>|\Google\Protobuf\Internal\RepeatedField $var * @return $this diff --git a/Compute/src/V1/BackendService/IpAddressSelectionPolicy.php b/Compute/src/V1/BackendService/IpAddressSelectionPolicy.php new file mode 100644 index 000000000000..cdc9e4ca56ef --- /dev/null +++ b/Compute/src/V1/BackendService/IpAddressSelectionPolicy.php @@ -0,0 +1,76 @@ +google.cloud.compute.v1.BackendService.IpAddressSelectionPolicy + */ +class IpAddressSelectionPolicy +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_IP_ADDRESS_SELECTION_POLICY = 0; + */ + const UNDEFINED_IP_ADDRESS_SELECTION_POLICY = 0; + /** + * Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. + * + * Generated from protobuf enum IPV4_ONLY = 22373798; + */ + const IPV4_ONLY = 22373798; + /** + * Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. + * + * Generated from protobuf enum IPV6_ONLY = 79632100; + */ + const IPV6_ONLY = 79632100; + /** + * Unspecified IP address selection policy. + * + * Generated from protobuf enum IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED = 36210144; + */ + const IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED = 36210144; + /** + * Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). + * + * Generated from protobuf enum PREFER_IPV6 = 408601302; + */ + const PREFER_IPV6 = 408601302; + + private static $valueToName = [ + self::UNDEFINED_IP_ADDRESS_SELECTION_POLICY => 'UNDEFINED_IP_ADDRESS_SELECTION_POLICY', + self::IPV4_ONLY => 'IPV4_ONLY', + self::IPV6_ONLY => 'IPV6_ONLY', + self::IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED => 'IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED', + self::PREFER_IPV6 => 'PREFER_IPV6', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/BackendService/LocalityLbPolicy.php b/Compute/src/V1/BackendService/LocalityLbPolicy.php index 19b7b6662096..4a5f4357f24c 100644 --- a/Compute/src/V1/BackendService/LocalityLbPolicy.php +++ b/Compute/src/V1/BackendService/LocalityLbPolicy.php @@ -7,7 +7,7 @@ use UnexpectedValueException; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. * * Protobuf type google.cloud.compute.v1.BackendService.LocalityLbPolicy */ diff --git a/Compute/src/V1/BackendService/SessionAffinity.php b/Compute/src/V1/BackendService/SessionAffinity.php index d4ea2999a845..6b76d76901fa 100644 --- a/Compute/src/V1/BackendService/SessionAffinity.php +++ b/Compute/src/V1/BackendService/SessionAffinity.php @@ -67,6 +67,12 @@ class SessionAffinity * Generated from protobuf enum NONE = 2402104; */ const NONE = 2402104; + /** + * Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired. + * + * Generated from protobuf enum STRONG_COOKIE_AFFINITY = 438628091; + */ + const STRONG_COOKIE_AFFINITY = 438628091; private static $valueToName = [ self::UNDEFINED_SESSION_AFFINITY => 'UNDEFINED_SESSION_AFFINITY', @@ -78,6 +84,7 @@ class SessionAffinity self::HEADER_FIELD => 'HEADER_FIELD', self::HTTP_COOKIE => 'HTTP_COOKIE', self::NONE => 'NONE', + self::STRONG_COOKIE_AFFINITY => 'STRONG_COOKIE_AFFINITY', ]; public static function name($value) diff --git a/Compute/src/V1/BackendServiceHttpCookie.php b/Compute/src/V1/BackendServiceHttpCookie.php new file mode 100644 index 000000000000..4c0e16aa7425 --- /dev/null +++ b/Compute/src/V1/BackendServiceHttpCookie.php @@ -0,0 +1,165 @@ +google.cloud.compute.v1.BackendServiceHttpCookie + */ +class BackendServiceHttpCookie extends \Google\Protobuf\Internal\Message +{ + /** + * Name of the cookie. + * + * Generated from protobuf field optional string name = 3373707; + */ + private $name = null; + /** + * Path to set for the cookie. + * + * Generated from protobuf field optional string path = 3433509; + */ + private $path = null; + /** + * Lifetime of the cookie. + * + * Generated from protobuf field optional .google.cloud.compute.v1.Duration ttl = 115180; + */ + private $ttl = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Name of the cookie. + * @type string $path + * Path to set for the cookie. + * @type \Google\Cloud\Compute\V1\Duration $ttl + * Lifetime of the cookie. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * Name of the cookie. + * + * Generated from protobuf field optional string name = 3373707; + * @return string + */ + public function getName() + { + return isset($this->name) ? $this->name : ''; + } + + public function hasName() + { + return isset($this->name); + } + + public function clearName() + { + unset($this->name); + } + + /** + * Name of the cookie. + * + * Generated from protobuf field optional string name = 3373707; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Path to set for the cookie. + * + * Generated from protobuf field optional string path = 3433509; + * @return string + */ + public function getPath() + { + return isset($this->path) ? $this->path : ''; + } + + public function hasPath() + { + return isset($this->path); + } + + public function clearPath() + { + unset($this->path); + } + + /** + * Path to set for the cookie. + * + * Generated from protobuf field optional string path = 3433509; + * @param string $var + * @return $this + */ + public function setPath($var) + { + GPBUtil::checkString($var, True); + $this->path = $var; + + return $this; + } + + /** + * Lifetime of the cookie. + * + * Generated from protobuf field optional .google.cloud.compute.v1.Duration ttl = 115180; + * @return \Google\Cloud\Compute\V1\Duration|null + */ + public function getTtl() + { + return $this->ttl; + } + + public function hasTtl() + { + return isset($this->ttl); + } + + public function clearTtl() + { + unset($this->ttl); + } + + /** + * Lifetime of the cookie. + * + * Generated from protobuf field optional .google.cloud.compute.v1.Duration ttl = 115180; + * @param \Google\Cloud\Compute\V1\Duration $var + * @return $this + */ + public function setTtl($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\Duration::class); + $this->ttl = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/BackendServiceUsedBy.php b/Compute/src/V1/BackendServiceUsedBy.php index b959e943a0b6..9e8742663910 100644 --- a/Compute/src/V1/BackendServiceUsedBy.php +++ b/Compute/src/V1/BackendServiceUsedBy.php @@ -15,6 +15,8 @@ class BackendServiceUsedBy extends \Google\Protobuf\Internal\Message { /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + * * Generated from protobuf field optional string reference = 148586315; */ private $reference = null; @@ -26,6 +28,7 @@ class BackendServiceUsedBy extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $reference + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. * } */ public function __construct($data = NULL) { @@ -34,6 +37,8 @@ public function __construct($data = NULL) { } /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + * * Generated from protobuf field optional string reference = 148586315; * @return string */ @@ -53,6 +58,8 @@ public function clearReference() } /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + * * Generated from protobuf field optional string reference = 148586315; * @param string $var * @return $this diff --git a/Compute/src/V1/Binding.php b/Compute/src/V1/Binding.php index 3761e3911691..68f00cb29b8b 100644 --- a/Compute/src/V1/Binding.php +++ b/Compute/src/V1/Binding.php @@ -16,8 +16,6 @@ class Binding extends \Google\Protobuf\Internal\Message { /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field optional string binding_id = 441088277; */ private $binding_id = null; @@ -47,7 +45,6 @@ class Binding extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $binding_id - * This is deprecated and has no effect. Do not use. * @type \Google\Cloud\Compute\V1\Expr $condition * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @type array|\Google\Protobuf\Internal\RepeatedField $members @@ -62,8 +59,6 @@ public function __construct($data = NULL) { } /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field optional string binding_id = 441088277; * @return string */ @@ -83,8 +78,6 @@ public function clearBindingId() } /** - * This is deprecated and has no effect. Do not use. - * * Generated from protobuf field optional string binding_id = 441088277; * @param string $var * @return $this diff --git a/Compute/src/V1/BulkInsertInstanceResource.php b/Compute/src/V1/BulkInsertInstanceResource.php index 36c2d2f1cca3..b37ef121a300 100644 --- a/Compute/src/V1/BulkInsertInstanceResource.php +++ b/Compute/src/V1/BulkInsertInstanceResource.php @@ -28,7 +28,7 @@ class BulkInsertInstanceResource extends \Google\Protobuf\Internal\Message */ private $instance_properties = null; /** - * Policy for chosing target zone. For more information, see Create VMs in bulk . + * Policy for choosing target zone. For more information, see Create VMs in bulk. * * Generated from protobuf field optional .google.cloud.compute.v1.LocationPolicy location_policy = 465689852; */ @@ -69,7 +69,7 @@ class BulkInsertInstanceResource extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\Compute\V1\InstanceProperties $instance_properties * The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided. * @type \Google\Cloud\Compute\V1\LocationPolicy $location_policy - * Policy for chosing target zone. For more information, see Create VMs in bulk . + * Policy for choosing target zone. For more information, see Create VMs in bulk. * @type int|string $min_count * The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted. * @type string $name_pattern @@ -158,7 +158,7 @@ public function setInstanceProperties($var) } /** - * Policy for chosing target zone. For more information, see Create VMs in bulk . + * Policy for choosing target zone. For more information, see Create VMs in bulk. * * Generated from protobuf field optional .google.cloud.compute.v1.LocationPolicy location_policy = 465689852; * @return \Google\Cloud\Compute\V1\LocationPolicy|null @@ -179,7 +179,7 @@ public function clearLocationPolicy() } /** - * Policy for chosing target zone. For more information, see Create VMs in bulk . + * Policy for choosing target zone. For more information, see Create VMs in bulk. * * Generated from protobuf field optional .google.cloud.compute.v1.LocationPolicy location_policy = 465689852; * @param \Google\Cloud\Compute\V1\LocationPolicy $var diff --git a/Compute/src/V1/Client/AcceleratorTypesClient.php b/Compute/src/V1/Client/AcceleratorTypesClient.php index 7123486abeb8..dc52ead7f60a 100644 --- a/Compute/src/V1/Client/AcceleratorTypesClient.php +++ b/Compute/src/V1/Client/AcceleratorTypesClient.php @@ -47,9 +47,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListAcceleratorTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetAcceleratorTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListAcceleratorTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListAcceleratorTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetAcceleratorTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListAcceleratorTypesRequest $request, array $optionalArgs = []) */ final class AcceleratorTypesClient { diff --git a/Compute/src/V1/Client/AddressesClient.php b/Compute/src/V1/Client/AddressesClient.php index f3b0d61a8a78..7828797dc11b 100644 --- a/Compute/src/V1/Client/AddressesClient.php +++ b/Compute/src/V1/Client/AddressesClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListAddressesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListAddressesRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveAsync(MoveAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListAddressesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface
getAsync(GetAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListAddressesRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveAsync(MoveAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsAddressRequest $request, array $optionalArgs = []) */ final class AddressesClient { diff --git a/Compute/src/V1/Client/AutoscalersClient.php b/Compute/src/V1/Client/AutoscalersClient.php index afdd473b7bc0..3a0f47f70846 100644 --- a/Compute/src/V1/Client/AutoscalersClient.php +++ b/Compute/src/V1/Client/AutoscalersClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListAutoscalersRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteAutoscalerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetAutoscalerRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertAutoscalerRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListAutoscalersRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchAutoscalerRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListAutoscalersRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListAutoscalersRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateAutoscalerRequest $request, array $optionalArgs = []) */ final class AutoscalersClient { diff --git a/Compute/src/V1/Client/BackendBucketsClient.php b/Compute/src/V1/Client/BackendBucketsClient.php index 9c3841a880be..da0be511720b 100644 --- a/Compute/src/V1/Client/BackendBucketsClient.php +++ b/Compute/src/V1/Client/BackendBucketsClient.php @@ -57,18 +57,18 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addSignedUrlKeyAsync(AddSignedUrlKeyBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListBackendBucketsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface setEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsBackendBucketRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface addSignedUrlKeyAsync(AddSignedUrlKeyBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListBackendBucketsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface setEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsBackendBucketRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateBackendBucketRequest $request, array $optionalArgs = []) */ final class BackendBucketsClient { diff --git a/Compute/src/V1/Client/BackendServicesClient.php b/Compute/src/V1/Client/BackendServicesClient.php index 98fa41276321..ed7f64f78c2b 100644 --- a/Compute/src/V1/Client/BackendServicesClient.php +++ b/Compute/src/V1/Client/BackendServicesClient.php @@ -62,22 +62,22 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addSignedUrlKeyAsync(AddSignedUrlKeyBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregatedListAsync(AggregatedListBackendServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHealthAsync(GetHealthBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListBackendServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUsableAsync(ListUsableBackendServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface addSignedUrlKeyAsync(AddSignedUrlKeyBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListBackendServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHealthAsync(GetHealthBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListBackendServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUsableAsync(ListUsableBackendServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateBackendServiceRequest $request, array $optionalArgs = []) */ final class BackendServicesClient { @@ -480,7 +480,7 @@ public function list(ListBackendServicesRequest $request, array $callOptions = [ } /** - * Retrieves an aggregated list of all usable backend services in the specified project. + * Retrieves a list of all usable backend services in the specified project. * * The async variant is {@see BackendServicesClient::listUsableAsync()} . * diff --git a/Compute/src/V1/Client/DiskTypesClient.php b/Compute/src/V1/Client/DiskTypesClient.php index 18d2c0299e90..809e1bd8843c 100644 --- a/Compute/src/V1/Client/DiskTypesClient.php +++ b/Compute/src/V1/Client/DiskTypesClient.php @@ -44,9 +44,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListDiskTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetDiskTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListDiskTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListDiskTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetDiskTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListDiskTypesRequest $request, array $optionalArgs = []) */ final class DiskTypesClient { diff --git a/Compute/src/V1/Client/DisksClient.php b/Compute/src/V1/Client/DisksClient.php index 079515d22a10..fbd72157b863 100644 --- a/Compute/src/V1/Client/DisksClient.php +++ b/Compute/src/V1/Client/DisksClient.php @@ -63,24 +63,24 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addResourcePoliciesAsync(AddResourcePoliciesDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregatedListAsync(AggregatedListDisksRequest $request, array $optionalArgs = []) - * @method PromiseInterface bulkInsertAsync(BulkInsertDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSnapshotAsync(CreateSnapshotDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListDisksRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeResourcePoliciesAsync(RemoveResourcePoliciesDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface resizeAsync(ResizeDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface startAsyncReplicationAsync(StartAsyncReplicationDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopAsyncReplicationAsync(StopAsyncReplicationDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopGroupAsyncReplicationAsync(StopGroupAsyncReplicationDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface addResourcePoliciesAsync(AddResourcePoliciesDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListDisksRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkInsertAsync(BulkInsertDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSnapshotAsync(CreateSnapshotDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListDisksRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeResourcePoliciesAsync(RemoveResourcePoliciesDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface resizeAsync(ResizeDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface startAsyncReplicationAsync(StartAsyncReplicationDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopAsyncReplicationAsync(StopAsyncReplicationDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopGroupAsyncReplicationAsync(StopGroupAsyncReplicationDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateDiskRequest $request, array $optionalArgs = []) */ final class DisksClient { diff --git a/Compute/src/V1/Client/ExternalVpnGatewaysClient.php b/Compute/src/V1/Client/ExternalVpnGatewaysClient.php index f018d02312fe..c79c99f1102c 100644 --- a/Compute/src/V1/Client/ExternalVpnGatewaysClient.php +++ b/Compute/src/V1/Client/ExternalVpnGatewaysClient.php @@ -50,12 +50,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteExternalVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetExternalVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertExternalVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListExternalVpnGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsExternalVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsExternalVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteExternalVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetExternalVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertExternalVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListExternalVpnGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsExternalVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsExternalVpnGatewayRequest $request, array $optionalArgs = []) */ final class ExternalVpnGatewaysClient { diff --git a/Compute/src/V1/Client/FirewallPoliciesClient.php b/Compute/src/V1/Client/FirewallPoliciesClient.php index 3b2181313b2f..b0da655911f9 100644 --- a/Compute/src/V1/Client/FirewallPoliciesClient.php +++ b/Compute/src/V1/Client/FirewallPoliciesClient.php @@ -66,24 +66,24 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addAssociationAsync(AddAssociationFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface addRuleAsync(AddRuleFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface cloneRulesAsync(CloneRulesFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAssociationAsync(GetAssociationFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuleAsync(GetRuleFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListFirewallPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAssociationsAsync(ListAssociationsFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveAsync(MoveFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchRuleAsync(PatchRuleFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeAssociationAsync(RemoveAssociationFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeRuleAsync(RemoveRuleFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addAssociationAsync(AddAssociationFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addRuleAsync(AddRuleFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface cloneRulesAsync(CloneRulesFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAssociationAsync(GetAssociationFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuleAsync(GetRuleFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListFirewallPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAssociationsAsync(ListAssociationsFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveAsync(MoveFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchRuleAsync(PatchRuleFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeAssociationAsync(RemoveAssociationFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeRuleAsync(RemoveRuleFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsFirewallPolicyRequest $request, array $optionalArgs = []) */ final class FirewallPoliciesClient { diff --git a/Compute/src/V1/Client/FirewallsClient.php b/Compute/src/V1/Client/FirewallsClient.php index 7aa437492d68..e329d97a3fe0 100644 --- a/Compute/src/V1/Client/FirewallsClient.php +++ b/Compute/src/V1/Client/FirewallsClient.php @@ -49,12 +49,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteFirewallRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetFirewallRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertFirewallRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListFirewallsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchFirewallRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateFirewallRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteFirewallRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetFirewallRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertFirewallRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListFirewallsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchFirewallRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateFirewallRequest $request, array $optionalArgs = []) */ final class FirewallsClient { diff --git a/Compute/src/V1/Client/ForwardingRulesClient.php b/Compute/src/V1/Client/ForwardingRulesClient.php index 8a8eee0ab094..0e3b5ec4a759 100644 --- a/Compute/src/V1/Client/ForwardingRulesClient.php +++ b/Compute/src/V1/Client/ForwardingRulesClient.php @@ -51,14 +51,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListForwardingRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListForwardingRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface setTargetAsync(SetTargetForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListForwardingRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListForwardingRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface setTargetAsync(SetTargetForwardingRuleRequest $request, array $optionalArgs = []) */ final class ForwardingRulesClient { diff --git a/Compute/src/V1/Client/GlobalAddressesClient.php b/Compute/src/V1/Client/GlobalAddressesClient.php index 5d82e1b1ded7..f2fc0e79bace 100644 --- a/Compute/src/V1/Client/GlobalAddressesClient.php +++ b/Compute/src/V1/Client/GlobalAddressesClient.php @@ -49,12 +49,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteGlobalAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetGlobalAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertGlobalAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListGlobalAddressesRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveAsync(MoveGlobalAddressRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsGlobalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteGlobalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface
getAsync(GetGlobalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertGlobalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListGlobalAddressesRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveAsync(MoveGlobalAddressRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsGlobalAddressRequest $request, array $optionalArgs = []) */ final class GlobalAddressesClient { diff --git a/Compute/src/V1/Client/GlobalForwardingRulesClient.php b/Compute/src/V1/Client/GlobalForwardingRulesClient.php index 0b3d6c051a7b..c3d7e3e1694f 100644 --- a/Compute/src/V1/Client/GlobalForwardingRulesClient.php +++ b/Compute/src/V1/Client/GlobalForwardingRulesClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteGlobalForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetGlobalForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertGlobalForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListGlobalForwardingRulesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchGlobalForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsGlobalForwardingRuleRequest $request, array $optionalArgs = []) - * @method PromiseInterface setTargetAsync(SetTargetGlobalForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteGlobalForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetGlobalForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertGlobalForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListGlobalForwardingRulesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchGlobalForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsGlobalForwardingRuleRequest $request, array $optionalArgs = []) + * @method PromiseInterface setTargetAsync(SetTargetGlobalForwardingRuleRequest $request, array $optionalArgs = []) */ final class GlobalForwardingRulesClient { diff --git a/Compute/src/V1/Client/GlobalNetworkEndpointGroupsClient.php b/Compute/src/V1/Client/GlobalNetworkEndpointGroupsClient.php index bf45142b9de7..1d4c5922a5a2 100644 --- a/Compute/src/V1/Client/GlobalNetworkEndpointGroupsClient.php +++ b/Compute/src/V1/Client/GlobalNetworkEndpointGroupsClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface attachNetworkEndpointsAsync(AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface detachNetworkEndpointsAsync(DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListGlobalNetworkEndpointGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworkEndpointsAsync(ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface attachNetworkEndpointsAsync(AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface detachNetworkEndpointsAsync(DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertGlobalNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListGlobalNetworkEndpointGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworkEndpointsAsync(ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest $request, array $optionalArgs = []) */ final class GlobalNetworkEndpointGroupsClient { diff --git a/Compute/src/V1/Client/GlobalOperationsClient.php b/Compute/src/V1/Client/GlobalOperationsClient.php index 0093b203ae83..c65bd799d793 100644 --- a/Compute/src/V1/Client/GlobalOperationsClient.php +++ b/Compute/src/V1/Client/GlobalOperationsClient.php @@ -47,11 +47,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListGlobalOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteGlobalOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetGlobalOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListGlobalOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface waitAsync(WaitGlobalOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListGlobalOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteGlobalOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetGlobalOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListGlobalOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface waitAsync(WaitGlobalOperationRequest $request, array $optionalArgs = []) */ final class GlobalOperationsClient { diff --git a/Compute/src/V1/Client/GlobalOrganizationOperationsClient.php b/Compute/src/V1/Client/GlobalOrganizationOperationsClient.php index 43e410c3220c..791738e5f0c9 100644 --- a/Compute/src/V1/Client/GlobalOrganizationOperationsClient.php +++ b/Compute/src/V1/Client/GlobalOrganizationOperationsClient.php @@ -45,9 +45,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteGlobalOrganizationOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetGlobalOrganizationOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListGlobalOrganizationOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteGlobalOrganizationOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetGlobalOrganizationOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListGlobalOrganizationOperationsRequest $request, array $optionalArgs = []) */ final class GlobalOrganizationOperationsClient { diff --git a/Compute/src/V1/Client/GlobalPublicDelegatedPrefixesClient.php b/Compute/src/V1/Client/GlobalPublicDelegatedPrefixesClient.php index 4c4a7f51a953..c0b485e86eb4 100644 --- a/Compute/src/V1/Client/GlobalPublicDelegatedPrefixesClient.php +++ b/Compute/src/V1/Client/GlobalPublicDelegatedPrefixesClient.php @@ -48,11 +48,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteGlobalPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetGlobalPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertGlobalPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListGlobalPublicDelegatedPrefixesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchGlobalPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteGlobalPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetGlobalPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertGlobalPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListGlobalPublicDelegatedPrefixesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchGlobalPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) */ final class GlobalPublicDelegatedPrefixesClient { diff --git a/Compute/src/V1/Client/HealthChecksClient.php b/Compute/src/V1/Client/HealthChecksClient.php index 922be56acc3e..da04d3351eec 100644 --- a/Compute/src/V1/Client/HealthChecksClient.php +++ b/Compute/src/V1/Client/HealthChecksClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListHealthChecksRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteHealthCheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetHealthCheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertHealthCheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListHealthChecksRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchHealthCheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListHealthChecksRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListHealthChecksRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateHealthCheckRequest $request, array $optionalArgs = []) */ final class HealthChecksClient { diff --git a/Compute/src/V1/Client/ImageFamilyViewsClient.php b/Compute/src/V1/Client/ImageFamilyViewsClient.php index 19430ed31531..7e9138f198cf 100644 --- a/Compute/src/V1/Client/ImageFamilyViewsClient.php +++ b/Compute/src/V1/Client/ImageFamilyViewsClient.php @@ -41,7 +41,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetImageFamilyViewRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetImageFamilyViewRequest $request, array $optionalArgs = []) */ final class ImageFamilyViewsClient { diff --git a/Compute/src/V1/Client/ImagesClient.php b/Compute/src/V1/Client/ImagesClient.php index 0185978c85c1..dbf6626d9f9a 100644 --- a/Compute/src/V1/Client/ImagesClient.php +++ b/Compute/src/V1/Client/ImagesClient.php @@ -56,17 +56,17 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface deprecateAsync(DeprecateImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getFromFamilyAsync(GetFromFamilyImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListImagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface deprecateAsync(DeprecateImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getFromFamilyAsync(GetFromFamilyImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListImagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsImageRequest $request, array $optionalArgs = []) */ final class ImagesClient { diff --git a/Compute/src/V1/Client/InstanceGroupManagerResizeRequestsClient.php b/Compute/src/V1/Client/InstanceGroupManagerResizeRequestsClient.php index a9a0cd25131c..5767addf6403 100644 --- a/Compute/src/V1/Client/InstanceGroupManagerResizeRequestsClient.php +++ b/Compute/src/V1/Client/InstanceGroupManagerResizeRequestsClient.php @@ -48,11 +48,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface cancelAsync(CancelInstanceGroupManagerResizeRequestRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteInstanceGroupManagerResizeRequestRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetInstanceGroupManagerResizeRequestRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertInstanceGroupManagerResizeRequestRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInstanceGroupManagerResizeRequestsRequest $request, array $optionalArgs = []) + * @method PromiseInterface cancelAsync(CancelInstanceGroupManagerResizeRequestRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteInstanceGroupManagerResizeRequestRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInstanceGroupManagerResizeRequestRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertInstanceGroupManagerResizeRequestRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInstanceGroupManagerResizeRequestsRequest $request, array $optionalArgs = []) */ final class InstanceGroupManagerResizeRequestsClient { diff --git a/Compute/src/V1/Client/InstanceGroupManagersClient.php b/Compute/src/V1/Client/InstanceGroupManagersClient.php index 3bc618a75b98..c458cbc86fe1 100644 --- a/Compute/src/V1/Client/InstanceGroupManagersClient.php +++ b/Compute/src/V1/Client/InstanceGroupManagersClient.php @@ -63,26 +63,26 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface abandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregatedListAsync(AggregatedListInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface applyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstancesAsync(CreateInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listErrorsAsync(ListErrorsInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listManagedInstancesAsync(ListManagedInstancesInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPerInstanceConfigsAsync(ListPerInstanceConfigsInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface recreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface resizeAsync(ResizeInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface setInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface setTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface abandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface applyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstancesAsync(CreateInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listErrorsAsync(ListErrorsInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listManagedInstancesAsync(ListManagedInstancesInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPerInstanceConfigsAsync(ListPerInstanceConfigsInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface recreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface resizeAsync(ResizeInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface setInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface setTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest $request, array $optionalArgs = []) */ final class InstanceGroupManagersClient { diff --git a/Compute/src/V1/Client/InstanceGroupsClient.php b/Compute/src/V1/Client/InstanceGroupsClient.php index b625b1f2a05d..e410e538ed90 100644 --- a/Compute/src/V1/Client/InstanceGroupsClient.php +++ b/Compute/src/V1/Client/InstanceGroupsClient.php @@ -52,15 +52,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addInstancesAsync(AddInstancesInstanceGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregatedListAsync(AggregatedListInstanceGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteInstanceGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetInstanceGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertInstanceGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInstanceGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesInstanceGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeInstancesAsync(RemoveInstancesInstanceGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface setNamedPortsAsync(SetNamedPortsInstanceGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface addInstancesAsync(AddInstancesInstanceGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListInstanceGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteInstanceGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInstanceGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertInstanceGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInstanceGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesInstanceGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeInstancesAsync(RemoveInstancesInstanceGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface setNamedPortsAsync(SetNamedPortsInstanceGroupRequest $request, array $optionalArgs = []) */ final class InstanceGroupsClient { diff --git a/Compute/src/V1/Client/InstanceSettingsServiceClient.php b/Compute/src/V1/Client/InstanceSettingsServiceClient.php index 0d37239ad68e..fe3e8ccd869a 100644 --- a/Compute/src/V1/Client/InstanceSettingsServiceClient.php +++ b/Compute/src/V1/Client/InstanceSettingsServiceClient.php @@ -44,8 +44,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetInstanceSettingRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchInstanceSettingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInstanceSettingRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchInstanceSettingRequest $request, array $optionalArgs = []) */ final class InstanceSettingsServiceClient { diff --git a/Compute/src/V1/Client/InstanceTemplatesClient.php b/Compute/src/V1/Client/InstanceTemplatesClient.php index ac0ef31754a5..fda867d9b4db 100644 --- a/Compute/src/V1/Client/InstanceTemplatesClient.php +++ b/Compute/src/V1/Client/InstanceTemplatesClient.php @@ -53,14 +53,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListInstanceTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteInstanceTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetInstanceTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyInstanceTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertInstanceTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInstanceTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyInstanceTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListInstanceTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInstanceTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsInstanceTemplateRequest $request, array $optionalArgs = []) */ final class InstanceTemplatesClient { diff --git a/Compute/src/V1/Client/InstancesClient.php b/Compute/src/V1/Client/InstancesClient.php index 0b4536062c9b..b586e4959118 100644 --- a/Compute/src/V1/Client/InstancesClient.php +++ b/Compute/src/V1/Client/InstancesClient.php @@ -99,54 +99,54 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addAccessConfigAsync(AddAccessConfigInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface addResourcePoliciesAsync(AddResourcePoliciesInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregatedListAsync(AggregatedListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface attachDiskAsync(AttachDiskInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface bulkInsertAsync(BulkInsertInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAccessConfigAsync(DeleteAccessConfigInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface detachDiskAsync(DetachDiskInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEffectiveFirewallsAsync(GetEffectiveFirewallsInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getGuestAttributesAsync(GetGuestAttributesInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getScreenshotAsync(GetScreenshotInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getSerialPortOutputAsync(GetSerialPortOutputInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getShieldedInstanceIdentityAsync(GetShieldedInstanceIdentityInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listReferrersAsync(ListReferrersInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface performMaintenanceAsync(PerformMaintenanceInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeResourcePoliciesAsync(RemoveResourcePoliciesInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface resetAsync(ResetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface resumeAsync(ResumeInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface sendDiagnosticInterruptAsync(SendDiagnosticInterruptInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setDeletionProtectionAsync(SetDeletionProtectionInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setDiskAutoDeleteAsync(SetDiskAutoDeleteInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMachineResourcesAsync(SetMachineResourcesInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMachineTypeAsync(SetMachineTypeInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMetadataAsync(SetMetadataInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setMinCpuPlatformAsync(SetMinCpuPlatformInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setNameAsync(SetNameInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSchedulingAsync(SetSchedulingInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setServiceAccountAsync(SetServiceAccountInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setShieldedInstanceIntegrityPolicyAsync(SetShieldedInstanceIntegrityPolicyInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setTagsAsync(SetTagsInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface simulateMaintenanceEventAsync(SimulateMaintenanceEventInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface startAsync(StartInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface startWithEncryptionKeyAsync(StartWithEncryptionKeyInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopAsync(StopInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface suspendAsync(SuspendInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAccessConfigAsync(UpdateAccessConfigInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateDisplayDeviceAsync(UpdateDisplayDeviceInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateNetworkInterfaceAsync(UpdateNetworkInterfaceInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface addAccessConfigAsync(AddAccessConfigInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface addResourcePoliciesAsync(AddResourcePoliciesInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface attachDiskAsync(AttachDiskInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkInsertAsync(BulkInsertInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAccessConfigAsync(DeleteAccessConfigInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface detachDiskAsync(DetachDiskInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEffectiveFirewallsAsync(GetEffectiveFirewallsInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getGuestAttributesAsync(GetGuestAttributesInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getScreenshotAsync(GetScreenshotInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getSerialPortOutputAsync(GetSerialPortOutputInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getShieldedInstanceIdentityAsync(GetShieldedInstanceIdentityInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listReferrersAsync(ListReferrersInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface performMaintenanceAsync(PerformMaintenanceInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeResourcePoliciesAsync(RemoveResourcePoliciesInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface resetAsync(ResetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface resumeAsync(ResumeInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface sendDiagnosticInterruptAsync(SendDiagnosticInterruptInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setDeletionProtectionAsync(SetDeletionProtectionInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setDiskAutoDeleteAsync(SetDiskAutoDeleteInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMachineResourcesAsync(SetMachineResourcesInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMachineTypeAsync(SetMachineTypeInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMetadataAsync(SetMetadataInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setMinCpuPlatformAsync(SetMinCpuPlatformInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setNameAsync(SetNameInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSchedulingAsync(SetSchedulingInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setServiceAccountAsync(SetServiceAccountInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setShieldedInstanceIntegrityPolicyAsync(SetShieldedInstanceIntegrityPolicyInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setTagsAsync(SetTagsInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface simulateMaintenanceEventAsync(SimulateMaintenanceEventInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface startAsync(StartInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface startWithEncryptionKeyAsync(StartWithEncryptionKeyInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopAsync(StopInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface suspendAsync(SuspendInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAccessConfigAsync(UpdateAccessConfigInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateDisplayDeviceAsync(UpdateDisplayDeviceInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateNetworkInterfaceAsync(UpdateNetworkInterfaceInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigInstanceRequest $request, array $optionalArgs = []) */ final class InstancesClient { diff --git a/Compute/src/V1/Client/InstantSnapshotsClient.php b/Compute/src/V1/Client/InstantSnapshotsClient.php index d7f8080a02e7..b9ad51179ff6 100644 --- a/Compute/src/V1/Client/InstantSnapshotsClient.php +++ b/Compute/src/V1/Client/InstantSnapshotsClient.php @@ -54,15 +54,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListInstantSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInstantSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListInstantSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInstantSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsInstantSnapshotRequest $request, array $optionalArgs = []) */ final class InstantSnapshotsClient { diff --git a/Compute/src/V1/Client/InterconnectAttachmentsClient.php b/Compute/src/V1/Client/InterconnectAttachmentsClient.php index 9e74a892491b..78c03cf449e0 100644 --- a/Compute/src/V1/Client/InterconnectAttachmentsClient.php +++ b/Compute/src/V1/Client/InterconnectAttachmentsClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListInterconnectAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteInterconnectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetInterconnectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertInterconnectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInterconnectAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchInterconnectAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsInterconnectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListInterconnectAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteInterconnectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInterconnectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertInterconnectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInterconnectAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchInterconnectAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsInterconnectAttachmentRequest $request, array $optionalArgs = []) */ final class InterconnectAttachmentsClient { diff --git a/Compute/src/V1/Client/InterconnectLocationsClient.php b/Compute/src/V1/Client/InterconnectLocationsClient.php index 88af4f7b1b08..279ca2725b30 100644 --- a/Compute/src/V1/Client/InterconnectLocationsClient.php +++ b/Compute/src/V1/Client/InterconnectLocationsClient.php @@ -43,8 +43,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetInterconnectLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInterconnectLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInterconnectLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInterconnectLocationsRequest $request, array $optionalArgs = []) */ final class InterconnectLocationsClient { diff --git a/Compute/src/V1/Client/InterconnectRemoteLocationsClient.php b/Compute/src/V1/Client/InterconnectRemoteLocationsClient.php index f08b0facc2df..897b517a1aa2 100644 --- a/Compute/src/V1/Client/InterconnectRemoteLocationsClient.php +++ b/Compute/src/V1/Client/InterconnectRemoteLocationsClient.php @@ -43,8 +43,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetInterconnectRemoteLocationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInterconnectRemoteLocationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInterconnectRemoteLocationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInterconnectRemoteLocationsRequest $request, array $optionalArgs = []) */ final class InterconnectRemoteLocationsClient { diff --git a/Compute/src/V1/Client/InterconnectsClient.php b/Compute/src/V1/Client/InterconnectsClient.php index 8242fd8c963a..ee3015031274 100644 --- a/Compute/src/V1/Client/InterconnectsClient.php +++ b/Compute/src/V1/Client/InterconnectsClient.php @@ -53,14 +53,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteInterconnectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetInterconnectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getDiagnosticsAsync(GetDiagnosticsInterconnectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getMacsecConfigAsync(GetMacsecConfigInterconnectRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertInterconnectRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListInterconnectsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchInterconnectRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getDiagnosticsAsync(GetDiagnosticsInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMacsecConfigAsync(GetMacsecConfigInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListInterconnectsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchInterconnectRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsInterconnectRequest $request, array $optionalArgs = []) */ final class InterconnectsClient { diff --git a/Compute/src/V1/Client/LicenseCodesClient.php b/Compute/src/V1/Client/LicenseCodesClient.php index 5528f944bee8..49e2c2e758d5 100644 --- a/Compute/src/V1/Client/LicenseCodesClient.php +++ b/Compute/src/V1/Client/LicenseCodesClient.php @@ -43,8 +43,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetLicenseCodeRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsLicenseCodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetLicenseCodeRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsLicenseCodeRequest $request, array $optionalArgs = []) */ final class LicenseCodesClient { diff --git a/Compute/src/V1/Client/LicensesClient.php b/Compute/src/V1/Client/LicensesClient.php index 3c1f0b40d082..40814a6fde4a 100644 --- a/Compute/src/V1/Client/LicensesClient.php +++ b/Compute/src/V1/Client/LicensesClient.php @@ -52,13 +52,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteLicenseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetLicenseRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyLicenseRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertLicenseRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListLicensesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyLicenseRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsLicenseRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteLicenseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetLicenseRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyLicenseRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertLicenseRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListLicensesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyLicenseRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsLicenseRequest $request, array $optionalArgs = []) */ final class LicensesClient { diff --git a/Compute/src/V1/Client/MachineImagesClient.php b/Compute/src/V1/Client/MachineImagesClient.php index 98483ad18ed2..e86c366fa86a 100644 --- a/Compute/src/V1/Client/MachineImagesClient.php +++ b/Compute/src/V1/Client/MachineImagesClient.php @@ -52,13 +52,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteMachineImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetMachineImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyMachineImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertMachineImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListMachineImagesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyMachineImageRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsMachineImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteMachineImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetMachineImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyMachineImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertMachineImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListMachineImagesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyMachineImageRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsMachineImageRequest $request, array $optionalArgs = []) */ final class MachineImagesClient { diff --git a/Compute/src/V1/Client/MachineTypesClient.php b/Compute/src/V1/Client/MachineTypesClient.php index 170704115b34..056360630a3f 100644 --- a/Compute/src/V1/Client/MachineTypesClient.php +++ b/Compute/src/V1/Client/MachineTypesClient.php @@ -44,9 +44,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListMachineTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetMachineTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListMachineTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListMachineTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetMachineTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListMachineTypesRequest $request, array $optionalArgs = []) */ final class MachineTypesClient { diff --git a/Compute/src/V1/Client/NetworkAttachmentsClient.php b/Compute/src/V1/Client/NetworkAttachmentsClient.php index f1c0b2dc866a..cde656105c11 100644 --- a/Compute/src/V1/Client/NetworkAttachmentsClient.php +++ b/Compute/src/V1/Client/NetworkAttachmentsClient.php @@ -54,15 +54,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListNetworkAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteNetworkAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetNetworkAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyNetworkAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertNetworkAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListNetworkAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchNetworkAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyNetworkAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNetworkAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListNetworkAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteNetworkAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetNetworkAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyNetworkAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertNetworkAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListNetworkAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchNetworkAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyNetworkAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNetworkAttachmentRequest $request, array $optionalArgs = []) */ final class NetworkAttachmentsClient { diff --git a/Compute/src/V1/Client/NetworkEdgeSecurityServicesClient.php b/Compute/src/V1/Client/NetworkEdgeSecurityServicesClient.php index a4ec845ffe51..ddeeea779656 100644 --- a/Compute/src/V1/Client/NetworkEdgeSecurityServicesClient.php +++ b/Compute/src/V1/Client/NetworkEdgeSecurityServicesClient.php @@ -48,11 +48,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListNetworkEdgeSecurityServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteNetworkEdgeSecurityServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetNetworkEdgeSecurityServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertNetworkEdgeSecurityServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchNetworkEdgeSecurityServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListNetworkEdgeSecurityServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteNetworkEdgeSecurityServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetNetworkEdgeSecurityServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertNetworkEdgeSecurityServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchNetworkEdgeSecurityServiceRequest $request, array $optionalArgs = []) */ final class NetworkEdgeSecurityServicesClient { diff --git a/Compute/src/V1/Client/NetworkEndpointGroupsClient.php b/Compute/src/V1/Client/NetworkEndpointGroupsClient.php index d7021b16e707..458b2c4ed9cc 100644 --- a/Compute/src/V1/Client/NetworkEndpointGroupsClient.php +++ b/Compute/src/V1/Client/NetworkEndpointGroupsClient.php @@ -53,15 +53,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListNetworkEndpointGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface attachNetworkEndpointsAsync(AttachNetworkEndpointsNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface detachNetworkEndpointsAsync(DetachNetworkEndpointsNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListNetworkEndpointGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworkEndpointsAsync(ListNetworkEndpointsNetworkEndpointGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListNetworkEndpointGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface attachNetworkEndpointsAsync(AttachNetworkEndpointsNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface detachNetworkEndpointsAsync(DetachNetworkEndpointsNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListNetworkEndpointGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworkEndpointsAsync(ListNetworkEndpointsNetworkEndpointGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNetworkEndpointGroupRequest $request, array $optionalArgs = []) */ final class NetworkEndpointGroupsClient { diff --git a/Compute/src/V1/Client/NetworkFirewallPoliciesClient.php b/Compute/src/V1/Client/NetworkFirewallPoliciesClient.php index 5191530d1e96..7d808bae4143 100644 --- a/Compute/src/V1/Client/NetworkFirewallPoliciesClient.php +++ b/Compute/src/V1/Client/NetworkFirewallPoliciesClient.php @@ -63,22 +63,22 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addAssociationAsync(AddAssociationNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface addRuleAsync(AddRuleNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface cloneRulesAsync(CloneRulesNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAssociationAsync(GetAssociationNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuleAsync(GetRuleNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListNetworkFirewallPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchRuleAsync(PatchRuleNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeAssociationAsync(RemoveAssociationNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeRuleAsync(RemoveRuleNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addAssociationAsync(AddAssociationNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addRuleAsync(AddRuleNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface cloneRulesAsync(CloneRulesNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAssociationAsync(GetAssociationNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuleAsync(GetRuleNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListNetworkFirewallPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchRuleAsync(PatchRuleNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeAssociationAsync(RemoveAssociationNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeRuleAsync(RemoveRuleNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNetworkFirewallPolicyRequest $request, array $optionalArgs = []) */ final class NetworkFirewallPoliciesClient { diff --git a/Compute/src/V1/Client/NetworksClient.php b/Compute/src/V1/Client/NetworksClient.php index 274b2d9c3f28..36f047fc61d8 100644 --- a/Compute/src/V1/Client/NetworksClient.php +++ b/Compute/src/V1/Client/NetworksClient.php @@ -55,17 +55,17 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addPeeringAsync(AddPeeringNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEffectiveFirewallsAsync(GetEffectiveFirewallsNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListNetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPeeringRoutesAsync(ListPeeringRoutesNetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface removePeeringAsync(RemovePeeringNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface switchToCustomModeAsync(SwitchToCustomModeNetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePeeringAsync(UpdatePeeringNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface addPeeringAsync(AddPeeringNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEffectiveFirewallsAsync(GetEffectiveFirewallsNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListNetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPeeringRoutesAsync(ListPeeringRoutesNetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface removePeeringAsync(RemovePeeringNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface switchToCustomModeAsync(SwitchToCustomModeNetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePeeringAsync(UpdatePeeringNetworkRequest $request, array $optionalArgs = []) */ final class NetworksClient { @@ -420,7 +420,7 @@ public function listPeeringRoutes(ListPeeringRoutesNetworksRequest $request, arr } /** - * Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. + * Patches the specified network with the data included in the request. Only routingConfig can be modified. * * The async variant is {@see NetworksClient::patchAsync()} . * diff --git a/Compute/src/V1/Client/NodeGroupsClient.php b/Compute/src/V1/Client/NodeGroupsClient.php index 0cb2d5e8c1c8..f40ca2c19310 100644 --- a/Compute/src/V1/Client/NodeGroupsClient.php +++ b/Compute/src/V1/Client/NodeGroupsClient.php @@ -60,21 +60,21 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addNodesAsync(AddNodesNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregatedListAsync(AggregatedListNodeGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteNodesAsync(DeleteNodesNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListNodeGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNodesAsync(ListNodesNodeGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface performMaintenanceAsync(PerformMaintenanceNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface setNodeTemplateAsync(SetNodeTemplateNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface simulateMaintenanceEventAsync(SimulateMaintenanceEventNodeGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface addNodesAsync(AddNodesNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListNodeGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNodesAsync(DeleteNodesNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListNodeGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNodesAsync(ListNodesNodeGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface performMaintenanceAsync(PerformMaintenanceNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface setNodeTemplateAsync(SetNodeTemplateNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface simulateMaintenanceEventAsync(SimulateMaintenanceEventNodeGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNodeGroupRequest $request, array $optionalArgs = []) */ final class NodeGroupsClient { diff --git a/Compute/src/V1/Client/NodeTemplatesClient.php b/Compute/src/V1/Client/NodeTemplatesClient.php index a65c3352a865..7afb18530d54 100644 --- a/Compute/src/V1/Client/NodeTemplatesClient.php +++ b/Compute/src/V1/Client/NodeTemplatesClient.php @@ -53,14 +53,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListNodeTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteNodeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetNodeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyNodeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertNodeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListNodeTemplatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyNodeTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNodeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListNodeTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteNodeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetNodeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyNodeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertNodeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListNodeTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyNodeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsNodeTemplateRequest $request, array $optionalArgs = []) */ final class NodeTemplatesClient { diff --git a/Compute/src/V1/Client/NodeTypesClient.php b/Compute/src/V1/Client/NodeTypesClient.php index f8a501a1dbb0..446a3bd3c2d9 100644 --- a/Compute/src/V1/Client/NodeTypesClient.php +++ b/Compute/src/V1/Client/NodeTypesClient.php @@ -44,9 +44,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListNodeTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetNodeTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListNodeTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListNodeTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetNodeTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListNodeTypesRequest $request, array $optionalArgs = []) */ final class NodeTypesClient { diff --git a/Compute/src/V1/Client/PacketMirroringsClient.php b/Compute/src/V1/Client/PacketMirroringsClient.php index a81618df35d8..6c385f21864f 100644 --- a/Compute/src/V1/Client/PacketMirroringsClient.php +++ b/Compute/src/V1/Client/PacketMirroringsClient.php @@ -51,13 +51,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListPacketMirroringsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeletePacketMirroringRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetPacketMirroringRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertPacketMirroringRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListPacketMirroringsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchPacketMirroringRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsPacketMirroringRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListPacketMirroringsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeletePacketMirroringRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetPacketMirroringRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertPacketMirroringRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListPacketMirroringsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchPacketMirroringRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsPacketMirroringRequest $request, array $optionalArgs = []) */ final class PacketMirroringsClient { diff --git a/Compute/src/V1/Client/ProjectsClient.php b/Compute/src/V1/Client/ProjectsClient.php index 4c1f6e2bd00c..20e9ebf6b9eb 100644 --- a/Compute/src/V1/Client/ProjectsClient.php +++ b/Compute/src/V1/Client/ProjectsClient.php @@ -57,20 +57,20 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface disableXpnHostAsync(DisableXpnHostProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface disableXpnResourceAsync(DisableXpnResourceProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableXpnHostAsync(EnableXpnHostProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface enableXpnResourceAsync(EnableXpnResourceProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getXpnHostAsync(GetXpnHostProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface getXpnResourcesAsync(GetXpnResourcesProjectsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listXpnHostsAsync(ListXpnHostsProjectsRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveDiskAsync(MoveDiskProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface moveInstanceAsync(MoveInstanceProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface setCloudArmorTierAsync(SetCloudArmorTierProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface setCommonInstanceMetadataAsync(SetCommonInstanceMetadataProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface setDefaultNetworkTierAsync(SetDefaultNetworkTierProjectRequest $request, array $optionalArgs = []) - * @method PromiseInterface setUsageExportBucketAsync(SetUsageExportBucketProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableXpnHostAsync(DisableXpnHostProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface disableXpnResourceAsync(DisableXpnResourceProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableXpnHostAsync(EnableXpnHostProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface enableXpnResourceAsync(EnableXpnResourceProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getXpnHostAsync(GetXpnHostProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface getXpnResourcesAsync(GetXpnResourcesProjectsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listXpnHostsAsync(ListXpnHostsProjectsRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveDiskAsync(MoveDiskProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface moveInstanceAsync(MoveInstanceProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface setCloudArmorTierAsync(SetCloudArmorTierProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface setCommonInstanceMetadataAsync(SetCommonInstanceMetadataProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface setDefaultNetworkTierAsync(SetDefaultNetworkTierProjectRequest $request, array $optionalArgs = []) + * @method PromiseInterface setUsageExportBucketAsync(SetUsageExportBucketProjectRequest $request, array $optionalArgs = []) */ final class ProjectsClient { diff --git a/Compute/src/V1/Client/PublicAdvertisedPrefixesClient.php b/Compute/src/V1/Client/PublicAdvertisedPrefixesClient.php index fb96aae7016a..22d4ce334f67 100644 --- a/Compute/src/V1/Client/PublicAdvertisedPrefixesClient.php +++ b/Compute/src/V1/Client/PublicAdvertisedPrefixesClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface announceAsync(AnnouncePublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeletePublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetPublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertPublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListPublicAdvertisedPrefixesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchPublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface withdrawAsync(WithdrawPublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface announceAsync(AnnouncePublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeletePublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetPublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertPublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListPublicAdvertisedPrefixesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchPublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface withdrawAsync(WithdrawPublicAdvertisedPrefixeRequest $request, array $optionalArgs = []) */ final class PublicAdvertisedPrefixesClient { diff --git a/Compute/src/V1/Client/PublicDelegatedPrefixesClient.php b/Compute/src/V1/Client/PublicDelegatedPrefixesClient.php index 12c4cfa060e6..ff39d7612d6d 100644 --- a/Compute/src/V1/Client/PublicDelegatedPrefixesClient.php +++ b/Compute/src/V1/Client/PublicDelegatedPrefixesClient.php @@ -51,14 +51,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListPublicDelegatedPrefixesRequest $request, array $optionalArgs = []) - * @method PromiseInterface announceAsync(AnnouncePublicDelegatedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeletePublicDelegatedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListPublicDelegatedPrefixesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) - * @method PromiseInterface withdrawAsync(WithdrawPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListPublicDelegatedPrefixesRequest $request, array $optionalArgs = []) + * @method PromiseInterface announceAsync(AnnouncePublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeletePublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListPublicDelegatedPrefixesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) + * @method PromiseInterface withdrawAsync(WithdrawPublicDelegatedPrefixeRequest $request, array $optionalArgs = []) */ final class PublicDelegatedPrefixesClient { diff --git a/Compute/src/V1/Client/RegionAutoscalersClient.php b/Compute/src/V1/Client/RegionAutoscalersClient.php index 64aebe0ab1b0..63d72cf3a269 100644 --- a/Compute/src/V1/Client/RegionAutoscalersClient.php +++ b/Compute/src/V1/Client/RegionAutoscalersClient.php @@ -49,12 +49,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionAutoscalerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionAutoscalerRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionAutoscalerRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionAutoscalersRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionAutoscalerRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateRegionAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionAutoscalersRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionAutoscalerRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateRegionAutoscalerRequest $request, array $optionalArgs = []) */ final class RegionAutoscalersClient { diff --git a/Compute/src/V1/Client/RegionBackendServicesClient.php b/Compute/src/V1/Client/RegionBackendServicesClient.php index e829aa69a9e9..39b70150048c 100644 --- a/Compute/src/V1/Client/RegionBackendServicesClient.php +++ b/Compute/src/V1/Client/RegionBackendServicesClient.php @@ -58,18 +58,18 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHealthAsync(GetHealthRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionBackendServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUsableAsync(ListUsableRegionBackendServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRegionBackendServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHealthAsync(GetHealthRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionBackendServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUsableAsync(ListUsableRegionBackendServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRegionBackendServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateRegionBackendServiceRequest $request, array $optionalArgs = []) */ final class RegionBackendServicesClient { @@ -401,7 +401,7 @@ public function list(ListRegionBackendServicesRequest $request, array $callOptio } /** - * Retrieves an aggregated list of all usable backend services in the specified project in the given region. + * Retrieves a list of all usable backend services in the specified project in the given region. * * The async variant is {@see RegionBackendServicesClient::listUsableAsync()} . * diff --git a/Compute/src/V1/Client/RegionCommitmentsClient.php b/Compute/src/V1/Client/RegionCommitmentsClient.php index 41ec92c154fe..c7b33840271c 100644 --- a/Compute/src/V1/Client/RegionCommitmentsClient.php +++ b/Compute/src/V1/Client/RegionCommitmentsClient.php @@ -48,11 +48,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListRegionCommitmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionCommitmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionCommitmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionCommitmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateRegionCommitmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListRegionCommitmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionCommitmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionCommitmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionCommitmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateRegionCommitmentRequest $request, array $optionalArgs = []) */ final class RegionCommitmentsClient { diff --git a/Compute/src/V1/Client/RegionDiskTypesClient.php b/Compute/src/V1/Client/RegionDiskTypesClient.php index a2770e96ec02..a16feaf3fe42 100644 --- a/Compute/src/V1/Client/RegionDiskTypesClient.php +++ b/Compute/src/V1/Client/RegionDiskTypesClient.php @@ -43,8 +43,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetRegionDiskTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionDiskTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionDiskTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionDiskTypesRequest $request, array $optionalArgs = []) */ final class RegionDiskTypesClient { diff --git a/Compute/src/V1/Client/RegionDisksClient.php b/Compute/src/V1/Client/RegionDisksClient.php index b7507dc2b688..91944f30ff61 100644 --- a/Compute/src/V1/Client/RegionDisksClient.php +++ b/Compute/src/V1/Client/RegionDisksClient.php @@ -62,23 +62,23 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addResourcePoliciesAsync(AddResourcePoliciesRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface bulkInsertAsync(BulkInsertRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface createSnapshotAsync(CreateSnapshotRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionDisksRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeResourcePoliciesAsync(RemoveResourcePoliciesRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface resizeAsync(ResizeRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface startAsyncReplicationAsync(StartAsyncReplicationRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopAsyncReplicationAsync(StopAsyncReplicationRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface stopGroupAsyncReplicationAsync(StopGroupAsyncReplicationRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRegionDiskRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface addResourcePoliciesAsync(AddResourcePoliciesRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkInsertAsync(BulkInsertRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface createSnapshotAsync(CreateSnapshotRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionDisksRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeResourcePoliciesAsync(RemoveResourcePoliciesRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface resizeAsync(ResizeRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface startAsyncReplicationAsync(StartAsyncReplicationRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopAsyncReplicationAsync(StopAsyncReplicationRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface stopGroupAsyncReplicationAsync(StopGroupAsyncReplicationRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRegionDiskRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateRegionDiskRequest $request, array $optionalArgs = []) */ final class RegionDisksClient { diff --git a/Compute/src/V1/Client/RegionHealthCheckServicesClient.php b/Compute/src/V1/Client/RegionHealthCheckServicesClient.php index 8ae34ddefb72..d800d8671aca 100644 --- a/Compute/src/V1/Client/RegionHealthCheckServicesClient.php +++ b/Compute/src/V1/Client/RegionHealthCheckServicesClient.php @@ -48,11 +48,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionHealthCheckServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionHealthCheckServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionHealthCheckServiceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionHealthCheckServicesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionHealthCheckServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionHealthCheckServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionHealthCheckServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionHealthCheckServiceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionHealthCheckServicesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionHealthCheckServiceRequest $request, array $optionalArgs = []) */ final class RegionHealthCheckServicesClient { diff --git a/Compute/src/V1/Client/RegionHealthChecksClient.php b/Compute/src/V1/Client/RegionHealthChecksClient.php index 9e34718e9249..2e5e2957f300 100644 --- a/Compute/src/V1/Client/RegionHealthChecksClient.php +++ b/Compute/src/V1/Client/RegionHealthChecksClient.php @@ -49,12 +49,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionHealthCheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionHealthCheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionHealthCheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionHealthChecksRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionHealthCheckRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateRegionHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionHealthChecksRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionHealthCheckRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateRegionHealthCheckRequest $request, array $optionalArgs = []) */ final class RegionHealthChecksClient { diff --git a/Compute/src/V1/Client/RegionInstanceGroupManagersClient.php b/Compute/src/V1/Client/RegionInstanceGroupManagersClient.php index e58d4a4457ee..f9a189dc8ef5 100644 --- a/Compute/src/V1/Client/RegionInstanceGroupManagersClient.php +++ b/Compute/src/V1/Client/RegionInstanceGroupManagersClient.php @@ -62,25 +62,25 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface abandonInstancesAsync(AbandonInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface applyUpdatesToInstancesAsync(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface createInstancesAsync(CreateInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteInstancesAsync(DeleteInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface deletePerInstanceConfigsAsync(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listErrorsAsync(ListErrorsRegionInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listManagedInstancesAsync(ListManagedInstancesRegionInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPerInstanceConfigsAsync(ListPerInstanceConfigsRegionInstanceGroupManagersRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchPerInstanceConfigsAsync(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface recreateInstancesAsync(RecreateInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface resizeAsync(ResizeRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface setInstanceTemplateAsync(SetInstanceTemplateRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface setTargetPoolsAsync(SetTargetPoolsRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) - * @method PromiseInterface updatePerInstanceConfigsAsync(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface abandonInstancesAsync(AbandonInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface applyUpdatesToInstancesAsync(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface createInstancesAsync(CreateInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteInstancesAsync(DeleteInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface deletePerInstanceConfigsAsync(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listErrorsAsync(ListErrorsRegionInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listManagedInstancesAsync(ListManagedInstancesRegionInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPerInstanceConfigsAsync(ListPerInstanceConfigsRegionInstanceGroupManagersRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchPerInstanceConfigsAsync(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface recreateInstancesAsync(RecreateInstancesRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface resizeAsync(ResizeRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface setInstanceTemplateAsync(SetInstanceTemplateRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface setTargetPoolsAsync(SetTargetPoolsRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) + * @method PromiseInterface updatePerInstanceConfigsAsync(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest $request, array $optionalArgs = []) */ final class RegionInstanceGroupManagersClient { diff --git a/Compute/src/V1/Client/RegionInstanceGroupsClient.php b/Compute/src/V1/Client/RegionInstanceGroupsClient.php index b370cb6cd540..1461eab9738d 100644 --- a/Compute/src/V1/Client/RegionInstanceGroupsClient.php +++ b/Compute/src/V1/Client/RegionInstanceGroupsClient.php @@ -47,10 +47,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetRegionInstanceGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionInstanceGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listInstancesAsync(ListInstancesRegionInstanceGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionInstanceGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionInstanceGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listInstancesAsync(ListInstancesRegionInstanceGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest $request, array $optionalArgs = []) */ final class RegionInstanceGroupsClient { diff --git a/Compute/src/V1/Client/RegionInstanceTemplatesClient.php b/Compute/src/V1/Client/RegionInstanceTemplatesClient.php index 15a1e23cabba..b39df549f8b2 100644 --- a/Compute/src/V1/Client/RegionInstanceTemplatesClient.php +++ b/Compute/src/V1/Client/RegionInstanceTemplatesClient.php @@ -47,10 +47,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionInstanceTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionInstanceTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionInstanceTemplateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionInstanceTemplatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionInstanceTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionInstanceTemplatesRequest $request, array $optionalArgs = []) */ final class RegionInstanceTemplatesClient { diff --git a/Compute/src/V1/Client/RegionInstancesClient.php b/Compute/src/V1/Client/RegionInstancesClient.php index 11fed84940a0..8f97283b0bd1 100644 --- a/Compute/src/V1/Client/RegionInstancesClient.php +++ b/Compute/src/V1/Client/RegionInstancesClient.php @@ -42,7 +42,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface bulkInsertAsync(BulkInsertRegionInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface bulkInsertAsync(BulkInsertRegionInstanceRequest $request, array $optionalArgs = []) */ final class RegionInstancesClient { diff --git a/Compute/src/V1/Client/RegionInstantSnapshotsClient.php b/Compute/src/V1/Client/RegionInstantSnapshotsClient.php index 4532eff547c5..b72a3a3deaf2 100644 --- a/Compute/src/V1/Client/RegionInstantSnapshotsClient.php +++ b/Compute/src/V1/Client/RegionInstantSnapshotsClient.php @@ -53,14 +53,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRegionInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionInstantSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRegionInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsRegionInstantSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRegionInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRegionInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionInstantSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRegionInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsRegionInstantSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRegionInstantSnapshotRequest $request, array $optionalArgs = []) */ final class RegionInstantSnapshotsClient { diff --git a/Compute/src/V1/Client/RegionNetworkEndpointGroupsClient.php b/Compute/src/V1/Client/RegionNetworkEndpointGroupsClient.php index ea1603f569da..c5c362033cc6 100644 --- a/Compute/src/V1/Client/RegionNetworkEndpointGroupsClient.php +++ b/Compute/src/V1/Client/RegionNetworkEndpointGroupsClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface attachNetworkEndpointsAsync(AttachNetworkEndpointsRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface detachNetworkEndpointsAsync(DetachNetworkEndpointsRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionNetworkEndpointGroupsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listNetworkEndpointsAsync(ListNetworkEndpointsRegionNetworkEndpointGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface attachNetworkEndpointsAsync(AttachNetworkEndpointsRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface detachNetworkEndpointsAsync(DetachNetworkEndpointsRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionNetworkEndpointGroupRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionNetworkEndpointGroupsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNetworkEndpointsAsync(ListNetworkEndpointsRegionNetworkEndpointGroupsRequest $request, array $optionalArgs = []) */ final class RegionNetworkEndpointGroupsClient { diff --git a/Compute/src/V1/Client/RegionNetworkFirewallPoliciesClient.php b/Compute/src/V1/Client/RegionNetworkFirewallPoliciesClient.php index 91628aa6c00c..afe1d4fbdd15 100644 --- a/Compute/src/V1/Client/RegionNetworkFirewallPoliciesClient.php +++ b/Compute/src/V1/Client/RegionNetworkFirewallPoliciesClient.php @@ -65,23 +65,23 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addAssociationAsync(AddAssociationRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface addRuleAsync(AddRuleRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface cloneRulesAsync(CloneRulesRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAssociationAsync(GetAssociationRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getEffectiveFirewallsAsync(GetEffectiveFirewallsRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuleAsync(GetRuleRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionNetworkFirewallPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchRuleAsync(PatchRuleRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeAssociationAsync(RemoveAssociationRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeRuleAsync(RemoveRuleRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addAssociationAsync(AddAssociationRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addRuleAsync(AddRuleRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface cloneRulesAsync(CloneRulesRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAssociationAsync(GetAssociationRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getEffectiveFirewallsAsync(GetEffectiveFirewallsRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuleAsync(GetRuleRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionNetworkFirewallPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchRuleAsync(PatchRuleRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeAssociationAsync(RemoveAssociationRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeRuleAsync(RemoveRuleRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsRegionNetworkFirewallPolicyRequest $request, array $optionalArgs = []) */ final class RegionNetworkFirewallPoliciesClient { diff --git a/Compute/src/V1/Client/RegionNotificationEndpointsClient.php b/Compute/src/V1/Client/RegionNotificationEndpointsClient.php index c9c9c5d6f5ee..a82bbf258f2b 100644 --- a/Compute/src/V1/Client/RegionNotificationEndpointsClient.php +++ b/Compute/src/V1/Client/RegionNotificationEndpointsClient.php @@ -47,10 +47,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionNotificationEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionNotificationEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionNotificationEndpointRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionNotificationEndpointsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionNotificationEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionNotificationEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionNotificationEndpointRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionNotificationEndpointsRequest $request, array $optionalArgs = []) */ final class RegionNotificationEndpointsClient { diff --git a/Compute/src/V1/Client/RegionOperationsClient.php b/Compute/src/V1/Client/RegionOperationsClient.php index 92dd739bd74d..572a031787db 100644 --- a/Compute/src/V1/Client/RegionOperationsClient.php +++ b/Compute/src/V1/Client/RegionOperationsClient.php @@ -46,10 +46,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface waitAsync(WaitRegionOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface waitAsync(WaitRegionOperationRequest $request, array $optionalArgs = []) */ final class RegionOperationsClient { diff --git a/Compute/src/V1/Client/RegionSecurityPoliciesClient.php b/Compute/src/V1/Client/RegionSecurityPoliciesClient.php index 45ff79e42c90..397c6cc46d8b 100644 --- a/Compute/src/V1/Client/RegionSecurityPoliciesClient.php +++ b/Compute/src/V1/Client/RegionSecurityPoliciesClient.php @@ -53,15 +53,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addRuleAsync(AddRuleRegionSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteRegionSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuleAsync(GetRuleRegionSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionSecurityPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchRuleAsync(PatchRuleRegionSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeRuleAsync(RemoveRuleRegionSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addRuleAsync(AddRuleRegionSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuleAsync(GetRuleRegionSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionSecurityPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchRuleAsync(PatchRuleRegionSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeRuleAsync(RemoveRuleRegionSecurityPolicyRequest $request, array $optionalArgs = []) */ final class RegionSecurityPoliciesClient { diff --git a/Compute/src/V1/Client/RegionSslCertificatesClient.php b/Compute/src/V1/Client/RegionSslCertificatesClient.php index c82732a00cb1..66c8c2ecbdee 100644 --- a/Compute/src/V1/Client/RegionSslCertificatesClient.php +++ b/Compute/src/V1/Client/RegionSslCertificatesClient.php @@ -47,10 +47,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionSslCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionSslCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionSslCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionSslCertificatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionSslCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionSslCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionSslCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionSslCertificatesRequest $request, array $optionalArgs = []) */ final class RegionSslCertificatesClient { diff --git a/Compute/src/V1/Client/RegionSslPoliciesClient.php b/Compute/src/V1/Client/RegionSslPoliciesClient.php index 4efc84c2edb1..55b408a9e903 100644 --- a/Compute/src/V1/Client/RegionSslPoliciesClient.php +++ b/Compute/src/V1/Client/RegionSslPoliciesClient.php @@ -50,12 +50,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionSslPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionSslPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionSslPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionSslPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAvailableFeaturesAsync(ListAvailableFeaturesRegionSslPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionSslPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionSslPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionSslPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionSslPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionSslPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAvailableFeaturesAsync(ListAvailableFeaturesRegionSslPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionSslPolicyRequest $request, array $optionalArgs = []) */ final class RegionSslPoliciesClient { diff --git a/Compute/src/V1/Client/RegionTargetHttpProxiesClient.php b/Compute/src/V1/Client/RegionTargetHttpProxiesClient.php index 44354946778f..3b37e86078ad 100644 --- a/Compute/src/V1/Client/RegionTargetHttpProxiesClient.php +++ b/Compute/src/V1/Client/RegionTargetHttpProxiesClient.php @@ -48,11 +48,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionTargetHttpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionTargetHttpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionTargetHttpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionTargetHttpProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setUrlMapAsync(SetUrlMapRegionTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionTargetHttpProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setUrlMapAsync(SetUrlMapRegionTargetHttpProxyRequest $request, array $optionalArgs = []) */ final class RegionTargetHttpProxiesClient { diff --git a/Compute/src/V1/Client/RegionTargetHttpsProxiesClient.php b/Compute/src/V1/Client/RegionTargetHttpsProxiesClient.php index 3848490518af..5b57f85e75e1 100644 --- a/Compute/src/V1/Client/RegionTargetHttpsProxiesClient.php +++ b/Compute/src/V1/Client/RegionTargetHttpsProxiesClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionTargetHttpsProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSslCertificatesAsync(SetSslCertificatesRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setUrlMapAsync(SetUrlMapRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionTargetHttpsProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSslCertificatesAsync(SetSslCertificatesRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setUrlMapAsync(SetUrlMapRegionTargetHttpsProxyRequest $request, array $optionalArgs = []) */ final class RegionTargetHttpsProxiesClient { diff --git a/Compute/src/V1/Client/RegionTargetTcpProxiesClient.php b/Compute/src/V1/Client/RegionTargetTcpProxiesClient.php index 246f95019da1..094482477204 100644 --- a/Compute/src/V1/Client/RegionTargetTcpProxiesClient.php +++ b/Compute/src/V1/Client/RegionTargetTcpProxiesClient.php @@ -47,10 +47,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionTargetTcpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionTargetTcpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionTargetTcpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionTargetTcpProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionTargetTcpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionTargetTcpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionTargetTcpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionTargetTcpProxiesRequest $request, array $optionalArgs = []) */ final class RegionTargetTcpProxiesClient { diff --git a/Compute/src/V1/Client/RegionUrlMapsClient.php b/Compute/src/V1/Client/RegionUrlMapsClient.php index 398af0cda22b..2fa11a601e9e 100644 --- a/Compute/src/V1/Client/RegionUrlMapsClient.php +++ b/Compute/src/V1/Client/RegionUrlMapsClient.php @@ -51,13 +51,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRegionUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRegionUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRegionUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionUrlMapsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRegionUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateRegionUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateAsync(ValidateRegionUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRegionUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRegionUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionUrlMapsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRegionUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateRegionUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateAsync(ValidateRegionUrlMapRequest $request, array $optionalArgs = []) */ final class RegionUrlMapsClient { diff --git a/Compute/src/V1/Client/RegionZonesClient.php b/Compute/src/V1/Client/RegionZonesClient.php index 680b1aa3824a..675c31fbe7b2 100644 --- a/Compute/src/V1/Client/RegionZonesClient.php +++ b/Compute/src/V1/Client/RegionZonesClient.php @@ -41,7 +41,7 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface listAsync(ListRegionZonesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionZonesRequest $request, array $optionalArgs = []) */ final class RegionZonesClient { diff --git a/Compute/src/V1/Client/RegionsClient.php b/Compute/src/V1/Client/RegionsClient.php index 96fc3f6b948d..1226110cc8a9 100644 --- a/Compute/src/V1/Client/RegionsClient.php +++ b/Compute/src/V1/Client/RegionsClient.php @@ -43,8 +43,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetRegionRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRegionsRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRegionRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRegionsRequest $request, array $optionalArgs = []) */ final class RegionsClient { @@ -178,7 +178,7 @@ public function __call($method, $args) } /** - * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * The async variant is {@see RegionsClient::getAsync()} . * @@ -202,7 +202,7 @@ public function get(GetRegionRequest $request, array $callOptions = []): Region } /** - * Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * The async variant is {@see RegionsClient::listAsync()} . * diff --git a/Compute/src/V1/Client/ReservationsClient.php b/Compute/src/V1/Client/ReservationsClient.php index 8be4f534058c..4d8b10692d95 100644 --- a/Compute/src/V1/Client/ReservationsClient.php +++ b/Compute/src/V1/Client/ReservationsClient.php @@ -55,16 +55,16 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListReservationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListReservationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface resizeAsync(ResizeReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsReservationRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListReservationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListReservationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface resizeAsync(ResizeReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsReservationRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateReservationRequest $request, array $optionalArgs = []) */ final class ReservationsClient { diff --git a/Compute/src/V1/Client/ResourcePoliciesClient.php b/Compute/src/V1/Client/ResourcePoliciesClient.php index 0e2dec87469a..f4149fd79ca2 100644 --- a/Compute/src/V1/Client/ResourcePoliciesClient.php +++ b/Compute/src/V1/Client/ResourcePoliciesClient.php @@ -54,15 +54,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListResourcePoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteResourcePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetResourcePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyResourcePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertResourcePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListResourcePoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchResourcePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyResourcePolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListResourcePoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteResourcePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetResourcePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyResourcePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertResourcePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListResourcePoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchResourcePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyResourcePolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest $request, array $optionalArgs = []) */ final class ResourcePoliciesClient { diff --git a/Compute/src/V1/Client/RoutersClient.php b/Compute/src/V1/Client/RoutersClient.php index 8e2910b96af6..3a8a1aa2f23f 100644 --- a/Compute/src/V1/Client/RoutersClient.php +++ b/Compute/src/V1/Client/RoutersClient.php @@ -57,17 +57,17 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListRoutersRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNatIpInfoAsync(GetNatIpInfoRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface getNatMappingInfoAsync(GetNatMappingInfoRoutersRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRouterStatusAsync(GetRouterStatusRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRoutersRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface previewAsync(PreviewRouterRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListRoutersRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNatIpInfoAsync(GetNatIpInfoRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNatMappingInfoAsync(GetNatMappingInfoRoutersRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRouterStatusAsync(GetRouterStatusRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRoutersRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface previewAsync(PreviewRouterRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateRouterRequest $request, array $optionalArgs = []) */ final class RoutersClient { diff --git a/Compute/src/V1/Client/RoutesClient.php b/Compute/src/V1/Client/RoutesClient.php index 072d8fb91517..4e88c130b66b 100644 --- a/Compute/src/V1/Client/RoutesClient.php +++ b/Compute/src/V1/Client/RoutesClient.php @@ -47,10 +47,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertRouteRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListRoutesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertRouteRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListRoutesRequest $request, array $optionalArgs = []) */ final class RoutesClient { diff --git a/Compute/src/V1/Client/SecurityPoliciesClient.php b/Compute/src/V1/Client/SecurityPoliciesClient.php index cd6ae0277a55..32a1ce4502b2 100644 --- a/Compute/src/V1/Client/SecurityPoliciesClient.php +++ b/Compute/src/V1/Client/SecurityPoliciesClient.php @@ -57,18 +57,18 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addRuleAsync(AddRuleSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregatedListAsync(AggregatedListSecurityPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getRuleAsync(GetRuleSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListSecurityPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listPreconfiguredExpressionSetsAsync(ListPreconfiguredExpressionSetsSecurityPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchRuleAsync(PatchRuleSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeRuleAsync(RemoveRuleSecurityPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface addRuleAsync(AddRuleSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListSecurityPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getRuleAsync(GetRuleSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListSecurityPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listPreconfiguredExpressionSetsAsync(ListPreconfiguredExpressionSetsSecurityPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchRuleAsync(PatchRuleSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeRuleAsync(RemoveRuleSecurityPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsSecurityPolicyRequest $request, array $optionalArgs = []) */ final class SecurityPoliciesClient { diff --git a/Compute/src/V1/Client/ServiceAttachmentsClient.php b/Compute/src/V1/Client/ServiceAttachmentsClient.php index bc00f30f7da2..ff6e0ee2c0bf 100644 --- a/Compute/src/V1/Client/ServiceAttachmentsClient.php +++ b/Compute/src/V1/Client/ServiceAttachmentsClient.php @@ -54,15 +54,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListServiceAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteServiceAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetServiceAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyServiceAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertServiceAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListServiceAttachmentsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchServiceAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyServiceAttachmentRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsServiceAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListServiceAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteServiceAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetServiceAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyServiceAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertServiceAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListServiceAttachmentsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchServiceAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyServiceAttachmentRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsServiceAttachmentRequest $request, array $optionalArgs = []) */ final class ServiceAttachmentsClient { diff --git a/Compute/src/V1/Client/SnapshotSettingsServiceClient.php b/Compute/src/V1/Client/SnapshotSettingsServiceClient.php index adf412a9b092..c6b3ef74f967 100644 --- a/Compute/src/V1/Client/SnapshotSettingsServiceClient.php +++ b/Compute/src/V1/Client/SnapshotSettingsServiceClient.php @@ -44,8 +44,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetSnapshotSettingRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchSnapshotSettingRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetSnapshotSettingRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchSnapshotSettingRequest $request, array $optionalArgs = []) */ final class SnapshotSettingsServiceClient { diff --git a/Compute/src/V1/Client/SnapshotsClient.php b/Compute/src/V1/Client/SnapshotsClient.php index 4995465e8d0e..1ba3afe8dcb2 100644 --- a/Compute/src/V1/Client/SnapshotsClient.php +++ b/Compute/src/V1/Client/SnapshotsClient.php @@ -53,14 +53,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicySnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListSnapshotsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicySnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsSnapshotRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicySnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListSnapshotsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicySnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsSnapshotRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsSnapshotRequest $request, array $optionalArgs = []) */ final class SnapshotsClient { diff --git a/Compute/src/V1/Client/SslCertificatesClient.php b/Compute/src/V1/Client/SslCertificatesClient.php index 9562fd895b03..c3d0f63cf1ea 100644 --- a/Compute/src/V1/Client/SslCertificatesClient.php +++ b/Compute/src/V1/Client/SslCertificatesClient.php @@ -48,11 +48,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListSslCertificatesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteSslCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetSslCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertSslCertificateRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListSslCertificatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListSslCertificatesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteSslCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetSslCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertSslCertificateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListSslCertificatesRequest $request, array $optionalArgs = []) */ final class SslCertificatesClient { diff --git a/Compute/src/V1/Client/SslPoliciesClient.php b/Compute/src/V1/Client/SslPoliciesClient.php index 72e57a799f36..bc4ece5cc7a6 100644 --- a/Compute/src/V1/Client/SslPoliciesClient.php +++ b/Compute/src/V1/Client/SslPoliciesClient.php @@ -51,13 +51,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListSslPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteSslPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetSslPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertSslPolicyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListSslPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAvailableFeaturesAsync(ListAvailableFeaturesSslPoliciesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchSslPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListSslPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteSslPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetSslPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertSslPolicyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListSslPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAvailableFeaturesAsync(ListAvailableFeaturesSslPoliciesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchSslPolicyRequest $request, array $optionalArgs = []) */ final class SslPoliciesClient { diff --git a/Compute/src/V1/Client/StoragePoolTypesClient.php b/Compute/src/V1/Client/StoragePoolTypesClient.php index cb07eaaf1f6e..580780decbe3 100644 --- a/Compute/src/V1/Client/StoragePoolTypesClient.php +++ b/Compute/src/V1/Client/StoragePoolTypesClient.php @@ -44,9 +44,9 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListStoragePoolTypesRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetStoragePoolTypeRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListStoragePoolTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListStoragePoolTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetStoragePoolTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListStoragePoolTypesRequest $request, array $optionalArgs = []) */ final class StoragePoolTypesClient { diff --git a/Compute/src/V1/Client/StoragePoolsClient.php b/Compute/src/V1/Client/StoragePoolsClient.php index b29af1e95197..a83c088e4c4d 100644 --- a/Compute/src/V1/Client/StoragePoolsClient.php +++ b/Compute/src/V1/Client/StoragePoolsClient.php @@ -57,16 +57,16 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListStoragePoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicyStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListStoragePoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface listDisksAsync(ListDisksStoragePoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicyStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsStoragePoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListStoragePoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicyStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListStoragePoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface listDisksAsync(ListDisksStoragePoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicyStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsStoragePoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateStoragePoolRequest $request, array $optionalArgs = []) */ final class StoragePoolsClient { @@ -470,7 +470,7 @@ public function testIamPermissions(TestIamPermissionsStoragePoolRequest $request } /** - * Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: size_tb and provisioned_iops. + * Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: pool_provisioned_capacity_gb, pool_provisioned_iops and pool_provisioned_throughput. * * The async variant is {@see StoragePoolsClient::updateAsync()} . * diff --git a/Compute/src/V1/Client/SubnetworksClient.php b/Compute/src/V1/Client/SubnetworksClient.php index e9c14cd67fee..577ba17b964d 100644 --- a/Compute/src/V1/Client/SubnetworksClient.php +++ b/Compute/src/V1/Client/SubnetworksClient.php @@ -57,18 +57,18 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListSubnetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteSubnetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface expandIpCidrRangeAsync(ExpandIpCidrRangeSubnetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetSubnetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface getIamPolicyAsync(GetIamPolicySubnetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertSubnetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListSubnetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface listUsableAsync(ListUsableSubnetworksRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchSubnetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface setIamPolicyAsync(SetIamPolicySubnetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface setPrivateIpGoogleAccessAsync(SetPrivateIpGoogleAccessSubnetworkRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsSubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListSubnetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteSubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface expandIpCidrRangeAsync(ExpandIpCidrRangeSubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetSubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface getIamPolicyAsync(GetIamPolicySubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertSubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListSubnetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface listUsableAsync(ListUsableSubnetworksRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchSubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface setIamPolicyAsync(SetIamPolicySubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface setPrivateIpGoogleAccessAsync(SetPrivateIpGoogleAccessSubnetworkRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsSubnetworkRequest $request, array $optionalArgs = []) */ final class SubnetworksClient { diff --git a/Compute/src/V1/Client/TargetGrpcProxiesClient.php b/Compute/src/V1/Client/TargetGrpcProxiesClient.php index e1de89d88596..49ad7b9aaf43 100644 --- a/Compute/src/V1/Client/TargetGrpcProxiesClient.php +++ b/Compute/src/V1/Client/TargetGrpcProxiesClient.php @@ -48,11 +48,11 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteTargetGrpcProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetTargetGrpcProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertTargetGrpcProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListTargetGrpcProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchTargetGrpcProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteTargetGrpcProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetTargetGrpcProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertTargetGrpcProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListTargetGrpcProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchTargetGrpcProxyRequest $request, array $optionalArgs = []) */ final class TargetGrpcProxiesClient { diff --git a/Compute/src/V1/Client/TargetHttpProxiesClient.php b/Compute/src/V1/Client/TargetHttpProxiesClient.php index fad727fe4e86..7c137aa86df4 100644 --- a/Compute/src/V1/Client/TargetHttpProxiesClient.php +++ b/Compute/src/V1/Client/TargetHttpProxiesClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListTargetHttpProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteTargetHttpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetTargetHttpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertTargetHttpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListTargetHttpProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchTargetHttpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setUrlMapAsync(SetUrlMapTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListTargetHttpProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListTargetHttpProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchTargetHttpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setUrlMapAsync(SetUrlMapTargetHttpProxyRequest $request, array $optionalArgs = []) */ final class TargetHttpProxiesClient { diff --git a/Compute/src/V1/Client/TargetHttpsProxiesClient.php b/Compute/src/V1/Client/TargetHttpsProxiesClient.php index 0fd497aa35c4..6c16958e13ac 100644 --- a/Compute/src/V1/Client/TargetHttpsProxiesClient.php +++ b/Compute/src/V1/Client/TargetHttpsProxiesClient.php @@ -54,17 +54,17 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListTargetHttpsProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListTargetHttpsProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setCertificateMapAsync(SetCertificateMapTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setQuicOverrideAsync(SetQuicOverrideTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSslCertificatesAsync(SetSslCertificatesTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSslPolicyAsync(SetSslPolicyTargetHttpsProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setUrlMapAsync(SetUrlMapTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListTargetHttpsProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListTargetHttpsProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setCertificateMapAsync(SetCertificateMapTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setQuicOverrideAsync(SetQuicOverrideTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSslCertificatesAsync(SetSslCertificatesTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSslPolicyAsync(SetSslPolicyTargetHttpsProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setUrlMapAsync(SetUrlMapTargetHttpsProxyRequest $request, array $optionalArgs = []) */ final class TargetHttpsProxiesClient { diff --git a/Compute/src/V1/Client/TargetInstancesClient.php b/Compute/src/V1/Client/TargetInstancesClient.php index 85447f521ed7..8181292accd6 100644 --- a/Compute/src/V1/Client/TargetInstancesClient.php +++ b/Compute/src/V1/Client/TargetInstancesClient.php @@ -49,12 +49,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListTargetInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteTargetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetTargetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertTargetInstanceRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListTargetInstancesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyTargetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListTargetInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteTargetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetTargetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertTargetInstanceRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListTargetInstancesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyTargetInstanceRequest $request, array $optionalArgs = []) */ final class TargetInstancesClient { diff --git a/Compute/src/V1/Client/TargetPoolsClient.php b/Compute/src/V1/Client/TargetPoolsClient.php index ce732c9dd633..69aed2be5247 100644 --- a/Compute/src/V1/Client/TargetPoolsClient.php +++ b/Compute/src/V1/Client/TargetPoolsClient.php @@ -56,18 +56,18 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface addHealthCheckAsync(AddHealthCheckTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface addInstanceAsync(AddInstanceTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface aggregatedListAsync(AggregatedListTargetPoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface getHealthAsync(GetHealthTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListTargetPoolsRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeHealthCheckAsync(RemoveHealthCheckTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface removeInstanceAsync(RemoveInstanceTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface setBackupAsync(SetBackupTargetPoolRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface addHealthCheckAsync(AddHealthCheckTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface addInstanceAsync(AddInstanceTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListTargetPoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface getHealthAsync(GetHealthTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListTargetPoolsRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeHealthCheckAsync(RemoveHealthCheckTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface removeInstanceAsync(RemoveInstanceTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface setBackupAsync(SetBackupTargetPoolRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSecurityPolicyAsync(SetSecurityPolicyTargetPoolRequest $request, array $optionalArgs = []) */ final class TargetPoolsClient { diff --git a/Compute/src/V1/Client/TargetSslProxiesClient.php b/Compute/src/V1/Client/TargetSslProxiesClient.php index 89161f52e106..74fb4c581ec8 100644 --- a/Compute/src/V1/Client/TargetSslProxiesClient.php +++ b/Compute/src/V1/Client/TargetSslProxiesClient.php @@ -52,15 +52,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteTargetSslProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetTargetSslProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertTargetSslProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListTargetSslProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setBackendServiceAsync(SetBackendServiceTargetSslProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setCertificateMapAsync(SetCertificateMapTargetSslProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setProxyHeaderAsync(SetProxyHeaderTargetSslProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSslCertificatesAsync(SetSslCertificatesTargetSslProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setSslPolicyAsync(SetSslPolicyTargetSslProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteTargetSslProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetTargetSslProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertTargetSslProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListTargetSslProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setBackendServiceAsync(SetBackendServiceTargetSslProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setCertificateMapAsync(SetCertificateMapTargetSslProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setProxyHeaderAsync(SetProxyHeaderTargetSslProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSslCertificatesAsync(SetSslCertificatesTargetSslProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setSslPolicyAsync(SetSslPolicyTargetSslProxyRequest $request, array $optionalArgs = []) */ final class TargetSslProxiesClient { diff --git a/Compute/src/V1/Client/TargetTcpProxiesClient.php b/Compute/src/V1/Client/TargetTcpProxiesClient.php index c4920600a5d7..4855b6d64c40 100644 --- a/Compute/src/V1/Client/TargetTcpProxiesClient.php +++ b/Compute/src/V1/Client/TargetTcpProxiesClient.php @@ -50,13 +50,13 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListTargetTcpProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteTargetTcpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetTargetTcpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertTargetTcpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListTargetTcpProxiesRequest $request, array $optionalArgs = []) - * @method PromiseInterface setBackendServiceAsync(SetBackendServiceTargetTcpProxyRequest $request, array $optionalArgs = []) - * @method PromiseInterface setProxyHeaderAsync(SetProxyHeaderTargetTcpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListTargetTcpProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteTargetTcpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetTargetTcpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertTargetTcpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListTargetTcpProxiesRequest $request, array $optionalArgs = []) + * @method PromiseInterface setBackendServiceAsync(SetBackendServiceTargetTcpProxyRequest $request, array $optionalArgs = []) + * @method PromiseInterface setProxyHeaderAsync(SetProxyHeaderTargetTcpProxyRequest $request, array $optionalArgs = []) */ final class TargetTcpProxiesClient { diff --git a/Compute/src/V1/Client/TargetVpnGatewaysClient.php b/Compute/src/V1/Client/TargetVpnGatewaysClient.php index 7b8a6283b772..67050e64ecab 100644 --- a/Compute/src/V1/Client/TargetVpnGatewaysClient.php +++ b/Compute/src/V1/Client/TargetVpnGatewaysClient.php @@ -49,12 +49,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListTargetVpnGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteTargetVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetTargetVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertTargetVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListTargetVpnGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsTargetVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListTargetVpnGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteTargetVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetTargetVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertTargetVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListTargetVpnGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsTargetVpnGatewayRequest $request, array $optionalArgs = []) */ final class TargetVpnGatewaysClient { diff --git a/Compute/src/V1/Client/UrlMapsClient.php b/Compute/src/V1/Client/UrlMapsClient.php index 52ca9f05cea4..1d0f47b3dc86 100644 --- a/Compute/src/V1/Client/UrlMapsClient.php +++ b/Compute/src/V1/Client/UrlMapsClient.php @@ -53,15 +53,15 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListUrlMapsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface invalidateCacheAsync(InvalidateCacheUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListUrlMapsRequest $request, array $optionalArgs = []) - * @method PromiseInterface patchAsync(PatchUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface updateAsync(UpdateUrlMapRequest $request, array $optionalArgs = []) - * @method PromiseInterface validateAsync(ValidateUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListUrlMapsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface invalidateCacheAsync(InvalidateCacheUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListUrlMapsRequest $request, array $optionalArgs = []) + * @method PromiseInterface patchAsync(PatchUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface updateAsync(UpdateUrlMapRequest $request, array $optionalArgs = []) + * @method PromiseInterface validateAsync(ValidateUrlMapRequest $request, array $optionalArgs = []) */ final class UrlMapsClient { diff --git a/Compute/src/V1/Client/VpnGatewaysClient.php b/Compute/src/V1/Client/VpnGatewaysClient.php index 4f76c5719732..8b8eb4932c2b 100644 --- a/Compute/src/V1/Client/VpnGatewaysClient.php +++ b/Compute/src/V1/Client/VpnGatewaysClient.php @@ -53,14 +53,14 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListVpnGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface getStatusAsync(GetStatusVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListVpnGatewaysRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsVpnGatewayRequest $request, array $optionalArgs = []) - * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListVpnGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface getStatusAsync(GetStatusVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListVpnGatewaysRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsVpnGatewayRequest $request, array $optionalArgs = []) + * @method PromiseInterface testIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest $request, array $optionalArgs = []) */ final class VpnGatewaysClient { diff --git a/Compute/src/V1/Client/VpnTunnelsClient.php b/Compute/src/V1/Client/VpnTunnelsClient.php index 0dd62b4ed84d..daadaf59db3f 100644 --- a/Compute/src/V1/Client/VpnTunnelsClient.php +++ b/Compute/src/V1/Client/VpnTunnelsClient.php @@ -49,12 +49,12 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface aggregatedListAsync(AggregatedListVpnTunnelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface deleteAsync(DeleteVpnTunnelRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetVpnTunnelRequest $request, array $optionalArgs = []) - * @method PromiseInterface insertAsync(InsertVpnTunnelRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListVpnTunnelsRequest $request, array $optionalArgs = []) - * @method PromiseInterface setLabelsAsync(SetLabelsVpnTunnelRequest $request, array $optionalArgs = []) + * @method PromiseInterface aggregatedListAsync(AggregatedListVpnTunnelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteVpnTunnelRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetVpnTunnelRequest $request, array $optionalArgs = []) + * @method PromiseInterface insertAsync(InsertVpnTunnelRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListVpnTunnelsRequest $request, array $optionalArgs = []) + * @method PromiseInterface setLabelsAsync(SetLabelsVpnTunnelRequest $request, array $optionalArgs = []) */ final class VpnTunnelsClient { diff --git a/Compute/src/V1/Client/ZoneOperationsClient.php b/Compute/src/V1/Client/ZoneOperationsClient.php index 2e7ff6f097c8..839cb699a1b8 100644 --- a/Compute/src/V1/Client/ZoneOperationsClient.php +++ b/Compute/src/V1/Client/ZoneOperationsClient.php @@ -46,10 +46,10 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface deleteAsync(DeleteZoneOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface getAsync(GetZoneOperationRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListZoneOperationsRequest $request, array $optionalArgs = []) - * @method PromiseInterface waitAsync(WaitZoneOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteAsync(DeleteZoneOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetZoneOperationRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListZoneOperationsRequest $request, array $optionalArgs = []) + * @method PromiseInterface waitAsync(WaitZoneOperationRequest $request, array $optionalArgs = []) */ final class ZoneOperationsClient { diff --git a/Compute/src/V1/Client/ZonesClient.php b/Compute/src/V1/Client/ZonesClient.php index e92d8cb66ea1..f7cd14753c95 100644 --- a/Compute/src/V1/Client/ZonesClient.php +++ b/Compute/src/V1/Client/ZonesClient.php @@ -43,8 +43,8 @@ * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. * - * @method PromiseInterface getAsync(GetZoneRequest $request, array $optionalArgs = []) - * @method PromiseInterface listAsync(ListZonesRequest $request, array $optionalArgs = []) + * @method PromiseInterface getAsync(GetZoneRequest $request, array $optionalArgs = []) + * @method PromiseInterface listAsync(ListZonesRequest $request, array $optionalArgs = []) */ final class ZonesClient { diff --git a/Compute/src/V1/Commitment.php b/Compute/src/V1/Commitment.php index 87e380bbd86f..ce8396d12678 100644 --- a/Compute/src/V1/Commitment.php +++ b/Compute/src/V1/Commitment.php @@ -34,6 +34,12 @@ class Commitment extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string creation_timestamp = 30525366; */ private $creation_timestamp = null; + /** + * [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. + * + * Generated from protobuf field optional string custom_end_timestamp = 181770852; + */ + private $custom_end_timestamp = null; /** * An optional description of this resource. Provide this property when you create the resource. * @@ -101,6 +107,12 @@ class Commitment extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.compute.v1.Reservation reservations = 399717927; */ private $reservations; + /** + * [Output Only] Status information for Commitment resource. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315; + */ + private $resource_status = null; /** * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. * @@ -159,6 +171,8 @@ class Commitment extends \Google\Protobuf\Internal\Message * Check the Category enum for the list of possible values. * @type string $creation_timestamp * [Output Only] Creation timestamp in RFC3339 text format. + * @type string $custom_end_timestamp + * [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. * @type string $description * An optional description of this resource. Provide this property when you create the resource. * @type string $end_timestamp @@ -182,6 +196,8 @@ class Commitment extends \Google\Protobuf\Internal\Message * [Output Only] URL of the region where this commitment may be used. * @type array<\Google\Cloud\Compute\V1\Reservation>|\Google\Protobuf\Internal\RepeatedField $reservations * List of create-on-create reservations for this commitment. + * @type \Google\Cloud\Compute\V1\CommitmentResourceStatus $resource_status + * [Output Only] Status information for Commitment resource. * @type array<\Google\Cloud\Compute\V1\ResourceCommitment>|\Google\Protobuf\Internal\RepeatedField $resources * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. * @type string $self_link @@ -315,6 +331,42 @@ public function setCreationTimestamp($var) return $this; } + /** + * [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. + * + * Generated from protobuf field optional string custom_end_timestamp = 181770852; + * @return string + */ + public function getCustomEndTimestamp() + { + return isset($this->custom_end_timestamp) ? $this->custom_end_timestamp : ''; + } + + public function hasCustomEndTimestamp() + { + return isset($this->custom_end_timestamp); + } + + public function clearCustomEndTimestamp() + { + unset($this->custom_end_timestamp); + } + + /** + * [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. + * + * Generated from protobuf field optional string custom_end_timestamp = 181770852; + * @param string $var + * @return $this + */ + public function setCustomEndTimestamp($var) + { + GPBUtil::checkString($var, True); + $this->custom_end_timestamp = $var; + + return $this; + } + /** * An optional description of this resource. Provide this property when you create the resource. * @@ -683,6 +735,42 @@ public function setReservations($var) return $this; } + /** + * [Output Only] Status information for Commitment resource. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315; + * @return \Google\Cloud\Compute\V1\CommitmentResourceStatus|null + */ + public function getResourceStatus() + { + return $this->resource_status; + } + + public function hasResourceStatus() + { + return isset($this->resource_status); + } + + public function clearResourceStatus() + { + unset($this->resource_status); + } + + /** + * [Output Only] Status information for Commitment resource. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315; + * @param \Google\Cloud\Compute\V1\CommitmentResourceStatus $var + * @return $this + */ + public function setResourceStatus($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\CommitmentResourceStatus::class); + $this->resource_status = $var; + + return $this; + } + /** * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. * diff --git a/Compute/src/V1/Commitment/Type.php b/Compute/src/V1/Commitment/Type.php index ff94574567b5..7bd6b22b0191 100644 --- a/Compute/src/V1/Commitment/Type.php +++ b/Compute/src/V1/Commitment/Type.php @@ -55,6 +55,10 @@ class Type * Generated from protobuf enum GENERAL_PURPOSE = 299793543; */ const GENERAL_PURPOSE = 299793543; + /** + * Generated from protobuf enum GENERAL_PURPOSE_C4 = 301911817; + */ + const GENERAL_PURPOSE_C4 = 301911817; /** * Generated from protobuf enum GENERAL_PURPOSE_E2 = 301911877; */ @@ -107,6 +111,7 @@ class Type self::COMPUTE_OPTIMIZED_C3D => 'COMPUTE_OPTIMIZED_C3D', self::COMPUTE_OPTIMIZED_H3 => 'COMPUTE_OPTIMIZED_H3', self::GENERAL_PURPOSE => 'GENERAL_PURPOSE', + self::GENERAL_PURPOSE_C4 => 'GENERAL_PURPOSE_C4', self::GENERAL_PURPOSE_E2 => 'GENERAL_PURPOSE_E2', self::GENERAL_PURPOSE_N2 => 'GENERAL_PURPOSE_N2', self::GENERAL_PURPOSE_N2D => 'GENERAL_PURPOSE_N2D', diff --git a/Compute/src/V1/CommitmentResourceStatus.php b/Compute/src/V1/CommitmentResourceStatus.php new file mode 100644 index 000000000000..8c40ab7f6b16 --- /dev/null +++ b/Compute/src/V1/CommitmentResourceStatus.php @@ -0,0 +1,77 @@ +google.cloud.compute.v1.CommitmentResourceStatus + */ +class CommitmentResourceStatus extends \Google\Protobuf\Internal\Message +{ + /** + * [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. + * + * Generated from protobuf field optional string custom_term_eligibility_end_timestamp = 363976187; + */ + private $custom_term_eligibility_end_timestamp = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $custom_term_eligibility_end_timestamp + * [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. + * + * Generated from protobuf field optional string custom_term_eligibility_end_timestamp = 363976187; + * @return string + */ + public function getCustomTermEligibilityEndTimestamp() + { + return isset($this->custom_term_eligibility_end_timestamp) ? $this->custom_term_eligibility_end_timestamp : ''; + } + + public function hasCustomTermEligibilityEndTimestamp() + { + return isset($this->custom_term_eligibility_end_timestamp); + } + + public function clearCustomTermEligibilityEndTimestamp() + { + unset($this->custom_term_eligibility_end_timestamp); + } + + /** + * [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. + * + * Generated from protobuf field optional string custom_term_eligibility_end_timestamp = 363976187; + * @param string $var + * @return $this + */ + public function setCustomTermEligibilityEndTimestamp($var) + { + GPBUtil::checkString($var, True); + $this->custom_term_eligibility_end_timestamp = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/ConfidentialInstanceConfig.php b/Compute/src/V1/ConfidentialInstanceConfig.php index 57a075a99510..da315589680e 100644 --- a/Compute/src/V1/ConfidentialInstanceConfig.php +++ b/Compute/src/V1/ConfidentialInstanceConfig.php @@ -15,6 +15,13 @@ */ class ConfidentialInstanceConfig extends \Google\Protobuf\Internal\Message { + /** + * Defines the type of technology used by the confidential instance. + * Check the ConfidentialInstanceType enum for the list of possible values. + * + * Generated from protobuf field optional string confidential_instance_type = 43484717; + */ + private $confidential_instance_type = null; /** * Defines whether the instance should have confidential compute enabled. * @@ -28,6 +35,9 @@ class ConfidentialInstanceConfig extends \Google\Protobuf\Internal\Message * @param array $data { * Optional. Data for populating the Message object. * + * @type string $confidential_instance_type + * Defines the type of technology used by the confidential instance. + * Check the ConfidentialInstanceType enum for the list of possible values. * @type bool $enable_confidential_compute * Defines whether the instance should have confidential compute enabled. * } @@ -37,6 +47,44 @@ public function __construct($data = NULL) { parent::__construct($data); } + /** + * Defines the type of technology used by the confidential instance. + * Check the ConfidentialInstanceType enum for the list of possible values. + * + * Generated from protobuf field optional string confidential_instance_type = 43484717; + * @return string + */ + public function getConfidentialInstanceType() + { + return isset($this->confidential_instance_type) ? $this->confidential_instance_type : ''; + } + + public function hasConfidentialInstanceType() + { + return isset($this->confidential_instance_type); + } + + public function clearConfidentialInstanceType() + { + unset($this->confidential_instance_type); + } + + /** + * Defines the type of technology used by the confidential instance. + * Check the ConfidentialInstanceType enum for the list of possible values. + * + * Generated from protobuf field optional string confidential_instance_type = 43484717; + * @param string $var + * @return $this + */ + public function setConfidentialInstanceType($var) + { + GPBUtil::checkString($var, True); + $this->confidential_instance_type = $var; + + return $this; + } + /** * Defines whether the instance should have confidential compute enabled. * diff --git a/Compute/src/V1/ConfidentialInstanceConfig/ConfidentialInstanceType.php b/Compute/src/V1/ConfidentialInstanceConfig/ConfidentialInstanceType.php new file mode 100644 index 000000000000..4fcc489754a0 --- /dev/null +++ b/Compute/src/V1/ConfidentialInstanceConfig/ConfidentialInstanceType.php @@ -0,0 +1,76 @@ +google.cloud.compute.v1.ConfidentialInstanceConfig.ConfidentialInstanceType + */ +class ConfidentialInstanceType +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_CONFIDENTIAL_INSTANCE_TYPE = 0; + */ + const UNDEFINED_CONFIDENTIAL_INSTANCE_TYPE = 0; + /** + * No type specified. Do not use this value. + * + * Generated from protobuf enum CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED = 115021829; + */ + const CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED = 115021829; + /** + * AMD Secure Encrypted Virtualization. + * + * Generated from protobuf enum SEV = 81988; + */ + const SEV = 81988; + /** + * AMD Secure Encrypted Virtualization - Secure Nested Paging. + * + * Generated from protobuf enum SEV_SNP = 21753562; + */ + const SEV_SNP = 21753562; + /** + * Intel Trust Domain eXtension. + * + * Generated from protobuf enum TDX = 82920; + */ + const TDX = 82920; + + private static $valueToName = [ + self::UNDEFINED_CONFIDENTIAL_INSTANCE_TYPE => 'UNDEFINED_CONFIDENTIAL_INSTANCE_TYPE', + self::CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED => 'CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED', + self::SEV => 'SEV', + self::SEV_SNP => 'SEV_SNP', + self::TDX => 'TDX', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/CustomErrorResponsePolicy.php b/Compute/src/V1/CustomErrorResponsePolicy.php new file mode 100644 index 000000000000..eb63b50c6624 --- /dev/null +++ b/Compute/src/V1/CustomErrorResponsePolicy.php @@ -0,0 +1,111 @@ +google.cloud.compute.v1.CustomErrorResponsePolicy + */ +class CustomErrorResponsePolicy extends \Google\Protobuf\Internal\Message +{ + /** + * Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for 401 (Un-authorized) code, and another for all 4 series error codes (4XX). If the backend service returns a 401, then the rule for 401 will be applied. However if the backend service returns a 403, the rule for 4xx takes effect. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.CustomErrorResponsePolicyCustomErrorResponseRule error_response_rules = 14620304; + */ + private $error_response_rules; + /** + * The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. + * + * Generated from protobuf field optional string error_service = 164214654; + */ + private $error_service = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Compute\V1\CustomErrorResponsePolicyCustomErrorResponseRule>|\Google\Protobuf\Internal\RepeatedField $error_response_rules + * Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for 401 (Un-authorized) code, and another for all 4 series error codes (4XX). If the backend service returns a 401, then the rule for 401 will be applied. However if the backend service returns a 403, the rule for 4xx takes effect. + * @type string $error_service + * The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for 401 (Un-authorized) code, and another for all 4 series error codes (4XX). If the backend service returns a 401, then the rule for 401 will be applied. However if the backend service returns a 403, the rule for 4xx takes effect. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.CustomErrorResponsePolicyCustomErrorResponseRule error_response_rules = 14620304; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getErrorResponseRules() + { + return $this->error_response_rules; + } + + /** + * Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for 401 (Un-authorized) code, and another for all 4 series error codes (4XX). If the backend service returns a 401, then the rule for 401 will be applied. However if the backend service returns a 403, the rule for 4xx takes effect. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.CustomErrorResponsePolicyCustomErrorResponseRule error_response_rules = 14620304; + * @param array<\Google\Cloud\Compute\V1\CustomErrorResponsePolicyCustomErrorResponseRule>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setErrorResponseRules($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Compute\V1\CustomErrorResponsePolicyCustomErrorResponseRule::class); + $this->error_response_rules = $arr; + + return $this; + } + + /** + * The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. + * + * Generated from protobuf field optional string error_service = 164214654; + * @return string + */ + public function getErrorService() + { + return isset($this->error_service) ? $this->error_service : ''; + } + + public function hasErrorService() + { + return isset($this->error_service); + } + + public function clearErrorService() + { + unset($this->error_service); + } + + /** + * The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. + * + * Generated from protobuf field optional string error_service = 164214654; + * @param string $var + * @return $this + */ + public function setErrorService($var) + { + GPBUtil::checkString($var, True); + $this->error_service = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/CustomErrorResponsePolicyCustomErrorResponseRule.php b/Compute/src/V1/CustomErrorResponsePolicyCustomErrorResponseRule.php new file mode 100644 index 000000000000..4a17fd4f579b --- /dev/null +++ b/Compute/src/V1/CustomErrorResponsePolicyCustomErrorResponseRule.php @@ -0,0 +1,155 @@ +google.cloud.compute.v1.CustomErrorResponsePolicyCustomErrorResponseRule + */ +class CustomErrorResponsePolicyCustomErrorResponseRule extends \Google\Protobuf\Internal\Message +{ + /** + * Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy. + * + * Generated from protobuf field repeated string match_response_codes = 104973410; + */ + private $match_response_codes; + /** + * The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client. + * + * Generated from protobuf field optional int32 override_response_code = 530328568; + */ + private $override_response_code = null; + /** + * The full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters + * + * Generated from protobuf field optional string path = 3433509; + */ + private $path = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $match_response_codes + * Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy. + * @type int $override_response_code + * The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client. + * @type string $path + * The full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy. + * + * Generated from protobuf field repeated string match_response_codes = 104973410; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMatchResponseCodes() + { + return $this->match_response_codes; + } + + /** + * Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy. + * + * Generated from protobuf field repeated string match_response_codes = 104973410; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMatchResponseCodes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->match_response_codes = $arr; + + return $this; + } + + /** + * The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client. + * + * Generated from protobuf field optional int32 override_response_code = 530328568; + * @return int + */ + public function getOverrideResponseCode() + { + return isset($this->override_response_code) ? $this->override_response_code : 0; + } + + public function hasOverrideResponseCode() + { + return isset($this->override_response_code); + } + + public function clearOverrideResponseCode() + { + unset($this->override_response_code); + } + + /** + * The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client. + * + * Generated from protobuf field optional int32 override_response_code = 530328568; + * @param int $var + * @return $this + */ + public function setOverrideResponseCode($var) + { + GPBUtil::checkInt32($var); + $this->override_response_code = $var; + + return $this; + } + + /** + * The full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters + * + * Generated from protobuf field optional string path = 3433509; + * @return string + */ + public function getPath() + { + return isset($this->path) ? $this->path : ''; + } + + public function hasPath() + { + return isset($this->path); + } + + public function clearPath() + { + unset($this->path); + } + + /** + * The full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters + * + * Generated from protobuf field optional string path = 3433509; + * @param string $var + * @return $this + */ + public function setPath($var) + { + GPBUtil::checkString($var, True); + $this->path = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/DeleteGlobalOperationRequest.php b/Compute/src/V1/DeleteGlobalOperationRequest.php index f19840f8e7e5..2235c555fe02 100644 --- a/Compute/src/V1/DeleteGlobalOperationRequest.php +++ b/Compute/src/V1/DeleteGlobalOperationRequest.php @@ -16,7 +16,7 @@ class DeleteGlobalOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; */ @@ -30,7 +30,7 @@ class DeleteGlobalOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\DeleteGlobalOperationRequest * @@ -50,7 +50,7 @@ public static function build(string $project, string $operation): self * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * @type string $project * Project ID for this request. * } @@ -61,7 +61,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -72,7 +72,7 @@ public function getOperation() } /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Compute/src/V1/DeleteGlobalOrganizationOperationRequest.php b/Compute/src/V1/DeleteGlobalOrganizationOperationRequest.php index 0924271ba34b..f10e27998eab 100644 --- a/Compute/src/V1/DeleteGlobalOrganizationOperationRequest.php +++ b/Compute/src/V1/DeleteGlobalOrganizationOperationRequest.php @@ -16,7 +16,7 @@ class DeleteGlobalOrganizationOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; */ @@ -29,7 +29,7 @@ class DeleteGlobalOrganizationOperationRequest extends \Google\Protobuf\Internal private $parent_id = null; /** - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\DeleteGlobalOrganizationOperationRequest * @@ -48,7 +48,7 @@ public static function build(string $operation): self * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * @type string $parent_id * Parent ID for this request. * } @@ -59,7 +59,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -70,7 +70,7 @@ public function getOperation() } /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Compute/src/V1/DeleteRegionOperationRequest.php b/Compute/src/V1/DeleteRegionOperationRequest.php index 20d8c24eb93d..cff37a72b2cb 100644 --- a/Compute/src/V1/DeleteRegionOperationRequest.php +++ b/Compute/src/V1/DeleteRegionOperationRequest.php @@ -16,7 +16,7 @@ class DeleteRegionOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; */ @@ -37,7 +37,7 @@ class DeleteRegionOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. * @param string $region Name of the region for this request. - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\DeleteRegionOperationRequest * @@ -58,7 +58,7 @@ public static function build(string $project, string $region, string $operation) * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * @type string $project * Project ID for this request. * @type string $region @@ -71,7 +71,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -82,7 +82,7 @@ public function getOperation() } /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Compute/src/V1/DeleteZoneOperationRequest.php b/Compute/src/V1/DeleteZoneOperationRequest.php index 1d4add532597..7ca7c2cb5411 100644 --- a/Compute/src/V1/DeleteZoneOperationRequest.php +++ b/Compute/src/V1/DeleteZoneOperationRequest.php @@ -16,7 +16,7 @@ class DeleteZoneOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; */ @@ -37,7 +37,7 @@ class DeleteZoneOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\DeleteZoneOperationRequest * @@ -58,7 +58,7 @@ public static function build(string $project, string $zone, string $operation): * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * @type string $project * Project ID for this request. * @type string $zone @@ -71,7 +71,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -82,7 +82,7 @@ public function getOperation() } /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Compute/src/V1/Disk.php b/Compute/src/V1/Disk.php index 4b604a559bc3..d389ece0a50e 100644 --- a/Compute/src/V1/Disk.php +++ b/Compute/src/V1/Disk.php @@ -15,6 +15,13 @@ */ class Disk extends \Google\Protobuf\Internal\Message { + /** + * The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types. + * Check the AccessMode enum for the list of possible values. + * + * Generated from protobuf field optional string access_mode = 41155486; + */ + private $access_mode = null; /** * The architecture of the disk. Valid values are ARM64 or X86_64. * Check the Architecture enum for the list of possible values. @@ -318,6 +325,9 @@ class Disk extends \Google\Protobuf\Internal\Message * @param array $data { * Optional. Data for populating the Message object. * + * @type string $access_mode + * The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types. + * Check the AccessMode enum for the list of possible values. * @type string $architecture * The architecture of the disk. Valid values are ARM64 or X86_64. * Check the Architecture enum for the list of possible values. @@ -425,6 +435,44 @@ public function __construct($data = NULL) { parent::__construct($data); } + /** + * The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types. + * Check the AccessMode enum for the list of possible values. + * + * Generated from protobuf field optional string access_mode = 41155486; + * @return string + */ + public function getAccessMode() + { + return isset($this->access_mode) ? $this->access_mode : ''; + } + + public function hasAccessMode() + { + return isset($this->access_mode); + } + + public function clearAccessMode() + { + unset($this->access_mode); + } + + /** + * The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types. + * Check the AccessMode enum for the list of possible values. + * + * Generated from protobuf field optional string access_mode = 41155486; + * @param string $var + * @return $this + */ + public function setAccessMode($var) + { + GPBUtil::checkString($var, True); + $this->access_mode = $var; + + return $this; + } + /** * The architecture of the disk. Valid values are ARM64 or X86_64. * Check the Architecture enum for the list of possible values. diff --git a/Compute/src/V1/Disk/AccessMode.php b/Compute/src/V1/Disk/AccessMode.php new file mode 100644 index 000000000000..7a814f804326 --- /dev/null +++ b/Compute/src/V1/Disk/AccessMode.php @@ -0,0 +1,69 @@ +google.cloud.compute.v1.Disk.AccessMode + */ +class AccessMode +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_ACCESS_MODE = 0; + */ + const UNDEFINED_ACCESS_MODE = 0; + /** + * The AccessMode means the disk can be attached to multiple instances in RO mode. + * + * Generated from protobuf enum READ_ONLY_MANY = 63460265; + */ + const READ_ONLY_MANY = 63460265; + /** + * The AccessMode means the disk can be attached to multiple instances in RW mode. + * + * Generated from protobuf enum READ_WRITE_MANY = 488743208; + */ + const READ_WRITE_MANY = 488743208; + /** + * The default AccessMode, means the disk can be attached to single instance in RW mode. + * + * Generated from protobuf enum READ_WRITE_SINGLE = 99323089; + */ + const READ_WRITE_SINGLE = 99323089; + + private static $valueToName = [ + self::UNDEFINED_ACCESS_MODE => 'UNDEFINED_ACCESS_MODE', + self::READ_ONLY_MANY => 'READ_ONLY_MANY', + self::READ_WRITE_MANY => 'READ_WRITE_MANY', + self::READ_WRITE_SINGLE => 'READ_WRITE_SINGLE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/Enums/AdvancedMachineFeatures/PerformanceMonitoringUnit.php b/Compute/src/V1/Enums/AdvancedMachineFeatures/PerformanceMonitoringUnit.php new file mode 100644 index 000000000000..fae83ac731c0 --- /dev/null +++ b/Compute/src/V1/Enums/AdvancedMachineFeatures/PerformanceMonitoringUnit.php @@ -0,0 +1,44 @@ +optional string action = 187661878; */ @@ -47,7 +47,7 @@ class FirewallPolicyRule extends \Google\Protobuf\Internal\Message */ private $enable_logging = null; /** - * [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + * [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. * * Generated from protobuf field optional string kind = 3292052; */ @@ -59,7 +59,7 @@ class FirewallPolicyRule extends \Google\Protobuf\Internal\Message */ private $match = null; /** - * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. * * Generated from protobuf field optional int32 priority = 445151652; */ @@ -77,7 +77,7 @@ class FirewallPolicyRule extends \Google\Protobuf\Internal\Message */ private $rule_tuple_count = null; /** - * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. * * Generated from protobuf field optional string security_profile_group = 207411626; */ @@ -114,7 +114,7 @@ class FirewallPolicyRule extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $action - * The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + * The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". * @type string $description * An optional description for this resource. * @type string $direction @@ -125,17 +125,17 @@ class FirewallPolicyRule extends \Google\Protobuf\Internal\Message * @type bool $enable_logging * Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. * @type string $kind - * [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + * [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. * @type \Google\Cloud\Compute\V1\FirewallPolicyRuleMatcher $match * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. * @type int $priority - * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. * @type string $rule_name * An optional name for the rule. This field is not a unique identifier and can be updated. * @type int $rule_tuple_count * [Output Only] Calculation of the complexity of a single firewall policy rule. * @type string $security_profile_group - * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. * @type array|\Google\Protobuf\Internal\RepeatedField $target_resources * A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. * @type array<\Google\Cloud\Compute\V1\FirewallPolicyRuleSecureTag>|\Google\Protobuf\Internal\RepeatedField $target_secure_tags @@ -152,7 +152,7 @@ public function __construct($data = NULL) { } /** - * The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + * The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". * * Generated from protobuf field optional string action = 187661878; * @return string @@ -173,7 +173,7 @@ public function clearAction() } /** - * The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + * The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". * * Generated from protobuf field optional string action = 187661878; * @param string $var @@ -334,7 +334,7 @@ public function setEnableLogging($var) } /** - * [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + * [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. * * Generated from protobuf field optional string kind = 3292052; * @return string @@ -355,7 +355,7 @@ public function clearKind() } /** - * [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + * [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. * * Generated from protobuf field optional string kind = 3292052; * @param string $var @@ -406,7 +406,7 @@ public function setMatch($var) } /** - * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. * * Generated from protobuf field optional int32 priority = 445151652; * @return int @@ -427,7 +427,7 @@ public function clearPriority() } /** - * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. * * Generated from protobuf field optional int32 priority = 445151652; * @param int $var @@ -514,7 +514,7 @@ public function setRuleTupleCount($var) } /** - * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. * * Generated from protobuf field optional string security_profile_group = 207411626; * @return string @@ -535,7 +535,7 @@ public function clearSecurityProfileGroup() } /** - * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. * * Generated from protobuf field optional string security_profile_group = 207411626; * @param string $var diff --git a/Compute/src/V1/Gapic/BackendServicesGapicClient.php b/Compute/src/V1/Gapic/BackendServicesGapicClient.php index 47af2d7356a9..fbc01acfa249 100644 --- a/Compute/src/V1/Gapic/BackendServicesGapicClient.php +++ b/Compute/src/V1/Gapic/BackendServicesGapicClient.php @@ -892,7 +892,7 @@ public function list($project, array $optionalArgs = []) } /** - * Retrieves an aggregated list of all usable backend services in the specified project. + * Retrieves a list of all usable backend services in the specified project. * * Sample code: * ``` diff --git a/Compute/src/V1/Gapic/GlobalOperationsGapicClient.php b/Compute/src/V1/Gapic/GlobalOperationsGapicClient.php index 8743ee3be834..8230cd17901d 100644 --- a/Compute/src/V1/Gapic/GlobalOperationsGapicClient.php +++ b/Compute/src/V1/Gapic/GlobalOperationsGapicClient.php @@ -302,7 +302,7 @@ public function aggregatedList($project, array $optionalArgs = []) * } * ``` * - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * @param string $project Project ID for this request. * @param array $optionalArgs { * Optional. @@ -345,7 +345,7 @@ public function delete($operation, $project, array $optionalArgs = []) * } * ``` * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param array $optionalArgs { * Optional. @@ -472,7 +472,7 @@ public function list($project, array $optionalArgs = []) * } * ``` * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param array $optionalArgs { * Optional. diff --git a/Compute/src/V1/Gapic/GlobalOrganizationOperationsGapicClient.php b/Compute/src/V1/Gapic/GlobalOrganizationOperationsGapicClient.php index 1093d5069a0a..cbdaacbdc78d 100644 --- a/Compute/src/V1/Gapic/GlobalOrganizationOperationsGapicClient.php +++ b/Compute/src/V1/Gapic/GlobalOrganizationOperationsGapicClient.php @@ -190,7 +190,7 @@ public function __construct(array $options = []) * } * ``` * - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * @param array $optionalArgs { * Optional. * @@ -235,7 +235,7 @@ public function delete($operation, array $optionalArgs = []) * } * ``` * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param array $optionalArgs { * Optional. * diff --git a/Compute/src/V1/Gapic/NetworksGapicClient.php b/Compute/src/V1/Gapic/NetworksGapicClient.php index 97d449b9fde5..44b9e4c55089 100644 --- a/Compute/src/V1/Gapic/NetworksGapicClient.php +++ b/Compute/src/V1/Gapic/NetworksGapicClient.php @@ -766,7 +766,7 @@ public function listPeeringRoutes($network, $project, array $optionalArgs = []) } /** - * Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. + * Patches the specified network with the data included in the request. Only routingConfig can be modified. * * Sample code: * ``` diff --git a/Compute/src/V1/Gapic/RegionBackendServicesGapicClient.php b/Compute/src/V1/Gapic/RegionBackendServicesGapicClient.php index 16934d2cffeb..4ab93bc2c854 100644 --- a/Compute/src/V1/Gapic/RegionBackendServicesGapicClient.php +++ b/Compute/src/V1/Gapic/RegionBackendServicesGapicClient.php @@ -665,7 +665,7 @@ public function list($project, $region, array $optionalArgs = []) } /** - * Retrieves an aggregated list of all usable backend services in the specified project in the given region. + * Retrieves a list of all usable backend services in the specified project in the given region. * * Sample code: * ``` diff --git a/Compute/src/V1/Gapic/RegionOperationsGapicClient.php b/Compute/src/V1/Gapic/RegionOperationsGapicClient.php index 4dd06fed7b25..8b30f44522b7 100644 --- a/Compute/src/V1/Gapic/RegionOperationsGapicClient.php +++ b/Compute/src/V1/Gapic/RegionOperationsGapicClient.php @@ -195,7 +195,7 @@ public function __construct(array $options = []) * } * ``` * - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $region Name of the region for this request. * @param array $optionalArgs { @@ -242,7 +242,7 @@ public function delete($operation, $project, $region, array $optionalArgs = []) * } * ``` * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $region Name of the region for this request. * @param array $optionalArgs { @@ -377,7 +377,7 @@ public function list($project, $region, array $optionalArgs = []) * } * ``` * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $region Name of the region for this request. * @param array $optionalArgs { diff --git a/Compute/src/V1/Gapic/RegionsGapicClient.php b/Compute/src/V1/Gapic/RegionsGapicClient.php index cfc373a15061..e1a8cb070d32 100644 --- a/Compute/src/V1/Gapic/RegionsGapicClient.php +++ b/Compute/src/V1/Gapic/RegionsGapicClient.php @@ -177,7 +177,7 @@ public function __construct(array $options = []) } /** - * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * Sample code: * ``` @@ -220,7 +220,7 @@ public function get($project, $region, array $optionalArgs = []) } /** - * Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * Sample code: * ``` diff --git a/Compute/src/V1/Gapic/StoragePoolsGapicClient.php b/Compute/src/V1/Gapic/StoragePoolsGapicClient.php index bfcb752f50c3..9e0b78f99023 100644 --- a/Compute/src/V1/Gapic/StoragePoolsGapicClient.php +++ b/Compute/src/V1/Gapic/StoragePoolsGapicClient.php @@ -856,7 +856,7 @@ public function testIamPermissions($project, $resource, $testPermissionsRequestR } /** - * Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: size_tb and provisioned_iops. + * Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: pool_provisioned_capacity_gb, pool_provisioned_iops and pool_provisioned_throughput. * * Sample code: * ``` diff --git a/Compute/src/V1/Gapic/ZoneOperationsGapicClient.php b/Compute/src/V1/Gapic/ZoneOperationsGapicClient.php index b42825cb0a40..e437a84c6c4c 100644 --- a/Compute/src/V1/Gapic/ZoneOperationsGapicClient.php +++ b/Compute/src/V1/Gapic/ZoneOperationsGapicClient.php @@ -195,7 +195,7 @@ public function __construct(array $options = []) * } * ``` * - * @param string $operation Name of the Operations resource to delete. + * @param string $operation Name of the Operations resource to delete, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. * @param array $optionalArgs { @@ -242,7 +242,7 @@ public function delete($operation, $project, $zone, array $optionalArgs = []) * } * ``` * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. * @param array $optionalArgs { @@ -377,7 +377,7 @@ public function list($project, $zone, array $optionalArgs = []) * } * ``` * - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. * @param array $optionalArgs { diff --git a/Compute/src/V1/GetGlobalOperationRequest.php b/Compute/src/V1/GetGlobalOperationRequest.php index c97f23078684..a42a0fd6a3f2 100644 --- a/Compute/src/V1/GetGlobalOperationRequest.php +++ b/Compute/src/V1/GetGlobalOperationRequest.php @@ -16,7 +16,7 @@ class GetGlobalOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; */ @@ -30,7 +30,7 @@ class GetGlobalOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\GetGlobalOperationRequest * @@ -50,7 +50,7 @@ public static function build(string $project, string $operation): self * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * @type string $project * Project ID for this request. * } @@ -61,7 +61,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; * @return string @@ -72,7 +72,7 @@ public function getOperation() } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; * @param string $var diff --git a/Compute/src/V1/GetGlobalOrganizationOperationRequest.php b/Compute/src/V1/GetGlobalOrganizationOperationRequest.php index d8df15e54e3d..313d7f32189d 100644 --- a/Compute/src/V1/GetGlobalOrganizationOperationRequest.php +++ b/Compute/src/V1/GetGlobalOrganizationOperationRequest.php @@ -16,7 +16,7 @@ class GetGlobalOrganizationOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; */ @@ -29,7 +29,7 @@ class GetGlobalOrganizationOperationRequest extends \Google\Protobuf\Internal\Me private $parent_id = null; /** - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\GetGlobalOrganizationOperationRequest * @@ -48,7 +48,7 @@ public static function build(string $operation): self * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * @type string $parent_id * Parent ID for this request. * } @@ -59,7 +59,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; * @return string @@ -70,7 +70,7 @@ public function getOperation() } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; * @param string $var diff --git a/Compute/src/V1/GetRegionOperationRequest.php b/Compute/src/V1/GetRegionOperationRequest.php index d773bf3af998..9cec9398a711 100644 --- a/Compute/src/V1/GetRegionOperationRequest.php +++ b/Compute/src/V1/GetRegionOperationRequest.php @@ -16,7 +16,7 @@ class GetRegionOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; */ @@ -37,7 +37,7 @@ class GetRegionOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. * @param string $region Name of the region for this request. - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\GetRegionOperationRequest * @@ -58,7 +58,7 @@ public static function build(string $project, string $region, string $operation) * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * @type string $project * Project ID for this request. * @type string $region @@ -71,7 +71,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; * @return string @@ -82,7 +82,7 @@ public function getOperation() } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; * @param string $var diff --git a/Compute/src/V1/GetZoneOperationRequest.php b/Compute/src/V1/GetZoneOperationRequest.php index ca0e5d27f39f..9fb49eb15b6b 100644 --- a/Compute/src/V1/GetZoneOperationRequest.php +++ b/Compute/src/V1/GetZoneOperationRequest.php @@ -16,7 +16,7 @@ class GetZoneOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; */ @@ -37,7 +37,7 @@ class GetZoneOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\GetZoneOperationRequest * @@ -58,7 +58,7 @@ public static function build(string $project, string $zone, string $operation): * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * @type string $project * Project ID for this request. * @type string $zone @@ -71,7 +71,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; * @return string @@ -82,7 +82,7 @@ public function getOperation() } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_response_field) = "name"]; * @param string $var diff --git a/Compute/src/V1/GuestOsFeature/Type.php b/Compute/src/V1/GuestOsFeature/Type.php index 12ee8211e990..3f735441d502 100644 --- a/Compute/src/V1/GuestOsFeature/Type.php +++ b/Compute/src/V1/GuestOsFeature/Type.php @@ -55,6 +55,10 @@ class Type * Generated from protobuf enum SEV_SNP_CAPABLE = 426919; */ const SEV_SNP_CAPABLE = 426919; + /** + * Generated from protobuf enum TDX_CAPABLE = 240446133; + */ + const TDX_CAPABLE = 240446133; /** * Generated from protobuf enum UEFI_COMPATIBLE = 195865408; */ @@ -79,6 +83,7 @@ class Type self::SEV_LIVE_MIGRATABLE => 'SEV_LIVE_MIGRATABLE', self::SEV_LIVE_MIGRATABLE_V2 => 'SEV_LIVE_MIGRATABLE_V2', self::SEV_SNP_CAPABLE => 'SEV_SNP_CAPABLE', + self::TDX_CAPABLE => 'TDX_CAPABLE', self::UEFI_COMPATIBLE => 'UEFI_COMPATIBLE', self::VIRTIO_SCSI_MULTIQUEUE => 'VIRTIO_SCSI_MULTIQUEUE', self::WINDOWS => 'WINDOWS', diff --git a/Compute/src/V1/HealthCheck.php b/Compute/src/V1/HealthCheck.php index edf90c5abba6..d3e37ad14f3c 100644 --- a/Compute/src/V1/HealthCheck.php +++ b/Compute/src/V1/HealthCheck.php @@ -91,6 +91,12 @@ class HealthCheck extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string self_link = 456214797; */ private $self_link = null; + /** + * The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. + * + * Generated from protobuf field repeated string source_regions = 405568475; + */ + private $source_regions; /** * Generated from protobuf field optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440; */ @@ -149,6 +155,8 @@ class HealthCheck extends \Google\Protobuf\Internal\Message * [Output Only] Region where the health check resides. Not applicable to global health checks. * @type string $self_link * [Output Only] Server-defined URL for the resource. + * @type array|\Google\Protobuf\Internal\RepeatedField $source_regions + * The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. * @type \Google\Cloud\Compute\V1\SSLHealthCheck $ssl_health_check * @type \Google\Cloud\Compute\V1\TCPHealthCheck $tcp_health_check * @type int $timeout_sec @@ -653,6 +661,32 @@ public function setSelfLink($var) return $this; } + /** + * The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. + * + * Generated from protobuf field repeated string source_regions = 405568475; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSourceRegions() + { + return $this->source_regions; + } + + /** + * The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. + * + * Generated from protobuf field repeated string source_regions = 405568475; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSourceRegions($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->source_regions = $arr; + + return $this; + } + /** * Generated from protobuf field optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440; * @return \Google\Cloud\Compute\V1\SSLHealthCheck|null diff --git a/Compute/src/V1/HealthStatus.php b/Compute/src/V1/HealthStatus.php index afd152502dfd..49dc4c7e0ec9 100644 --- a/Compute/src/V1/HealthStatus.php +++ b/Compute/src/V1/HealthStatus.php @@ -51,6 +51,17 @@ class HealthStatus extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string ip_address = 406272220; */ private $ip_address = null; + /** + * Generated from protobuf field optional string ipv6_address = 341563804; + */ + private $ipv6_address = null; + /** + * Health state of the IPv6 address of the instance. + * Check the Ipv6HealthState enum for the list of possible values. + * + * Generated from protobuf field optional string ipv6_health_state = 190316614; + */ + private $ipv6_health_state = null; /** * The named port of the instance group, not necessarily the port that is health-checked. * @@ -88,6 +99,10 @@ class HealthStatus extends \Google\Protobuf\Internal\Message * URL of the instance resource. * @type string $ip_address * For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip. + * @type string $ipv6_address + * @type string $ipv6_health_state + * Health state of the IPv6 address of the instance. + * Check the Ipv6HealthState enum for the list of possible values. * @type int $port * The named port of the instance group, not necessarily the port that is health-checked. * @type string $weight @@ -309,6 +324,76 @@ public function setIpAddress($var) return $this; } + /** + * Generated from protobuf field optional string ipv6_address = 341563804; + * @return string + */ + public function getIpv6Address() + { + return isset($this->ipv6_address) ? $this->ipv6_address : ''; + } + + public function hasIpv6Address() + { + return isset($this->ipv6_address); + } + + public function clearIpv6Address() + { + unset($this->ipv6_address); + } + + /** + * Generated from protobuf field optional string ipv6_address = 341563804; + * @param string $var + * @return $this + */ + public function setIpv6Address($var) + { + GPBUtil::checkString($var, True); + $this->ipv6_address = $var; + + return $this; + } + + /** + * Health state of the IPv6 address of the instance. + * Check the Ipv6HealthState enum for the list of possible values. + * + * Generated from protobuf field optional string ipv6_health_state = 190316614; + * @return string + */ + public function getIpv6HealthState() + { + return isset($this->ipv6_health_state) ? $this->ipv6_health_state : ''; + } + + public function hasIpv6HealthState() + { + return isset($this->ipv6_health_state); + } + + public function clearIpv6HealthState() + { + unset($this->ipv6_health_state); + } + + /** + * Health state of the IPv6 address of the instance. + * Check the Ipv6HealthState enum for the list of possible values. + * + * Generated from protobuf field optional string ipv6_health_state = 190316614; + * @param string $var + * @return $this + */ + public function setIpv6HealthState($var) + { + GPBUtil::checkString($var, True); + $this->ipv6_health_state = $var; + + return $this; + } + /** * The named port of the instance group, not necessarily the port that is health-checked. * diff --git a/Compute/src/V1/HealthStatus/HealthState.php b/Compute/src/V1/HealthStatus/HealthState.php index b4267b7503dc..115a54e966ba 100644 --- a/Compute/src/V1/HealthStatus/HealthState.php +++ b/Compute/src/V1/HealthStatus/HealthState.php @@ -8,6 +8,9 @@ /** * Health state of the IPv4 address of the instance. + * Additional supported values which may be not listed in the enum directly due to technical reasons: + * HEALTHY + * UNHEALTHY * * Protobuf type google.cloud.compute.v1.HealthStatus.HealthState */ diff --git a/Compute/src/V1/HealthStatus/Ipv6HealthState.php b/Compute/src/V1/HealthStatus/Ipv6HealthState.php new file mode 100644 index 000000000000..780d17146eca --- /dev/null +++ b/Compute/src/V1/HealthStatus/Ipv6HealthState.php @@ -0,0 +1,51 @@ +google.cloud.compute.v1.HealthStatus.Ipv6HealthState + */ +class Ipv6HealthState +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_IPV6_HEALTH_STATE = 0; + */ + const UNDEFINED_IPV6_HEALTH_STATE = 0; + + private static $valueToName = [ + self::UNDEFINED_IPV6_HEALTH_STATE => 'UNDEFINED_IPV6_HEALTH_STATE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/HealthStatusForNetworkEndpoint.php b/Compute/src/V1/HealthStatusForNetworkEndpoint.php index 48c129c6c955..1371816da1e2 100644 --- a/Compute/src/V1/HealthStatusForNetworkEndpoint.php +++ b/Compute/src/V1/HealthStatusForNetworkEndpoint.php @@ -45,6 +45,13 @@ class HealthStatusForNetworkEndpoint extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string health_state = 324007150; */ private $health_state = null; + /** + * Health state of the ipv6 network endpoint determined based on the health checks configured. + * Check the Ipv6HealthState enum for the list of possible values. + * + * Generated from protobuf field optional string ipv6_health_state = 190316614; + */ + private $ipv6_health_state = null; /** * Constructor. @@ -63,6 +70,9 @@ class HealthStatusForNetworkEndpoint extends \Google\Protobuf\Internal\Message * @type string $health_state * Health state of the network endpoint determined based on the health checks configured. * Check the HealthState enum for the list of possible values. + * @type string $ipv6_health_state + * Health state of the ipv6 network endpoint determined based on the health checks configured. + * Check the Ipv6HealthState enum for the list of possible values. * } */ public function __construct($data = NULL) { @@ -252,5 +262,43 @@ public function setHealthState($var) return $this; } + /** + * Health state of the ipv6 network endpoint determined based on the health checks configured. + * Check the Ipv6HealthState enum for the list of possible values. + * + * Generated from protobuf field optional string ipv6_health_state = 190316614; + * @return string + */ + public function getIpv6HealthState() + { + return isset($this->ipv6_health_state) ? $this->ipv6_health_state : ''; + } + + public function hasIpv6HealthState() + { + return isset($this->ipv6_health_state); + } + + public function clearIpv6HealthState() + { + unset($this->ipv6_health_state); + } + + /** + * Health state of the ipv6 network endpoint determined based on the health checks configured. + * Check the Ipv6HealthState enum for the list of possible values. + * + * Generated from protobuf field optional string ipv6_health_state = 190316614; + * @param string $var + * @return $this + */ + public function setIpv6HealthState($var) + { + GPBUtil::checkString($var, True); + $this->ipv6_health_state = $var; + + return $this; + } + } diff --git a/Compute/src/V1/HealthStatusForNetworkEndpoint/HealthState.php b/Compute/src/V1/HealthStatusForNetworkEndpoint/HealthState.php index c2c48cfd29dd..d3f5ab347ba3 100644 --- a/Compute/src/V1/HealthStatusForNetworkEndpoint/HealthState.php +++ b/Compute/src/V1/HealthStatusForNetworkEndpoint/HealthState.php @@ -8,6 +8,11 @@ /** * Health state of the network endpoint determined based on the health checks configured. + * Additional supported values which may be not listed in the enum directly due to technical reasons: + * DRAINING + * HEALTHY + * UNHEALTHY + * UNKNOWN * * Protobuf type google.cloud.compute.v1.HealthStatusForNetworkEndpoint.HealthState */ @@ -20,26 +25,18 @@ class HealthState */ const UNDEFINED_HEALTH_STATE = 0; /** - * Endpoint is being drained. - * * Generated from protobuf enum DRAINING = 480455402; */ const DRAINING = 480455402; /** - * Endpoint is healthy. - * * Generated from protobuf enum HEALTHY = 439801213; */ const HEALTHY = 439801213; /** - * Endpoint is unhealthy. - * * Generated from protobuf enum UNHEALTHY = 462118084; */ const UNHEALTHY = 462118084; /** - * Health status of the endpoint is unknown. - * * Generated from protobuf enum UNKNOWN = 433141802; */ const UNKNOWN = 433141802; diff --git a/Compute/src/V1/HealthStatusForNetworkEndpoint/Ipv6HealthState.php b/Compute/src/V1/HealthStatusForNetworkEndpoint/Ipv6HealthState.php new file mode 100644 index 000000000000..311d9bb3d5dd --- /dev/null +++ b/Compute/src/V1/HealthStatusForNetworkEndpoint/Ipv6HealthState.php @@ -0,0 +1,53 @@ +google.cloud.compute.v1.HealthStatusForNetworkEndpoint.Ipv6HealthState + */ +class Ipv6HealthState +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_IPV6_HEALTH_STATE = 0; + */ + const UNDEFINED_IPV6_HEALTH_STATE = 0; + + private static $valueToName = [ + self::UNDEFINED_IPV6_HEALTH_STATE => 'UNDEFINED_IPV6_HEALTH_STATE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/HttpRouteRule.php b/Compute/src/V1/HttpRouteRule.php index 835d3a8e1d64..e793c10ba75a 100644 --- a/Compute/src/V1/HttpRouteRule.php +++ b/Compute/src/V1/HttpRouteRule.php @@ -15,6 +15,12 @@ */ class HttpRouteRule extends \Google\Protobuf\Internal\Message { + /** + * customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the RouteRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with routeRules.routeAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the customErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the customErrorResponsePolicy is ignored and the response from the service is returned to the client. customErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619; + */ + private $custom_error_response_policy = null; /** * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. * @@ -64,6 +70,8 @@ class HttpRouteRule extends \Google\Protobuf\Internal\Message * @param array $data { * Optional. Data for populating the Message object. * + * @type \Google\Cloud\Compute\V1\CustomErrorResponsePolicy $custom_error_response_policy + * customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the RouteRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with routeRules.routeAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the customErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the customErrorResponsePolicy is ignored and the response from the service is returned to the client. customErrorResponsePolicy is supported only for global external Application Load Balancers. * @type string $description * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. * @type \Google\Cloud\Compute\V1\HttpHeaderAction $header_action @@ -85,6 +93,42 @@ public function __construct($data = NULL) { parent::__construct($data); } + /** + * customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the RouteRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with routeRules.routeAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the customErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the customErrorResponsePolicy is ignored and the response from the service is returned to the client. customErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619; + * @return \Google\Cloud\Compute\V1\CustomErrorResponsePolicy|null + */ + public function getCustomErrorResponsePolicy() + { + return $this->custom_error_response_policy; + } + + public function hasCustomErrorResponsePolicy() + { + return isset($this->custom_error_response_policy); + } + + public function clearCustomErrorResponsePolicy() + { + unset($this->custom_error_response_policy); + } + + /** + * customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the RouteRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with routeRules.routeAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the customErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the customErrorResponsePolicy is ignored and the response from the service is returned to the client. customErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619; + * @param \Google\Cloud\Compute\V1\CustomErrorResponsePolicy $var + * @return $this + */ + public function setCustomErrorResponsePolicy($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\CustomErrorResponsePolicy::class); + $this->custom_error_response_policy = $var; + + return $this; + } + /** * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. * diff --git a/Compute/src/V1/InstanceGroupManager.php b/Compute/src/V1/InstanceGroupManager.php index 236c70441257..815f28e6c1ac 100644 --- a/Compute/src/V1/InstanceGroupManager.php +++ b/Compute/src/V1/InstanceGroupManager.php @@ -28,7 +28,7 @@ class InstanceGroupManager extends \Google\Protobuf\Internal\Message */ private $auto_healing_policies; /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) * * Generated from protobuf field optional string base_instance_name = 389106439; */ @@ -69,6 +69,12 @@ class InstanceGroupManager extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional uint64 id = 3355; */ private $id = null; + /** + * Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + * + * Generated from protobuf field optional .google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicy instance_flexibility_policy = 26937090; + */ + private $instance_flexibility_policy = null; /** * [Output Only] The URL of the Instance Group resource. * @@ -107,7 +113,7 @@ class InstanceGroupManager extends \Google\Protobuf\Internal\Message */ private $name = null; /** - * Named ports configured for the Instance Groups complementary to this Instance Group Manager. + * [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. * * Generated from protobuf field repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732; */ @@ -118,6 +124,18 @@ class InstanceGroupManager extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string region = 138946292; */ private $region = null; + /** + * [Output Only] Reserved for future use. + * + * Generated from protobuf field optional bool satisfies_pzi = 480964257; + */ + private $satisfies_pzi = null; + /** + * [Output Only] Reserved for future use. + * + * Generated from protobuf field optional bool satisfies_pzs = 480964267; + */ + private $satisfies_pzs = null; /** * [Output Only] The URL for this managed instance group. The server defines this URL. * @@ -178,7 +196,7 @@ class InstanceGroupManager extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\Compute\V1\InstanceGroupManagerAutoHealingPolicy>|\Google\Protobuf\Internal\RepeatedField $auto_healing_policies * The autohealing policy for this managed instance group. You can specify only one value. * @type string $base_instance_name - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) * @type string $creation_timestamp * [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. * @type \Google\Cloud\Compute\V1\InstanceGroupManagerActionsSummary $current_actions @@ -191,6 +209,8 @@ class InstanceGroupManager extends \Google\Protobuf\Internal\Message * Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. * @type int|string $id * [Output Only] A unique identifier for this resource type. The server generates this identifier. + * @type \Google\Cloud\Compute\V1\InstanceGroupManagerInstanceFlexibilityPolicy $instance_flexibility_policy + * Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. * @type string $instance_group * [Output Only] The URL of the Instance Group resource. * @type \Google\Cloud\Compute\V1\InstanceGroupManagerInstanceLifecyclePolicy $instance_lifecycle_policy @@ -205,9 +225,13 @@ class InstanceGroupManager extends \Google\Protobuf\Internal\Message * @type string $name * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. * @type array<\Google\Cloud\Compute\V1\NamedPort>|\Google\Protobuf\Internal\RepeatedField $named_ports - * Named ports configured for the Instance Groups complementary to this Instance Group Manager. + * [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. * @type string $region * [Output Only] The URL of the region where the managed instance group resides (for regional resources). + * @type bool $satisfies_pzi + * [Output Only] Reserved for future use. + * @type bool $satisfies_pzs + * [Output Only] Reserved for future use. * @type string $self_link * [Output Only] The URL for this managed instance group. The server defines this URL. * @type \Google\Cloud\Compute\V1\StatefulPolicy $stateful_policy @@ -294,7 +318,7 @@ public function setAutoHealingPolicies($var) } /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) * * Generated from protobuf field optional string base_instance_name = 389106439; * @return string @@ -315,7 +339,7 @@ public function clearBaseInstanceName() } /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) * * Generated from protobuf field optional string base_instance_name = 389106439; * @param string $var @@ -545,6 +569,42 @@ public function setId($var) return $this; } + /** + * Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + * + * Generated from protobuf field optional .google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicy instance_flexibility_policy = 26937090; + * @return \Google\Cloud\Compute\V1\InstanceGroupManagerInstanceFlexibilityPolicy|null + */ + public function getInstanceFlexibilityPolicy() + { + return $this->instance_flexibility_policy; + } + + public function hasInstanceFlexibilityPolicy() + { + return isset($this->instance_flexibility_policy); + } + + public function clearInstanceFlexibilityPolicy() + { + unset($this->instance_flexibility_policy); + } + + /** + * Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + * + * Generated from protobuf field optional .google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicy instance_flexibility_policy = 26937090; + * @param \Google\Cloud\Compute\V1\InstanceGroupManagerInstanceFlexibilityPolicy $var + * @return $this + */ + public function setInstanceFlexibilityPolicy($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\InstanceGroupManagerInstanceFlexibilityPolicy::class); + $this->instance_flexibility_policy = $var; + + return $this; + } + /** * [Output Only] The URL of the Instance Group resource. * @@ -764,7 +824,7 @@ public function setName($var) } /** - * Named ports configured for the Instance Groups complementary to this Instance Group Manager. + * [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. * * Generated from protobuf field repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732; * @return \Google\Protobuf\Internal\RepeatedField @@ -775,7 +835,7 @@ public function getNamedPorts() } /** - * Named ports configured for the Instance Groups complementary to this Instance Group Manager. + * [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. * * Generated from protobuf field repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732; * @param array<\Google\Cloud\Compute\V1\NamedPort>|\Google\Protobuf\Internal\RepeatedField $var @@ -825,6 +885,78 @@ public function setRegion($var) return $this; } + /** + * [Output Only] Reserved for future use. + * + * Generated from protobuf field optional bool satisfies_pzi = 480964257; + * @return bool + */ + public function getSatisfiesPzi() + { + return isset($this->satisfies_pzi) ? $this->satisfies_pzi : false; + } + + public function hasSatisfiesPzi() + { + return isset($this->satisfies_pzi); + } + + public function clearSatisfiesPzi() + { + unset($this->satisfies_pzi); + } + + /** + * [Output Only] Reserved for future use. + * + * Generated from protobuf field optional bool satisfies_pzi = 480964257; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzi($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzi = $var; + + return $this; + } + + /** + * [Output Only] Reserved for future use. + * + * Generated from protobuf field optional bool satisfies_pzs = 480964267; + * @return bool + */ + public function getSatisfiesPzs() + { + return isset($this->satisfies_pzs) ? $this->satisfies_pzs : false; + } + + public function hasSatisfiesPzs() + { + return isset($this->satisfies_pzs); + } + + public function clearSatisfiesPzs() + { + unset($this->satisfies_pzs); + } + + /** + * [Output Only] Reserved for future use. + * + * Generated from protobuf field optional bool satisfies_pzs = 480964267; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + /** * [Output Only] The URL for this managed instance group. The server defines this URL. * diff --git a/Compute/src/V1/InstanceGroupManagerInstanceFlexibilityPolicy.php b/Compute/src/V1/InstanceGroupManagerInstanceFlexibilityPolicy.php new file mode 100644 index 000000000000..db544835c61d --- /dev/null +++ b/Compute/src/V1/InstanceGroupManagerInstanceFlexibilityPolicy.php @@ -0,0 +1,66 @@ +google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicy + */ +class InstanceGroupManagerInstanceFlexibilityPolicy extends \Google\Protobuf\Internal\Message +{ + /** + * Named instance selections configuring properties that the group will use when creating new VMs. + * + * Generated from protobuf field map instance_selections = 22954577; + */ + private $instance_selections; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\MapField $instance_selections + * Named instance selections configuring properties that the group will use when creating new VMs. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * Named instance selections configuring properties that the group will use when creating new VMs. + * + * Generated from protobuf field map instance_selections = 22954577; + * @return \Google\Protobuf\Internal\MapField + */ + public function getInstanceSelections() + { + return $this->instance_selections; + } + + /** + * Named instance selections configuring properties that the group will use when creating new VMs. + * + * Generated from protobuf field map instance_selections = 22954577; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setInstanceSelections($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Compute\V1\InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection::class); + $this->instance_selections = $arr; + + return $this; + } + +} + diff --git a/Compute/src/V1/InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection.php b/Compute/src/V1/InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection.php new file mode 100644 index 000000000000..3cb094dee9e3 --- /dev/null +++ b/Compute/src/V1/InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection.php @@ -0,0 +1,110 @@ +google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection + */ +class InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection extends \Google\Protobuf\Internal\Message +{ + /** + * Full machine-type names, e.g. "n1-standard-16". + * + * Generated from protobuf field repeated string machine_types = 79720065; + */ + private $machine_types; + /** + * Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + * + * Generated from protobuf field optional int32 rank = 3492908; + */ + private $rank = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $machine_types + * Full machine-type names, e.g. "n1-standard-16". + * @type int $rank + * Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * Full machine-type names, e.g. "n1-standard-16". + * + * Generated from protobuf field repeated string machine_types = 79720065; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMachineTypes() + { + return $this->machine_types; + } + + /** + * Full machine-type names, e.g. "n1-standard-16". + * + * Generated from protobuf field repeated string machine_types = 79720065; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMachineTypes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->machine_types = $arr; + + return $this; + } + + /** + * Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + * + * Generated from protobuf field optional int32 rank = 3492908; + * @return int + */ + public function getRank() + { + return isset($this->rank) ? $this->rank : 0; + } + + public function hasRank() + { + return isset($this->rank); + } + + public function clearRank() + { + unset($this->rank); + } + + /** + * Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + * + * Generated from protobuf field optional int32 rank = 3492908; + * @param int $var + * @return $this + */ + public function setRank($var) + { + GPBUtil::checkInt32($var); + $this->rank = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/InstanceGroupManagerResizeRequest.php b/Compute/src/V1/InstanceGroupManagerResizeRequest.php index 6fb64ac43964..844fd11d49be 100644 --- a/Compute/src/V1/InstanceGroupManagerResizeRequest.php +++ b/Compute/src/V1/InstanceGroupManagerResizeRequest.php @@ -52,7 +52,7 @@ class InstanceGroupManagerResizeRequest extends \Google\Protobuf\Internal\Messag */ private $requested_run_duration = null; /** - * The number of instances to be created by this resize request. The group's target size will be increased by this number. + * The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'. * * Generated from protobuf field optional int32 resize_by = 533735362; */ @@ -108,7 +108,7 @@ class InstanceGroupManagerResizeRequest extends \Google\Protobuf\Internal\Messag * @type \Google\Cloud\Compute\V1\Duration $requested_run_duration * Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted. * @type int $resize_by - * The number of instances to be created by this resize request. The group's target size will be increased by this number. + * The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'. * @type string $self_link * [Output Only] The URL for this resize request. The server defines this URL. * @type string $self_link_with_id @@ -344,7 +344,7 @@ public function setRequestedRunDuration($var) } /** - * The number of instances to be created by this resize request. The group's target size will be increased by this number. + * The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'. * * Generated from protobuf field optional int32 resize_by = 533735362; * @return int @@ -365,7 +365,7 @@ public function clearResizeBy() } /** - * The number of instances to be created by this resize request. The group's target size will be increased by this number. + * The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'. * * Generated from protobuf field optional int32 resize_by = 533735362; * @param int $var diff --git a/Compute/src/V1/InstanceProperties.php b/Compute/src/V1/InstanceProperties.php index e22b719f268b..b518ba627f2d 100644 --- a/Compute/src/V1/InstanceProperties.php +++ b/Compute/src/V1/InstanceProperties.php @@ -64,7 +64,7 @@ class InstanceProperties extends \Google\Protobuf\Internal\Message */ private $labels; /** - * The machine type to use for instances that are created from these properties. + * The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, the request will result in an `INTERNAL_ERROR`. * * Generated from protobuf field optional string machine_type = 227711026; */ @@ -167,7 +167,7 @@ class InstanceProperties extends \Google\Protobuf\Internal\Message * @type array|\Google\Protobuf\Internal\MapField $labels * Labels to apply to instances that are created from these properties. * @type string $machine_type - * The machine type to use for instances that are created from these properties. + * The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, the request will result in an `INTERNAL_ERROR`. * @type \Google\Cloud\Compute\V1\Metadata $metadata * The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. * @type string $min_cpu_platform @@ -461,7 +461,7 @@ public function setLabels($var) } /** - * The machine type to use for instances that are created from these properties. + * The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, the request will result in an `INTERNAL_ERROR`. * * Generated from protobuf field optional string machine_type = 227711026; * @return string @@ -482,7 +482,7 @@ public function clearMachineType() } /** - * The machine type to use for instances that are created from these properties. + * The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, the request will result in an `INTERNAL_ERROR`. * * Generated from protobuf field optional string machine_type = 227711026; * @param string $var diff --git a/Compute/src/V1/InstancesGetEffectiveFirewallsResponse.php b/Compute/src/V1/InstancesGetEffectiveFirewallsResponse.php index b564751eab7a..765e1dc39e0f 100644 --- a/Compute/src/V1/InstancesGetEffectiveFirewallsResponse.php +++ b/Compute/src/V1/InstancesGetEffectiveFirewallsResponse.php @@ -15,7 +15,7 @@ class InstancesGetEffectiveFirewallsResponse extends \Google\Protobuf\Internal\Message { /** - * Effective firewalls from firewall policies. + * [Output Only] Effective firewalls from firewall policies. * * Generated from protobuf field repeated .google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; */ @@ -34,7 +34,7 @@ class InstancesGetEffectiveFirewallsResponse extends \Google\Protobuf\Internal\M * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Compute\V1\InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy>|\Google\Protobuf\Internal\RepeatedField $firewall_policys - * Effective firewalls from firewall policies. + * [Output Only] Effective firewalls from firewall policies. * @type array<\Google\Cloud\Compute\V1\Firewall>|\Google\Protobuf\Internal\RepeatedField $firewalls * Effective firewalls on the instance. * } @@ -45,7 +45,7 @@ public function __construct($data = NULL) { } /** - * Effective firewalls from firewall policies. + * [Output Only] Effective firewalls from firewall policies. * * Generated from protobuf field repeated .google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; * @return \Google\Protobuf\Internal\RepeatedField @@ -56,7 +56,7 @@ public function getFirewallPolicys() } /** - * Effective firewalls from firewall policies. + * [Output Only] Effective firewalls from firewall policies. * * Generated from protobuf field repeated .google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; * @param array<\Google\Cloud\Compute\V1\InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Compute/src/V1/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php b/Compute/src/V1/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php index 7688cfb964de..aaf163dad68e 100644 --- a/Compute/src/V1/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php +++ b/Compute/src/V1/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php @@ -27,7 +27,13 @@ class InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy extends \Goo */ private $name = null; /** - * The rules that apply to the network. + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + * + * Generated from protobuf field optional int32 priority = 445151652; + */ + private $priority = null; + /** + * [Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; */ @@ -56,8 +62,10 @@ class InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy extends \Goo * [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. * @type string $name * [Output Only] The name of the firewall policy. + * @type int $priority + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. * @type array<\Google\Cloud\Compute\V1\FirewallPolicyRule>|\Google\Protobuf\Internal\RepeatedField $rules - * The rules that apply to the network. + * [Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules. * @type string $short_name * [Output Only] The short name of the firewall policy. * @type string $type @@ -143,7 +151,43 @@ public function setName($var) } /** - * The rules that apply to the network. + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + * + * Generated from protobuf field optional int32 priority = 445151652; + * @return int + */ + public function getPriority() + { + return isset($this->priority) ? $this->priority : 0; + } + + public function hasPriority() + { + return isset($this->priority); + } + + public function clearPriority() + { + unset($this->priority); + } + + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + * + * Generated from protobuf field optional int32 priority = 445151652; + * @param int $var + * @return $this + */ + public function setPriority($var) + { + GPBUtil::checkInt32($var); + $this->priority = $var; + + return $this; + } + + /** + * [Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; * @return \Google\Protobuf\Internal\RepeatedField @@ -154,7 +198,7 @@ public function getRules() } /** - * The rules that apply to the network. + * [Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; * @param array<\Google\Cloud\Compute\V1\FirewallPolicyRule>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Compute/src/V1/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy/Type.php b/Compute/src/V1/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy/Type.php index 00d339e66e23..166ce64cb02b 100644 --- a/Compute/src/V1/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy/Type.php +++ b/Compute/src/V1/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy/Type.php @@ -31,6 +31,14 @@ class Type * Generated from protobuf enum NETWORK_REGIONAL = 190804272; */ const NETWORK_REGIONAL = 190804272; + /** + * Generated from protobuf enum SYSTEM_GLOBAL = 60099507; + */ + const SYSTEM_GLOBAL = 60099507; + /** + * Generated from protobuf enum SYSTEM_REGIONAL = 161777199; + */ + const SYSTEM_REGIONAL = 161777199; /** * Generated from protobuf enum UNSPECIFIED = 526786327; */ @@ -41,6 +49,8 @@ class Type self::HIERARCHY => 'HIERARCHY', self::NETWORK => 'NETWORK', self::NETWORK_REGIONAL => 'NETWORK_REGIONAL', + self::SYSTEM_GLOBAL => 'SYSTEM_GLOBAL', + self::SYSTEM_REGIONAL => 'SYSTEM_REGIONAL', self::UNSPECIFIED => 'UNSPECIFIED', ]; diff --git a/Compute/src/V1/Interconnect.php b/Compute/src/V1/Interconnect.php index 823e57ea4387..052cc42ed9c0 100644 --- a/Compute/src/V1/Interconnect.php +++ b/Compute/src/V1/Interconnect.php @@ -22,7 +22,7 @@ class Interconnect extends \Google\Protobuf\Internal\Message */ private $admin_enabled = null; /** - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. * Check the AvailableFeatures enum for the list of possible values. * * Generated from protobuf field repeated string available_features = 496344307; @@ -170,7 +170,7 @@ class Interconnect extends \Google\Protobuf\Internal\Message */ private $remote_location = null; /** - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. * Check the RequestedFeatures enum for the list of possible values. * * Generated from protobuf field repeated string requested_features = 461240814; @@ -211,7 +211,7 @@ class Interconnect extends \Google\Protobuf\Internal\Message * @type bool $admin_enabled * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. * @type array|\Google\Protobuf\Internal\RepeatedField $available_features - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. * Check the AvailableFeatures enum for the list of possible values. * @type array<\Google\Cloud\Compute\V1\InterconnectCircuitInfo>|\Google\Protobuf\Internal\RepeatedField $circuit_infos * [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. @@ -263,7 +263,7 @@ class Interconnect extends \Google\Protobuf\Internal\Message * @type string $remote_location * Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. * @type array|\Google\Protobuf\Internal\RepeatedField $requested_features - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. * Check the RequestedFeatures enum for the list of possible values. * @type int $requested_link_count * Target number of physical links in the link bundle, as requested by the customer. @@ -318,7 +318,7 @@ public function setAdminEnabled($var) } /** - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. * Check the AvailableFeatures enum for the list of possible values. * * Generated from protobuf field repeated string available_features = 496344307; @@ -330,7 +330,7 @@ public function getAvailableFeatures() } /** - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. * Check the AvailableFeatures enum for the list of possible values. * * Generated from protobuf field repeated string available_features = 496344307; @@ -1140,7 +1140,7 @@ public function setRemoteLocation($var) } /** - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. * Check the RequestedFeatures enum for the list of possible values. * * Generated from protobuf field repeated string requested_features = 461240814; @@ -1152,7 +1152,7 @@ public function getRequestedFeatures() } /** - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. * Check the RequestedFeatures enum for the list of possible values. * * Generated from protobuf field repeated string requested_features = 461240814; diff --git a/Compute/src/V1/MachineType.php b/Compute/src/V1/MachineType.php index b7376043f2c5..341d55dfb0b6 100644 --- a/Compute/src/V1/MachineType.php +++ b/Compute/src/V1/MachineType.php @@ -21,6 +21,13 @@ class MachineType extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.compute.v1.Accelerators accelerators = 269577064; */ private $accelerators; + /** + * [Output Only] The architecture of the machine type. + * Check the Architecture enum for the list of possible values. + * + * Generated from protobuf field optional string architecture = 302803283; + */ + private $architecture = null; /** * [Output Only] Creation timestamp in RFC3339 text format. * @@ -120,6 +127,9 @@ class MachineType extends \Google\Protobuf\Internal\Message * * @type array<\Google\Cloud\Compute\V1\Accelerators>|\Google\Protobuf\Internal\RepeatedField $accelerators * [Output Only] A list of accelerator configurations assigned to this machine type. + * @type string $architecture + * [Output Only] The architecture of the machine type. + * Check the Architecture enum for the list of possible values. * @type string $creation_timestamp * [Output Only] Creation timestamp in RFC3339 text format. * @type \Google\Cloud\Compute\V1\DeprecationStatus $deprecated @@ -183,6 +193,44 @@ public function setAccelerators($var) return $this; } + /** + * [Output Only] The architecture of the machine type. + * Check the Architecture enum for the list of possible values. + * + * Generated from protobuf field optional string architecture = 302803283; + * @return string + */ + public function getArchitecture() + { + return isset($this->architecture) ? $this->architecture : ''; + } + + public function hasArchitecture() + { + return isset($this->architecture); + } + + public function clearArchitecture() + { + unset($this->architecture); + } + + /** + * [Output Only] The architecture of the machine type. + * Check the Architecture enum for the list of possible values. + * + * Generated from protobuf field optional string architecture = 302803283; + * @param string $var + * @return $this + */ + public function setArchitecture($var) + { + GPBUtil::checkString($var, True); + $this->architecture = $var; + + return $this; + } + /** * [Output Only] Creation timestamp in RFC3339 text format. * diff --git a/Compute/src/V1/MachineType/Architecture.php b/Compute/src/V1/MachineType/Architecture.php new file mode 100644 index 000000000000..1e2626027184 --- /dev/null +++ b/Compute/src/V1/MachineType/Architecture.php @@ -0,0 +1,69 @@ +google.cloud.compute.v1.MachineType.Architecture + */ +class Architecture +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_ARCHITECTURE = 0; + */ + const UNDEFINED_ARCHITECTURE = 0; + /** + * Default value indicating Architecture is not set. + * + * Generated from protobuf enum ARCHITECTURE_UNSPECIFIED = 394750507; + */ + const ARCHITECTURE_UNSPECIFIED = 394750507; + /** + * Machines with architecture ARM64 + * + * Generated from protobuf enum ARM64 = 62547450; + */ + const ARM64 = 62547450; + /** + * Machines with architecture X86_64 + * + * Generated from protobuf enum X86_64 = 425300551; + */ + const X86_64 = 425300551; + + private static $valueToName = [ + self::UNDEFINED_ARCHITECTURE => 'UNDEFINED_ARCHITECTURE', + self::ARCHITECTURE_UNSPECIFIED => 'ARCHITECTURE_UNSPECIFIED', + self::ARM64 => 'ARM64', + self::X86_64 => 'X86_64', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/ManagedInstance.php b/Compute/src/V1/ManagedInstance.php index 280244117151..c68d4c5af4f7 100644 --- a/Compute/src/V1/ManagedInstance.php +++ b/Compute/src/V1/ManagedInstance.php @@ -71,6 +71,12 @@ class ManagedInstance extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional .google.cloud.compute.v1.PreservedState preserved_state_from_policy = 470783954; */ private $preserved_state_from_policy = null; + /** + * [Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy. + * + * Generated from protobuf field optional .google.cloud.compute.v1.ManagedInstancePropertiesFromFlexibilityPolicy properties_from_flexibility_policy = 155525825; + */ + private $properties_from_flexibility_policy = null; /** * [Output Only] Intended version of this instance. * @@ -104,6 +110,8 @@ class ManagedInstance extends \Google\Protobuf\Internal\Message * [Output Only] Preserved state applied from per-instance config for this instance. * @type \Google\Cloud\Compute\V1\PreservedState $preserved_state_from_policy * [Output Only] Preserved state generated based on stateful policy for this instance. + * @type \Google\Cloud\Compute\V1\ManagedInstancePropertiesFromFlexibilityPolicy $properties_from_flexibility_policy + * [Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy. * @type \Google\Cloud\Compute\V1\ManagedInstanceVersion $version * [Output Only] Intended version of this instance. * } @@ -431,6 +439,42 @@ public function setPreservedStateFromPolicy($var) return $this; } + /** + * [Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy. + * + * Generated from protobuf field optional .google.cloud.compute.v1.ManagedInstancePropertiesFromFlexibilityPolicy properties_from_flexibility_policy = 155525825; + * @return \Google\Cloud\Compute\V1\ManagedInstancePropertiesFromFlexibilityPolicy|null + */ + public function getPropertiesFromFlexibilityPolicy() + { + return $this->properties_from_flexibility_policy; + } + + public function hasPropertiesFromFlexibilityPolicy() + { + return isset($this->properties_from_flexibility_policy); + } + + public function clearPropertiesFromFlexibilityPolicy() + { + unset($this->properties_from_flexibility_policy); + } + + /** + * [Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy. + * + * Generated from protobuf field optional .google.cloud.compute.v1.ManagedInstancePropertiesFromFlexibilityPolicy properties_from_flexibility_policy = 155525825; + * @param \Google\Cloud\Compute\V1\ManagedInstancePropertiesFromFlexibilityPolicy $var + * @return $this + */ + public function setPropertiesFromFlexibilityPolicy($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\ManagedInstancePropertiesFromFlexibilityPolicy::class); + $this->properties_from_flexibility_policy = $var; + + return $this; + } + /** * [Output Only] Intended version of this instance. * diff --git a/Compute/src/V1/ManagedInstancePropertiesFromFlexibilityPolicy.php b/Compute/src/V1/ManagedInstancePropertiesFromFlexibilityPolicy.php new file mode 100644 index 000000000000..fdecb3c08f63 --- /dev/null +++ b/Compute/src/V1/ManagedInstancePropertiesFromFlexibilityPolicy.php @@ -0,0 +1,76 @@ +google.cloud.compute.v1.ManagedInstancePropertiesFromFlexibilityPolicy + */ +class ManagedInstancePropertiesFromFlexibilityPolicy extends \Google\Protobuf\Internal\Message +{ + /** + * The machine type to be used for this instance. + * + * Generated from protobuf field optional string machine_type = 227711026; + */ + private $machine_type = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $machine_type + * The machine type to be used for this instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * The machine type to be used for this instance. + * + * Generated from protobuf field optional string machine_type = 227711026; + * @return string + */ + public function getMachineType() + { + return isset($this->machine_type) ? $this->machine_type : ''; + } + + public function hasMachineType() + { + return isset($this->machine_type); + } + + public function clearMachineType() + { + unset($this->machine_type); + } + + /** + * The machine type to be used for this instance. + * + * Generated from protobuf field optional string machine_type = 227711026; + * @param string $var + * @return $this + */ + public function setMachineType($var) + { + GPBUtil::checkString($var, True); + $this->machine_type = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/NetworkEndpoint.php b/Compute/src/V1/NetworkEndpoint.php index a0606e564d7c..39e11db88710 100644 --- a/Compute/src/V1/NetworkEndpoint.php +++ b/Compute/src/V1/NetworkEndpoint.php @@ -21,6 +21,12 @@ class NetworkEndpoint extends \Google\Protobuf\Internal\Message * Generated from protobuf field map annotations = 112032548; */ private $annotations; + /** + * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + * + * Generated from protobuf field optional int32 client_destination_port = 123765766; + */ + private $client_destination_port = null; /** * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. * @@ -39,6 +45,12 @@ class NetworkEndpoint extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string ip_address = 406272220; */ private $ip_address = null; + /** + * Optional IPv6 address of network endpoint. + * + * Generated from protobuf field optional string ipv6_address = 341563804; + */ + private $ipv6_address = null; /** * Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. * @@ -54,12 +66,16 @@ class NetworkEndpoint extends \Google\Protobuf\Internal\Message * * @type array|\Google\Protobuf\Internal\MapField $annotations * Metadata defined as annotations on the network endpoint. + * @type int $client_destination_port + * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. * @type string $fqdn * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. * @type string $instance * The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. * @type string $ip_address * Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. + * @type string $ipv6_address + * Optional IPv6 address of network endpoint. * @type int $port * Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. * } @@ -95,6 +111,42 @@ public function setAnnotations($var) return $this; } + /** + * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + * + * Generated from protobuf field optional int32 client_destination_port = 123765766; + * @return int + */ + public function getClientDestinationPort() + { + return isset($this->client_destination_port) ? $this->client_destination_port : 0; + } + + public function hasClientDestinationPort() + { + return isset($this->client_destination_port); + } + + public function clearClientDestinationPort() + { + unset($this->client_destination_port); + } + + /** + * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + * + * Generated from protobuf field optional int32 client_destination_port = 123765766; + * @param int $var + * @return $this + */ + public function setClientDestinationPort($var) + { + GPBUtil::checkInt32($var); + $this->client_destination_port = $var; + + return $this; + } + /** * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. * @@ -203,6 +255,42 @@ public function setIpAddress($var) return $this; } + /** + * Optional IPv6 address of network endpoint. + * + * Generated from protobuf field optional string ipv6_address = 341563804; + * @return string + */ + public function getIpv6Address() + { + return isset($this->ipv6_address) ? $this->ipv6_address : ''; + } + + public function hasIpv6Address() + { + return isset($this->ipv6_address); + } + + public function clearIpv6Address() + { + unset($this->ipv6_address); + } + + /** + * Optional IPv6 address of network endpoint. + * + * Generated from protobuf field optional string ipv6_address = 341563804; + * @param string $var + * @return $this + */ + public function setIpv6Address($var) + { + GPBUtil::checkString($var, True); + $this->ipv6_address = $var; + + return $this; + } + /** * Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. * diff --git a/Compute/src/V1/NetworkEndpointGroup/NetworkEndpointType.php b/Compute/src/V1/NetworkEndpointGroup/NetworkEndpointType.php index edc0ebde5564..00265a011ce7 100644 --- a/Compute/src/V1/NetworkEndpointGroup/NetworkEndpointType.php +++ b/Compute/src/V1/NetworkEndpointGroup/NetworkEndpointType.php @@ -31,6 +31,12 @@ class NetworkEndpointType * Generated from protobuf enum GCE_VM_IP_PORT = 501838375; */ const GCE_VM_IP_PORT = 501838375; + /** + * The network endpoint is represented by an IP, Port and Client Destination Port. + * + * Generated from protobuf enum GCE_VM_IP_PORTMAP = 22819253; + */ + const GCE_VM_IP_PORTMAP = 22819253; /** * The network endpoint is represented by fully qualified domain name and port. * @@ -66,6 +72,7 @@ class NetworkEndpointType self::UNDEFINED_NETWORK_ENDPOINT_TYPE => 'UNDEFINED_NETWORK_ENDPOINT_TYPE', self::GCE_VM_IP => 'GCE_VM_IP', self::GCE_VM_IP_PORT => 'GCE_VM_IP_PORT', + self::GCE_VM_IP_PORTMAP => 'GCE_VM_IP_PORTMAP', self::INTERNET_FQDN_PORT => 'INTERNET_FQDN_PORT', self::INTERNET_IP_PORT => 'INTERNET_IP_PORT', self::NON_GCP_PRIVATE_IP_PORT => 'NON_GCP_PRIVATE_IP_PORT', diff --git a/Compute/src/V1/NetworkEndpointGroupPscData.php b/Compute/src/V1/NetworkEndpointGroupPscData.php index d1defec8df47..50c18014ec9c 100644 --- a/Compute/src/V1/NetworkEndpointGroupPscData.php +++ b/Compute/src/V1/NetworkEndpointGroupPscData.php @@ -21,6 +21,12 @@ class NetworkEndpointGroupPscData extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string consumer_psc_address = 452646572; */ private $consumer_psc_address = null; + /** + * The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type + * + * Generated from protobuf field optional int32 producer_port = 410021134; + */ + private $producer_port = null; /** * [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. * @@ -43,6 +49,8 @@ class NetworkEndpointGroupPscData extends \Google\Protobuf\Internal\Message * * @type string $consumer_psc_address * [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. + * @type int $producer_port + * The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type * @type int|string $psc_connection_id * [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. * @type string $psc_connection_status @@ -91,6 +99,42 @@ public function setConsumerPscAddress($var) return $this; } + /** + * The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type + * + * Generated from protobuf field optional int32 producer_port = 410021134; + * @return int + */ + public function getProducerPort() + { + return isset($this->producer_port) ? $this->producer_port : 0; + } + + public function hasProducerPort() + { + return isset($this->producer_port); + } + + public function clearProducerPort() + { + unset($this->producer_port); + } + + /** + * The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type + * + * Generated from protobuf field optional int32 producer_port = 410021134; + * @param int $var + * @return $this + */ + public function setProducerPort($var) + { + GPBUtil::checkInt32($var); + $this->producer_port = $var; + + return $this; + } + /** * [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. * diff --git a/Compute/src/V1/NetworkInterface/NicType.php b/Compute/src/V1/NetworkInterface/NicType.php index c0c6b05b98ae..872b8900903f 100644 --- a/Compute/src/V1/NetworkInterface/NicType.php +++ b/Compute/src/V1/NetworkInterface/NicType.php @@ -25,6 +25,12 @@ class NicType * Generated from protobuf enum GVNIC = 68209305; */ const GVNIC = 68209305; + /** + * IDPF + * + * Generated from protobuf enum IDPF = 2242641; + */ + const IDPF = 2242641; /** * No type specified. * @@ -41,6 +47,7 @@ class NicType private static $valueToName = [ self::UNDEFINED_NIC_TYPE => 'UNDEFINED_NIC_TYPE', self::GVNIC => 'GVNIC', + self::IDPF => 'IDPF', self::UNSPECIFIED_NIC_TYPE => 'UNSPECIFIED_NIC_TYPE', self::VIRTIO_NET => 'VIRTIO_NET', ]; diff --git a/Compute/src/V1/NetworkInterface/StackType.php b/Compute/src/V1/NetworkInterface/StackType.php index fce99beb21f1..8d5b46218763 100644 --- a/Compute/src/V1/NetworkInterface/StackType.php +++ b/Compute/src/V1/NetworkInterface/StackType.php @@ -26,11 +26,17 @@ class StackType */ const IPV4_IPV6 = 22197249; /** - * The network interface will be assigned IPv4 address. + * The network interface will only be assigned IPv4 addresses. * * Generated from protobuf enum IPV4_ONLY = 22373798; */ const IPV4_ONLY = 22373798; + /** + * The network interface will only be assigned IPv6 addresses. + * + * Generated from protobuf enum IPV6_ONLY = 79632100; + */ + const IPV6_ONLY = 79632100; /** * Generated from protobuf enum UNSPECIFIED_STACK_TYPE = 298084569; */ @@ -40,6 +46,7 @@ class StackType self::UNDEFINED_STACK_TYPE => 'UNDEFINED_STACK_TYPE', self::IPV4_IPV6 => 'IPV4_IPV6', self::IPV4_ONLY => 'IPV4_ONLY', + self::IPV6_ONLY => 'IPV6_ONLY', self::UNSPECIFIED_STACK_TYPE => 'UNSPECIFIED_STACK_TYPE', ]; diff --git a/Compute/src/V1/NetworksGetEffectiveFirewallsResponse.php b/Compute/src/V1/NetworksGetEffectiveFirewallsResponse.php index a478968c2216..e61eeb5d0268 100644 --- a/Compute/src/V1/NetworksGetEffectiveFirewallsResponse.php +++ b/Compute/src/V1/NetworksGetEffectiveFirewallsResponse.php @@ -15,7 +15,7 @@ class NetworksGetEffectiveFirewallsResponse extends \Google\Protobuf\Internal\Message { /** - * Effective firewalls from firewall policy. + * [Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well. * * Generated from protobuf field repeated .google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; */ @@ -34,7 +34,7 @@ class NetworksGetEffectiveFirewallsResponse extends \Google\Protobuf\Internal\Me * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Compute\V1\NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy>|\Google\Protobuf\Internal\RepeatedField $firewall_policys - * Effective firewalls from firewall policy. + * [Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well. * @type array<\Google\Cloud\Compute\V1\Firewall>|\Google\Protobuf\Internal\RepeatedField $firewalls * Effective firewalls on the network. * } @@ -45,7 +45,7 @@ public function __construct($data = NULL) { } /** - * Effective firewalls from firewall policy. + * [Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well. * * Generated from protobuf field repeated .google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; * @return \Google\Protobuf\Internal\RepeatedField @@ -56,7 +56,7 @@ public function getFirewallPolicys() } /** - * Effective firewalls from firewall policy. + * [Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well. * * Generated from protobuf field repeated .google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; * @param array<\Google\Cloud\Compute\V1\NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Compute/src/V1/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php b/Compute/src/V1/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php index dcde2feb9600..5d65aadce36d 100644 --- a/Compute/src/V1/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php +++ b/Compute/src/V1/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php @@ -27,7 +27,13 @@ class NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy extends \Goog */ private $name = null; /** - * The rules that apply to the network. + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + * + * Generated from protobuf field optional int32 priority = 445151652; + */ + private $priority = null; + /** + * [Output Only] The rules that apply to the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; */ @@ -56,8 +62,10 @@ class NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy extends \Goog * [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. * @type string $name * [Output Only] The name of the firewall policy. + * @type int $priority + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. * @type array<\Google\Cloud\Compute\V1\FirewallPolicyRule>|\Google\Protobuf\Internal\RepeatedField $rules - * The rules that apply to the network. + * [Output Only] The rules that apply to the network. * @type string $short_name * [Output Only] The short name of the firewall policy. * @type string $type @@ -143,7 +151,43 @@ public function setName($var) } /** - * The rules that apply to the network. + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + * + * Generated from protobuf field optional int32 priority = 445151652; + * @return int + */ + public function getPriority() + { + return isset($this->priority) ? $this->priority : 0; + } + + public function hasPriority() + { + return isset($this->priority); + } + + public function clearPriority() + { + unset($this->priority); + } + + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + * + * Generated from protobuf field optional int32 priority = 445151652; + * @param int $var + * @return $this + */ + public function setPriority($var) + { + GPBUtil::checkInt32($var); + $this->priority = $var; + + return $this; + } + + /** + * [Output Only] The rules that apply to the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; * @return \Google\Protobuf\Internal\RepeatedField @@ -154,7 +198,7 @@ public function getRules() } /** - * The rules that apply to the network. + * [Output Only] The rules that apply to the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; * @param array<\Google\Cloud\Compute\V1\FirewallPolicyRule>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Compute/src/V1/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy/Type.php b/Compute/src/V1/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy/Type.php index 1acdf3c4ccbc..39ecdd1f17ef 100644 --- a/Compute/src/V1/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy/Type.php +++ b/Compute/src/V1/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy/Type.php @@ -27,6 +27,10 @@ class Type * Generated from protobuf enum NETWORK = 413984270; */ const NETWORK = 413984270; + /** + * Generated from protobuf enum SYSTEM = 313484847; + */ + const SYSTEM = 313484847; /** * Generated from protobuf enum UNSPECIFIED = 526786327; */ @@ -36,6 +40,7 @@ class Type self::UNDEFINED_TYPE => 'UNDEFINED_TYPE', self::HIERARCHY => 'HIERARCHY', self::NETWORK => 'NETWORK', + self::SYSTEM => 'SYSTEM', self::UNSPECIFIED => 'UNSPECIFIED', ]; diff --git a/Compute/src/V1/Operation.php b/Compute/src/V1/Operation.php index 38ca6c0efd58..958c4f7a8385 100644 --- a/Compute/src/V1/Operation.php +++ b/Compute/src/V1/Operation.php @@ -146,7 +146,7 @@ class Operation extends \Google\Protobuf\Internal\Message */ private $target_id = null; /** - * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. * * Generated from protobuf field optional string target_link = 62671336; */ @@ -220,7 +220,7 @@ class Operation extends \Google\Protobuf\Internal\Message * @type int|string $target_id * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. * @type string $target_link - * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. * @type string $user * [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. * @type array<\Google\Cloud\Compute\V1\Warnings>|\Google\Protobuf\Internal\RepeatedField $warnings @@ -1023,7 +1023,7 @@ public function setTargetId($var) } /** - * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. * * Generated from protobuf field optional string target_link = 62671336; * @return string @@ -1044,7 +1044,7 @@ public function clearTargetLink() } /** - * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. * * Generated from protobuf field optional string target_link = 62671336; * @param string $var diff --git a/Compute/src/V1/PathMatcher.php b/Compute/src/V1/PathMatcher.php index e5e8540f96e3..09c6e4e14360 100644 --- a/Compute/src/V1/PathMatcher.php +++ b/Compute/src/V1/PathMatcher.php @@ -15,6 +15,12 @@ */ class PathMatcher extends \Google\Protobuf\Internal\Message { + /** + * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089; + */ + private $default_custom_error_response_policy = null; /** * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. * @@ -70,6 +76,8 @@ class PathMatcher extends \Google\Protobuf\Internal\Message * @param array $data { * Optional. Data for populating the Message object. * + * @type \Google\Cloud\Compute\V1\CustomErrorResponsePolicy $default_custom_error_response_policy + * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. * @type \Google\Cloud\Compute\V1\HttpRouteAction $default_route_action * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. * @type string $default_service @@ -93,6 +101,42 @@ public function __construct($data = NULL) { parent::__construct($data); } + /** + * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089; + * @return \Google\Cloud\Compute\V1\CustomErrorResponsePolicy|null + */ + public function getDefaultCustomErrorResponsePolicy() + { + return $this->default_custom_error_response_policy; + } + + public function hasDefaultCustomErrorResponsePolicy() + { + return isset($this->default_custom_error_response_policy); + } + + public function clearDefaultCustomErrorResponsePolicy() + { + unset($this->default_custom_error_response_policy); + } + + /** + * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089; + * @param \Google\Cloud\Compute\V1\CustomErrorResponsePolicy $var + * @return $this + */ + public function setDefaultCustomErrorResponsePolicy($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\CustomErrorResponsePolicy::class); + $this->default_custom_error_response_policy = $var; + + return $this; + } + /** * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. * diff --git a/Compute/src/V1/PathRule.php b/Compute/src/V1/PathRule.php index b25d89e27ed8..69ebb0b2028c 100644 --- a/Compute/src/V1/PathRule.php +++ b/Compute/src/V1/PathRule.php @@ -15,6 +15,12 @@ */ class PathRule extends \Google\Protobuf\Internal\Message { + /** + * customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619; + */ + private $custom_error_response_policy = null; /** * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. * @@ -46,6 +52,8 @@ class PathRule extends \Google\Protobuf\Internal\Message * @param array $data { * Optional. Data for populating the Message object. * + * @type \Google\Cloud\Compute\V1\CustomErrorResponsePolicy $custom_error_response_policy + * customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers. * @type array|\Google\Protobuf\Internal\RepeatedField $paths * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. * @type \Google\Cloud\Compute\V1\HttpRouteAction $route_action @@ -61,6 +69,42 @@ public function __construct($data = NULL) { parent::__construct($data); } + /** + * customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619; + * @return \Google\Cloud\Compute\V1\CustomErrorResponsePolicy|null + */ + public function getCustomErrorResponsePolicy() + { + return $this->custom_error_response_policy; + } + + public function hasCustomErrorResponsePolicy() + { + return isset($this->custom_error_response_policy); + } + + public function clearCustomErrorResponsePolicy() + { + unset($this->custom_error_response_policy); + } + + /** + * customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619; + * @param \Google\Cloud\Compute\V1\CustomErrorResponsePolicy $var + * @return $this + */ + public function setCustomErrorResponsePolicy($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\CustomErrorResponsePolicy::class); + $this->custom_error_response_policy = $var; + + return $this; + } + /** * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. * diff --git a/Compute/src/V1/Policy.php b/Compute/src/V1/Policy.php index 06a53e3c2bdf..adfe84f7809e 100644 --- a/Compute/src/V1/Policy.php +++ b/Compute/src/V1/Policy.php @@ -37,12 +37,6 @@ class Policy extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional bool iam_owned = 450566203; */ private $iam_owned = null; - /** - * This is deprecated and has no effect. Do not use. - * - * Generated from protobuf field repeated .google.cloud.compute.v1.Rule rules = 108873975; - */ - private $rules; /** * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @@ -63,8 +57,6 @@ class Policy extends \Google\Protobuf\Internal\Message * @type string $etag * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. * @type bool $iam_owned - * @type array<\Google\Cloud\Compute\V1\Rule>|\Google\Protobuf\Internal\RepeatedField $rules - * This is deprecated and has no effect. Do not use. * @type int $version * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * } @@ -194,32 +186,6 @@ public function setIamOwned($var) return $this; } - /** - * This is deprecated and has no effect. Do not use. - * - * Generated from protobuf field repeated .google.cloud.compute.v1.Rule rules = 108873975; - * @return \Google\Protobuf\Internal\RepeatedField - */ - public function getRules() - { - return $this->rules; - } - - /** - * This is deprecated and has no effect. Do not use. - * - * Generated from protobuf field repeated .google.cloud.compute.v1.Rule rules = 108873975; - * @param array<\Google\Cloud\Compute\V1\Rule>|\Google\Protobuf\Internal\RepeatedField $var - * @return $this - */ - public function setRules($var) - { - $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Compute\V1\Rule::class); - $this->rules = $arr; - - return $this; - } - /** * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * diff --git a/Compute/src/V1/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse.php b/Compute/src/V1/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse.php index bc85f35dc197..4da35401010d 100644 --- a/Compute/src/V1/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse.php +++ b/Compute/src/V1/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse.php @@ -15,7 +15,7 @@ class RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse extends \Google\Protobuf\Internal\Message { /** - * Effective firewalls from firewall policy. + * [Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; */ @@ -34,7 +34,7 @@ class RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse extends \Google * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Compute\V1\RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy>|\Google\Protobuf\Internal\RepeatedField $firewall_policys - * Effective firewalls from firewall policy. + * [Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network. * @type array<\Google\Cloud\Compute\V1\Firewall>|\Google\Protobuf\Internal\RepeatedField $firewalls * Effective firewalls on the network. * } @@ -45,7 +45,7 @@ public function __construct($data = NULL) { } /** - * Effective firewalls from firewall policy. + * [Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; * @return \Google\Protobuf\Internal\RepeatedField @@ -56,7 +56,7 @@ public function getFirewallPolicys() } /** - * Effective firewalls from firewall policy. + * [Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy firewall_policys = 410985794; * @param array<\Google\Cloud\Compute\V1\RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Compute/src/V1/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php b/Compute/src/V1/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php index 835f497de2b2..8ab25c4dead4 100644 --- a/Compute/src/V1/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php +++ b/Compute/src/V1/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.php @@ -27,7 +27,7 @@ class RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewal */ private $name = null; /** - * The rules that apply to the network. + * [Output only] The rules that apply to the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; */ @@ -51,7 +51,7 @@ class RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewal * @type string $name * [Output Only] The name of the firewall policy. * @type array<\Google\Cloud\Compute\V1\FirewallPolicyRule>|\Google\Protobuf\Internal\RepeatedField $rules - * The rules that apply to the network. + * [Output only] The rules that apply to the network. * @type string $type * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. * Check the Type enum for the list of possible values. @@ -135,7 +135,7 @@ public function setName($var) } /** - * The rules that apply to the network. + * [Output only] The rules that apply to the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; * @return \Google\Protobuf\Internal\RepeatedField @@ -146,7 +146,7 @@ public function getRules() } /** - * The rules that apply to the network. + * [Output only] The rules that apply to the network. * * Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975; * @param array<\Google\Cloud\Compute\V1\FirewallPolicyRule>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Compute/src/V1/Reservation.php b/Compute/src/V1/Reservation.php index 5025a1166567..95ff70b0a861 100644 --- a/Compute/src/V1/Reservation.php +++ b/Compute/src/V1/Reservation.php @@ -100,7 +100,7 @@ class Reservation extends \Google\Protobuf\Internal\Message */ private $specific_reservation_required = null; /** - * [Output Only] The status of the reservation. + * [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. * Check the Status enum for the list of possible values. * * Generated from protobuf field optional string status = 181260274; @@ -148,7 +148,7 @@ class Reservation extends \Google\Protobuf\Internal\Message * @type bool $specific_reservation_required * Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. * @type string $status - * [Output Only] The status of the reservation. + * [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. * Check the Status enum for the list of possible values. * @type string $zone * Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. @@ -654,7 +654,7 @@ public function setSpecificReservationRequired($var) } /** - * [Output Only] The status of the reservation. + * [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. * Check the Status enum for the list of possible values. * * Generated from protobuf field optional string status = 181260274; @@ -676,7 +676,7 @@ public function clearStatus() } /** - * [Output Only] The status of the reservation. + * [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. * Check the Status enum for the list of possible values. * * Generated from protobuf field optional string status = 181260274; diff --git a/Compute/src/V1/Reservation/Status.php b/Compute/src/V1/Reservation/Status.php index 271609220a9c..eb97b36fdee0 100644 --- a/Compute/src/V1/Reservation/Status.php +++ b/Compute/src/V1/Reservation/Status.php @@ -7,7 +7,7 @@ use UnexpectedValueException; /** - * [Output Only] The status of the reservation. + * [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. * * Protobuf type google.cloud.compute.v1.Reservation.Status */ @@ -20,13 +20,13 @@ class Status */ const UNDEFINED_STATUS = 0; /** - * Resources are being allocated for the reservation. + * Reservation resources are being allocated. * * Generated from protobuf enum CREATING = 455564985; */ const CREATING = 455564985; /** - * Reservation is currently being deleted. + * Reservation deletion is in progress. * * Generated from protobuf enum DELETING = 528602024; */ @@ -36,13 +36,13 @@ class Status */ const INVALID = 530283991; /** - * Reservation has allocated all its resources. + * Reservation resources have been allocated, and the reservation is ready for use. * * Generated from protobuf enum READY = 77848963; */ const READY = 77848963; /** - * Reservation is currently being resized. + * Reservation update is in progress. * * Generated from protobuf enum UPDATING = 494614342; */ diff --git a/Compute/src/V1/ResourceStatus.php b/Compute/src/V1/ResourceStatus.php index 5f51a5807ab8..0e003b025516 100644 --- a/Compute/src/V1/ResourceStatus.php +++ b/Compute/src/V1/ResourceStatus.php @@ -21,6 +21,10 @@ class ResourceStatus extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string physical_host = 464370704; */ private $physical_host = null; + /** + * Generated from protobuf field optional .google.cloud.compute.v1.ResourceStatusScheduling scheduling = 386688404; + */ + private $scheduling = null; /** * Generated from protobuf field optional .google.cloud.compute.v1.UpcomingMaintenance upcoming_maintenance = 227348592; */ @@ -34,6 +38,7 @@ class ResourceStatus extends \Google\Protobuf\Internal\Message * * @type string $physical_host * [Output Only] An opaque ID of the host on which the VM is running. + * @type \Google\Cloud\Compute\V1\ResourceStatusScheduling $scheduling * @type \Google\Cloud\Compute\V1\UpcomingMaintenance $upcoming_maintenance * } */ @@ -78,6 +83,38 @@ public function setPhysicalHost($var) return $this; } + /** + * Generated from protobuf field optional .google.cloud.compute.v1.ResourceStatusScheduling scheduling = 386688404; + * @return \Google\Cloud\Compute\V1\ResourceStatusScheduling|null + */ + public function getScheduling() + { + return $this->scheduling; + } + + public function hasScheduling() + { + return isset($this->scheduling); + } + + public function clearScheduling() + { + unset($this->scheduling); + } + + /** + * Generated from protobuf field optional .google.cloud.compute.v1.ResourceStatusScheduling scheduling = 386688404; + * @param \Google\Cloud\Compute\V1\ResourceStatusScheduling $var + * @return $this + */ + public function setScheduling($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\ResourceStatusScheduling::class); + $this->scheduling = $var; + + return $this; + } + /** * Generated from protobuf field optional .google.cloud.compute.v1.UpcomingMaintenance upcoming_maintenance = 227348592; * @return \Google\Cloud\Compute\V1\UpcomingMaintenance|null diff --git a/Compute/src/V1/ResourceStatusScheduling.php b/Compute/src/V1/ResourceStatusScheduling.php new file mode 100644 index 000000000000..3e3c6552f897 --- /dev/null +++ b/Compute/src/V1/ResourceStatusScheduling.php @@ -0,0 +1,76 @@ +google.cloud.compute.v1.ResourceStatusScheduling + */ +class ResourceStatusScheduling extends \Google\Protobuf\Internal\Message +{ + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + * + * Generated from protobuf field optional int32 availability_domain = 252514344; + */ + private $availability_domain = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $availability_domain + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + * + * Generated from protobuf field optional int32 availability_domain = 252514344; + * @return int + */ + public function getAvailabilityDomain() + { + return isset($this->availability_domain) ? $this->availability_domain : 0; + } + + public function hasAvailabilityDomain() + { + return isset($this->availability_domain); + } + + public function clearAvailabilityDomain() + { + unset($this->availability_domain); + } + + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + * + * Generated from protobuf field optional int32 availability_domain = 252514344; + * @param int $var + * @return $this + */ + public function setAvailabilityDomain($var) + { + GPBUtil::checkInt32($var); + $this->availability_domain = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/Route.php b/Compute/src/V1/Route.php index 9b04741a1501..44de523291b9 100644 --- a/Compute/src/V1/Route.php +++ b/Compute/src/V1/Route.php @@ -76,7 +76,7 @@ class Route extends \Google\Protobuf\Internal\Message */ private $next_hop_hub = null; /** - * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. * * Generated from protobuf field optional string next_hop_ilb = 198679901; */ @@ -177,7 +177,7 @@ class Route extends \Google\Protobuf\Internal\Message * @type string $next_hop_hub * [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. * @type string $next_hop_ilb - * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. * @type string $next_hop_instance * The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ * @type string $next_hop_ip @@ -560,7 +560,7 @@ public function setNextHopHub($var) } /** - * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. * * Generated from protobuf field optional string next_hop_ilb = 198679901; * @return string @@ -581,7 +581,7 @@ public function clearNextHopIlb() } /** - * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. * * Generated from protobuf field optional string next_hop_ilb = 198679901; * @param string $var diff --git a/Compute/src/V1/RouterNatRule.php b/Compute/src/V1/RouterNatRule.php index 3255668d270d..777319d547c2 100644 --- a/Compute/src/V1/RouterNatRule.php +++ b/Compute/src/V1/RouterNatRule.php @@ -27,7 +27,7 @@ class RouterNatRule extends \Google\Protobuf\Internal\Message */ private $description = null; /** - * CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'" + * CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')` `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` The following example is a valid match expression for private NAT: `nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` * * Generated from protobuf field optional string match = 103668165; */ @@ -50,7 +50,7 @@ class RouterNatRule extends \Google\Protobuf\Internal\Message * @type string $description * An optional description of this rule. * @type string $match - * CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'" + * CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')` `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` The following example is a valid match expression for private NAT: `nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` * @type int $rule_number * An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT. * } @@ -133,7 +133,7 @@ public function setDescription($var) } /** - * CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'" + * CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')` `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` The following example is a valid match expression for private NAT: `nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` * * Generated from protobuf field optional string match = 103668165; * @return string @@ -154,7 +154,7 @@ public function clearMatch() } /** - * CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'" + * CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')` `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` The following example is a valid match expression for private NAT: `nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` * * Generated from protobuf field optional string match = 103668165; * @param string $var diff --git a/Compute/src/V1/RouterStatus.php b/Compute/src/V1/RouterStatus.php index babc3337f708..b38a5386ab6f 100644 --- a/Compute/src/V1/RouterStatus.php +++ b/Compute/src/V1/RouterStatus.php @@ -15,13 +15,13 @@ class RouterStatus extends \Google\Protobuf\Internal\Message { /** - * Best routes for this router's network. + * A list of the best dynamic routes for this Cloud Router's Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region's VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions. * * Generated from protobuf field repeated .google.cloud.compute.v1.Route best_routes = 395826693; */ private $best_routes; /** - * Best routes learned by this router. + * A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router. * * Generated from protobuf field repeated .google.cloud.compute.v1.Route best_routes_for_router = 119389689; */ @@ -48,9 +48,9 @@ class RouterStatus extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Compute\V1\Route>|\Google\Protobuf\Internal\RepeatedField $best_routes - * Best routes for this router's network. + * A list of the best dynamic routes for this Cloud Router's Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region's VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions. * @type array<\Google\Cloud\Compute\V1\Route>|\Google\Protobuf\Internal\RepeatedField $best_routes_for_router - * Best routes learned by this router. + * A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router. * @type array<\Google\Cloud\Compute\V1\RouterStatusBgpPeerStatus>|\Google\Protobuf\Internal\RepeatedField $bgp_peer_status * @type array<\Google\Cloud\Compute\V1\RouterStatusNatStatus>|\Google\Protobuf\Internal\RepeatedField $nat_status * @type string $network @@ -63,7 +63,7 @@ public function __construct($data = NULL) { } /** - * Best routes for this router's network. + * A list of the best dynamic routes for this Cloud Router's Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region's VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions. * * Generated from protobuf field repeated .google.cloud.compute.v1.Route best_routes = 395826693; * @return \Google\Protobuf\Internal\RepeatedField @@ -74,7 +74,7 @@ public function getBestRoutes() } /** - * Best routes for this router's network. + * A list of the best dynamic routes for this Cloud Router's Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region's VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions. * * Generated from protobuf field repeated .google.cloud.compute.v1.Route best_routes = 395826693; * @param array<\Google\Cloud\Compute\V1\Route>|\Google\Protobuf\Internal\RepeatedField $var @@ -89,7 +89,7 @@ public function setBestRoutes($var) } /** - * Best routes learned by this router. + * A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router. * * Generated from protobuf field repeated .google.cloud.compute.v1.Route best_routes_for_router = 119389689; * @return \Google\Protobuf\Internal\RepeatedField @@ -100,7 +100,7 @@ public function getBestRoutesForRouter() } /** - * Best routes learned by this router. + * A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router. * * Generated from protobuf field repeated .google.cloud.compute.v1.Route best_routes_for_router = 119389689; * @param array<\Google\Cloud\Compute\V1\Route>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Compute/src/V1/Scheduling.php b/Compute/src/V1/Scheduling.php index 6c3bfae08ee1..5ee0ced02dfd 100644 --- a/Compute/src/V1/Scheduling.php +++ b/Compute/src/V1/Scheduling.php @@ -21,6 +21,12 @@ class Scheduling extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional bool automatic_restart = 350821371; */ private $automatic_restart = null; + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + * + * Generated from protobuf field optional int32 availability_domain = 252514344; + */ + private $availability_domain = null; /** * Specifies the termination action for the instance. * Check the InstanceTerminationAction enum for the list of possible values. @@ -40,6 +46,12 @@ class Scheduling extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string location_hint = 350519505; */ private $location_hint = null; + /** + * Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration. + * + * Generated from protobuf field optional .google.cloud.compute.v1.Duration max_run_duration = 430839747; + */ + private $max_run_duration = null; /** * The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. * @@ -59,6 +71,10 @@ class Scheduling extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string on_host_maintenance = 64616796; */ private $on_host_maintenance = null; + /** + * Generated from protobuf field optional .google.cloud.compute.v1.SchedulingOnInstanceStopAction on_instance_stop_action = 529876681; + */ + private $on_instance_stop_action = null; /** * Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. * @@ -72,6 +88,12 @@ class Scheduling extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string provisioning_model = 494423; */ private $provisioning_model = null; + /** + * Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. + * + * Generated from protobuf field optional string termination_time = 428082984; + */ + private $termination_time = null; /** * Constructor. @@ -81,6 +103,8 @@ class Scheduling extends \Google\Protobuf\Internal\Message * * @type bool $automatic_restart * Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + * @type int $availability_domain + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. * @type string $instance_termination_action * Specifies the termination action for the instance. * Check the InstanceTerminationAction enum for the list of possible values. @@ -88,6 +112,8 @@ class Scheduling extends \Google\Protobuf\Internal\Message * Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. * @type string $location_hint * An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API. + * @type \Google\Cloud\Compute\V1\Duration $max_run_duration + * Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration. * @type int $min_node_cpus * The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. * @type array<\Google\Cloud\Compute\V1\SchedulingNodeAffinity>|\Google\Protobuf\Internal\RepeatedField $node_affinities @@ -95,11 +121,14 @@ class Scheduling extends \Google\Protobuf\Internal\Message * @type string $on_host_maintenance * Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy. * Check the OnHostMaintenance enum for the list of possible values. + * @type \Google\Cloud\Compute\V1\SchedulingOnInstanceStopAction $on_instance_stop_action * @type bool $preemptible * Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. * @type string $provisioning_model * Specifies the provisioning model of the instance. * Check the ProvisioningModel enum for the list of possible values. + * @type string $termination_time + * Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. * } */ public function __construct($data = NULL) { @@ -143,6 +172,42 @@ public function setAutomaticRestart($var) return $this; } + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + * + * Generated from protobuf field optional int32 availability_domain = 252514344; + * @return int + */ + public function getAvailabilityDomain() + { + return isset($this->availability_domain) ? $this->availability_domain : 0; + } + + public function hasAvailabilityDomain() + { + return isset($this->availability_domain); + } + + public function clearAvailabilityDomain() + { + unset($this->availability_domain); + } + + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + * + * Generated from protobuf field optional int32 availability_domain = 252514344; + * @param int $var + * @return $this + */ + public function setAvailabilityDomain($var) + { + GPBUtil::checkInt32($var); + $this->availability_domain = $var; + + return $this; + } + /** * Specifies the termination action for the instance. * Check the InstanceTerminationAction enum for the list of possible values. @@ -253,6 +318,42 @@ public function setLocationHint($var) return $this; } + /** + * Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration. + * + * Generated from protobuf field optional .google.cloud.compute.v1.Duration max_run_duration = 430839747; + * @return \Google\Cloud\Compute\V1\Duration|null + */ + public function getMaxRunDuration() + { + return $this->max_run_duration; + } + + public function hasMaxRunDuration() + { + return isset($this->max_run_duration); + } + + public function clearMaxRunDuration() + { + unset($this->max_run_duration); + } + + /** + * Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration. + * + * Generated from protobuf field optional .google.cloud.compute.v1.Duration max_run_duration = 430839747; + * @param \Google\Cloud\Compute\V1\Duration $var + * @return $this + */ + public function setMaxRunDuration($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\Duration::class); + $this->max_run_duration = $var; + + return $this; + } + /** * The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. * @@ -353,6 +454,38 @@ public function setOnHostMaintenance($var) return $this; } + /** + * Generated from protobuf field optional .google.cloud.compute.v1.SchedulingOnInstanceStopAction on_instance_stop_action = 529876681; + * @return \Google\Cloud\Compute\V1\SchedulingOnInstanceStopAction|null + */ + public function getOnInstanceStopAction() + { + return $this->on_instance_stop_action; + } + + public function hasOnInstanceStopAction() + { + return isset($this->on_instance_stop_action); + } + + public function clearOnInstanceStopAction() + { + unset($this->on_instance_stop_action); + } + + /** + * Generated from protobuf field optional .google.cloud.compute.v1.SchedulingOnInstanceStopAction on_instance_stop_action = 529876681; + * @param \Google\Cloud\Compute\V1\SchedulingOnInstanceStopAction $var + * @return $this + */ + public function setOnInstanceStopAction($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\SchedulingOnInstanceStopAction::class); + $this->on_instance_stop_action = $var; + + return $this; + } + /** * Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. * @@ -427,5 +560,41 @@ public function setProvisioningModel($var) return $this; } + /** + * Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. + * + * Generated from protobuf field optional string termination_time = 428082984; + * @return string + */ + public function getTerminationTime() + { + return isset($this->termination_time) ? $this->termination_time : ''; + } + + public function hasTerminationTime() + { + return isset($this->termination_time); + } + + public function clearTerminationTime() + { + unset($this->termination_time); + } + + /** + * Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. + * + * Generated from protobuf field optional string termination_time = 428082984; + * @param string $var + * @return $this + */ + public function setTerminationTime($var) + { + GPBUtil::checkString($var, True); + $this->termination_time = $var; + + return $this; + } + } diff --git a/Compute/src/V1/SchedulingOnInstanceStopAction.php b/Compute/src/V1/SchedulingOnInstanceStopAction.php new file mode 100644 index 000000000000..419bcf881df8 --- /dev/null +++ b/Compute/src/V1/SchedulingOnInstanceStopAction.php @@ -0,0 +1,77 @@ +google.cloud.compute.v1.SchedulingOnInstanceStopAction + */ +class SchedulingOnInstanceStopAction extends \Google\Protobuf\Internal\Message +{ + /** + * If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time. + * + * Generated from protobuf field optional bool discard_local_ssd = 319517903; + */ + private $discard_local_ssd = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $discard_local_ssd + * If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time. + * + * Generated from protobuf field optional bool discard_local_ssd = 319517903; + * @return bool + */ + public function getDiscardLocalSsd() + { + return isset($this->discard_local_ssd) ? $this->discard_local_ssd : false; + } + + public function hasDiscardLocalSsd() + { + return isset($this->discard_local_ssd); + } + + public function clearDiscardLocalSsd() + { + unset($this->discard_local_ssd); + } + + /** + * If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time. + * + * Generated from protobuf field optional bool discard_local_ssd = 319517903; + * @param bool $var + * @return $this + */ + public function setDiscardLocalSsd($var) + { + GPBUtil::checkBool($var); + $this->discard_local_ssd = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig.php b/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig.php index db9dfc1d66e6..7cf8da270530 100644 --- a/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig.php +++ b/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig.php @@ -30,12 +30,30 @@ class SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConf * Generated from protobuf field optional float auto_deploy_load_threshold = 522227738; */ private $auto_deploy_load_threshold = null; + /** + * Generated from protobuf field optional float detection_absolute_qps = 383123174; + */ + private $detection_absolute_qps = null; + /** + * Generated from protobuf field optional float detection_load_threshold = 430499148; + */ + private $detection_load_threshold = null; + /** + * Generated from protobuf field optional float detection_relative_to_baseline_qps = 291343749; + */ + private $detection_relative_to_baseline_qps = null; /** * The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. * * Generated from protobuf field optional string name = 3373707; */ private $name = null; + /** + * Configuration options for enabling Adaptive Protection to operate on specified granular traffic units. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig traffic_granularity_configs = 85367358; + */ + private $traffic_granularity_configs; /** * Constructor. @@ -47,8 +65,13 @@ class SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConf * @type int $auto_deploy_expiration_sec * @type float $auto_deploy_impacted_baseline_threshold * @type float $auto_deploy_load_threshold + * @type float $detection_absolute_qps + * @type float $detection_load_threshold + * @type float $detection_relative_to_baseline_qps * @type string $name * The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. + * @type array<\Google\Cloud\Compute\V1\SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig>|\Google\Protobuf\Internal\RepeatedField $traffic_granularity_configs + * Configuration options for enabling Adaptive Protection to operate on specified granular traffic units. * } */ public function __construct($data = NULL) { @@ -184,6 +207,102 @@ public function setAutoDeployLoadThreshold($var) return $this; } + /** + * Generated from protobuf field optional float detection_absolute_qps = 383123174; + * @return float + */ + public function getDetectionAbsoluteQps() + { + return isset($this->detection_absolute_qps) ? $this->detection_absolute_qps : 0.0; + } + + public function hasDetectionAbsoluteQps() + { + return isset($this->detection_absolute_qps); + } + + public function clearDetectionAbsoluteQps() + { + unset($this->detection_absolute_qps); + } + + /** + * Generated from protobuf field optional float detection_absolute_qps = 383123174; + * @param float $var + * @return $this + */ + public function setDetectionAbsoluteQps($var) + { + GPBUtil::checkFloat($var); + $this->detection_absolute_qps = $var; + + return $this; + } + + /** + * Generated from protobuf field optional float detection_load_threshold = 430499148; + * @return float + */ + public function getDetectionLoadThreshold() + { + return isset($this->detection_load_threshold) ? $this->detection_load_threshold : 0.0; + } + + public function hasDetectionLoadThreshold() + { + return isset($this->detection_load_threshold); + } + + public function clearDetectionLoadThreshold() + { + unset($this->detection_load_threshold); + } + + /** + * Generated from protobuf field optional float detection_load_threshold = 430499148; + * @param float $var + * @return $this + */ + public function setDetectionLoadThreshold($var) + { + GPBUtil::checkFloat($var); + $this->detection_load_threshold = $var; + + return $this; + } + + /** + * Generated from protobuf field optional float detection_relative_to_baseline_qps = 291343749; + * @return float + */ + public function getDetectionRelativeToBaselineQps() + { + return isset($this->detection_relative_to_baseline_qps) ? $this->detection_relative_to_baseline_qps : 0.0; + } + + public function hasDetectionRelativeToBaselineQps() + { + return isset($this->detection_relative_to_baseline_qps); + } + + public function clearDetectionRelativeToBaselineQps() + { + unset($this->detection_relative_to_baseline_qps); + } + + /** + * Generated from protobuf field optional float detection_relative_to_baseline_qps = 291343749; + * @param float $var + * @return $this + */ + public function setDetectionRelativeToBaselineQps($var) + { + GPBUtil::checkFloat($var); + $this->detection_relative_to_baseline_qps = $var; + + return $this; + } + /** * The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy. * @@ -220,5 +339,31 @@ public function setName($var) return $this; } + /** + * Configuration options for enabling Adaptive Protection to operate on specified granular traffic units. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig traffic_granularity_configs = 85367358; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTrafficGranularityConfigs() + { + return $this->traffic_granularity_configs; + } + + /** + * Configuration options for enabling Adaptive Protection to operate on specified granular traffic units. + * + * Generated from protobuf field repeated .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig traffic_granularity_configs = 85367358; + * @param array<\Google\Cloud\Compute\V1\SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTrafficGranularityConfigs($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Compute\V1\SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig::class); + $this->traffic_granularity_configs = $arr; + + return $this; + } + } diff --git a/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig.php b/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig.php new file mode 100644 index 000000000000..5899c77e3ba8 --- /dev/null +++ b/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig.php @@ -0,0 +1,169 @@ +google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig + */ +class SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig extends \Google\Protobuf\Internal\Message +{ + /** + * If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty. + * + * Generated from protobuf field optional bool enable_each_unique_value = 469206341; + */ + private $enable_each_unique_value = null; + /** + * Type of this configuration. + * Check the Type enum for the list of possible values. + * + * Generated from protobuf field optional string type = 3575610; + */ + private $type = null; + /** + * Requests that match this value constitute a granular traffic unit. + * + * Generated from protobuf field optional string value = 111972721; + */ + private $value = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $enable_each_unique_value + * If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty. + * @type string $type + * Type of this configuration. + * Check the Type enum for the list of possible values. + * @type string $value + * Requests that match this value constitute a granular traffic unit. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Compute\V1\Compute::initOnce(); + parent::__construct($data); + } + + /** + * If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty. + * + * Generated from protobuf field optional bool enable_each_unique_value = 469206341; + * @return bool + */ + public function getEnableEachUniqueValue() + { + return isset($this->enable_each_unique_value) ? $this->enable_each_unique_value : false; + } + + public function hasEnableEachUniqueValue() + { + return isset($this->enable_each_unique_value); + } + + public function clearEnableEachUniqueValue() + { + unset($this->enable_each_unique_value); + } + + /** + * If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty. + * + * Generated from protobuf field optional bool enable_each_unique_value = 469206341; + * @param bool $var + * @return $this + */ + public function setEnableEachUniqueValue($var) + { + GPBUtil::checkBool($var); + $this->enable_each_unique_value = $var; + + return $this; + } + + /** + * Type of this configuration. + * Check the Type enum for the list of possible values. + * + * Generated from protobuf field optional string type = 3575610; + * @return string + */ + public function getType() + { + return isset($this->type) ? $this->type : ''; + } + + public function hasType() + { + return isset($this->type); + } + + public function clearType() + { + unset($this->type); + } + + /** + * Type of this configuration. + * Check the Type enum for the list of possible values. + * + * Generated from protobuf field optional string type = 3575610; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + + /** + * Requests that match this value constitute a granular traffic unit. + * + * Generated from protobuf field optional string value = 111972721; + * @return string + */ + public function getValue() + { + return isset($this->value) ? $this->value : ''; + } + + public function hasValue() + { + return isset($this->value); + } + + public function clearValue() + { + unset($this->value); + } + + /** + * Requests that match this value constitute a granular traffic unit. + * + * Generated from protobuf field optional string value = 111972721; + * @param string $var + * @return $this + */ + public function setValue($var) + { + GPBUtil::checkString($var, True); + $this->value = $var; + + return $this; + } + +} + diff --git a/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig/Type.php b/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig/Type.php new file mode 100644 index 000000000000..b9038d734b3d --- /dev/null +++ b/Compute/src/V1/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig/Type.php @@ -0,0 +1,63 @@ +google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig.Type + */ +class Type +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_TYPE = 0; + */ + const UNDEFINED_TYPE = 0; + /** + * Generated from protobuf enum HTTP_HEADER_HOST = 374321891; + */ + const HTTP_HEADER_HOST = 374321891; + /** + * Generated from protobuf enum HTTP_PATH = 311503228; + */ + const HTTP_PATH = 311503228; + /** + * Generated from protobuf enum UNSPECIFIED_TYPE = 53933922; + */ + const UNSPECIFIED_TYPE = 53933922; + + private static $valueToName = [ + self::UNDEFINED_TYPE => 'UNDEFINED_TYPE', + self::HTTP_HEADER_HOST => 'HTTP_HEADER_HOST', + self::HTTP_PATH => 'HTTP_PATH', + self::UNSPECIFIED_TYPE => 'UNSPECIFIED_TYPE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/ServiceAttachment.php b/Compute/src/V1/ServiceAttachment.php index edcf19a0917c..bf42e5e81f5f 100644 --- a/Compute/src/V1/ServiceAttachment.php +++ b/Compute/src/V1/ServiceAttachment.php @@ -100,6 +100,12 @@ class ServiceAttachment extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string producer_forwarding_rule = 247927889; */ private $producer_forwarding_rule = null; + /** + * The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250. + * + * Generated from protobuf field optional uint32 propagated_connection_limit = 332719230; + */ + private $propagated_connection_limit = null; /** * [Output Only] An 128-bit global unique ID of the PSC service attachment. * @@ -166,6 +172,8 @@ class ServiceAttachment extends \Google\Protobuf\Internal\Message * An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment. * @type string $producer_forwarding_rule * The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment. + * @type int $propagated_connection_limit + * The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250. * @type \Google\Cloud\Compute\V1\Uint128 $psc_service_attachment_id * [Output Only] An 128-bit global unique ID of the PSC service attachment. * @type bool $reconcile_connections @@ -639,6 +647,42 @@ public function setProducerForwardingRule($var) return $this; } + /** + * The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250. + * + * Generated from protobuf field optional uint32 propagated_connection_limit = 332719230; + * @return int + */ + public function getPropagatedConnectionLimit() + { + return isset($this->propagated_connection_limit) ? $this->propagated_connection_limit : 0; + } + + public function hasPropagatedConnectionLimit() + { + return isset($this->propagated_connection_limit); + } + + public function clearPropagatedConnectionLimit() + { + unset($this->propagated_connection_limit); + } + + /** + * The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250. + * + * Generated from protobuf field optional uint32 propagated_connection_limit = 332719230; + * @param int $var + * @return $this + */ + public function setPropagatedConnectionLimit($var) + { + GPBUtil::checkUint32($var); + $this->propagated_connection_limit = $var; + + return $this; + } + /** * [Output Only] An 128-bit global unique ID of the PSC service attachment. * diff --git a/Compute/src/V1/ServiceAttachmentConnectedEndpoint.php b/Compute/src/V1/ServiceAttachmentConnectedEndpoint.php index 4c73e49944b5..810321f28935 100644 --- a/Compute/src/V1/ServiceAttachmentConnectedEndpoint.php +++ b/Compute/src/V1/ServiceAttachmentConnectedEndpoint.php @@ -27,6 +27,12 @@ class ServiceAttachmentConnectedEndpoint extends \Google\Protobuf\Internal\Messa * Generated from protobuf field optional string endpoint = 130489749; */ private $endpoint = null; + /** + * The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to. + * + * Generated from protobuf field optional uint32 propagated_connection_count = 324594130; + */ + private $propagated_connection_count = null; /** * The PSC connection id of the connected endpoint. * @@ -51,6 +57,8 @@ class ServiceAttachmentConnectedEndpoint extends \Google\Protobuf\Internal\Messa * The url of the consumer network. * @type string $endpoint * The url of a connected endpoint. + * @type int $propagated_connection_count + * The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to. * @type int|string $psc_connection_id * The PSC connection id of the connected endpoint. * @type string $status @@ -135,6 +143,42 @@ public function setEndpoint($var) return $this; } + /** + * The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to. + * + * Generated from protobuf field optional uint32 propagated_connection_count = 324594130; + * @return int + */ + public function getPropagatedConnectionCount() + { + return isset($this->propagated_connection_count) ? $this->propagated_connection_count : 0; + } + + public function hasPropagatedConnectionCount() + { + return isset($this->propagated_connection_count); + } + + public function clearPropagatedConnectionCount() + { + unset($this->propagated_connection_count); + } + + /** + * The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to. + * + * Generated from protobuf field optional uint32 propagated_connection_count = 324594130; + * @param int $var + * @return $this + */ + public function setPropagatedConnectionCount($var) + { + GPBUtil::checkUint32($var); + $this->propagated_connection_count = $var; + + return $this; + } + /** * The PSC connection id of the connected endpoint. * diff --git a/Compute/src/V1/StoragePool.php b/Compute/src/V1/StoragePool.php index 69212b2834bb..3f7a43ad98fe 100644 --- a/Compute/src/V1/StoragePool.php +++ b/Compute/src/V1/StoragePool.php @@ -72,7 +72,7 @@ class StoragePool extends \Google\Protobuf\Internal\Message */ private $performance_provisioning_type = null; /** - * Size, in GiB, of the storage pool. + * Size, in GiB, of the storage pool. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools. * * Generated from protobuf field optional int64 pool_provisioned_capacity_gb = 478537682; */ @@ -160,7 +160,7 @@ class StoragePool extends \Google\Protobuf\Internal\Message * Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. * Check the PerformanceProvisioningType enum for the list of possible values. * @type int|string $pool_provisioned_capacity_gb - * Size, in GiB, of the storage pool. + * Size, in GiB, of the storage pool. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools. * @type int|string $pool_provisioned_iops * Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced. * @type int|string $pool_provisioned_throughput @@ -506,7 +506,7 @@ public function setPerformanceProvisioningType($var) } /** - * Size, in GiB, of the storage pool. + * Size, in GiB, of the storage pool. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools. * * Generated from protobuf field optional int64 pool_provisioned_capacity_gb = 478537682; * @return int|string @@ -527,7 +527,7 @@ public function clearPoolProvisionedCapacityGb() } /** - * Size, in GiB, of the storage pool. + * Size, in GiB, of the storage pool. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools. * * Generated from protobuf field optional int64 pool_provisioned_capacity_gb = 478537682; * @param int|string $var diff --git a/Compute/src/V1/StoragePoolResourceStatus.php b/Compute/src/V1/StoragePoolResourceStatus.php index 8dfb231b130a..618ee04d90e8 100644 --- a/Compute/src/V1/StoragePoolResourceStatus.php +++ b/Compute/src/V1/StoragePoolResourceStatus.php @@ -40,7 +40,7 @@ class StoragePoolResourceStatus extends \Google\Protobuf\Internal\Message */ private $pool_used_capacity_bytes = null; /** - * Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. + * [Output Only] Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. For more information, see https://cloud.google.com/compute/docs/disks/storage-pools. * * Generated from protobuf field optional int64 pool_used_iops = 99558536; */ @@ -91,7 +91,7 @@ class StoragePoolResourceStatus extends \Google\Protobuf\Internal\Message * @type int|string $pool_used_capacity_bytes * [Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks. * @type int|string $pool_used_iops - * Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. + * [Output Only] Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. For more information, see https://cloud.google.com/compute/docs/disks/storage-pools. * @type int|string $pool_used_throughput * [Output Only] Sum of all the disks' provisioned throughput in MB/s. * @type int|string $pool_user_written_bytes @@ -254,7 +254,7 @@ public function setPoolUsedCapacityBytes($var) } /** - * Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. + * [Output Only] Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. For more information, see https://cloud.google.com/compute/docs/disks/storage-pools. * * Generated from protobuf field optional int64 pool_used_iops = 99558536; * @return int|string @@ -275,7 +275,7 @@ public function clearPoolUsedIops() } /** - * Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. + * [Output Only] Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. For more information, see https://cloud.google.com/compute/docs/disks/storage-pools. * * Generated from protobuf field optional int64 pool_used_iops = 99558536; * @param int|string $var diff --git a/Compute/src/V1/Subnetwork.php b/Compute/src/V1/Subnetwork.php index a4daacd7fe8b..59ef7613be2f 100644 --- a/Compute/src/V1/Subnetwork.php +++ b/Compute/src/V1/Subnetwork.php @@ -58,7 +58,7 @@ class Subnetwork extends \Google\Protobuf\Internal\Message */ private $id = null; /** - * [Output Only] The internal IPv6 address range that is assigned to this subnetwork. + * The internal IPv6 address range that is owned by this subnetwork. * * Generated from protobuf field optional string internal_ipv6_prefix = 506270056; */ @@ -193,7 +193,7 @@ class Subnetwork extends \Google\Protobuf\Internal\Message * @type int|string $id * [Output Only] The unique identifier for the resource. This identifier is defined by the server. * @type string $internal_ipv6_prefix - * [Output Only] The internal IPv6 address range that is assigned to this subnetwork. + * The internal IPv6 address range that is owned by this subnetwork. * @type string $ip_cidr_range * The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. * @type string $ipv6_access_type @@ -494,7 +494,7 @@ public function setId($var) } /** - * [Output Only] The internal IPv6 address range that is assigned to this subnetwork. + * The internal IPv6 address range that is owned by this subnetwork. * * Generated from protobuf field optional string internal_ipv6_prefix = 506270056; * @return string @@ -515,7 +515,7 @@ public function clearInternalIpv6Prefix() } /** - * [Output Only] The internal IPv6 address range that is assigned to this subnetwork. + * The internal IPv6 address range that is owned by this subnetwork. * * Generated from protobuf field optional string internal_ipv6_prefix = 506270056; * @param string $var diff --git a/Compute/src/V1/Subnetwork/StackType.php b/Compute/src/V1/Subnetwork/StackType.php index 35716498827d..2d8a2f456cbb 100644 --- a/Compute/src/V1/Subnetwork/StackType.php +++ b/Compute/src/V1/Subnetwork/StackType.php @@ -31,6 +31,12 @@ class StackType * Generated from protobuf enum IPV4_ONLY = 22373798; */ const IPV4_ONLY = 22373798; + /** + * New VMs in this subnet will only be assigned IPv6 addresses. + * + * Generated from protobuf enum IPV6_ONLY = 79632100; + */ + const IPV6_ONLY = 79632100; /** * Generated from protobuf enum UNSPECIFIED_STACK_TYPE = 298084569; */ @@ -40,6 +46,7 @@ class StackType self::UNDEFINED_STACK_TYPE => 'UNDEFINED_STACK_TYPE', self::IPV4_IPV6 => 'IPV4_IPV6', self::IPV4_ONLY => 'IPV4_ONLY', + self::IPV6_ONLY => 'IPV6_ONLY', self::UNSPECIFIED_STACK_TYPE => 'UNSPECIFIED_STACK_TYPE', ]; diff --git a/Compute/src/V1/TargetHttpsProxy.php b/Compute/src/V1/TargetHttpsProxy.php index 5041816e0da7..58b66f8e6f83 100644 --- a/Compute/src/V1/TargetHttpsProxy.php +++ b/Compute/src/V1/TargetHttpsProxy.php @@ -22,7 +22,7 @@ class TargetHttpsProxy extends \Google\Protobuf\Internal\Message */ private $authorization_policy = null; /** - * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. + * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. * * Generated from protobuf field optional string certificate_map = 156463796; */ @@ -101,7 +101,7 @@ class TargetHttpsProxy extends \Google\Protobuf\Internal\Message */ private $server_tls_policy = null; /** - * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}. * * Generated from protobuf field repeated string ssl_certificates = 366006543; */ @@ -112,6 +112,13 @@ class TargetHttpsProxy extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string ssl_policy = 295190213; */ private $ssl_policy = null; + /** + * Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to "zero". This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the "Early-Data" HTTP header set on the request, with a value of "1", to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the "Early-Data: 1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED. + * Check the TlsEarlyData enum for the list of possible values. + * + * Generated from protobuf field optional string tls_early_data = 61108426; + */ + private $tls_early_data = null; /** * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map * @@ -128,7 +135,7 @@ class TargetHttpsProxy extends \Google\Protobuf\Internal\Message * @type string $authorization_policy * Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. * @type string $certificate_map - * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. + * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. * @type string $creation_timestamp * [Output Only] Creation timestamp in RFC3339 text format. * @type string $description @@ -155,9 +162,12 @@ class TargetHttpsProxy extends \Google\Protobuf\Internal\Message * @type string $server_tls_policy * Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. * @type array|\Google\Protobuf\Internal\RepeatedField $ssl_certificates - * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}. * @type string $ssl_policy * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. + * @type string $tls_early_data + * Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to "zero". This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the "Early-Data" HTTP header set on the request, with a value of "1", to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the "Early-Data: 1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED. + * Check the TlsEarlyData enum for the list of possible values. * @type string $url_map * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map * } @@ -204,7 +214,7 @@ public function setAuthorizationPolicy($var) } /** - * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. + * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. * * Generated from protobuf field optional string certificate_map = 156463796; * @return string @@ -225,7 +235,7 @@ public function clearCertificateMap() } /** - * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. + * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. * * Generated from protobuf field optional string certificate_map = 156463796; * @param string $var @@ -674,7 +684,7 @@ public function setServerTlsPolicy($var) } /** - * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}. * * Generated from protobuf field repeated string ssl_certificates = 366006543; * @return \Google\Protobuf\Internal\RepeatedField @@ -685,7 +695,7 @@ public function getSslCertificates() } /** - * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}. * * Generated from protobuf field repeated string ssl_certificates = 366006543; * @param array|\Google\Protobuf\Internal\RepeatedField $var @@ -735,6 +745,44 @@ public function setSslPolicy($var) return $this; } + /** + * Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to "zero". This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the "Early-Data" HTTP header set on the request, with a value of "1", to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the "Early-Data: 1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED. + * Check the TlsEarlyData enum for the list of possible values. + * + * Generated from protobuf field optional string tls_early_data = 61108426; + * @return string + */ + public function getTlsEarlyData() + { + return isset($this->tls_early_data) ? $this->tls_early_data : ''; + } + + public function hasTlsEarlyData() + { + return isset($this->tls_early_data); + } + + public function clearTlsEarlyData() + { + unset($this->tls_early_data); + } + + /** + * Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to "zero". This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the "Early-Data" HTTP header set on the request, with a value of "1", to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the "Early-Data: 1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED. + * Check the TlsEarlyData enum for the list of possible values. + * + * Generated from protobuf field optional string tls_early_data = 61108426; + * @param string $var + * @return $this + */ + public function setTlsEarlyData($var) + { + GPBUtil::checkString($var, True); + $this->tls_early_data = $var; + + return $this; + } + /** * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map * diff --git a/Compute/src/V1/TargetHttpsProxy/TlsEarlyData.php b/Compute/src/V1/TargetHttpsProxy/TlsEarlyData.php new file mode 100644 index 000000000000..597594335f94 --- /dev/null +++ b/Compute/src/V1/TargetHttpsProxy/TlsEarlyData.php @@ -0,0 +1,69 @@ +google.cloud.compute.v1.TargetHttpsProxy.TlsEarlyData + */ +class TlsEarlyData +{ + /** + * A value indicating that the enum field is not set. + * + * Generated from protobuf enum UNDEFINED_TLS_EARLY_DATA = 0; + */ + const UNDEFINED_TLS_EARLY_DATA = 0; + /** + * TLS 1.3 Early Data is not advertised, and any (invalid) attempts to send Early Data will be rejected by closing the connection. + * + * Generated from protobuf enum DISABLED = 516696700; + */ + const DISABLED = 516696700; + /** + * This enables TLS 1.3 0-RTT, and only allows Early Data to be included on requests with safe HTTP methods (GET, HEAD, OPTIONS, TRACE). This mode does not enforce any other limitations for requests with Early Data. The application owner should validate that Early Data is acceptable for a given request path. + * + * Generated from protobuf enum PERMISSIVE = 504345247; + */ + const PERMISSIVE = 504345247; + /** + * This enables TLS 1.3 0-RTT, and only allows Early Data to be included on requests with safe HTTP methods (GET, HEAD, OPTIONS, TRACE) without query parameters. Requests that send Early Data with non-idempotent HTTP methods or with query parameters will be rejected with a HTTP 425. + * + * Generated from protobuf enum STRICT = 308826825; + */ + const STRICT = 308826825; + + private static $valueToName = [ + self::UNDEFINED_TLS_EARLY_DATA => 'UNDEFINED_TLS_EARLY_DATA', + self::DISABLED => 'DISABLED', + self::PERMISSIVE => 'PERMISSIVE', + self::STRICT => 'STRICT', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Compute/src/V1/TargetPool/SessionAffinity.php b/Compute/src/V1/TargetPool/SessionAffinity.php index 684ca5ad2403..cbccd93dcce7 100644 --- a/Compute/src/V1/TargetPool/SessionAffinity.php +++ b/Compute/src/V1/TargetPool/SessionAffinity.php @@ -67,6 +67,12 @@ class SessionAffinity * Generated from protobuf enum NONE = 2402104; */ const NONE = 2402104; + /** + * Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired. + * + * Generated from protobuf enum STRONG_COOKIE_AFFINITY = 438628091; + */ + const STRONG_COOKIE_AFFINITY = 438628091; private static $valueToName = [ self::UNDEFINED_SESSION_AFFINITY => 'UNDEFINED_SESSION_AFFINITY', @@ -78,6 +84,7 @@ class SessionAffinity self::HEADER_FIELD => 'HEADER_FIELD', self::HTTP_COOKIE => 'HTTP_COOKIE', self::NONE => 'NONE', + self::STRONG_COOKIE_AFFINITY => 'STRONG_COOKIE_AFFINITY', ]; public static function name($value) diff --git a/Compute/src/V1/UrlMap.php b/Compute/src/V1/UrlMap.php index 8d9315562a90..96cd3660d52e 100644 --- a/Compute/src/V1/UrlMap.php +++ b/Compute/src/V1/UrlMap.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by global external Application Load Balancers, classic Application Load Balancers, and cross-region internal Application Load Balancers. * regionUrlMaps are used by internal Application Load Balancers, regional external Application Load Balancers and regional internal Application Load Balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts. + * Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by global external Application Load Balancers, classic Application Load Balancers, and cross-region internal Application Load Balancers. * regionUrlMaps are used by internal Application Load Balancers, regional external Application Load Balancers and regional internal Application Load Balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL, EXTERNAL_MANAGED, or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts. * * Generated from protobuf message google.cloud.compute.v1.UrlMap */ @@ -21,6 +21,12 @@ class UrlMap extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional string creation_timestamp = 30525366; */ private $creation_timestamp = null; + /** + * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089; + */ + private $default_custom_error_response_policy = null; /** * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. * @@ -28,7 +34,7 @@ class UrlMap extends \Google\Protobuf\Internal\Message */ private $default_route_action = null; /** - * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. * * Generated from protobuf field optional string default_service = 370242231; */ @@ -114,10 +120,12 @@ class UrlMap extends \Google\Protobuf\Internal\Message * * @type string $creation_timestamp * [Output Only] Creation timestamp in RFC3339 text format. + * @type \Google\Cloud\Compute\V1\CustomErrorResponsePolicy $default_custom_error_response_policy + * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. * @type \Google\Cloud\Compute\V1\HttpRouteAction $default_route_action * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. * @type string $default_service - * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. * @type \Google\Cloud\Compute\V1\HttpRedirectAction $default_url_redirect * When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. * @type string $description @@ -185,6 +193,42 @@ public function setCreationTimestamp($var) return $this; } + /** + * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089; + * @return \Google\Cloud\Compute\V1\CustomErrorResponsePolicy|null + */ + public function getDefaultCustomErrorResponsePolicy() + { + return $this->default_custom_error_response_policy; + } + + public function hasDefaultCustomErrorResponsePolicy() + { + return isset($this->default_custom_error_response_policy); + } + + public function clearDefaultCustomErrorResponsePolicy() + { + unset($this->default_custom_error_response_policy); + } + + /** + * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. + * + * Generated from protobuf field optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089; + * @param \Google\Cloud\Compute\V1\CustomErrorResponsePolicy $var + * @return $this + */ + public function setDefaultCustomErrorResponsePolicy($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\CustomErrorResponsePolicy::class); + $this->default_custom_error_response_policy = $var; + + return $this; + } + /** * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. * @@ -222,7 +266,7 @@ public function setDefaultRouteAction($var) } /** - * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. * * Generated from protobuf field optional string default_service = 370242231; * @return string @@ -243,7 +287,7 @@ public function clearDefaultService() } /** - * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. * * Generated from protobuf field optional string default_service = 370242231; * @param string $var diff --git a/Compute/src/V1/UsableSubnetwork/StackType.php b/Compute/src/V1/UsableSubnetwork/StackType.php index d196ba2e12ee..87d458ded8c4 100644 --- a/Compute/src/V1/UsableSubnetwork/StackType.php +++ b/Compute/src/V1/UsableSubnetwork/StackType.php @@ -31,11 +31,18 @@ class StackType * Generated from protobuf enum IPV4_ONLY = 22373798; */ const IPV4_ONLY = 22373798; + /** + * New VMs in this subnet will only be assigned IPv6 addresses. + * + * Generated from protobuf enum IPV6_ONLY = 79632100; + */ + const IPV6_ONLY = 79632100; private static $valueToName = [ self::UNDEFINED_STACK_TYPE => 'UNDEFINED_STACK_TYPE', self::IPV4_IPV6 => 'IPV4_IPV6', self::IPV4_ONLY => 'IPV4_ONLY', + self::IPV6_ONLY => 'IPV6_ONLY', ]; public static function name($value) diff --git a/Compute/src/V1/VpnGateway.php b/Compute/src/V1/VpnGateway.php index 997c65b32a8d..a708dff9b772 100644 --- a/Compute/src/V1/VpnGateway.php +++ b/Compute/src/V1/VpnGateway.php @@ -83,7 +83,7 @@ class VpnGateway extends \Google\Protobuf\Internal\Message */ private $self_link = null; /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. * Check the StackType enum for the list of possible values. * * Generated from protobuf field optional string stack_type = 425908881; @@ -126,7 +126,7 @@ class VpnGateway extends \Google\Protobuf\Internal\Message * @type string $self_link * [Output Only] Server-defined URL for the resource. * @type string $stack_type - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. * Check the StackType enum for the list of possible values. * @type array<\Google\Cloud\Compute\V1\VpnGatewayVpnGatewayInterface>|\Google\Protobuf\Internal\RepeatedField $vpn_interfaces * The list of VPN interfaces associated with this VPN gateway. @@ -526,7 +526,7 @@ public function setSelfLink($var) } /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. * Check the StackType enum for the list of possible values. * * Generated from protobuf field optional string stack_type = 425908881; @@ -548,7 +548,7 @@ public function clearStackType() } /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. * Check the StackType enum for the list of possible values. * * Generated from protobuf field optional string stack_type = 425908881; diff --git a/Compute/src/V1/VpnGateway/StackType.php b/Compute/src/V1/VpnGateway/StackType.php index cc20747a7dca..d672cbc2762f 100644 --- a/Compute/src/V1/VpnGateway/StackType.php +++ b/Compute/src/V1/VpnGateway/StackType.php @@ -7,7 +7,7 @@ use UnexpectedValueException; /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. * * Protobuf type google.cloud.compute.v1.VpnGateway.StackType */ @@ -31,11 +31,18 @@ class StackType * Generated from protobuf enum IPV4_ONLY = 22373798; */ const IPV4_ONLY = 22373798; + /** + * Enable VPN gateway with only IPv6 protocol. + * + * Generated from protobuf enum IPV6_ONLY = 79632100; + */ + const IPV6_ONLY = 79632100; private static $valueToName = [ self::UNDEFINED_STACK_TYPE => 'UNDEFINED_STACK_TYPE', self::IPV4_IPV6 => 'IPV4_IPV6', self::IPV4_ONLY => 'IPV4_ONLY', + self::IPV6_ONLY => 'IPV6_ONLY', ]; public static function name($value) diff --git a/Compute/src/V1/VpnTunnel.php b/Compute/src/V1/VpnTunnel.php index 1ed69b1b4af1..c22c7d03dd64 100644 --- a/Compute/src/V1/VpnTunnel.php +++ b/Compute/src/V1/VpnTunnel.php @@ -64,7 +64,7 @@ class VpnTunnel extends \Google\Protobuf\Internal\Message */ private $labels; /** - * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. * * Generated from protobuf field repeated string local_traffic_selector = 317314613; */ @@ -94,7 +94,7 @@ class VpnTunnel extends \Google\Protobuf\Internal\Message */ private $peer_gcp_gateway = null; /** - * IP address of the peer VPN gateway. Only IPv4 is supported. + * IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. * * Generated from protobuf field optional string peer_ip = 383249700; */ @@ -106,7 +106,7 @@ class VpnTunnel extends \Google\Protobuf\Internal\Message */ private $region = null; /** - * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. * * Generated from protobuf field repeated string remote_traffic_selector = 358887098; */ @@ -143,7 +143,7 @@ class VpnTunnel extends \Google\Protobuf\Internal\Message */ private $status = null; /** - * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. * * Generated from protobuf field optional string target_vpn_gateway = 532512843; */ @@ -184,7 +184,7 @@ class VpnTunnel extends \Google\Protobuf\Internal\Message * @type array|\Google\Protobuf\Internal\MapField $labels * Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. * @type array|\Google\Protobuf\Internal\RepeatedField $local_traffic_selector - * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. * @type string $name * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. * @type string $peer_external_gateway @@ -194,11 +194,11 @@ class VpnTunnel extends \Google\Protobuf\Internal\Message * @type string $peer_gcp_gateway * URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. * @type string $peer_ip - * IP address of the peer VPN gateway. Only IPv4 is supported. + * IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. * @type string $region * [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. * @type array|\Google\Protobuf\Internal\RepeatedField $remote_traffic_selector - * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. * @type string $router * URL of the router resource to be used for dynamic routing. * @type string $self_link @@ -211,7 +211,7 @@ class VpnTunnel extends \Google\Protobuf\Internal\Message * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. * Check the Status enum for the list of possible values. * @type string $target_vpn_gateway - * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. * @type string $vpn_gateway * URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. * @type int $vpn_gateway_interface @@ -502,7 +502,7 @@ public function setLabels($var) } /** - * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. * * Generated from protobuf field repeated string local_traffic_selector = 317314613; * @return \Google\Protobuf\Internal\RepeatedField @@ -513,7 +513,7 @@ public function getLocalTrafficSelector() } /** - * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. * * Generated from protobuf field repeated string local_traffic_selector = 317314613; * @param array|\Google\Protobuf\Internal\RepeatedField $var @@ -672,7 +672,7 @@ public function setPeerGcpGateway($var) } /** - * IP address of the peer VPN gateway. Only IPv4 is supported. + * IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. * * Generated from protobuf field optional string peer_ip = 383249700; * @return string @@ -693,7 +693,7 @@ public function clearPeerIp() } /** - * IP address of the peer VPN gateway. Only IPv4 is supported. + * IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. * * Generated from protobuf field optional string peer_ip = 383249700; * @param string $var @@ -744,7 +744,7 @@ public function setRegion($var) } /** - * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. * * Generated from protobuf field repeated string remote_traffic_selector = 358887098; * @return \Google\Protobuf\Internal\RepeatedField @@ -755,7 +755,7 @@ public function getRemoteTrafficSelector() } /** - * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. * * Generated from protobuf field repeated string remote_traffic_selector = 358887098; * @param array|\Google\Protobuf\Internal\RepeatedField $var @@ -952,7 +952,7 @@ public function setStatus($var) } /** - * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. * * Generated from protobuf field optional string target_vpn_gateway = 532512843; * @return string @@ -973,7 +973,7 @@ public function clearTargetVpnGateway() } /** - * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. * * Generated from protobuf field optional string target_vpn_gateway = 532512843; * @param string $var diff --git a/Compute/src/V1/WaitGlobalOperationRequest.php b/Compute/src/V1/WaitGlobalOperationRequest.php index f1729233bb8e..95107919ebfa 100644 --- a/Compute/src/V1/WaitGlobalOperationRequest.php +++ b/Compute/src/V1/WaitGlobalOperationRequest.php @@ -16,7 +16,7 @@ class WaitGlobalOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; */ @@ -30,7 +30,7 @@ class WaitGlobalOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\WaitGlobalOperationRequest * @@ -50,7 +50,7 @@ public static function build(string $project, string $operation): self * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * @type string $project * Project ID for this request. * } @@ -61,7 +61,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -72,7 +72,7 @@ public function getOperation() } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Compute/src/V1/WaitRegionOperationRequest.php b/Compute/src/V1/WaitRegionOperationRequest.php index 6e065f9d0b10..86b96744ccba 100644 --- a/Compute/src/V1/WaitRegionOperationRequest.php +++ b/Compute/src/V1/WaitRegionOperationRequest.php @@ -16,7 +16,7 @@ class WaitRegionOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; */ @@ -37,7 +37,7 @@ class WaitRegionOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. * @param string $region Name of the region for this request. - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\WaitRegionOperationRequest * @@ -58,7 +58,7 @@ public static function build(string $project, string $region, string $operation) * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * @type string $project * Project ID for this request. * @type string $region @@ -71,7 +71,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -82,7 +82,7 @@ public function getOperation() } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Compute/src/V1/WaitZoneOperationRequest.php b/Compute/src/V1/WaitZoneOperationRequest.php index c14adb3636fd..6a2f59746466 100644 --- a/Compute/src/V1/WaitZoneOperationRequest.php +++ b/Compute/src/V1/WaitZoneOperationRequest.php @@ -16,7 +16,7 @@ class WaitZoneOperationRequest extends \Google\Protobuf\Internal\Message { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; */ @@ -37,7 +37,7 @@ class WaitZoneOperationRequest extends \Google\Protobuf\Internal\Message /** * @param string $project Project ID for this request. * @param string $zone Name of the zone for this request. - * @param string $operation Name of the Operations resource to return. + * @param string $operation Name of the Operations resource to return, or its unique numeric identifier. * * @return \Google\Cloud\Compute\V1\WaitZoneOperationRequest * @@ -58,7 +58,7 @@ public static function build(string $project, string $zone, string $operation): * Optional. Data for populating the Message object. * * @type string $operation - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * @type string $project * Project ID for this request. * @type string $zone @@ -71,7 +71,7 @@ public function __construct($data = NULL) { } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -82,7 +82,7 @@ public function getOperation() } /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. * * Generated from protobuf field string operation = 52090215 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Compute/src/V1/WeightedBackendService.php b/Compute/src/V1/WeightedBackendService.php index 651414a1bf47..377b8102f991 100644 --- a/Compute/src/V1/WeightedBackendService.php +++ b/Compute/src/V1/WeightedBackendService.php @@ -28,7 +28,7 @@ class WeightedBackendService extends \Google\Protobuf\Internal\Message */ private $header_action = null; /** - * Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000. + * Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000. * * Generated from protobuf field optional uint32 weight = 282149496; */ @@ -45,7 +45,7 @@ class WeightedBackendService extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\Compute\V1\HttpHeaderAction $header_action * Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. * @type int $weight - * Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000. + * Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000. * } */ public function __construct($data = NULL) { @@ -126,7 +126,7 @@ public function setHeaderAction($var) } /** - * Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000. + * Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000. * * Generated from protobuf field optional uint32 weight = 282149496; * @return int @@ -147,7 +147,7 @@ public function clearWeight() } /** - * Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000. + * Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000. * * Generated from protobuf field optional uint32 weight = 282149496; * @param int $var diff --git a/Compute/src/V1/Zone.php b/Compute/src/V1/Zone.php index c092a15fde13..50344d8f043f 100644 --- a/Compute/src/V1/Zone.php +++ b/Compute/src/V1/Zone.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. + * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-b is located in the us-east1 region. For more information, read Regions and Zones. * * Generated from protobuf message google.cloud.compute.v1.Zone */ diff --git a/Compute/tests/Unit/V1/BackendServicesClientTest.php b/Compute/tests/Unit/V1/BackendServicesClientTest.php index 50c55891e361..1e7e20ad9788 100644 --- a/Compute/tests/Unit/V1/BackendServicesClientTest.php +++ b/Compute/tests/Unit/V1/BackendServicesClientTest.php @@ -517,6 +517,7 @@ public function getTest() $enableCDN = false; $fingerprint = 'fingerprint-1375934236'; $id = 3355; + $ipAddressSelectionPolicy = 'ipAddressSelectionPolicy614471752'; $kind = 'kind3292052'; $loadBalancingScheme = 'loadBalancingScheme1974502980'; $localityLbPolicy = 'localityLbPolicy-2016052161'; @@ -540,6 +541,7 @@ public function getTest() $expectedResponse->setEnableCDN($enableCDN); $expectedResponse->setFingerprint($fingerprint); $expectedResponse->setId($id); + $expectedResponse->setIpAddressSelectionPolicy($ipAddressSelectionPolicy); $expectedResponse->setKind($kind); $expectedResponse->setLoadBalancingScheme($loadBalancingScheme); $expectedResponse->setLocalityLbPolicy($localityLbPolicy); diff --git a/Compute/tests/Unit/V1/Client/BackendServicesClientTest.php b/Compute/tests/Unit/V1/Client/BackendServicesClientTest.php index e23414dcfd38..93120a38738c 100644 --- a/Compute/tests/Unit/V1/Client/BackendServicesClientTest.php +++ b/Compute/tests/Unit/V1/Client/BackendServicesClientTest.php @@ -559,6 +559,7 @@ public function getTest() $enableCDN = false; $fingerprint = 'fingerprint-1375934236'; $id = 3355; + $ipAddressSelectionPolicy = 'ipAddressSelectionPolicy614471752'; $kind = 'kind3292052'; $loadBalancingScheme = 'loadBalancingScheme1974502980'; $localityLbPolicy = 'localityLbPolicy-2016052161'; @@ -582,6 +583,7 @@ public function getTest() $expectedResponse->setEnableCDN($enableCDN); $expectedResponse->setFingerprint($fingerprint); $expectedResponse->setId($id); + $expectedResponse->setIpAddressSelectionPolicy($ipAddressSelectionPolicy); $expectedResponse->setKind($kind); $expectedResponse->setLoadBalancingScheme($loadBalancingScheme); $expectedResponse->setLocalityLbPolicy($localityLbPolicy); diff --git a/Compute/tests/Unit/V1/Client/DisksClientTest.php b/Compute/tests/Unit/V1/Client/DisksClientTest.php index 2fdef39b91a9..cb7b35cce771 100644 --- a/Compute/tests/Unit/V1/Client/DisksClientTest.php +++ b/Compute/tests/Unit/V1/Client/DisksClientTest.php @@ -704,6 +704,7 @@ public function getTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response + $accessMode = 'accessMode-1032586338'; $architecture = 'architecture839674195'; $creationTimestamp = 'creationTimestamp567396278'; $description = 'description-1724546052'; @@ -740,6 +741,7 @@ public function getTest() $type = 'type3575610'; $zone2 = 'zone2-696322977'; $expectedResponse = new Disk(); + $expectedResponse->setAccessMode($accessMode); $expectedResponse->setArchitecture($architecture); $expectedResponse->setCreationTimestamp($creationTimestamp); $expectedResponse->setDescription($description); diff --git a/Compute/tests/Unit/V1/Client/InstanceGroupManagersClientTest.php b/Compute/tests/Unit/V1/Client/InstanceGroupManagersClientTest.php index ac07cd22d5cb..4c8d9b0d2033 100644 --- a/Compute/tests/Unit/V1/Client/InstanceGroupManagersClientTest.php +++ b/Compute/tests/Unit/V1/Client/InstanceGroupManagersClientTest.php @@ -993,6 +993,8 @@ public function getTest() $listManagedInstancesResults = 'listManagedInstancesResults832918068'; $name = 'name3373707'; $region = 'region-934795532'; + $satisfiesPzi = false; + $satisfiesPzs = false; $selfLink = 'selfLink-1691268851'; $targetSize = 2084603409; $zone2 = 'zone2-696322977'; @@ -1008,6 +1010,8 @@ public function getTest() $expectedResponse->setListManagedInstancesResults($listManagedInstancesResults); $expectedResponse->setName($name); $expectedResponse->setRegion($region); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $expectedResponse->setSelfLink($selfLink); $expectedResponse->setTargetSize($targetSize); $expectedResponse->setZone($zone2); diff --git a/Compute/tests/Unit/V1/Client/MachineTypesClientTest.php b/Compute/tests/Unit/V1/Client/MachineTypesClientTest.php index 744aa675fb14..8dcc2fda5adc 100644 --- a/Compute/tests/Unit/V1/Client/MachineTypesClientTest.php +++ b/Compute/tests/Unit/V1/Client/MachineTypesClientTest.php @@ -153,6 +153,7 @@ public function getTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response + $architecture = 'architecture839674195'; $creationTimestamp = 'creationTimestamp567396278'; $description = 'description-1724546052'; $guestCpus = 1754126894; @@ -167,6 +168,7 @@ public function getTest() $selfLink = 'selfLink-1691268851'; $zone2 = 'zone2-696322977'; $expectedResponse = new MachineType(); + $expectedResponse->setArchitecture($architecture); $expectedResponse->setCreationTimestamp($creationTimestamp); $expectedResponse->setDescription($description); $expectedResponse->setGuestCpus($guestCpus); diff --git a/Compute/tests/Unit/V1/Client/RegionBackendServicesClientTest.php b/Compute/tests/Unit/V1/Client/RegionBackendServicesClientTest.php index 429a8fafd7b9..c0a5325cf8a0 100644 --- a/Compute/tests/Unit/V1/Client/RegionBackendServicesClientTest.php +++ b/Compute/tests/Unit/V1/Client/RegionBackendServicesClientTest.php @@ -228,6 +228,7 @@ public function getTest() $enableCDN = false; $fingerprint = 'fingerprint-1375934236'; $id = 3355; + $ipAddressSelectionPolicy = 'ipAddressSelectionPolicy614471752'; $kind = 'kind3292052'; $loadBalancingScheme = 'loadBalancingScheme1974502980'; $localityLbPolicy = 'localityLbPolicy-2016052161'; @@ -251,6 +252,7 @@ public function getTest() $expectedResponse->setEnableCDN($enableCDN); $expectedResponse->setFingerprint($fingerprint); $expectedResponse->setId($id); + $expectedResponse->setIpAddressSelectionPolicy($ipAddressSelectionPolicy); $expectedResponse->setKind($kind); $expectedResponse->setLoadBalancingScheme($loadBalancingScheme); $expectedResponse->setLocalityLbPolicy($localityLbPolicy); diff --git a/Compute/tests/Unit/V1/Client/RegionCommitmentsClientTest.php b/Compute/tests/Unit/V1/Client/RegionCommitmentsClientTest.php index 5a509153c42e..d3b4847fa69e 100644 --- a/Compute/tests/Unit/V1/Client/RegionCommitmentsClientTest.php +++ b/Compute/tests/Unit/V1/Client/RegionCommitmentsClientTest.php @@ -162,6 +162,7 @@ public function getTest() $autoRenew = false; $category = 'category50511102'; $creationTimestamp = 'creationTimestamp567396278'; + $customEndTimestamp = 'customEndTimestamp-1965712796'; $description = 'description-1724546052'; $endTimestamp = 'endTimestamp1004967602'; $id = 3355; @@ -179,6 +180,7 @@ public function getTest() $expectedResponse->setAutoRenew($autoRenew); $expectedResponse->setCategory($category); $expectedResponse->setCreationTimestamp($creationTimestamp); + $expectedResponse->setCustomEndTimestamp($customEndTimestamp); $expectedResponse->setDescription($description); $expectedResponse->setEndTimestamp($endTimestamp); $expectedResponse->setId($id); diff --git a/Compute/tests/Unit/V1/Client/RegionDisksClientTest.php b/Compute/tests/Unit/V1/Client/RegionDisksClientTest.php index 944e3b410b7f..69f49293dcc7 100644 --- a/Compute/tests/Unit/V1/Client/RegionDisksClientTest.php +++ b/Compute/tests/Unit/V1/Client/RegionDisksClientTest.php @@ -622,6 +622,7 @@ public function getTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response + $accessMode = 'accessMode-1032586338'; $architecture = 'architecture839674195'; $creationTimestamp = 'creationTimestamp567396278'; $description = 'description-1724546052'; @@ -658,6 +659,7 @@ public function getTest() $type = 'type3575610'; $zone = 'zone3744684'; $expectedResponse = new Disk(); + $expectedResponse->setAccessMode($accessMode); $expectedResponse->setArchitecture($architecture); $expectedResponse->setCreationTimestamp($creationTimestamp); $expectedResponse->setDescription($description); diff --git a/Compute/tests/Unit/V1/Client/RegionInstanceGroupManagersClientTest.php b/Compute/tests/Unit/V1/Client/RegionInstanceGroupManagersClientTest.php index 6a385097d20e..61fa103be176 100644 --- a/Compute/tests/Unit/V1/Client/RegionInstanceGroupManagersClientTest.php +++ b/Compute/tests/Unit/V1/Client/RegionInstanceGroupManagersClientTest.php @@ -911,6 +911,8 @@ public function getTest() $listManagedInstancesResults = 'listManagedInstancesResults832918068'; $name = 'name3373707'; $region2 = 'region2-690338393'; + $satisfiesPzi = false; + $satisfiesPzs = false; $selfLink = 'selfLink-1691268851'; $targetSize = 2084603409; $zone = 'zone3744684'; @@ -926,6 +928,8 @@ public function getTest() $expectedResponse->setListManagedInstancesResults($listManagedInstancesResults); $expectedResponse->setName($name); $expectedResponse->setRegion($region2); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $expectedResponse->setSelfLink($selfLink); $expectedResponse->setTargetSize($targetSize); $expectedResponse->setZone($zone); diff --git a/Compute/tests/Unit/V1/Client/RegionTargetHttpsProxiesClientTest.php b/Compute/tests/Unit/V1/Client/RegionTargetHttpsProxiesClientTest.php index d797873f7993..834ce229f901 100644 --- a/Compute/tests/Unit/V1/Client/RegionTargetHttpsProxiesClientTest.php +++ b/Compute/tests/Unit/V1/Client/RegionTargetHttpsProxiesClientTest.php @@ -224,6 +224,7 @@ public function getTest() $selfLink = 'selfLink-1691268851'; $serverTlsPolicy = 'serverTlsPolicy1906438002'; $sslPolicy = 'sslPolicy-1852293435'; + $tlsEarlyData = 'tlsEarlyData-1549504310'; $urlMap = 'urlMap-169850228'; $expectedResponse = new TargetHttpsProxy(); $expectedResponse->setAuthorizationPolicy($authorizationPolicy); @@ -241,6 +242,7 @@ public function getTest() $expectedResponse->setSelfLink($selfLink); $expectedResponse->setServerTlsPolicy($serverTlsPolicy); $expectedResponse->setSslPolicy($sslPolicy); + $expectedResponse->setTlsEarlyData($tlsEarlyData); $expectedResponse->setUrlMap($urlMap); $transport->addResponse($expectedResponse); // Mock request diff --git a/Compute/tests/Unit/V1/Client/ServiceAttachmentsClientTest.php b/Compute/tests/Unit/V1/Client/ServiceAttachmentsClientTest.php index 79726cadf3af..87aa08bcb619 100644 --- a/Compute/tests/Unit/V1/Client/ServiceAttachmentsClientTest.php +++ b/Compute/tests/Unit/V1/Client/ServiceAttachmentsClientTest.php @@ -303,6 +303,7 @@ public function getTest() $kind = 'kind3292052'; $name = 'name3373707'; $producerForwardingRule = 'producerForwardingRule-825813935'; + $propagatedConnectionLimit = 1814764418; $reconcileConnections = true; $region2 = 'region2-690338393'; $selfLink = 'selfLink-1691268851'; @@ -317,6 +318,7 @@ public function getTest() $expectedResponse->setKind($kind); $expectedResponse->setName($name); $expectedResponse->setProducerForwardingRule($producerForwardingRule); + $expectedResponse->setPropagatedConnectionLimit($propagatedConnectionLimit); $expectedResponse->setReconcileConnections($reconcileConnections); $expectedResponse->setRegion($region2); $expectedResponse->setSelfLink($selfLink); diff --git a/Compute/tests/Unit/V1/Client/TargetHttpsProxiesClientTest.php b/Compute/tests/Unit/V1/Client/TargetHttpsProxiesClientTest.php index ebffedbec524..6eeee417a314 100644 --- a/Compute/tests/Unit/V1/Client/TargetHttpsProxiesClientTest.php +++ b/Compute/tests/Unit/V1/Client/TargetHttpsProxiesClientTest.php @@ -305,6 +305,7 @@ public function getTest() $selfLink = 'selfLink-1691268851'; $serverTlsPolicy = 'serverTlsPolicy1906438002'; $sslPolicy = 'sslPolicy-1852293435'; + $tlsEarlyData = 'tlsEarlyData-1549504310'; $urlMap = 'urlMap-169850228'; $expectedResponse = new TargetHttpsProxy(); $expectedResponse->setAuthorizationPolicy($authorizationPolicy); @@ -322,6 +323,7 @@ public function getTest() $expectedResponse->setSelfLink($selfLink); $expectedResponse->setServerTlsPolicy($serverTlsPolicy); $expectedResponse->setSslPolicy($sslPolicy); + $expectedResponse->setTlsEarlyData($tlsEarlyData); $expectedResponse->setUrlMap($urlMap); $transport->addResponse($expectedResponse); // Mock request diff --git a/Compute/tests/Unit/V1/DisksClientTest.php b/Compute/tests/Unit/V1/DisksClientTest.php index 135dae766799..473002bfd6c7 100644 --- a/Compute/tests/Unit/V1/DisksClientTest.php +++ b/Compute/tests/Unit/V1/DisksClientTest.php @@ -646,6 +646,7 @@ public function getTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response + $accessMode = 'accessMode-1032586338'; $architecture = 'architecture839674195'; $creationTimestamp = 'creationTimestamp567396278'; $description = 'description-1724546052'; @@ -682,6 +683,7 @@ public function getTest() $type = 'type3575610'; $zone2 = 'zone2-696322977'; $expectedResponse = new Disk(); + $expectedResponse->setAccessMode($accessMode); $expectedResponse->setArchitecture($architecture); $expectedResponse->setCreationTimestamp($creationTimestamp); $expectedResponse->setDescription($description); diff --git a/Compute/tests/Unit/V1/InstanceGroupManagersClientTest.php b/Compute/tests/Unit/V1/InstanceGroupManagersClientTest.php index 6cf0dc0288da..aef3bcdfdf02 100644 --- a/Compute/tests/Unit/V1/InstanceGroupManagersClientTest.php +++ b/Compute/tests/Unit/V1/InstanceGroupManagersClientTest.php @@ -911,6 +911,8 @@ public function getTest() $listManagedInstancesResults = 'listManagedInstancesResults832918068'; $name = 'name3373707'; $region = 'region-934795532'; + $satisfiesPzi = false; + $satisfiesPzs = false; $selfLink = 'selfLink-1691268851'; $targetSize = 2084603409; $zone2 = 'zone2-696322977'; @@ -926,6 +928,8 @@ public function getTest() $expectedResponse->setListManagedInstancesResults($listManagedInstancesResults); $expectedResponse->setName($name); $expectedResponse->setRegion($region); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $expectedResponse->setSelfLink($selfLink); $expectedResponse->setTargetSize($targetSize); $expectedResponse->setZone($zone2); diff --git a/Compute/tests/Unit/V1/MachineTypesClientTest.php b/Compute/tests/Unit/V1/MachineTypesClientTest.php index d53b913629f2..4e9136c06077 100644 --- a/Compute/tests/Unit/V1/MachineTypesClientTest.php +++ b/Compute/tests/Unit/V1/MachineTypesClientTest.php @@ -146,6 +146,7 @@ public function getTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response + $architecture = 'architecture839674195'; $creationTimestamp = 'creationTimestamp567396278'; $description = 'description-1724546052'; $guestCpus = 1754126894; @@ -160,6 +161,7 @@ public function getTest() $selfLink = 'selfLink-1691268851'; $zone2 = 'zone2-696322977'; $expectedResponse = new MachineType(); + $expectedResponse->setArchitecture($architecture); $expectedResponse->setCreationTimestamp($creationTimestamp); $expectedResponse->setDescription($description); $expectedResponse->setGuestCpus($guestCpus); diff --git a/Compute/tests/Unit/V1/RegionBackendServicesClientTest.php b/Compute/tests/Unit/V1/RegionBackendServicesClientTest.php index b59bcec32fc0..4bceef4c235a 100644 --- a/Compute/tests/Unit/V1/RegionBackendServicesClientTest.php +++ b/Compute/tests/Unit/V1/RegionBackendServicesClientTest.php @@ -208,6 +208,7 @@ public function getTest() $enableCDN = false; $fingerprint = 'fingerprint-1375934236'; $id = 3355; + $ipAddressSelectionPolicy = 'ipAddressSelectionPolicy614471752'; $kind = 'kind3292052'; $loadBalancingScheme = 'loadBalancingScheme1974502980'; $localityLbPolicy = 'localityLbPolicy-2016052161'; @@ -231,6 +232,7 @@ public function getTest() $expectedResponse->setEnableCDN($enableCDN); $expectedResponse->setFingerprint($fingerprint); $expectedResponse->setId($id); + $expectedResponse->setIpAddressSelectionPolicy($ipAddressSelectionPolicy); $expectedResponse->setKind($kind); $expectedResponse->setLoadBalancingScheme($loadBalancingScheme); $expectedResponse->setLocalityLbPolicy($localityLbPolicy); diff --git a/Compute/tests/Unit/V1/RegionCommitmentsClientTest.php b/Compute/tests/Unit/V1/RegionCommitmentsClientTest.php index f22b3acd0a36..6d65bd11f0bb 100644 --- a/Compute/tests/Unit/V1/RegionCommitmentsClientTest.php +++ b/Compute/tests/Unit/V1/RegionCommitmentsClientTest.php @@ -153,6 +153,7 @@ public function getTest() $autoRenew = false; $category = 'category50511102'; $creationTimestamp = 'creationTimestamp567396278'; + $customEndTimestamp = 'customEndTimestamp-1965712796'; $description = 'description-1724546052'; $endTimestamp = 'endTimestamp1004967602'; $id = 3355; @@ -170,6 +171,7 @@ public function getTest() $expectedResponse->setAutoRenew($autoRenew); $expectedResponse->setCategory($category); $expectedResponse->setCreationTimestamp($creationTimestamp); + $expectedResponse->setCustomEndTimestamp($customEndTimestamp); $expectedResponse->setDescription($description); $expectedResponse->setEndTimestamp($endTimestamp); $expectedResponse->setId($id); diff --git a/Compute/tests/Unit/V1/RegionDisksClientTest.php b/Compute/tests/Unit/V1/RegionDisksClientTest.php index 45f266e1bfff..cf2869b246ab 100644 --- a/Compute/tests/Unit/V1/RegionDisksClientTest.php +++ b/Compute/tests/Unit/V1/RegionDisksClientTest.php @@ -569,6 +569,7 @@ public function getTest() ]); $this->assertTrue($transport->isExhausted()); // Mock response + $accessMode = 'accessMode-1032586338'; $architecture = 'architecture839674195'; $creationTimestamp = 'creationTimestamp567396278'; $description = 'description-1724546052'; @@ -605,6 +606,7 @@ public function getTest() $type = 'type3575610'; $zone = 'zone3744684'; $expectedResponse = new Disk(); + $expectedResponse->setAccessMode($accessMode); $expectedResponse->setArchitecture($architecture); $expectedResponse->setCreationTimestamp($creationTimestamp); $expectedResponse->setDescription($description); diff --git a/Compute/tests/Unit/V1/RegionInstanceGroupManagersClientTest.php b/Compute/tests/Unit/V1/RegionInstanceGroupManagersClientTest.php index a593a9c0cbca..39494c65b945 100644 --- a/Compute/tests/Unit/V1/RegionInstanceGroupManagersClientTest.php +++ b/Compute/tests/Unit/V1/RegionInstanceGroupManagersClientTest.php @@ -834,6 +834,8 @@ public function getTest() $listManagedInstancesResults = 'listManagedInstancesResults832918068'; $name = 'name3373707'; $region2 = 'region2-690338393'; + $satisfiesPzi = false; + $satisfiesPzs = false; $selfLink = 'selfLink-1691268851'; $targetSize = 2084603409; $zone = 'zone3744684'; @@ -849,6 +851,8 @@ public function getTest() $expectedResponse->setListManagedInstancesResults($listManagedInstancesResults); $expectedResponse->setName($name); $expectedResponse->setRegion($region2); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); $expectedResponse->setSelfLink($selfLink); $expectedResponse->setTargetSize($targetSize); $expectedResponse->setZone($zone); diff --git a/Compute/tests/Unit/V1/RegionTargetHttpsProxiesClientTest.php b/Compute/tests/Unit/V1/RegionTargetHttpsProxiesClientTest.php index aebd18fe5e97..79ed0933f7ce 100644 --- a/Compute/tests/Unit/V1/RegionTargetHttpsProxiesClientTest.php +++ b/Compute/tests/Unit/V1/RegionTargetHttpsProxiesClientTest.php @@ -209,6 +209,7 @@ public function getTest() $selfLink = 'selfLink-1691268851'; $serverTlsPolicy = 'serverTlsPolicy1906438002'; $sslPolicy = 'sslPolicy-1852293435'; + $tlsEarlyData = 'tlsEarlyData-1549504310'; $urlMap = 'urlMap-169850228'; $expectedResponse = new TargetHttpsProxy(); $expectedResponse->setAuthorizationPolicy($authorizationPolicy); @@ -226,6 +227,7 @@ public function getTest() $expectedResponse->setSelfLink($selfLink); $expectedResponse->setServerTlsPolicy($serverTlsPolicy); $expectedResponse->setSslPolicy($sslPolicy); + $expectedResponse->setTlsEarlyData($tlsEarlyData); $expectedResponse->setUrlMap($urlMap); $transport->addResponse($expectedResponse); // Mock request diff --git a/Compute/tests/Unit/V1/ServiceAttachmentsClientTest.php b/Compute/tests/Unit/V1/ServiceAttachmentsClientTest.php index d90dd255734f..ec5ffe147c53 100644 --- a/Compute/tests/Unit/V1/ServiceAttachmentsClientTest.php +++ b/Compute/tests/Unit/V1/ServiceAttachmentsClientTest.php @@ -282,6 +282,7 @@ public function getTest() $kind = 'kind3292052'; $name = 'name3373707'; $producerForwardingRule = 'producerForwardingRule-825813935'; + $propagatedConnectionLimit = 1814764418; $reconcileConnections = true; $region2 = 'region2-690338393'; $selfLink = 'selfLink-1691268851'; @@ -296,6 +297,7 @@ public function getTest() $expectedResponse->setKind($kind); $expectedResponse->setName($name); $expectedResponse->setProducerForwardingRule($producerForwardingRule); + $expectedResponse->setPropagatedConnectionLimit($propagatedConnectionLimit); $expectedResponse->setReconcileConnections($reconcileConnections); $expectedResponse->setRegion($region2); $expectedResponse->setSelfLink($selfLink); diff --git a/Compute/tests/Unit/V1/TargetHttpsProxiesClientTest.php b/Compute/tests/Unit/V1/TargetHttpsProxiesClientTest.php index e6c84fe10c09..b4116ebb74f4 100644 --- a/Compute/tests/Unit/V1/TargetHttpsProxiesClientTest.php +++ b/Compute/tests/Unit/V1/TargetHttpsProxiesClientTest.php @@ -284,6 +284,7 @@ public function getTest() $selfLink = 'selfLink-1691268851'; $serverTlsPolicy = 'serverTlsPolicy1906438002'; $sslPolicy = 'sslPolicy-1852293435'; + $tlsEarlyData = 'tlsEarlyData-1549504310'; $urlMap = 'urlMap-169850228'; $expectedResponse = new TargetHttpsProxy(); $expectedResponse->setAuthorizationPolicy($authorizationPolicy); @@ -301,6 +302,7 @@ public function getTest() $expectedResponse->setSelfLink($selfLink); $expectedResponse->setServerTlsPolicy($serverTlsPolicy); $expectedResponse->setSslPolicy($sslPolicy); + $expectedResponse->setTlsEarlyData($tlsEarlyData); $expectedResponse->setUrlMap($urlMap); $transport->addResponse($expectedResponse); // Mock request From d5d831b8a49c207b622cc1665699d1869aadc5b5 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 22:02:40 -0800 Subject: [PATCH 083/157] feat: add options of client_certificate_settings, bigquery_export_settings, bearer_token_config and boost_control_spec; add support of ALAW encoding (#7811) PiperOrigin-RevId: 693462707 Source-Link: https://github.com/googleapis/googleapis/commit/dc219758b92d84a58e46228cc32654027e31d8b3 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4ff8e5c4614a77b72d43f5b64b71d9171ea78259 Copy-Tag: eyJwIjoiRGlhbG9nZmxvd0N4Ly5Pd2xCb3QueWFtbCIsImgiOiI0ZmY4ZTVjNDYxNGE3N2I3MmQ0M2Y1YjY0YjcxZDkxNzFlYTc4MjU5In0= --- DialogflowCx/metadata/V3/AdvancedSettings.php | 6 +- DialogflowCx/metadata/V3/Agent.php | Bin 8597 -> 9008 bytes DialogflowCx/metadata/V3/AudioConfig.php | Bin 3359 -> 3416 bytes DialogflowCx/metadata/V3/Changelog.php | 6 +- .../metadata/V3/DataStoreConnection.php | Bin 3486 -> 3483 bytes DialogflowCx/metadata/V3/EntityType.php | Bin 6228 -> 6225 bytes DialogflowCx/metadata/V3/Environment.php | Bin 7380 -> 7377 bytes DialogflowCx/metadata/V3/Experiment.php | Bin 6925 -> 6922 bytes DialogflowCx/metadata/V3/Flow.php | Bin 7585 -> 7582 bytes DialogflowCx/metadata/V3/Fulfillment.php | Bin 2229 -> 2226 bytes DialogflowCx/metadata/V3/Gcs.php | 6 +- .../metadata/V3/GenerativeSettings.php | 6 +- DialogflowCx/metadata/V3/Generator.php | Bin 3650 -> 3905 bytes DialogflowCx/metadata/V3/ImportStrategy.php | Bin 1048 -> 1045 bytes DialogflowCx/metadata/V3/Intent.php | Bin 5934 -> 5931 bytes DialogflowCx/metadata/V3/Page.php | Bin 5850 -> 5847 bytes DialogflowCx/metadata/V3/SafetySettings.php | 6 +- DialogflowCx/metadata/V3/Session.php | Bin 12855 -> 13601 bytes DialogflowCx/metadata/V3/TestCase.php | Bin 12149 -> 12146 bytes .../metadata/V3/TransitionRouteGroup.php | 6 +- .../metadata/V3/ValidationMessage.php | Bin 1582 -> 1579 bytes DialogflowCx/metadata/V3/Version.php | Bin 5018 -> 5015 bytes DialogflowCx/metadata/V3/Webhook.php | Bin 8332 -> 8329 bytes .../samples/V3/AgentsClient/create_agent.php | 2 +- .../samples/V3/AgentsClient/delete_agent.php | 2 +- .../samples/V3/AgentsClient/export_agent.php | 2 +- .../samples/V3/AgentsClient/get_agent.php | 2 +- .../get_agent_validation_result.php | 4 +- .../AgentsClient/get_generative_settings.php | 4 +- .../samples/V3/AgentsClient/list_agents.php | 2 +- .../samples/V3/AgentsClient/restore_agent.php | 2 +- .../V3/AgentsClient/validate_agent.php | 2 +- .../V3/ChangelogsClient/get_changelog.php | 4 +- .../V3/ChangelogsClient/list_changelogs.php | 2 +- .../V3/DeploymentsClient/get_deployment.php | 3 +- .../V3/DeploymentsClient/list_deployments.php | 5 +- .../EntityTypesClient/create_entity_type.php | 2 +- .../EntityTypesClient/delete_entity_type.php | 4 +- .../EntityTypesClient/export_entity_types.php | 7 +- .../V3/EntityTypesClient/get_entity_type.php | 4 +- .../EntityTypesClient/import_entity_types.php | 2 +- .../EntityTypesClient/list_entity_types.php | 2 +- .../EnvironmentsClient/create_environment.php | 2 +- .../EnvironmentsClient/delete_environment.php | 3 +- .../V3/EnvironmentsClient/deploy_flow.php | 8 +- .../V3/EnvironmentsClient/get_environment.php | 3 +- .../list_continuous_test_results.php | 4 +- .../EnvironmentsClient/list_environments.php | 4 +- .../lookup_environment_history.php | 4 +- .../run_continuous_test.php | 4 +- .../ExperimentsClient/create_experiment.php | 3 +- .../ExperimentsClient/delete_experiment.php | 3 +- .../V3/ExperimentsClient/get_experiment.php | 3 +- .../V3/ExperimentsClient/list_experiments.php | 5 +- .../V3/ExperimentsClient/start_experiment.php | 4 +- .../V3/ExperimentsClient/stop_experiment.php | 4 +- .../samples/V3/FlowsClient/create_flow.php | 2 +- .../samples/V3/FlowsClient/delete_flow.php | 4 +- .../samples/V3/FlowsClient/export_flow.php | 4 +- .../samples/V3/FlowsClient/get_flow.php | 4 +- .../get_flow_validation_result.php | 4 +- .../samples/V3/FlowsClient/import_flow.php | 2 +- .../samples/V3/FlowsClient/list_flows.php | 2 +- .../samples/V3/FlowsClient/train_flow.php | 4 +- .../samples/V3/FlowsClient/validate_flow.php | 4 +- .../V3/GeneratorsClient/create_generator.php | 2 +- .../V3/GeneratorsClient/delete_generator.php | 4 +- .../V3/GeneratorsClient/get_generator.php | 4 +- .../V3/GeneratorsClient/list_generators.php | 2 +- .../V3/IntentsClient/create_intent.php | 2 +- .../V3/IntentsClient/delete_intent.php | 4 +- .../V3/IntentsClient/export_intents.php | 7 +- .../samples/V3/IntentsClient/get_intent.php | 4 +- .../V3/IntentsClient/import_intents.php | 2 +- .../samples/V3/IntentsClient/list_intents.php | 2 +- .../samples/V3/PagesClient/create_page.php | 4 +- .../samples/V3/PagesClient/delete_page.php | 4 +- .../samples/V3/PagesClient/get_page.php | 4 +- .../samples/V3/PagesClient/list_pages.php | 4 +- .../create_security_settings.php | 2 +- .../delete_security_settings.php | 4 +- .../get_security_settings.php | 4 +- .../list_security_settings.php | 2 +- .../create_session_entity_type.php | 17 +- .../delete_session_entity_type.php | 12 +- .../get_session_entity_type.php | 10 +- .../list_session_entity_types.php | 7 +- .../update_session_entity_type.php | 10 +- .../V3/SessionsClient/detect_intent.php | 7 +- .../V3/SessionsClient/match_intent.php | 7 +- .../server_streaming_detect_intent.php | 7 +- .../batch_delete_test_cases.php | 6 +- .../TestCasesClient/batch_run_test_cases.php | 8 +- .../V3/TestCasesClient/calculate_coverage.php | 2 +- .../V3/TestCasesClient/create_test_case.php | 2 +- .../V3/TestCasesClient/export_test_cases.php | 2 +- .../V3/TestCasesClient/get_test_case.php | 4 +- .../TestCasesClient/get_test_case_result.php | 4 +- .../V3/TestCasesClient/import_test_cases.php | 2 +- .../list_test_case_results.php | 5 +- .../V3/TestCasesClient/list_test_cases.php | 2 +- .../V3/TestCasesClient/run_test_case.php | 4 +- .../create_transition_route_group.php | 6 +- .../delete_transition_route_group.php | 8 +- .../get_transition_route_group.php | 8 +- .../list_transition_route_groups.php | 6 +- .../V3/VersionsClient/compare_versions.php | 8 +- .../V3/VersionsClient/create_version.php | 3 +- .../V3/VersionsClient/delete_version.php | 4 +- .../samples/V3/VersionsClient/get_version.php | 4 +- .../V3/VersionsClient/list_versions.php | 4 +- .../V3/VersionsClient/load_version.php | 4 +- .../V3/WebhooksClient/create_webhook.php | 2 +- .../V3/WebhooksClient/delete_webhook.php | 4 +- .../samples/V3/WebhooksClient/get_webhook.php | 4 +- .../V3/WebhooksClient/list_webhooks.php | 2 +- .../V3/AdvancedSettings/LoggingSettings.php | 8 +- DialogflowCx/src/V3/Agent.php | 84 ++++-- .../V3/Agent/ClientCertificateSettings.php | 160 +++++++++++ DialogflowCx/src/V3/AgentValidationResult.php | 16 +- DialogflowCx/src/V3/AudioEncoding.php | 7 + .../src/V3/BatchDeleteTestCasesRequest.php | 26 +- .../src/V3/BatchRunTestCasesRequest.php | 44 ++- .../src/V3/BoostSpec/ConditionBoostSpec.php | 48 ++++ .../ConditionBoostSpec/BoostControlSpec.php | 204 ++++++++++++++ .../BoostControlSpec/AttributeType.php | 71 +++++ .../BoostControlSpec/ControlPoint.php | 128 +++++++++ .../BoostControlSpec/InterpolationType.php | 57 ++++ .../src/V3/CalculateCoverageRequest.php | 8 +- .../src/V3/CalculateCoverageResponse.php | 8 +- DialogflowCx/src/V3/Changelog.php | 16 +- DialogflowCx/src/V3/Client/AgentsClient.php | 20 ++ .../src/V3/CompareVersionsRequest.php | 36 +-- DialogflowCx/src/V3/ContinuousTestResult.php | 16 +- DialogflowCx/src/V3/CreateAgentRequest.php | 10 +- .../src/V3/CreateEntityTypeRequest.php | 10 +- .../src/V3/CreateEnvironmentRequest.php | 10 +- .../src/V3/CreateExperimentRequest.php | 15 +- DialogflowCx/src/V3/CreateFlowRequest.php | 10 +- .../src/V3/CreateGeneratorRequest.php | 10 +- DialogflowCx/src/V3/CreateIntentRequest.php | 10 +- DialogflowCx/src/V3/CreatePageRequest.php | 20 +- .../src/V3/CreateSecuritySettingsRequest.php | 10 +- .../src/V3/CreateSessionEntityTypeRequest.php | 35 +-- DialogflowCx/src/V3/CreateTestCaseRequest.php | 10 +- .../V3/CreateTransitionRouteGroupRequest.php | 30 +-- .../src/V3/CreateVersionOperationMetadata.php | 16 +- DialogflowCx/src/V3/CreateVersionRequest.php | 15 +- DialogflowCx/src/V3/CreateWebhookRequest.php | 10 +- DialogflowCx/src/V3/DeleteAgentRequest.php | 10 +- .../src/V3/DeleteEntityTypeRequest.php | 20 +- .../src/V3/DeleteEnvironmentRequest.php | 15 +- .../src/V3/DeleteExperimentRequest.php | 15 +- DialogflowCx/src/V3/DeleteFlowRequest.php | 20 +- .../src/V3/DeleteGeneratorRequest.php | 20 +- DialogflowCx/src/V3/DeleteIntentRequest.php | 20 +- DialogflowCx/src/V3/DeletePageRequest.php | 20 +- .../src/V3/DeleteSecuritySettingsRequest.php | 20 +- .../src/V3/DeleteSessionEntityTypeRequest.php | 60 ++--- .../V3/DeleteTransitionRouteGroupRequest.php | 40 +-- DialogflowCx/src/V3/DeleteVersionRequest.php | 20 +- DialogflowCx/src/V3/DeleteWebhookRequest.php | 20 +- DialogflowCx/src/V3/DeployFlowRequest.php | 32 +-- DialogflowCx/src/V3/DeployFlowResponse.php | 12 +- DialogflowCx/src/V3/Deployment.php | 32 +-- DialogflowCx/src/V3/Deployment/Result.php | 32 +-- DialogflowCx/src/V3/DetectIntentRequest.php | 28 +- DialogflowCx/src/V3/EntityType.php | 16 +- DialogflowCx/src/V3/Environment.php | 16 +- .../src/V3/Environment/TestCasesConfig.php | 16 +- .../src/V3/Environment/VersionConfig.php | 28 +- DialogflowCx/src/V3/EventHandler.php | 24 +- DialogflowCx/src/V3/Experiment.php | 16 +- .../V3/Experiment/Result/VersionMetrics.php | 16 +- DialogflowCx/src/V3/ExportAgentRequest.php | 24 +- .../src/V3/ExportEntityTypesRequest.php | 28 +- DialogflowCx/src/V3/ExportFlowRequest.php | 16 +- DialogflowCx/src/V3/ExportIntentsRequest.php | 28 +- .../src/V3/ExportTestCasesRequest.php | 8 +- .../src/V3/ExportTestCasesResponse.php | 6 +- DialogflowCx/src/V3/Flow.php | 56 ++-- DialogflowCx/src/V3/FlowValidationResult.php | 16 +- DialogflowCx/src/V3/Form/Parameter.php | 36 +-- DialogflowCx/src/V3/Fulfillment.php | 16 +- DialogflowCx/src/V3/GenerativeSettings.php | 16 +- DialogflowCx/src/V3/Generator.php | 60 ++++- .../src/V3/Generator/ModelParameter.php | 255 ++++++++++++++++++ DialogflowCx/src/V3/GetAgentRequest.php | 10 +- .../V3/GetAgentValidationResultRequest.php | 20 +- DialogflowCx/src/V3/GetChangelogRequest.php | 20 +- DialogflowCx/src/V3/GetDeploymentRequest.php | 15 +- DialogflowCx/src/V3/GetEntityTypeRequest.php | 20 +- DialogflowCx/src/V3/GetEnvironmentRequest.php | 15 +- DialogflowCx/src/V3/GetExperimentRequest.php | 15 +- DialogflowCx/src/V3/GetFlowRequest.php | 20 +- .../src/V3/GetFlowValidationResultRequest.php | 20 +- .../src/V3/GetGenerativeSettingsRequest.php | 20 +- DialogflowCx/src/V3/GetGeneratorRequest.php | 20 +- DialogflowCx/src/V3/GetIntentRequest.php | 20 +- DialogflowCx/src/V3/GetPageRequest.php | 20 +- .../src/V3/GetSecuritySettingsRequest.php | 20 +- .../src/V3/GetSessionEntityTypeRequest.php | 50 ++-- DialogflowCx/src/V3/GetTestCaseRequest.php | 20 +- .../src/V3/GetTestCaseResultRequest.php | 20 +- .../src/V3/GetTransitionRouteGroupRequest.php | 40 +-- DialogflowCx/src/V3/GetVersionRequest.php | 20 +- DialogflowCx/src/V3/GetWebhookRequest.php | 20 +- .../src/V3/ImportEntityTypesRequest.php | 24 +- .../src/V3/ImportEntityTypesResponse.php | 16 +- DialogflowCx/src/V3/ImportFlowRequest.php | 8 +- DialogflowCx/src/V3/ImportFlowResponse.php | 16 +- DialogflowCx/src/V3/ImportIntentsRequest.php | 8 +- DialogflowCx/src/V3/ImportIntentsResponse.php | 16 +- .../src/V3/ImportTestCasesRequest.php | 8 +- .../src/V3/ImportTestCasesResponse.php | 16 +- DialogflowCx/src/V3/Intent.php | 16 +- DialogflowCx/src/V3/Intent/Parameter.php | 36 +-- DialogflowCx/src/V3/IntentInput.php | 16 +- .../src/V3/KnowledgeConnectorSettings.php | 24 +- DialogflowCx/src/V3/ListAgentsRequest.php | 10 +- DialogflowCx/src/V3/ListChangelogsRequest.php | 10 +- .../V3/ListContinuousTestResultsRequest.php | 20 +- .../src/V3/ListDeploymentsRequest.php | 25 +- .../src/V3/ListEntityTypesRequest.php | 10 +- .../src/V3/ListEnvironmentsRequest.php | 20 +- .../src/V3/ListExperimentsRequest.php | 25 +- DialogflowCx/src/V3/ListFlowsRequest.php | 10 +- DialogflowCx/src/V3/ListGeneratorsRequest.php | 10 +- DialogflowCx/src/V3/ListIntentsRequest.php | 10 +- DialogflowCx/src/V3/ListPagesRequest.php | 20 +- .../src/V3/ListSecuritySettingsRequest.php | 10 +- .../src/V3/ListSessionEntityTypesRequest.php | 35 +-- .../src/V3/ListTestCaseResultsRequest.php | 33 ++- DialogflowCx/src/V3/ListTestCasesRequest.php | 10 +- .../V3/ListTransitionRouteGroupsRequest.php | 30 +-- DialogflowCx/src/V3/ListVersionsRequest.php | 20 +- DialogflowCx/src/V3/ListWebhooksRequest.php | 10 +- DialogflowCx/src/V3/LoadVersionRequest.php | 20 +- .../V3/LookupEnvironmentHistoryRequest.php | 20 +- DialogflowCx/src/V3/MatchIntentRequest.php | 28 +- DialogflowCx/src/V3/MatchIntentResponse.php | 9 +- DialogflowCx/src/V3/NluSettings.php | 12 +- DialogflowCx/src/V3/OutputAudioEncoding.php | 7 + DialogflowCx/src/V3/Page.php | 52 ++-- DialogflowCx/src/V3/PageInfo.php | 20 +- DialogflowCx/src/V3/QueryParameters.php | 32 +-- DialogflowCx/src/V3/QueryResult.php | 25 +- DialogflowCx/src/V3/ResponseMessage/Text.php | 12 +- DialogflowCx/src/V3/RestoreAgentRequest.php | 8 +- .../src/V3/RunContinuousTestRequest.php | 16 +- DialogflowCx/src/V3/RunTestCaseRequest.php | 32 +-- DialogflowCx/src/V3/SecuritySettings.php | 64 ++--- .../src/V3/SentimentAnalysisResult.php | 8 +- DialogflowCx/src/V3/SessionEntityType.php | 40 +-- DialogflowCx/src/V3/SessionInfo.php | 28 +- .../src/V3/StartExperimentRequest.php | 20 +- DialogflowCx/src/V3/StopExperimentRequest.php | 20 +- .../src/V3/StreamingDetectIntentRequest.php | 28 +- DialogflowCx/src/V3/TestCase.php | 12 +- DialogflowCx/src/V3/TestCaseResult.php | 12 +- DialogflowCx/src/V3/TestConfig.php | 80 +++--- DialogflowCx/src/V3/TrainFlowRequest.php | 20 +- DialogflowCx/src/V3/TransitionRoute.php | 40 +-- DialogflowCx/src/V3/TransitionRouteGroup.php | 20 +- .../src/V3/UpdateSessionEntityTypeRequest.php | 60 ++--- DialogflowCx/src/V3/ValidateAgentRequest.php | 8 +- DialogflowCx/src/V3/ValidateFlowRequest.php | 16 +- DialogflowCx/src/V3/Version.php | 28 +- .../src/V3/VersionVariants/Variant.php | 16 +- DialogflowCx/src/V3/Webhook.php | 16 +- .../src/V3/Webhook/ServiceDirectoryConfig.php | 16 +- DialogflowCx/src/V3/WebhookRequest.php | 9 +- .../src/V3/WebhookRequest/IntentInfo.php | 16 +- .../SentimentAnalysisResult.php | 8 +- DialogflowCx/src/V3/WebhookResponse.php | 24 +- .../V3/resources/agents_descriptor_config.php | 1 + 276 files changed, 2795 insertions(+), 1789 deletions(-) create mode 100644 DialogflowCx/src/V3/Agent/ClientCertificateSettings.php create mode 100644 DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec.php create mode 100644 DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/AttributeType.php create mode 100644 DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/ControlPoint.php create mode 100644 DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/InterpolationType.php create mode 100644 DialogflowCx/src/V3/Generator/ModelParameter.php diff --git a/DialogflowCx/metadata/V3/AdvancedSettings.php b/DialogflowCx/metadata/V3/AdvancedSettings.php index 12b1a373f4a6..46561e2d32ff 100644 --- a/DialogflowCx/metadata/V3/AdvancedSettings.php +++ b/DialogflowCx/metadata/V3/AdvancedSettings.php @@ -19,7 +19,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Duration::initOnce(); $pool->internalAddGeneratedFile( ' -Ä +Á 5google/cloud/dialogflow/cx/v3/advanced_settings.protogoogle.cloud.dialogflow.cx.v3\'google/cloud/dialogflow/cx/v3/gcs.protogoogle/protobuf/duration.proto"Ü AdvancedSettingsS @@ -45,8 +45,8 @@ public static function initOnce() { LoggingSettings" enable_stackdriver_logging (" enable_interaction_logging (& -enable_consent_based_redaction (B» -!com.google.cloud.dialogflow.cx.v3BAdvancedSettingsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpbø¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' +enable_consent_based_redaction (B¸ +!com.google.cloud.dialogflow.cx.v3BAdvancedSettingsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' , true); static::$is_initialized = true; diff --git a/DialogflowCx/metadata/V3/Agent.php b/DialogflowCx/metadata/V3/Agent.php index 6f49d64ae2894c533e047b25b7f83105272d7aea..d188e8e2ce4fe5b413495a28424a0105e2551e59 100644 GIT binary patch delta 476 zcmbR0yuoe5BNmo_)?AvC-?7R~%;et8&-#~<=_dbXK6Y;wHK7bH>ExWu)Vz}Toxw_-5h^$PaKB`%mpaABC5a&y z3^hbZhKs+rI0xAR2}Yo~oKDOS9GQgNxws38GRr{LW~Ww4Fo9)^fHJ=vb-1*OQ}lQSYolj9;yvoaN# diff --git a/DialogflowCx/metadata/V3/AudioConfig.php b/DialogflowCx/metadata/V3/AudioConfig.php index c6b2a14637d9b994ef15530a17872499799d4bda..b304f7c980249969f148d3764693a39b0f463d07 100644 GIT binary patch delta 80 zcmbO)bwg^y3?{~(n`bhaurWH6QtDm#Ki>IG^yrYj}xB$oI iQ=FWPOg&7KuX4R%5t8GQn%uxG#s-#S+kB8aju8L~Wf!pk delta 38 wcmV+>0NMZ88lM`lm;wR7vzY=k1_Jv5lg|kIv*QT~0Rrp+lkN)av-%5O0Wd@l$N&HU diff --git a/DialogflowCx/metadata/V3/Changelog.php b/DialogflowCx/metadata/V3/Changelog.php index 292e8ca075a8..d67179b838c3 100644 --- a/DialogflowCx/metadata/V3/Changelog.php +++ b/DialogflowCx/metadata/V3/Changelog.php @@ -21,7 +21,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -• +’ -google/cloud/dialogflow/cx/v3/changelog.protogoogle.cloud.dialogflow.cx.v3google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.protogoogle/protobuf/timestamp.proto"‹ ListChangelogsRequest; parent ( B+àAúA%#dialogflow.googleapis.com/Changelog @@ -50,8 +50,8 @@ public static function initOnce() { ChangelogsÇ ListChangelogs4.google.cloud.dialogflow.cx.v3.ListChangelogsRequest5.google.cloud.dialogflow.cx.v3.ListChangelogsResponse"HÚAparent‚Óä“97/v3/{parent=projects/*/locations/*/agents/*}/changelogs´ - GetChangelog2.google.cloud.dialogflow.cx.v3.GetChangelogRequest(.google.cloud.dialogflow.cx.v3.Changelog"FÚAname‚Óä“97/v3/{name=projects/*/locations/*/agents/*/changelogs/*}xÊAdialogflow.googleapis.comÒAYhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/dialogflowB´ -!com.google.cloud.dialogflow.cx.v3BChangelogProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpbø¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' + GetChangelog2.google.cloud.dialogflow.cx.v3.GetChangelogRequest(.google.cloud.dialogflow.cx.v3.Changelog"FÚAname‚Óä“97/v3/{name=projects/*/locations/*/agents/*/changelogs/*}xÊAdialogflow.googleapis.comÒAYhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/dialogflowB± +!com.google.cloud.dialogflow.cx.v3BChangelogProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' , true); static::$is_initialized = true; diff --git a/DialogflowCx/metadata/V3/DataStoreConnection.php b/DialogflowCx/metadata/V3/DataStoreConnection.php index 259eb0c7eebc1a42de85af9187872542e3d2e556..b234de5b49804fe0f5d49b8466d4455567c74317 100644 GIT binary patch delta 34 qcmbOyJzIK%1ry`!&6Z3NT0NMZ1Fw`)x#sdV#C<-r=Zv-BZX%Vye16LCPwUbd7Y6JKI0h7BImK#Y91poj5 diff --git a/DialogflowCx/metadata/V3/Environment.php b/DialogflowCx/metadata/V3/Environment.php index 157f2fbf9e01e0025937624ec91d18219e8cf76c..7605482be85b5089a9c8a534c5e407fbf49edcf8 100644 GIT binary patch delta 34 qcmca&dC_u18w<-HeJ=gU`mAyjGX*#AWDyf*+&uY$boOLBnP~vv01RgU delta 38 ucmca;dBt)=8w<;SeJ=gU`mAyjGX*#AWDyf*+&1}wbT;!3M#jn3GSdJO{0(OS diff --git a/DialogflowCx/metadata/V3/Experiment.php b/DialogflowCx/metadata/V3/Experiment.php index 603ca43951173ab37e22b610a32993d5a9ffb5e7..4a6fd0db6eb3a4e112665bb117217778a23314ab 100644 GIT binary patch delta 40 wcmeA*>oVK0m6@eak4tZ&x8COG%t~VHn;5wilk;;Y3$n>g){}CZTrM>Y01BZDiU0rr delta 44 zcmeA&>owc3m6>It9+%!kZ@taWnU%!Yw=!}mCg@)zz<_lK< delta 38 ucmbPdz0i7t94q6V&GM`*;_T}gxfGN0b0;6internalAddGeneratedFile( ' -¥ +¢ \'google/cloud/dialogflow/cx/v3/gcs.protogoogle.cloud.dialogflow.cx.v3"" GcsDestination -uri ( BàAB® -!com.google.cloud.dialogflow.cx.v3BGcsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpbø¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' +uri ( BàAB« +!com.google.cloud.dialogflow.cx.v3BGcsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' , true); static::$is_initialized = true; diff --git a/DialogflowCx/metadata/V3/GenerativeSettings.php b/DialogflowCx/metadata/V3/GenerativeSettings.php index d08485099ce1..4c1c57bb2fbf 100644 --- a/DialogflowCx/metadata/V3/GenerativeSettings.php +++ b/DialogflowCx/metadata/V3/GenerativeSettings.php @@ -18,7 +18,7 @@ public static function initOnce() { \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\SafetySettings::initOnce(); $pool->internalAddGeneratedFile( ' -Ó +Ð 7google/cloud/dialogflow/cx/v3/generative_settings.protogoogle.cloud.dialogflow.cx.v33google/cloud/dialogflow/cx/v3/safety_settings.proto"û GenerativeSettings name ( ] @@ -40,8 +40,8 @@ public static function initOnce() { business_description (  agent_scope ( # disable_data_store_fallback (:êA~ -1dialogflow.googleapis.com/AgentGenerativeSettingsIprojects/{project}/locations/{location}/agents/{agent}/generativeSettingsB½ -!com.google.cloud.dialogflow.cx.v3BGenerativeSettingsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpbø¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' +1dialogflow.googleapis.com/AgentGenerativeSettingsIprojects/{project}/locations/{location}/agents/{agent}/generativeSettingsBº +!com.google.cloud.dialogflow.cx.v3BGenerativeSettingsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' , true); static::$is_initialized = true; diff --git a/DialogflowCx/metadata/V3/Generator.php b/DialogflowCx/metadata/V3/Generator.php index 218a2d49f9afe7b376bbf252b97806abff6c67a2..db5d5eaea936aee945f71b29a457b33e36677427 100644 GIT binary patch delta 261 zcmX>kb5L%B4KveT@yT|~kC~pcOjc$&CM^`e#h;s>lA04=kXV$Mn_7}uB*CG;sKISy zK6wL+CZ8`zE&wJq`6Y{1z0@j3E;Ml=2`=uE)ZBv9qQsKYqErb+pb1PK3>}P&Lb6-} zxrr6=DXGaolj4g@QVWVDn1Ir(9*iJqAuiUE{DSxb31+YsCM2ocSvS~4Kvd|(aCnqkC|RDO;%<(Hrbk0i`A<9m1D`|xtwa7ZP{2j0VLrKSpWb4 diff --git a/DialogflowCx/metadata/V3/ImportStrategy.php b/DialogflowCx/metadata/V3/ImportStrategy.php index 7397ef020c28c7575ad4088e726ef5783c75fdf3..2561bbed81cec73d459fa951a4d7e50a3ead95f4 100644 GIT binary patch delta 29 lcmbQiF_mM(Cq|Y#%v{D3y^SYpGCgP9Hd&B4Z*mj!Gys`C3NHWv delta 33 pcmbQrF@s~nCq|b0%v{D3y^SYpGCgP9Ia!c7kNF29H>D0HN{-xW=n>>@S|0DNW%jsO4v delta 28 kcmcbvdrNmi3=8A-&9N-?f{g1Y-xW<^{=vvN*->m70He_gjsO4v diff --git a/DialogflowCx/metadata/V3/SafetySettings.php b/DialogflowCx/metadata/V3/SafetySettings.php index 7942d6ed9aac..1a14fd5d3ef0 100644 --- a/DialogflowCx/metadata/V3/SafetySettings.php +++ b/DialogflowCx/metadata/V3/SafetySettings.php @@ -17,14 +17,14 @@ public static function initOnce() { \GPBMetadata\Google\Api\FieldBehavior::initOnce(); $pool->internalAddGeneratedFile( ' -² +¯ 3google/cloud/dialogflow/cx/v3/safety_settings.protogoogle.cloud.dialogflow.cx.v3"— SafetySettingsL banned_phrases ( 24.google.cloud.dialogflow.cx.v3.SafetySettings.Phrase7 Phrase text ( BàA - language_code ( BàAB¹ -!com.google.cloud.dialogflow.cx.v3BSafetySettingsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpbø¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' + language_code ( BàAB¶ +!com.google.cloud.dialogflow.cx.v3BSafetySettingsProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' , true); static::$is_initialized = true; diff --git a/DialogflowCx/metadata/V3/Session.php b/DialogflowCx/metadata/V3/Session.php index 7cf1792a81ce9d392bd8e2e0271251b12bad5996..37fe18a625c8ea8ba17d05ee72ba6a1e52be94e4 100644 GIT binary patch delta 604 zcmdmHK~5-_ODHKnzqlkmIX|zYC_g8@ zxF9uIf<=K*gWJewvY@*B z;`0)7QzaOICUJsQ3zc*6C6<&FWhRxDq{f$27Nklr0VVm2qF~lIVOXQ*2-6S(R1Yzx zo=Ye*uOzjoAU`LuBr`t`ViYsjs5m@Ec_M2<7+1!{2lIMCKG5J|py!!^o{xkXRgdW^ zXg~yj)I&nTor?!qP)LT0AK}-s#GF!;kdWl!fdqPDZhmQA2{;^>zy>M#a`B@0SxBy) zOUf}MB*@b#G{iMNBr?D?KGZKbz}4B)&C}IIfI*0ti_@&ei}ftsvX!A2h#)!A!BcClQAJ4 QlczF61NZ>}v+6Q80$`RC=l}o! diff --git a/DialogflowCx/metadata/V3/TestCase.php b/DialogflowCx/metadata/V3/TestCase.php index 0b70b8bef9cbb956aed3bc5f952bc8f302b4b940..2ece2d5dd16c9d9c83f8d637456867a5f61ee623 100644 GIT binary patch delta 44 zcmV+{0Mq~VUh-bB;spe|QVK1T-v%C$X%Dj#24E-$umK7oV{dJf5f&bkm@Y(<-!7Jh CXAnaG delta 48 zcmV-00MGyOUiDtE;spf0QVK1T-v%C$X%Dj#24E-$vjGYrV{dJf5f&bkm@Y&E_yGZv G+%A^JG!a7p diff --git a/DialogflowCx/metadata/V3/TransitionRouteGroup.php b/DialogflowCx/metadata/V3/TransitionRouteGroup.php index eaab8023dcf3..98d785bf242c 100644 --- a/DialogflowCx/metadata/V3/TransitionRouteGroup.php +++ b/DialogflowCx/metadata/V3/TransitionRouteGroup.php @@ -23,7 +23,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\FieldMask::initOnce(); $pool->internalAddGeneratedFile( ' -ï +ì :google/cloud/dialogflow/cx/v3/transition_route_group.protogoogle.cloud.dialogflow.cx.v3google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto(google/cloud/dialogflow/cx/v3/page.protogoogle/protobuf/empty.proto google/protobuf/field_mask.proto"É TransitionRouteGroup name (  @@ -60,8 +60,8 @@ public static function initOnce() { GetTransitionRouteGroup=.google.cloud.dialogflow.cx.v3.GetTransitionRouteGroupRequest3.google.cloud.dialogflow.cx.v3.TransitionRouteGroup" ÚAname‚Óä“’J/v3/{name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}ZDB/v3/{name=projects/*/locations/*/agents/*/transitionRouteGroups/*}ÿ CreateTransitionRouteGroup@.google.cloud.dialogflow.cx.v3.CreateTransitionRouteGroupRequest3.google.cloud.dialogflow.cx.v3.TransitionRouteGroup"éÚAparent,transition_route_group‚Óä“Â"J/v3/{parent=projects/*/locations/*/agents/*/flows/*}/transitionRouteGroups:transition_route_groupZ\\"B/v3/{parent=projects/*/locations/*/agents/*}/transitionRouteGroups:transition_route_group² UpdateTransitionRouteGroup@.google.cloud.dialogflow.cx.v3.UpdateTransitionRouteGroupRequest3.google.cloud.dialogflow.cx.v3.TransitionRouteGroup"œÚA"transition_route_group,update_mask‚Óä“ð2a/v3/{transition_route_group.name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}:transition_route_groupZs2Y/v3/{transition_route_group.name=projects/*/locations/*/agents/*/transitionRouteGroups/*}:transition_route_group™ -DeleteTransitionRouteGroup@.google.cloud.dialogflow.cx.v3.DeleteTransitionRouteGroupRequest.google.protobuf.Empty" ÚAname‚Óä“’*J/v3/{name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}ZD*B/v3/{name=projects/*/locations/*/agents/*/transitionRouteGroups/*}xÊAdialogflow.googleapis.comÒAYhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/dialogflowB¿ -!com.google.cloud.dialogflow.cx.v3BTransitionRouteGroupProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpbø¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' +DeleteTransitionRouteGroup@.google.cloud.dialogflow.cx.v3.DeleteTransitionRouteGroupRequest.google.protobuf.Empty" ÚAname‚Óä“’*J/v3/{name=projects/*/locations/*/agents/*/flows/*/transitionRouteGroups/*}ZD*B/v3/{name=projects/*/locations/*/agents/*/transitionRouteGroups/*}xÊAdialogflow.googleapis.comÒAYhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/dialogflowB¼ +!com.google.cloud.dialogflow.cx.v3BTransitionRouteGroupProtoPZ1cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb¢DFªGoogle.Cloud.Dialogflow.Cx.V3ê!Google::Cloud::Dialogflow::CX::V3bproto3' , true); static::$is_initialized = true; diff --git a/DialogflowCx/metadata/V3/ValidationMessage.php b/DialogflowCx/metadata/V3/ValidationMessage.php index 0729931438f14ebf03c4cca63a42a3b60c6d0b2a..620eda930c01ca29f4596fd33c6bf6f2ad387a84 100644 GIT binary patch delta 34 qcmZ3-vzlka4@Sl}n}0HDF|+Sv03)yr A*#H0l diff --git a/DialogflowCx/metadata/V3/Webhook.php b/DialogflowCx/metadata/V3/Webhook.php index c0e6a78502ae3f525da579280787d103ff71308d..e3f82e6465d1e6ae9b3be7dc96fb3f28fa81abd1 100644 GIT binary patch delta 32 ocmeBi>~!4lhnZ!+1(){Zg)DNL~Y-ihneM&1(){Zg)DNLaj9BcIOvgOPD_vAh@~0P?X5+yDRo diff --git a/DialogflowCx/samples/V3/AgentsClient/create_agent.php b/DialogflowCx/samples/V3/AgentsClient/create_agent.php index 3ef7ed4fd802..488e6458d792 100644 --- a/DialogflowCx/samples/V3/AgentsClient/create_agent.php +++ b/DialogflowCx/samples/V3/AgentsClient/create_agent.php @@ -36,7 +36,7 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedParent The location to create a agent for. - * Format: `projects//locations/`. Please see + * Format: `projects//locations/`. Please see * {@see AgentsClient::locationName()} for help formatting this field. * @param string $agentDisplayName The human-readable name of the agent, unique within the location. * @param string $agentDefaultLanguageCode Immutable. The default language of the agent as a language tag. diff --git a/DialogflowCx/samples/V3/AgentsClient/delete_agent.php b/DialogflowCx/samples/V3/AgentsClient/delete_agent.php index 87177478ab00..9077190c8203 100644 --- a/DialogflowCx/samples/V3/AgentsClient/delete_agent.php +++ b/DialogflowCx/samples/V3/AgentsClient/delete_agent.php @@ -31,7 +31,7 @@ * Deletes the specified agent. * * @param string $formattedName The name of the agent to delete. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see AgentsClient::agentName()} for help formatting this field. */ function delete_agent_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/AgentsClient/export_agent.php b/DialogflowCx/samples/V3/AgentsClient/export_agent.php index 152fde95ed70..5e493853197f 100644 --- a/DialogflowCx/samples/V3/AgentsClient/export_agent.php +++ b/DialogflowCx/samples/V3/AgentsClient/export_agent.php @@ -43,7 +43,7 @@ * [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse] * * @param string $formattedName The name of the agent to export. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see AgentsClient::agentName()} for help formatting this field. */ function export_agent_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/AgentsClient/get_agent.php b/DialogflowCx/samples/V3/AgentsClient/get_agent.php index 8b648dd5fb8f..41daf7c77276 100644 --- a/DialogflowCx/samples/V3/AgentsClient/get_agent.php +++ b/DialogflowCx/samples/V3/AgentsClient/get_agent.php @@ -32,7 +32,7 @@ * Retrieves the specified agent. * * @param string $formattedName The name of the agent. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see AgentsClient::agentName()} for help formatting this field. */ function get_agent_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/AgentsClient/get_agent_validation_result.php b/DialogflowCx/samples/V3/AgentsClient/get_agent_validation_result.php index 69638dde44d8..6e7ab2de68ca 100644 --- a/DialogflowCx/samples/V3/AgentsClient/get_agent_validation_result.php +++ b/DialogflowCx/samples/V3/AgentsClient/get_agent_validation_result.php @@ -33,8 +33,8 @@ * when ValidateAgent is called. * * @param string $formattedName The agent name. - * Format: `projects//locations//agents//validationResult`. Please see + * Format: + * `projects//locations//agents//validationResult`. Please see * {@see AgentsClient::agentValidationResultName()} for help formatting this field. */ function get_agent_validation_result_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/AgentsClient/get_generative_settings.php b/DialogflowCx/samples/V3/AgentsClient/get_generative_settings.php index 823bbb6ee977..0a0b99f22235 100644 --- a/DialogflowCx/samples/V3/AgentsClient/get_generative_settings.php +++ b/DialogflowCx/samples/V3/AgentsClient/get_generative_settings.php @@ -31,8 +31,8 @@ /** * Gets the generative settings for the agent. * - * @param string $formattedName Format: `projects//locations//agents//generativeSettings`. Please see + * @param string $formattedName Format: + * `projects//locations//agents//generativeSettings`. Please see * {@see AgentsClient::agentGenerativeSettingsName()} for help formatting this field. * @param string $languageCode Language code of the generative settings. */ diff --git a/DialogflowCx/samples/V3/AgentsClient/list_agents.php b/DialogflowCx/samples/V3/AgentsClient/list_agents.php index 2b4b13d6d742..70deac8bcc76 100644 --- a/DialogflowCx/samples/V3/AgentsClient/list_agents.php +++ b/DialogflowCx/samples/V3/AgentsClient/list_agents.php @@ -33,7 +33,7 @@ * Returns the list of all agents in the specified location. * * @param string $formattedParent The location to list all agents for. - * Format: `projects//locations/`. Please see + * Format: `projects//locations/`. Please see * {@see AgentsClient::locationName()} for help formatting this field. */ function list_agents_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/AgentsClient/restore_agent.php b/DialogflowCx/samples/V3/AgentsClient/restore_agent.php index 18f117c3ba11..811d100b526a 100644 --- a/DialogflowCx/samples/V3/AgentsClient/restore_agent.php +++ b/DialogflowCx/samples/V3/AgentsClient/restore_agent.php @@ -49,7 +49,7 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedName The name of the agent to restore into. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see AgentsClient::agentName()} for help formatting this field. */ function restore_agent_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/AgentsClient/validate_agent.php b/DialogflowCx/samples/V3/AgentsClient/validate_agent.php index 56deabb6f10d..fcf7de872644 100644 --- a/DialogflowCx/samples/V3/AgentsClient/validate_agent.php +++ b/DialogflowCx/samples/V3/AgentsClient/validate_agent.php @@ -34,7 +34,7 @@ * training is completed to get the complete validation results. * * @param string $formattedName The agent to validate. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see AgentsClient::agentName()} for help formatting this field. */ function validate_agent_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/ChangelogsClient/get_changelog.php b/DialogflowCx/samples/V3/ChangelogsClient/get_changelog.php index 6b098bc95566..e5405872ac3c 100644 --- a/DialogflowCx/samples/V3/ChangelogsClient/get_changelog.php +++ b/DialogflowCx/samples/V3/ChangelogsClient/get_changelog.php @@ -32,8 +32,8 @@ * Retrieves the specified Changelog. * * @param string $formattedName The name of the changelog to get. - * Format: `projects//locations//agents//changelogs/`. Please see + * Format: + * `projects//locations//agents//changelogs/`. Please see * {@see ChangelogsClient::changelogName()} for help formatting this field. */ function get_changelog_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/ChangelogsClient/list_changelogs.php b/DialogflowCx/samples/V3/ChangelogsClient/list_changelogs.php index 835438d49104..7342680203df 100644 --- a/DialogflowCx/samples/V3/ChangelogsClient/list_changelogs.php +++ b/DialogflowCx/samples/V3/ChangelogsClient/list_changelogs.php @@ -33,7 +33,7 @@ * Returns the list of Changelogs. * * @param string $formattedParent The agent containing the changelogs. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see ChangelogsClient::agentName()} for help formatting this field. */ function list_changelogs_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/DeploymentsClient/get_deployment.php b/DialogflowCx/samples/V3/DeploymentsClient/get_deployment.php index c9e282215650..64df340f3745 100644 --- a/DialogflowCx/samples/V3/DeploymentsClient/get_deployment.php +++ b/DialogflowCx/samples/V3/DeploymentsClient/get_deployment.php @@ -34,8 +34,7 @@ * * @param string $formattedName The name of the * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents//environments//deployments/`. Please see + * `projects//locations//agents//environments//deployments/`. Please see * {@see DeploymentsClient::deploymentName()} for help formatting this field. */ function get_deployment_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/DeploymentsClient/list_deployments.php b/DialogflowCx/samples/V3/DeploymentsClient/list_deployments.php index 06fd63c09b8c..2d3fefdb6205 100644 --- a/DialogflowCx/samples/V3/DeploymentsClient/list_deployments.php +++ b/DialogflowCx/samples/V3/DeploymentsClient/list_deployments.php @@ -34,9 +34,8 @@ * [Environment][google.cloud.dialogflow.cx.v3.Environment]. * * @param string $formattedParent The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. Please see + * list all environments for. Format: + * `projects//locations//agents//environments/`. Please see * {@see DeploymentsClient::environmentName()} for help formatting this field. */ function list_deployments_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/EntityTypesClient/create_entity_type.php b/DialogflowCx/samples/V3/EntityTypesClient/create_entity_type.php index 07ede591165c..eab54efb03d0 100644 --- a/DialogflowCx/samples/V3/EntityTypesClient/create_entity_type.php +++ b/DialogflowCx/samples/V3/EntityTypesClient/create_entity_type.php @@ -37,7 +37,7 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedParent The agent to create a entity type for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see EntityTypesClient::agentName()} for help formatting this field. * @param string $entityTypeDisplayName The human-readable name of the entity type, unique within the * agent. diff --git a/DialogflowCx/samples/V3/EntityTypesClient/delete_entity_type.php b/DialogflowCx/samples/V3/EntityTypesClient/delete_entity_type.php index f963847d5a97..3116e671fe3d 100644 --- a/DialogflowCx/samples/V3/EntityTypesClient/delete_entity_type.php +++ b/DialogflowCx/samples/V3/EntityTypesClient/delete_entity_type.php @@ -35,8 +35,8 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedName The name of the entity type to delete. - * Format: `projects//locations//agents//entityTypes/`. Please see + * Format: + * `projects//locations//agents//entityTypes/`. Please see * {@see EntityTypesClient::entityTypeName()} for help formatting this field. */ function delete_entity_type_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/EntityTypesClient/export_entity_types.php b/DialogflowCx/samples/V3/EntityTypesClient/export_entity_types.php index 04919a56cd1a..3d61b8ab865b 100644 --- a/DialogflowCx/samples/V3/EntityTypesClient/export_entity_types.php +++ b/DialogflowCx/samples/V3/EntityTypesClient/export_entity_types.php @@ -34,12 +34,11 @@ * Exports the selected entity types. * * @param string $formattedParent The name of the parent agent to export entity types. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see EntityTypesClient::agentName()} for help formatting this field. * @param string $entityTypesElement The name of the entity types to export. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. */ function export_entity_types_sample(string $formattedParent, string $entityTypesElement): void { diff --git a/DialogflowCx/samples/V3/EntityTypesClient/get_entity_type.php b/DialogflowCx/samples/V3/EntityTypesClient/get_entity_type.php index 84e6c9335508..cd97c607bf01 100644 --- a/DialogflowCx/samples/V3/EntityTypesClient/get_entity_type.php +++ b/DialogflowCx/samples/V3/EntityTypesClient/get_entity_type.php @@ -32,8 +32,8 @@ * Retrieves the specified entity type. * * @param string $formattedName The name of the entity type. - * Format: `projects//locations//agents//entityTypes/`. Please see + * Format: + * `projects//locations//agents//entityTypes/`. Please see * {@see EntityTypesClient::entityTypeName()} for help formatting this field. */ function get_entity_type_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/EntityTypesClient/import_entity_types.php b/DialogflowCx/samples/V3/EntityTypesClient/import_entity_types.php index 635f8c6bd66a..aba10a4c490a 100644 --- a/DialogflowCx/samples/V3/EntityTypesClient/import_entity_types.php +++ b/DialogflowCx/samples/V3/EntityTypesClient/import_entity_types.php @@ -35,7 +35,7 @@ * Imports the specified entitytypes into the agent. * * @param string $formattedParent The agent to import the entity types into. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see EntityTypesClient::agentName()} for help formatting this field. * @param int $mergeOption Merge option for importing entity types. */ diff --git a/DialogflowCx/samples/V3/EntityTypesClient/list_entity_types.php b/DialogflowCx/samples/V3/EntityTypesClient/list_entity_types.php index 8dda6344a959..1b27186c5d03 100644 --- a/DialogflowCx/samples/V3/EntityTypesClient/list_entity_types.php +++ b/DialogflowCx/samples/V3/EntityTypesClient/list_entity_types.php @@ -33,7 +33,7 @@ * Returns the list of all entity types in the specified agent. * * @param string $formattedParent The agent to list all entity types for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see EntityTypesClient::agentName()} for help formatting this field. */ function list_entity_types_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/EnvironmentsClient/create_environment.php b/DialogflowCx/samples/V3/EnvironmentsClient/create_environment.php index 0712d84d32f5..f4778448bd57 100644 --- a/DialogflowCx/samples/V3/EnvironmentsClient/create_environment.php +++ b/DialogflowCx/samples/V3/EnvironmentsClient/create_environment.php @@ -44,7 +44,7 @@ * * @param string $formattedParent The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents/`. Please see + * `projects//locations//agents/`. Please see * {@see EnvironmentsClient::agentName()} for help formatting this field. * @param string $environmentDisplayName The human-readable name of the environment (unique in an agent). * Limit of 64 characters. diff --git a/DialogflowCx/samples/V3/EnvironmentsClient/delete_environment.php b/DialogflowCx/samples/V3/EnvironmentsClient/delete_environment.php index 5c09f67ad316..20bdd8f14b15 100644 --- a/DialogflowCx/samples/V3/EnvironmentsClient/delete_environment.php +++ b/DialogflowCx/samples/V3/EnvironmentsClient/delete_environment.php @@ -33,8 +33,7 @@ * * @param string $formattedName The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments/`. Please see + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. */ function delete_environment_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/EnvironmentsClient/deploy_flow.php b/DialogflowCx/samples/V3/EnvironmentsClient/deploy_flow.php index 9d4343eb51fb..3fdb24881c8e 100644 --- a/DialogflowCx/samples/V3/EnvironmentsClient/deploy_flow.php +++ b/DialogflowCx/samples/V3/EnvironmentsClient/deploy_flow.php @@ -44,12 +44,12 @@ * [DeployFlowResponse][google.cloud.dialogflow.cx.v3.DeployFlowResponse] * * @param string $formattedEnvironment The environment to deploy the flow to. - * Format: `projects//locations//agents// - * environments/`. Please see + * Format: + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. * @param string $formattedFlowVersion The flow version to deploy. - * Format: `projects//locations//agents// - * flows//versions/`. Please see + * Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see EnvironmentsClient::versionName()} for help formatting this field. */ function deploy_flow_sample(string $formattedEnvironment, string $formattedFlowVersion): void diff --git a/DialogflowCx/samples/V3/EnvironmentsClient/get_environment.php b/DialogflowCx/samples/V3/EnvironmentsClient/get_environment.php index e91f34316d18..93fc5f9f8b5c 100644 --- a/DialogflowCx/samples/V3/EnvironmentsClient/get_environment.php +++ b/DialogflowCx/samples/V3/EnvironmentsClient/get_environment.php @@ -34,8 +34,7 @@ * * @param string $formattedName The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments/`. Please see + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. */ function get_environment_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/EnvironmentsClient/list_continuous_test_results.php b/DialogflowCx/samples/V3/EnvironmentsClient/list_continuous_test_results.php index 28881033cdcd..80b0df8bd625 100644 --- a/DialogflowCx/samples/V3/EnvironmentsClient/list_continuous_test_results.php +++ b/DialogflowCx/samples/V3/EnvironmentsClient/list_continuous_test_results.php @@ -33,8 +33,8 @@ * Fetches a list of continuous test results for a given environment. * * @param string $formattedParent The environment to list results for. - * Format: `projects//locations//agents// - * environments/`. Please see + * Format: + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. */ function list_continuous_test_results_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/EnvironmentsClient/list_environments.php b/DialogflowCx/samples/V3/EnvironmentsClient/list_environments.php index 37ae4570a800..ba8bd56691a7 100644 --- a/DialogflowCx/samples/V3/EnvironmentsClient/list_environments.php +++ b/DialogflowCx/samples/V3/EnvironmentsClient/list_environments.php @@ -34,8 +34,8 @@ * [Agent][google.cloud.dialogflow.cx.v3.Agent]. * * @param string $formattedParent The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all - * environments for. Format: `projects//locations//agents/`. Please see + * environments for. Format: + * `projects//locations//agents/`. Please see * {@see EnvironmentsClient::agentName()} for help formatting this field. */ function list_environments_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/EnvironmentsClient/lookup_environment_history.php b/DialogflowCx/samples/V3/EnvironmentsClient/lookup_environment_history.php index 15f795fe5ecc..20726d16f1ea 100644 --- a/DialogflowCx/samples/V3/EnvironmentsClient/lookup_environment_history.php +++ b/DialogflowCx/samples/V3/EnvironmentsClient/lookup_environment_history.php @@ -34,8 +34,8 @@ * [Environment][google.cloud.dialogflow.cx.v3.Environment]. * * @param string $formattedName Resource name of the environment to look up the history for. - * Format: `projects//locations//agents//environments/`. Please see + * Format: + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. */ function lookup_environment_history_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/EnvironmentsClient/run_continuous_test.php b/DialogflowCx/samples/V3/EnvironmentsClient/run_continuous_test.php index e285637ae5c7..cf299f3fbc67 100644 --- a/DialogflowCx/samples/V3/EnvironmentsClient/run_continuous_test.php +++ b/DialogflowCx/samples/V3/EnvironmentsClient/run_continuous_test.php @@ -43,8 +43,8 @@ * - `response`: * [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3.RunContinuousTestResponse] * - * @param string $formattedEnvironment Format: `projects//locations//agents//environments/`. Please see + * @param string $formattedEnvironment Format: + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. */ function run_continuous_test_sample(string $formattedEnvironment): void diff --git a/DialogflowCx/samples/V3/ExperimentsClient/create_experiment.php b/DialogflowCx/samples/V3/ExperimentsClient/create_experiment.php index 6f27e03edb00..9e62a2fbc773 100644 --- a/DialogflowCx/samples/V3/ExperimentsClient/create_experiment.php +++ b/DialogflowCx/samples/V3/ExperimentsClient/create_experiment.php @@ -34,8 +34,7 @@ * * @param string $formattedParent The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents//environments/`. Please see + * `projects//locations//agents//environments/`. Please see * {@see ExperimentsClient::environmentName()} for help formatting this field. * @param string $experimentDisplayName The human-readable name of the experiment (unique in an * environment). Limit of 64 characters. diff --git a/DialogflowCx/samples/V3/ExperimentsClient/delete_experiment.php b/DialogflowCx/samples/V3/ExperimentsClient/delete_experiment.php index 5f75b7094649..e99ab3425a7b 100644 --- a/DialogflowCx/samples/V3/ExperimentsClient/delete_experiment.php +++ b/DialogflowCx/samples/V3/ExperimentsClient/delete_experiment.php @@ -33,8 +33,7 @@ * * @param string $formattedName The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments//experiments/`. Please see + * `projects//locations//agents//environments//experiments/`. Please see * {@see ExperimentsClient::experimentName()} for help formatting this field. */ function delete_experiment_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/ExperimentsClient/get_experiment.php b/DialogflowCx/samples/V3/ExperimentsClient/get_experiment.php index 7f700c2a5421..41be9c5cb3dd 100644 --- a/DialogflowCx/samples/V3/ExperimentsClient/get_experiment.php +++ b/DialogflowCx/samples/V3/ExperimentsClient/get_experiment.php @@ -34,8 +34,7 @@ * * @param string $formattedName The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments//experiments/`. Please see + * `projects//locations//agents//environments//experiments/`. Please see * {@see ExperimentsClient::experimentName()} for help formatting this field. */ function get_experiment_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/ExperimentsClient/list_experiments.php b/DialogflowCx/samples/V3/ExperimentsClient/list_experiments.php index 980e118ff5b0..47cfd8e58d87 100644 --- a/DialogflowCx/samples/V3/ExperimentsClient/list_experiments.php +++ b/DialogflowCx/samples/V3/ExperimentsClient/list_experiments.php @@ -34,9 +34,8 @@ * [Environment][google.cloud.dialogflow.cx.v3.Environment]. * * @param string $formattedParent The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. Please see + * list all environments for. Format: + * `projects//locations//agents//environments/`. Please see * {@see ExperimentsClient::environmentName()} for help formatting this field. */ function list_experiments_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/ExperimentsClient/start_experiment.php b/DialogflowCx/samples/V3/ExperimentsClient/start_experiment.php index 000a648db2e8..464326c34369 100644 --- a/DialogflowCx/samples/V3/ExperimentsClient/start_experiment.php +++ b/DialogflowCx/samples/V3/ExperimentsClient/start_experiment.php @@ -34,8 +34,8 @@ * changes the state of experiment from PENDING to RUNNING. * * @param string $formattedName Resource name of the experiment to start. - * Format: `projects//locations//agents//environments//experiments/`. Please see + * Format: + * `projects//locations//agents//environments//experiments/`. Please see * {@see ExperimentsClient::experimentName()} for help formatting this field. */ function start_experiment_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/ExperimentsClient/stop_experiment.php b/DialogflowCx/samples/V3/ExperimentsClient/stop_experiment.php index fd1252fb7474..3241a84ae0a5 100644 --- a/DialogflowCx/samples/V3/ExperimentsClient/stop_experiment.php +++ b/DialogflowCx/samples/V3/ExperimentsClient/stop_experiment.php @@ -33,8 +33,8 @@ * This rpc only changes the state of experiment from RUNNING to DONE. * * @param string $formattedName Resource name of the experiment to stop. - * Format: `projects//locations//agents//environments//experiments/`. Please see + * Format: + * `projects//locations//agents//environments//experiments/`. Please see * {@see ExperimentsClient::experimentName()} for help formatting this field. */ function stop_experiment_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/FlowsClient/create_flow.php b/DialogflowCx/samples/V3/FlowsClient/create_flow.php index 25341629a947..d7270dfb92fa 100644 --- a/DialogflowCx/samples/V3/FlowsClient/create_flow.php +++ b/DialogflowCx/samples/V3/FlowsClient/create_flow.php @@ -36,7 +36,7 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedParent The agent to create a flow for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see FlowsClient::agentName()} for help formatting this field. * @param string $flowDisplayName The human-readable name of the flow. */ diff --git a/DialogflowCx/samples/V3/FlowsClient/delete_flow.php b/DialogflowCx/samples/V3/FlowsClient/delete_flow.php index 33f57cc0f794..15fa85d73295 100644 --- a/DialogflowCx/samples/V3/FlowsClient/delete_flow.php +++ b/DialogflowCx/samples/V3/FlowsClient/delete_flow.php @@ -31,8 +31,8 @@ * Deletes a specified flow. * * @param string $formattedName The name of the flow to delete. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see FlowsClient::flowName()} for help formatting this field. */ function delete_flow_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/FlowsClient/export_flow.php b/DialogflowCx/samples/V3/FlowsClient/export_flow.php index 9d029e88a7bd..5cc395f58461 100644 --- a/DialogflowCx/samples/V3/FlowsClient/export_flow.php +++ b/DialogflowCx/samples/V3/FlowsClient/export_flow.php @@ -46,8 +46,8 @@ * references will also be exported. * * @param string $formattedName The name of the flow to export. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see FlowsClient::flowName()} for help formatting this field. */ function export_flow_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/FlowsClient/get_flow.php b/DialogflowCx/samples/V3/FlowsClient/get_flow.php index 9332d14a519c..c28840538ba8 100644 --- a/DialogflowCx/samples/V3/FlowsClient/get_flow.php +++ b/DialogflowCx/samples/V3/FlowsClient/get_flow.php @@ -32,8 +32,8 @@ * Retrieves the specified flow. * * @param string $formattedName The name of the flow to get. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see FlowsClient::flowName()} for help formatting this field. */ function get_flow_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/FlowsClient/get_flow_validation_result.php b/DialogflowCx/samples/V3/FlowsClient/get_flow_validation_result.php index 25377d59327f..0459d046dff4 100644 --- a/DialogflowCx/samples/V3/FlowsClient/get_flow_validation_result.php +++ b/DialogflowCx/samples/V3/FlowsClient/get_flow_validation_result.php @@ -33,8 +33,8 @@ * when ValidateFlow is called. * * @param string $formattedName The flow name. - * Format: `projects//locations//agents//flows//validationResult`. Please see + * Format: + * `projects//locations//agents//flows//validationResult`. Please see * {@see FlowsClient::flowValidationResultName()} for help formatting this field. */ function get_flow_validation_result_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/FlowsClient/import_flow.php b/DialogflowCx/samples/V3/FlowsClient/import_flow.php index 61e29b03a04b..699b6b8f02d6 100644 --- a/DialogflowCx/samples/V3/FlowsClient/import_flow.php +++ b/DialogflowCx/samples/V3/FlowsClient/import_flow.php @@ -47,7 +47,7 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedParent The agent to import the flow into. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see FlowsClient::agentName()} for help formatting this field. */ function import_flow_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/FlowsClient/list_flows.php b/DialogflowCx/samples/V3/FlowsClient/list_flows.php index 14e3c2f08ac0..98c28e0a245b 100644 --- a/DialogflowCx/samples/V3/FlowsClient/list_flows.php +++ b/DialogflowCx/samples/V3/FlowsClient/list_flows.php @@ -33,7 +33,7 @@ * Returns the list of all flows in the specified agent. * * @param string $formattedParent The agent containing the flows. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see FlowsClient::agentName()} for help formatting this field. */ function list_flows_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/FlowsClient/train_flow.php b/DialogflowCx/samples/V3/FlowsClient/train_flow.php index 60d72613eff4..55a9b908676d 100644 --- a/DialogflowCx/samples/V3/FlowsClient/train_flow.php +++ b/DialogflowCx/samples/V3/FlowsClient/train_flow.php @@ -47,8 +47,8 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedName The flow to train. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see FlowsClient::flowName()} for help formatting this field. */ function train_flow_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/FlowsClient/validate_flow.php b/DialogflowCx/samples/V3/FlowsClient/validate_flow.php index 2966e0e4d152..414f083c853d 100644 --- a/DialogflowCx/samples/V3/FlowsClient/validate_flow.php +++ b/DialogflowCx/samples/V3/FlowsClient/validate_flow.php @@ -34,8 +34,8 @@ * validation results. * * @param string $formattedName The flow to validate. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see FlowsClient::flowName()} for help formatting this field. */ function validate_flow_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/GeneratorsClient/create_generator.php b/DialogflowCx/samples/V3/GeneratorsClient/create_generator.php index d64af776758d..b3650cfef480 100644 --- a/DialogflowCx/samples/V3/GeneratorsClient/create_generator.php +++ b/DialogflowCx/samples/V3/GeneratorsClient/create_generator.php @@ -33,7 +33,7 @@ * Creates a generator in the specified agent. * * @param string $formattedParent The agent to create a generator for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see GeneratorsClient::agentName()} for help formatting this field. * @param string $generatorDisplayName The human-readable name of the generator, unique within the * agent. The prompt contains pre-defined parameters such as $conversation, diff --git a/DialogflowCx/samples/V3/GeneratorsClient/delete_generator.php b/DialogflowCx/samples/V3/GeneratorsClient/delete_generator.php index c581b190e504..e42ea5015a15 100644 --- a/DialogflowCx/samples/V3/GeneratorsClient/delete_generator.php +++ b/DialogflowCx/samples/V3/GeneratorsClient/delete_generator.php @@ -31,8 +31,8 @@ * Deletes the specified generators. * * @param string $formattedName The name of the generator to delete. - * Format: `projects//locations//agents//generators/`. Please see + * Format: + * `projects//locations//agents//generators/`. Please see * {@see GeneratorsClient::generatorName()} for help formatting this field. */ function delete_generator_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/GeneratorsClient/get_generator.php b/DialogflowCx/samples/V3/GeneratorsClient/get_generator.php index f44b708b397c..af40550c781d 100644 --- a/DialogflowCx/samples/V3/GeneratorsClient/get_generator.php +++ b/DialogflowCx/samples/V3/GeneratorsClient/get_generator.php @@ -32,8 +32,8 @@ * Retrieves the specified generator. * * @param string $formattedName The name of the generator. - * Format: `projects//locations//agents//generators/`. Please see + * Format: + * `projects//locations//agents//generators/`. Please see * {@see GeneratorsClient::generatorName()} for help formatting this field. */ function get_generator_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/GeneratorsClient/list_generators.php b/DialogflowCx/samples/V3/GeneratorsClient/list_generators.php index 4a3fa3befd34..a392502d6eaf 100644 --- a/DialogflowCx/samples/V3/GeneratorsClient/list_generators.php +++ b/DialogflowCx/samples/V3/GeneratorsClient/list_generators.php @@ -33,7 +33,7 @@ * Returns the list of all generators in the specified agent. * * @param string $formattedParent The agent to list all generators for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see GeneratorsClient::agentName()} for help formatting this field. */ function list_generators_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/IntentsClient/create_intent.php b/DialogflowCx/samples/V3/IntentsClient/create_intent.php index 0d749913034c..247c350a422c 100644 --- a/DialogflowCx/samples/V3/IntentsClient/create_intent.php +++ b/DialogflowCx/samples/V3/IntentsClient/create_intent.php @@ -36,7 +36,7 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedParent The agent to create an intent for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see IntentsClient::agentName()} for help formatting this field. * @param string $intentDisplayName The human-readable name of the intent, unique within the agent. */ diff --git a/DialogflowCx/samples/V3/IntentsClient/delete_intent.php b/DialogflowCx/samples/V3/IntentsClient/delete_intent.php index dc5366fc3b14..b6db6e78cbc8 100644 --- a/DialogflowCx/samples/V3/IntentsClient/delete_intent.php +++ b/DialogflowCx/samples/V3/IntentsClient/delete_intent.php @@ -35,8 +35,8 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedName The name of the intent to delete. - * Format: `projects//locations//agents//intents/`. Please see + * Format: + * `projects//locations//agents//intents/`. Please see * {@see IntentsClient::intentName()} for help formatting this field. */ function delete_intent_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/IntentsClient/export_intents.php b/DialogflowCx/samples/V3/IntentsClient/export_intents.php index 1ea57bdfcb27..17788037c2f1 100644 --- a/DialogflowCx/samples/V3/IntentsClient/export_intents.php +++ b/DialogflowCx/samples/V3/IntentsClient/export_intents.php @@ -43,12 +43,11 @@ * [ExportIntentsResponse][google.cloud.dialogflow.cx.v3.ExportIntentsResponse] * * @param string $formattedParent The name of the parent agent to export intents. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see IntentsClient::agentName()} for help formatting this field. * @param string $intentsElement The name of the intents to export. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. */ function export_intents_sample(string $formattedParent, string $intentsElement): void { diff --git a/DialogflowCx/samples/V3/IntentsClient/get_intent.php b/DialogflowCx/samples/V3/IntentsClient/get_intent.php index c9ce78ef1989..f36870b4301b 100644 --- a/DialogflowCx/samples/V3/IntentsClient/get_intent.php +++ b/DialogflowCx/samples/V3/IntentsClient/get_intent.php @@ -32,8 +32,8 @@ * Retrieves the specified intent. * * @param string $formattedName The name of the intent. - * Format: `projects//locations//agents//intents/`. Please see + * Format: + * `projects//locations//agents//intents/`. Please see * {@see IntentsClient::intentName()} for help formatting this field. */ function get_intent_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/IntentsClient/import_intents.php b/DialogflowCx/samples/V3/IntentsClient/import_intents.php index 34ee761d50ab..bb93ea1d5b9d 100644 --- a/DialogflowCx/samples/V3/IntentsClient/import_intents.php +++ b/DialogflowCx/samples/V3/IntentsClient/import_intents.php @@ -43,7 +43,7 @@ * [ImportIntentsResponse][google.cloud.dialogflow.cx.v3.ImportIntentsResponse] * * @param string $formattedParent The agent to import the intents into. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see IntentsClient::agentName()} for help formatting this field. */ function import_intents_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/IntentsClient/list_intents.php b/DialogflowCx/samples/V3/IntentsClient/list_intents.php index 45a04e3a4981..ea5fa274f356 100644 --- a/DialogflowCx/samples/V3/IntentsClient/list_intents.php +++ b/DialogflowCx/samples/V3/IntentsClient/list_intents.php @@ -33,7 +33,7 @@ * Returns the list of all intents in the specified agent. * * @param string $formattedParent The agent to list all intents for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see IntentsClient::agentName()} for help formatting this field. */ function list_intents_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/PagesClient/create_page.php b/DialogflowCx/samples/V3/PagesClient/create_page.php index 4114ef1ddd80..53c86a75c819 100644 --- a/DialogflowCx/samples/V3/PagesClient/create_page.php +++ b/DialogflowCx/samples/V3/PagesClient/create_page.php @@ -36,8 +36,8 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedParent The flow to create a page for. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see PagesClient::flowName()} for help formatting this field. * @param string $pageDisplayName The human-readable name of the page, unique within the flow. */ diff --git a/DialogflowCx/samples/V3/PagesClient/delete_page.php b/DialogflowCx/samples/V3/PagesClient/delete_page.php index 79b5085bfe40..fe869fc8afdf 100644 --- a/DialogflowCx/samples/V3/PagesClient/delete_page.php +++ b/DialogflowCx/samples/V3/PagesClient/delete_page.php @@ -35,8 +35,8 @@ * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * * @param string $formattedName The name of the page to delete. - * Format: `projects//locations//agents//Flows//pages/`. Please see + * Format: + * `projects//locations//agents//Flows//pages/`. Please see * {@see PagesClient::pageName()} for help formatting this field. */ function delete_page_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/PagesClient/get_page.php b/DialogflowCx/samples/V3/PagesClient/get_page.php index 5a67f7b14512..7c98a6cf1c4b 100644 --- a/DialogflowCx/samples/V3/PagesClient/get_page.php +++ b/DialogflowCx/samples/V3/PagesClient/get_page.php @@ -32,8 +32,8 @@ * Retrieves the specified page. * * @param string $formattedName The name of the page. - * Format: `projects//locations//agents//flows//pages/`. Please see + * Format: + * `projects//locations//agents//flows//pages/`. Please see * {@see PagesClient::pageName()} for help formatting this field. */ function get_page_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/PagesClient/list_pages.php b/DialogflowCx/samples/V3/PagesClient/list_pages.php index 26ef14f835fe..cb084ec68c15 100644 --- a/DialogflowCx/samples/V3/PagesClient/list_pages.php +++ b/DialogflowCx/samples/V3/PagesClient/list_pages.php @@ -33,8 +33,8 @@ * Returns the list of all pages in the specified flow. * * @param string $formattedParent The flow to list all pages for. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see PagesClient::flowName()} for help formatting this field. */ function list_pages_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/SecuritySettingsServiceClient/create_security_settings.php b/DialogflowCx/samples/V3/SecuritySettingsServiceClient/create_security_settings.php index 4fa08d7dd73d..8dd3aec2dacf 100644 --- a/DialogflowCx/samples/V3/SecuritySettingsServiceClient/create_security_settings.php +++ b/DialogflowCx/samples/V3/SecuritySettingsServiceClient/create_security_settings.php @@ -33,7 +33,7 @@ * * @param string $formattedParent The location to create an * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. - * Format: `projects//locations/`. Please see + * Format: `projects//locations/`. Please see * {@see SecuritySettingsServiceClient::locationName()} for help formatting this field. * @param string $securitySettingsDisplayName The human-readable name of the security settings, unique within * the location. diff --git a/DialogflowCx/samples/V3/SecuritySettingsServiceClient/delete_security_settings.php b/DialogflowCx/samples/V3/SecuritySettingsServiceClient/delete_security_settings.php index 3d880e26b5c1..d34a1ef7fbc9 100644 --- a/DialogflowCx/samples/V3/SecuritySettingsServiceClient/delete_security_settings.php +++ b/DialogflowCx/samples/V3/SecuritySettingsServiceClient/delete_security_settings.php @@ -33,8 +33,8 @@ * * @param string $formattedName The name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to - * delete. Format: `projects//locations//securitySettings/`. Please see + * delete. Format: + * `projects//locations//securitySettings/`. Please see * {@see SecuritySettingsServiceClient::securitySettingsName()} for help formatting this field. */ function delete_security_settings_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/SecuritySettingsServiceClient/get_security_settings.php b/DialogflowCx/samples/V3/SecuritySettingsServiceClient/get_security_settings.php index ebd5a4ef5fa3..6f0d5079e93d 100644 --- a/DialogflowCx/samples/V3/SecuritySettingsServiceClient/get_security_settings.php +++ b/DialogflowCx/samples/V3/SecuritySettingsServiceClient/get_security_settings.php @@ -34,8 +34,8 @@ * returned settings may be stale by up to 1 minute. * * @param string $formattedName Resource name of the settings. - * Format: `projects//locations//securitySettings/`. Please see + * Format: + * `projects//locations//securitySettings/`. Please see * {@see SecuritySettingsServiceClient::securitySettingsName()} for help formatting this field. */ function get_security_settings_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/SecuritySettingsServiceClient/list_security_settings.php b/DialogflowCx/samples/V3/SecuritySettingsServiceClient/list_security_settings.php index 27a5ecb03817..586c8e3b835f 100644 --- a/DialogflowCx/samples/V3/SecuritySettingsServiceClient/list_security_settings.php +++ b/DialogflowCx/samples/V3/SecuritySettingsServiceClient/list_security_settings.php @@ -33,7 +33,7 @@ * Returns the list of all security settings in the specified location. * * @param string $formattedParent The location to list all security settings for. - * Format: `projects//locations/`. Please see + * Format: `projects//locations/`. Please see * {@see SecuritySettingsServiceClient::locationName()} for help formatting this field. */ function list_security_settings_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/SessionEntityTypesClient/create_session_entity_type.php b/DialogflowCx/samples/V3/SessionEntityTypesClient/create_session_entity_type.php index d66ed4c3fde9..9e69c1b42805 100644 --- a/DialogflowCx/samples/V3/SessionEntityTypesClient/create_session_entity_type.php +++ b/DialogflowCx/samples/V3/SessionEntityTypesClient/create_session_entity_type.php @@ -34,18 +34,19 @@ * Creates a session entity type. * * @param string $formattedParent The session to create a session entity type for. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. Please see * {@see SessionEntityTypesClient::sessionName()} for help formatting this field. * @param string $sessionEntityTypeName The unique identifier of the session entity type. - * Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, we assume default 'draft' * environment. * @param int $sessionEntityTypeEntityOverrideMode Indicates whether the additional data should override or * supplement the custom entity type definition. diff --git a/DialogflowCx/samples/V3/SessionEntityTypesClient/delete_session_entity_type.php b/DialogflowCx/samples/V3/SessionEntityTypesClient/delete_session_entity_type.php index 335f8fdfa221..19928e422e42 100644 --- a/DialogflowCx/samples/V3/SessionEntityTypesClient/delete_session_entity_type.php +++ b/DialogflowCx/samples/V3/SessionEntityTypesClient/delete_session_entity_type.php @@ -31,12 +31,12 @@ * Deletes the specified session entity type. * * @param string $formattedName The name of the session entity type to delete. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. Please see + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, + * we assume default 'draft' environment. Please see * {@see SessionEntityTypesClient::sessionEntityTypeName()} for help formatting this field. */ function delete_session_entity_type_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/SessionEntityTypesClient/get_session_entity_type.php b/DialogflowCx/samples/V3/SessionEntityTypesClient/get_session_entity_type.php index d760f41f8e9c..e31018c40ed5 100644 --- a/DialogflowCx/samples/V3/SessionEntityTypesClient/get_session_entity_type.php +++ b/DialogflowCx/samples/V3/SessionEntityTypesClient/get_session_entity_type.php @@ -32,11 +32,11 @@ * Retrieves the specified session entity type. * * @param string $formattedName The name of the session entity type. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, we assume default 'draft' * environment. Please see * {@see SessionEntityTypesClient::sessionEntityTypeName()} for help formatting this field. */ diff --git a/DialogflowCx/samples/V3/SessionEntityTypesClient/list_session_entity_types.php b/DialogflowCx/samples/V3/SessionEntityTypesClient/list_session_entity_types.php index 85f5e86a8079..0f9e8575c14a 100644 --- a/DialogflowCx/samples/V3/SessionEntityTypesClient/list_session_entity_types.php +++ b/DialogflowCx/samples/V3/SessionEntityTypesClient/list_session_entity_types.php @@ -33,9 +33,10 @@ * Returns the list of all session entity types in the specified session. * * @param string $formattedParent The session to list all session entity types from. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. Please see * {@see SessionEntityTypesClient::sessionName()} for help formatting this field. diff --git a/DialogflowCx/samples/V3/SessionEntityTypesClient/update_session_entity_type.php b/DialogflowCx/samples/V3/SessionEntityTypesClient/update_session_entity_type.php index 4cf2e0e726f8..4bdf97f99d2e 100644 --- a/DialogflowCx/samples/V3/SessionEntityTypesClient/update_session_entity_type.php +++ b/DialogflowCx/samples/V3/SessionEntityTypesClient/update_session_entity_type.php @@ -34,11 +34,11 @@ * Updates the specified session entity type. * * @param string $sessionEntityTypeName The unique identifier of the session entity type. - * Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, we assume default 'draft' * environment. * @param int $sessionEntityTypeEntityOverrideMode Indicates whether the additional data should override or * supplement the custom entity type definition. diff --git a/DialogflowCx/samples/V3/SessionsClient/detect_intent.php b/DialogflowCx/samples/V3/SessionsClient/detect_intent.php index 761d1bae5d1e..ae413907a95e 100644 --- a/DialogflowCx/samples/V3/SessionsClient/detect_intent.php +++ b/DialogflowCx/samples/V3/SessionsClient/detect_intent.php @@ -40,9 +40,10 @@ * environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). * * @param string $formattedSession The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be diff --git a/DialogflowCx/samples/V3/SessionsClient/match_intent.php b/DialogflowCx/samples/V3/SessionsClient/match_intent.php index 9d5b2a7e6d8f..013f7242071c 100644 --- a/DialogflowCx/samples/V3/SessionsClient/match_intent.php +++ b/DialogflowCx/samples/V3/SessionsClient/match_intent.php @@ -34,9 +34,10 @@ * status. * * @param string $formattedSession The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be diff --git a/DialogflowCx/samples/V3/SessionsClient/server_streaming_detect_intent.php b/DialogflowCx/samples/V3/SessionsClient/server_streaming_detect_intent.php index 7ee3a1b7383a..49ece05219f6 100644 --- a/DialogflowCx/samples/V3/SessionsClient/server_streaming_detect_intent.php +++ b/DialogflowCx/samples/V3/SessionsClient/server_streaming_detect_intent.php @@ -38,9 +38,10 @@ * earlier in a single request. * * @param string $formattedSession The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be diff --git a/DialogflowCx/samples/V3/TestCasesClient/batch_delete_test_cases.php b/DialogflowCx/samples/V3/TestCasesClient/batch_delete_test_cases.php index 785a700debc1..7ef29b4d1eed 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/batch_delete_test_cases.php +++ b/DialogflowCx/samples/V3/TestCasesClient/batch_delete_test_cases.php @@ -31,10 +31,10 @@ * Batch deletes test cases. * * @param string $formattedParent The agent to delete test cases from. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. - * @param string $formattedNamesElement Format of test case names: `projects//locations/ - * /agents//testCases/`. Please see + * @param string $formattedNamesElement Format of test case names: + * `projects//locations//agents//testCases/`. Please see * {@see TestCasesClient::testCaseName()} for help formatting this field. */ function batch_delete_test_cases_sample( diff --git a/DialogflowCx/samples/V3/TestCasesClient/batch_run_test_cases.php b/DialogflowCx/samples/V3/TestCasesClient/batch_run_test_cases.php index 9d21bd8d8b51..5b1c531147bb 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/batch_run_test_cases.php +++ b/DialogflowCx/samples/V3/TestCasesClient/batch_run_test_cases.php @@ -42,11 +42,11 @@ * - `response`: * [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse] * - * @param string $formattedParent Agent name. Format: `projects//locations//agents/ `. Please see + * @param string $formattedParent Agent name. Format: + * `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. - * @param string $formattedTestCasesElement Format: `projects//locations//agents//testCases/`. Please see + * @param string $formattedTestCasesElement Format: + * `projects//locations//agents//testCases/`. Please see * {@see TestCasesClient::testCaseName()} for help formatting this field. */ function batch_run_test_cases_sample( diff --git a/DialogflowCx/samples/V3/TestCasesClient/calculate_coverage.php b/DialogflowCx/samples/V3/TestCasesClient/calculate_coverage.php index b87633bd4251..cdacad91054f 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/calculate_coverage.php +++ b/DialogflowCx/samples/V3/TestCasesClient/calculate_coverage.php @@ -33,7 +33,7 @@ * Calculates the test coverage for an agent. * * @param string $formattedAgent The agent to calculate coverage for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. * @param int $type The type of coverage requested. */ diff --git a/DialogflowCx/samples/V3/TestCasesClient/create_test_case.php b/DialogflowCx/samples/V3/TestCasesClient/create_test_case.php index 332dc0b308a6..faab059290b1 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/create_test_case.php +++ b/DialogflowCx/samples/V3/TestCasesClient/create_test_case.php @@ -32,7 +32,7 @@ * Creates a test case for the given agent. * * @param string $formattedParent The agent to create the test case for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. * @param string $testCaseDisplayName The human-readable name of the test case, unique within the * agent. Limit of 200 characters. diff --git a/DialogflowCx/samples/V3/TestCasesClient/export_test_cases.php b/DialogflowCx/samples/V3/TestCasesClient/export_test_cases.php index b831cd6a15e3..a749c75d826a 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/export_test_cases.php +++ b/DialogflowCx/samples/V3/TestCasesClient/export_test_cases.php @@ -44,7 +44,7 @@ * [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3.ExportTestCasesResponse] * * @param string $formattedParent The agent where to export test cases from. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. */ function export_test_cases_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/TestCasesClient/get_test_case.php b/DialogflowCx/samples/V3/TestCasesClient/get_test_case.php index c9685a09642d..94ea7db9a307 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/get_test_case.php +++ b/DialogflowCx/samples/V3/TestCasesClient/get_test_case.php @@ -32,8 +32,8 @@ * Gets a test case. * * @param string $formattedName The name of the testcase. - * Format: `projects//locations//agents//testCases/`. Please see + * Format: + * `projects//locations//agents//testCases/`. Please see * {@see TestCasesClient::testCaseName()} for help formatting this field. */ function get_test_case_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/TestCasesClient/get_test_case_result.php b/DialogflowCx/samples/V3/TestCasesClient/get_test_case_result.php index 17e68d5e53a9..3270ec411485 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/get_test_case_result.php +++ b/DialogflowCx/samples/V3/TestCasesClient/get_test_case_result.php @@ -32,8 +32,8 @@ * Gets a test case result. * * @param string $formattedName The name of the testcase. - * Format: `projects//locations//agents//testCases//results/`. Please see + * Format: + * `projects//locations//agents//testCases//results/`. Please see * {@see TestCasesClient::testCaseResultName()} for help formatting this field. */ function get_test_case_result_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/TestCasesClient/import_test_cases.php b/DialogflowCx/samples/V3/TestCasesClient/import_test_cases.php index 6bf451b1ddb5..680da65e0426 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/import_test_cases.php +++ b/DialogflowCx/samples/V3/TestCasesClient/import_test_cases.php @@ -45,7 +45,7 @@ * [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3.ImportTestCasesResponse] * * @param string $formattedParent The agent to import test cases to. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. */ function import_test_cases_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/TestCasesClient/list_test_case_results.php b/DialogflowCx/samples/V3/TestCasesClient/list_test_case_results.php index 61ed825bc6c4..158f836ec440 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/list_test_case_results.php +++ b/DialogflowCx/samples/V3/TestCasesClient/list_test_case_results.php @@ -34,8 +34,9 @@ * results are kept for each test case. * * @param string $formattedParent The test case to list results for. - * Format: `projects//locations//agents// - * testCases/`. Specify a `-` as a wildcard for TestCase ID to + * Format: + * `projects//locations//agents//testCases/`. + * Specify a `-` as a wildcard for TestCase ID to * list results across multiple test cases. Please see * {@see TestCasesClient::testCaseName()} for help formatting this field. */ diff --git a/DialogflowCx/samples/V3/TestCasesClient/list_test_cases.php b/DialogflowCx/samples/V3/TestCasesClient/list_test_cases.php index 614d3c21db23..9d3bfabc3a59 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/list_test_cases.php +++ b/DialogflowCx/samples/V3/TestCasesClient/list_test_cases.php @@ -33,7 +33,7 @@ * Fetches a list of test cases for a given agent. * * @param string $formattedParent The agent to list all pages for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. */ function list_test_cases_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/TestCasesClient/run_test_case.php b/DialogflowCx/samples/V3/TestCasesClient/run_test_case.php index a1553a5fdf1f..e5187c35872f 100644 --- a/DialogflowCx/samples/V3/TestCasesClient/run_test_case.php +++ b/DialogflowCx/samples/V3/TestCasesClient/run_test_case.php @@ -42,8 +42,8 @@ * - `response`: * [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse] * - * @param string $formattedName Format of test case name to run: `projects//locations/ /agents//testCases/`. Please see + * @param string $formattedName Format of test case name to run: + * `projects//locations//agents//testCases/`. Please see * {@see TestCasesClient::testCaseName()} for help formatting this field. */ function run_test_case_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/TransitionRouteGroupsClient/create_transition_route_group.php b/DialogflowCx/samples/V3/TransitionRouteGroupsClient/create_transition_route_group.php index cbf61cd5587a..2eb892c4426e 100644 --- a/DialogflowCx/samples/V3/TransitionRouteGroupsClient/create_transition_route_group.php +++ b/DialogflowCx/samples/V3/TransitionRouteGroupsClient/create_transition_route_group.php @@ -39,9 +39,9 @@ * * @param string $formattedParent The flow to create an * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * for. Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/` + * for. Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/` * for agent-level groups. Please see * {@see TransitionRouteGroupsClient::flowName()} for help formatting this field. * @param string $transitionRouteGroupDisplayName The human-readable name of the transition route group, unique diff --git a/DialogflowCx/samples/V3/TransitionRouteGroupsClient/delete_transition_route_group.php b/DialogflowCx/samples/V3/TransitionRouteGroupsClient/delete_transition_route_group.php index 93dfada3f5dd..65825f335652 100644 --- a/DialogflowCx/samples/V3/TransitionRouteGroupsClient/delete_transition_route_group.php +++ b/DialogflowCx/samples/V3/TransitionRouteGroupsClient/delete_transition_route_group.php @@ -37,10 +37,10 @@ * * @param string $formattedName The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`. Please see + * to delete. Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. Please see * {@see TransitionRouteGroupsClient::transitionRouteGroupName()} for help formatting this field. */ function delete_transition_route_group_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/TransitionRouteGroupsClient/get_transition_route_group.php b/DialogflowCx/samples/V3/TransitionRouteGroupsClient/get_transition_route_group.php index 62d07a94e564..e6892f6ac4fe 100644 --- a/DialogflowCx/samples/V3/TransitionRouteGroupsClient/get_transition_route_group.php +++ b/DialogflowCx/samples/V3/TransitionRouteGroupsClient/get_transition_route_group.php @@ -34,10 +34,10 @@ * * @param string $formattedName The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. - * Format: `projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/`. Please see + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. Please see * {@see TransitionRouteGroupsClient::transitionRouteGroupName()} for help formatting this field. */ function get_transition_route_group_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/TransitionRouteGroupsClient/list_transition_route_groups.php b/DialogflowCx/samples/V3/TransitionRouteGroupsClient/list_transition_route_groups.php index 73ed12b7b060..e54477ffb881 100644 --- a/DialogflowCx/samples/V3/TransitionRouteGroupsClient/list_transition_route_groups.php +++ b/DialogflowCx/samples/V3/TransitionRouteGroupsClient/list_transition_route_groups.php @@ -33,9 +33,9 @@ * Returns the list of all transition route groups in the specified flow. * * @param string $formattedParent The flow to list all transition route groups for. - * Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/. Please see + * Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/. Please see * {@see TransitionRouteGroupsClient::flowName()} for help formatting this field. */ function list_transition_route_groups_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/VersionsClient/compare_versions.php b/DialogflowCx/samples/V3/VersionsClient/compare_versions.php index 31e7db6932ce..c523942566a7 100644 --- a/DialogflowCx/samples/V3/VersionsClient/compare_versions.php +++ b/DialogflowCx/samples/V3/VersionsClient/compare_versions.php @@ -34,13 +34,13 @@ * @param string $formattedBaseVersion Name of the base flow version to compare with the target version. * Use version ID `0` to indicate the draft version of the specified flow. * - * Format: `projects//locations//agents/ - * /flows//versions/`. Please see + * Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. * @param string $formattedTargetVersion Name of the target flow version to compare with the * base version. Use version ID `0` to indicate the draft version of the - * specified flow. Format: `projects//locations//agents//flows//versions/`. Please see + * specified flow. Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. */ function compare_versions_sample( diff --git a/DialogflowCx/samples/V3/VersionsClient/create_version.php b/DialogflowCx/samples/V3/VersionsClient/create_version.php index e9facdb2f5ea..a8e9f624a203 100644 --- a/DialogflowCx/samples/V3/VersionsClient/create_version.php +++ b/DialogflowCx/samples/V3/VersionsClient/create_version.php @@ -44,8 +44,7 @@ * * @param string $formattedParent The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an * [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: - * `projects//locations//agents//flows/`. Please see + * `projects//locations//agents//flows/`. Please see * {@see VersionsClient::flowName()} for help formatting this field. * @param string $versionDisplayName The human-readable name of the version. Limit of 64 characters. */ diff --git a/DialogflowCx/samples/V3/VersionsClient/delete_version.php b/DialogflowCx/samples/V3/VersionsClient/delete_version.php index 9fd008efe15e..f0ef8d674200 100644 --- a/DialogflowCx/samples/V3/VersionsClient/delete_version.php +++ b/DialogflowCx/samples/V3/VersionsClient/delete_version.php @@ -31,8 +31,8 @@ * Deletes the specified [Version][google.cloud.dialogflow.cx.v3.Version]. * * @param string $formattedName The name of the [Version][google.cloud.dialogflow.cx.v3.Version] - * to delete. Format: `projects//locations//agents//flows//versions/`. Please see + * to delete. Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. */ function delete_version_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/VersionsClient/get_version.php b/DialogflowCx/samples/V3/VersionsClient/get_version.php index c6eb1042380a..b7e170604e75 100644 --- a/DialogflowCx/samples/V3/VersionsClient/get_version.php +++ b/DialogflowCx/samples/V3/VersionsClient/get_version.php @@ -32,8 +32,8 @@ * Retrieves the specified [Version][google.cloud.dialogflow.cx.v3.Version]. * * @param string $formattedName The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. Please see + * Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. */ function get_version_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/VersionsClient/list_versions.php b/DialogflowCx/samples/V3/VersionsClient/list_versions.php index 970bdb978ad8..547c3c558171 100644 --- a/DialogflowCx/samples/V3/VersionsClient/list_versions.php +++ b/DialogflowCx/samples/V3/VersionsClient/list_versions.php @@ -34,8 +34,8 @@ * [Flow][google.cloud.dialogflow.cx.v3.Flow]. * * @param string $formattedParent The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all - * versions for. Format: `projects//locations//agents//flows/`. Please see + * versions for. Format: + * `projects//locations//agents//flows/`. Please see * {@see VersionsClient::flowName()} for help formatting this field. */ function list_versions_sample(string $formattedParent): void diff --git a/DialogflowCx/samples/V3/VersionsClient/load_version.php b/DialogflowCx/samples/V3/VersionsClient/load_version.php index 4492a3be3ec0..15d6296c2094 100644 --- a/DialogflowCx/samples/V3/VersionsClient/load_version.php +++ b/DialogflowCx/samples/V3/VersionsClient/load_version.php @@ -42,8 +42,8 @@ * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) * * @param string $formattedName The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded - * to draft flow. Format: `projects//locations//agents//flows//versions/`. Please see + * to draft flow. Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. */ function load_version_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/WebhooksClient/create_webhook.php b/DialogflowCx/samples/V3/WebhooksClient/create_webhook.php index d250cf3743e3..c2336ed0c454 100644 --- a/DialogflowCx/samples/V3/WebhooksClient/create_webhook.php +++ b/DialogflowCx/samples/V3/WebhooksClient/create_webhook.php @@ -32,7 +32,7 @@ * Creates a webhook in the specified agent. * * @param string $formattedParent The agent to create a webhook for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see WebhooksClient::agentName()} for help formatting this field. * @param string $webhookDisplayName The human-readable name of the webhook, unique within the agent. */ diff --git a/DialogflowCx/samples/V3/WebhooksClient/delete_webhook.php b/DialogflowCx/samples/V3/WebhooksClient/delete_webhook.php index 4a909a87c0f2..467cd47da802 100644 --- a/DialogflowCx/samples/V3/WebhooksClient/delete_webhook.php +++ b/DialogflowCx/samples/V3/WebhooksClient/delete_webhook.php @@ -31,8 +31,8 @@ * Deletes the specified webhook. * * @param string $formattedName The name of the webhook to delete. - * Format: `projects//locations//agents//webhooks/`. Please see + * Format: + * `projects//locations//agents//webhooks/`. Please see * {@see WebhooksClient::webhookName()} for help formatting this field. */ function delete_webhook_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/WebhooksClient/get_webhook.php b/DialogflowCx/samples/V3/WebhooksClient/get_webhook.php index 28be7d6f0d3a..d04f17b31140 100644 --- a/DialogflowCx/samples/V3/WebhooksClient/get_webhook.php +++ b/DialogflowCx/samples/V3/WebhooksClient/get_webhook.php @@ -32,8 +32,8 @@ * Retrieves the specified webhook. * * @param string $formattedName The name of the webhook. - * Format: `projects//locations//agents//webhooks/`. Please see + * Format: + * `projects//locations//agents//webhooks/`. Please see * {@see WebhooksClient::webhookName()} for help formatting this field. */ function get_webhook_sample(string $formattedName): void diff --git a/DialogflowCx/samples/V3/WebhooksClient/list_webhooks.php b/DialogflowCx/samples/V3/WebhooksClient/list_webhooks.php index aa9aad325bac..83fa0ba55508 100644 --- a/DialogflowCx/samples/V3/WebhooksClient/list_webhooks.php +++ b/DialogflowCx/samples/V3/WebhooksClient/list_webhooks.php @@ -33,7 +33,7 @@ * Returns the list of all webhooks in the specified agent. * * @param string $formattedParent The agent to list all webhooks for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see WebhooksClient::agentName()} for help formatting this field. */ function list_webhooks_sample(string $formattedParent): void diff --git a/DialogflowCx/src/V3/AdvancedSettings/LoggingSettings.php b/DialogflowCx/src/V3/AdvancedSettings/LoggingSettings.php index 92f4573527f8..cf638d290d61 100644 --- a/DialogflowCx/src/V3/AdvancedSettings/LoggingSettings.php +++ b/DialogflowCx/src/V3/AdvancedSettings/LoggingSettings.php @@ -16,7 +16,7 @@ class LoggingSettings extends \Google\Protobuf\Internal\Message { /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. * * Generated from protobuf field bool enable_stackdriver_logging = 2; */ @@ -43,7 +43,7 @@ class LoggingSettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $enable_stackdriver_logging - * Enables StackDriver logging. + * Enables Google Cloud Logging. * @type bool $enable_interaction_logging * Enables DF Interaction logging. * @type bool $enable_consent_based_redaction @@ -58,7 +58,7 @@ public function __construct($data = NULL) { } /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. * * Generated from protobuf field bool enable_stackdriver_logging = 2; * @return bool @@ -69,7 +69,7 @@ public function getEnableStackdriverLogging() } /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. * * Generated from protobuf field bool enable_stackdriver_logging = 2; * @param bool $var diff --git a/DialogflowCx/src/V3/Agent.php b/DialogflowCx/src/V3/Agent.php index 9a52d873ce1d..de1015f26def 100644 --- a/DialogflowCx/src/V3/Agent.php +++ b/DialogflowCx/src/V3/Agent.php @@ -33,7 +33,7 @@ class Agent extends \Google\Protobuf\Internal\Message * method. * [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] * populates the name automatically. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1; */ @@ -96,8 +96,8 @@ class Agent extends \Google\Protobuf\Internal\Message /** * Immutable. Name of the start flow in this agent. A start flow will be * automatically created when the agent is created, and can only be deleted by - * deleting the agent. Format: `projects//locations//agents//flows/`. + * deleting the agent. Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { */ @@ -105,8 +105,8 @@ class Agent extends \Google\Protobuf\Internal\Message /** * Name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] - * reference for the agent. Format: `projects//locations//securitySettings/`. + * reference for the agent. Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string security_settings = 17 [(.google.api.resource_reference) = { */ @@ -180,6 +180,12 @@ class Agent extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL]; */ protected $personalization_settings = null; + /** + * Optional. Settings for custom client certificates. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Agent.ClientCertificateSettings client_certificate_settings = 43 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $client_certificate_settings = null; /** * Constructor. @@ -194,7 +200,7 @@ class Agent extends \Google\Protobuf\Internal\Message * method. * [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] * populates the name automatically. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $display_name * Required. The human-readable name of the agent, unique within the location. * @type string $default_language_code @@ -225,13 +231,13 @@ class Agent extends \Google\Protobuf\Internal\Message * @type string $start_flow * Immutable. Name of the start flow in this agent. A start flow will be * automatically created when the agent is created, and can only be deleted by - * deleting the agent. Format: `projects//locations//agents//flows/`. + * deleting the agent. Format: + * `projects//locations//agents//flows/`. * @type string $security_settings * Name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] - * reference for the agent. Format: `projects//locations//securitySettings/`. + * reference for the agent. Format: + * `projects//locations//securitySettings/`. * @type bool $enable_stackdriver_logging * Indicates if stackdriver logging is enabled for the agent. * Please use @@ -260,6 +266,8 @@ class Agent extends \Google\Protobuf\Internal\Message * Optional. Answer feedback collection settings. * @type \Google\Cloud\Dialogflow\Cx\V3\Agent\PersonalizationSettings $personalization_settings * Optional. Settings for end user personalization. + * @type \Google\Cloud\Dialogflow\Cx\V3\Agent\ClientCertificateSettings $client_certificate_settings + * Optional. Settings for custom client certificates. * } */ public function __construct($data = NULL) { @@ -274,7 +282,7 @@ public function __construct($data = NULL) { * method. * [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] * populates the name automatically. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1; * @return string @@ -291,7 +299,7 @@ public function getName() * method. * [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] * populates the name automatically. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1; * @param string $var @@ -526,8 +534,8 @@ public function setSpeechToTextSettings($var) /** * Immutable. Name of the start flow in this agent. A start flow will be * automatically created when the agent is created, and can only be deleted by - * deleting the agent. Format: `projects//locations//agents//flows/`. + * deleting the agent. Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { * @return string @@ -540,8 +548,8 @@ public function getStartFlow() /** * Immutable. Name of the start flow in this agent. A start flow will be * automatically created when the agent is created, and can only be deleted by - * deleting the agent. Format: `projects//locations//agents//flows/`. + * deleting the agent. Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { * @param string $var @@ -558,8 +566,8 @@ public function setStartFlow($var) /** * Name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] - * reference for the agent. Format: `projects//locations//securitySettings/`. + * reference for the agent. Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string security_settings = 17 [(.google.api.resource_reference) = { * @return string @@ -572,8 +580,8 @@ public function getSecuritySettings() /** * Name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] - * reference for the agent. Format: `projects//locations//securitySettings/`. + * reference for the agent. Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string security_settings = 17 [(.google.api.resource_reference) = { * @param string $var @@ -927,5 +935,41 @@ public function setPersonalizationSettings($var) return $this; } + /** + * Optional. Settings for custom client certificates. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Agent.ClientCertificateSettings client_certificate_settings = 43 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\Agent\ClientCertificateSettings|null + */ + public function getClientCertificateSettings() + { + return $this->client_certificate_settings; + } + + public function hasClientCertificateSettings() + { + return isset($this->client_certificate_settings); + } + + public function clearClientCertificateSettings() + { + unset($this->client_certificate_settings); + } + + /** + * Optional. Settings for custom client certificates. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Agent.ClientCertificateSettings client_certificate_settings = 43 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\Agent\ClientCertificateSettings $var + * @return $this + */ + public function setClientCertificateSettings($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\Agent\ClientCertificateSettings::class); + $this->client_certificate_settings = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/Agent/ClientCertificateSettings.php b/DialogflowCx/src/V3/Agent/ClientCertificateSettings.php new file mode 100644 index 000000000000..f8f4f72bfcdd --- /dev/null +++ b/DialogflowCx/src/V3/Agent/ClientCertificateSettings.php @@ -0,0 +1,160 @@ +google.cloud.dialogflow.cx.v3.Agent.ClientCertificateSettings + */ +class ClientCertificateSettings extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The ssl certificate encoded in PEM format. This string must + * include the begin header and end footer lines. + * + * Generated from protobuf field string ssl_certificate = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $ssl_certificate = ''; + /** + * Required. The name of the SecretManager secret version resource storing + * the private key encoded in PEM format. Format: + * `projects/{project}/secrets/{secret}/versions/{version}` + * + * Generated from protobuf field string private_key = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $private_key = ''; + /** + * Optional. The name of the SecretManager secret version resource storing + * the passphrase. 'passphrase' should be left unset if the private key is + * not encrypted. + * Format: `projects/{project}/secrets/{secret}/versions/{version}` + * + * Generated from protobuf field string passphrase = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $passphrase = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $ssl_certificate + * Required. The ssl certificate encoded in PEM format. This string must + * include the begin header and end footer lines. + * @type string $private_key + * Required. The name of the SecretManager secret version resource storing + * the private key encoded in PEM format. Format: + * `projects/{project}/secrets/{secret}/versions/{version}` + * @type string $passphrase + * Optional. The name of the SecretManager secret version resource storing + * the passphrase. 'passphrase' should be left unset if the private key is + * not encrypted. + * Format: `projects/{project}/secrets/{secret}/versions/{version}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Agent::initOnce(); + parent::__construct($data); + } + + /** + * Required. The ssl certificate encoded in PEM format. This string must + * include the begin header and end footer lines. + * + * Generated from protobuf field string ssl_certificate = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getSslCertificate() + { + return $this->ssl_certificate; + } + + /** + * Required. The ssl certificate encoded in PEM format. This string must + * include the begin header and end footer lines. + * + * Generated from protobuf field string ssl_certificate = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setSslCertificate($var) + { + GPBUtil::checkString($var, True); + $this->ssl_certificate = $var; + + return $this; + } + + /** + * Required. The name of the SecretManager secret version resource storing + * the private key encoded in PEM format. Format: + * `projects/{project}/secrets/{secret}/versions/{version}` + * + * Generated from protobuf field string private_key = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getPrivateKey() + { + return $this->private_key; + } + + /** + * Required. The name of the SecretManager secret version resource storing + * the private key encoded in PEM format. Format: + * `projects/{project}/secrets/{secret}/versions/{version}` + * + * Generated from protobuf field string private_key = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setPrivateKey($var) + { + GPBUtil::checkString($var, True); + $this->private_key = $var; + + return $this; + } + + /** + * Optional. The name of the SecretManager secret version resource storing + * the passphrase. 'passphrase' should be left unset if the private key is + * not encrypted. + * Format: `projects/{project}/secrets/{secret}/versions/{version}` + * + * Generated from protobuf field string passphrase = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getPassphrase() + { + return $this->passphrase; + } + + /** + * Optional. The name of the SecretManager secret version resource storing + * the passphrase. 'passphrase' should be left unset if the private key is + * not encrypted. + * Format: `projects/{project}/secrets/{secret}/versions/{version}` + * + * Generated from protobuf field string passphrase = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setPassphrase($var) + { + GPBUtil::checkString($var, True); + $this->passphrase = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/AgentValidationResult.php b/DialogflowCx/src/V3/AgentValidationResult.php index db66f3142df8..7ebeb05e766a 100644 --- a/DialogflowCx/src/V3/AgentValidationResult.php +++ b/DialogflowCx/src/V3/AgentValidationResult.php @@ -18,8 +18,8 @@ class AgentValidationResult extends \Google\Protobuf\Internal\Message { /** * The unique identifier of the agent validation result. - * Format: `projects//locations//agents//validationResult`. + * Format: + * `projects//locations//agents//validationResult`. * * Generated from protobuf field string name = 1; */ @@ -39,8 +39,8 @@ class AgentValidationResult extends \Google\Protobuf\Internal\Message * * @type string $name * The unique identifier of the agent validation result. - * Format: `projects//locations//agents//validationResult`. + * Format: + * `projects//locations//agents//validationResult`. * @type array<\Google\Cloud\Dialogflow\Cx\V3\FlowValidationResult>|\Google\Protobuf\Internal\RepeatedField $flow_validation_results * Contains all flow validation results. * } @@ -52,8 +52,8 @@ public function __construct($data = NULL) { /** * The unique identifier of the agent validation result. - * Format: `projects//locations//agents//validationResult`. + * Format: + * `projects//locations//agents//validationResult`. * * Generated from protobuf field string name = 1; * @return string @@ -65,8 +65,8 @@ public function getName() /** * The unique identifier of the agent validation result. - * Format: `projects//locations//agents//validationResult`. + * Format: + * `projects//locations//agents//validationResult`. * * Generated from protobuf field string name = 1; * @param string $var diff --git a/DialogflowCx/src/V3/AudioEncoding.php b/DialogflowCx/src/V3/AudioEncoding.php index 3f7ad7437021..8d8ca43f7a10 100644 --- a/DialogflowCx/src/V3/AudioEncoding.php +++ b/DialogflowCx/src/V3/AudioEncoding.php @@ -83,6 +83,12 @@ class AudioEncoding * Generated from protobuf enum AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7; */ const AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7; + /** + * 8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law. + * + * Generated from protobuf enum AUDIO_ENCODING_ALAW = 8; + */ + const AUDIO_ENCODING_ALAW = 8; private static $valueToName = [ self::AUDIO_ENCODING_UNSPECIFIED => 'AUDIO_ENCODING_UNSPECIFIED', @@ -93,6 +99,7 @@ class AudioEncoding self::AUDIO_ENCODING_AMR_WB => 'AUDIO_ENCODING_AMR_WB', self::AUDIO_ENCODING_OGG_OPUS => 'AUDIO_ENCODING_OGG_OPUS', self::AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE => 'AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE', + self::AUDIO_ENCODING_ALAW => 'AUDIO_ENCODING_ALAW', ]; public static function name($value) diff --git a/DialogflowCx/src/V3/BatchDeleteTestCasesRequest.php b/DialogflowCx/src/V3/BatchDeleteTestCasesRequest.php index e3313ded1461..22fcf3ee8005 100644 --- a/DialogflowCx/src/V3/BatchDeleteTestCasesRequest.php +++ b/DialogflowCx/src/V3/BatchDeleteTestCasesRequest.php @@ -18,14 +18,14 @@ class BatchDeleteTestCasesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to delete test cases from. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** - * Required. Format of test case names: `projects//locations/ - * /agents//testCases/`. + * Required. Format of test case names: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string names = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,7 +33,7 @@ class BatchDeleteTestCasesRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to delete test cases from. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\BatchDeleteTestCasesRequest @@ -54,10 +54,10 @@ public static function build(string $parent): self * * @type string $parent * Required. The agent to delete test cases from. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type array|\Google\Protobuf\Internal\RepeatedField $names - * Required. Format of test case names: `projects//locations/ - * /agents//testCases/`. + * Required. Format of test case names: + * `projects//locations//agents//testCases/`. * } */ public function __construct($data = NULL) { @@ -67,7 +67,7 @@ public function __construct($data = NULL) { /** * Required. The agent to delete test cases from. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -79,7 +79,7 @@ public function getParent() /** * Required. The agent to delete test cases from. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -94,8 +94,8 @@ public function setParent($var) } /** - * Required. Format of test case names: `projects//locations/ - * /agents//testCases/`. + * Required. Format of test case names: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string names = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -106,8 +106,8 @@ public function getNames() } /** - * Required. Format of test case names: `projects//locations/ - * /agents//testCases/`. + * Required. Format of test case names: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string names = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/BatchRunTestCasesRequest.php b/DialogflowCx/src/V3/BatchRunTestCasesRequest.php index 588b6971f4a9..32eb0e37f997 100644 --- a/DialogflowCx/src/V3/BatchRunTestCasesRequest.php +++ b/DialogflowCx/src/V3/BatchRunTestCasesRequest.php @@ -17,23 +17,22 @@ class BatchRunTestCasesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Agent name. Format: `projects//locations//agents/ `. + * Required. Agent name. Format: + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Optional. If not set, draft environment is assumed. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ protected $environment = ''; /** - * Required. Format: `projects//locations//agents//testCases/`. + * Required. Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string test_cases = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -46,15 +45,14 @@ class BatchRunTestCasesRequest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $parent - * Required. Agent name. Format: `projects//locations//agents/ `. + * Required. Agent name. Format: + * `projects//locations//agents/`. * @type string $environment * Optional. If not set, draft environment is assumed. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * @type array|\Google\Protobuf\Internal\RepeatedField $test_cases - * Required. Format: `projects//locations//agents//testCases/`. + * Required. Format: + * `projects//locations//agents//testCases/`. * } */ public function __construct($data = NULL) { @@ -63,8 +61,8 @@ public function __construct($data = NULL) { } /** - * Required. Agent name. Format: `projects//locations//agents/ `. + * Required. Agent name. Format: + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -75,8 +73,8 @@ public function getParent() } /** - * Required. Agent name. Format: `projects//locations//agents/ `. + * Required. Agent name. Format: + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -92,8 +90,7 @@ public function setParent($var) /** * Optional. If not set, draft environment is assumed. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string @@ -105,8 +102,7 @@ public function getEnvironment() /** * Optional. If not set, draft environment is assumed. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var @@ -121,8 +117,8 @@ public function setEnvironment($var) } /** - * Required. Format: `projects//locations//agents//testCases/`. + * Required. Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string test_cases = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -133,8 +129,8 @@ public function getTestCases() } /** - * Required. Format: `projects//locations//agents//testCases/`. + * Required. Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string test_cases = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec.php b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec.php index 694496ff6c08..2ce95dbeaaf8 100644 --- a/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec.php +++ b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec.php @@ -46,6 +46,13 @@ class ConditionBoostSpec extends \Google\Protobuf\Internal\Message * Generated from protobuf field float boost = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $boost = 0.0; + /** + * Optional. Complex specification for custom ranking based on customer + * defined attribute value. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $boost_control_spec = null; /** * Constructor. @@ -76,6 +83,9 @@ class ConditionBoostSpec extends \Google\Protobuf\Internal\Message * out completely. * Setting to 0.0 means no boost applied. The boosting condition is * ignored. + * @type \Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec $boost_control_spec + * Optional. Complex specification for custom ranking based on customer + * defined attribute value. * } */ public function __construct($data = NULL) { @@ -173,6 +183,44 @@ public function setBoost($var) return $this; } + /** + * Optional. Complex specification for custom ranking based on customer + * defined attribute value. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec|null + */ + public function getBoostControlSpec() + { + return $this->boost_control_spec; + } + + public function hasBoostControlSpec() + { + return isset($this->boost_control_spec); + } + + public function clearBoostControlSpec() + { + unset($this->boost_control_spec); + } + + /** + * Optional. Complex specification for custom ranking based on customer + * defined attribute value. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec $var + * @return $this + */ + public function setBoostControlSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec::class); + $this->boost_control_spec = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec.php b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec.php new file mode 100644 index 000000000000..2b3ebcf58361 --- /dev/null +++ b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec.php @@ -0,0 +1,204 @@ +google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec + */ +class BoostControlSpec extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The name of the field whose value will be used to determine + * the boost amount. + * + * Generated from protobuf field string field_name = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $field_name = ''; + /** + * Optional. The attribute type to be used to determine the boost amount. + * The attribute value can be derived from the field value of the + * specified field_name. In the case of numerical it is straightforward + * i.e. attribute_value = numerical_field_value. In the case of freshness + * however, attribute_value = (time.now() - datetime_field_value). + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $attribute_type = 0; + /** + * Optional. The interpolation type to be applied to connect the control + * points listed below. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $interpolation_type = 0; + /** + * Optional. The control points used to define the curve. The monotonic + * function (defined through the interpolation_type above) passes through + * the control points listed here. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $control_points; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $field_name + * Optional. The name of the field whose value will be used to determine + * the boost amount. + * @type int $attribute_type + * Optional. The attribute type to be used to determine the boost amount. + * The attribute value can be derived from the field value of the + * specified field_name. In the case of numerical it is straightforward + * i.e. attribute_value = numerical_field_value. In the case of freshness + * however, attribute_value = (time.now() - datetime_field_value). + * @type int $interpolation_type + * Optional. The interpolation type to be applied to connect the control + * points listed below. + * @type array<\Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec\ControlPoint>|\Google\Protobuf\Internal\RepeatedField $control_points + * Optional. The control points used to define the curve. The monotonic + * function (defined through the interpolation_type above) passes through + * the control points listed here. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Session::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The name of the field whose value will be used to determine + * the boost amount. + * + * Generated from protobuf field string field_name = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFieldName() + { + return $this->field_name; + } + + /** + * Optional. The name of the field whose value will be used to determine + * the boost amount. + * + * Generated from protobuf field string field_name = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFieldName($var) + { + GPBUtil::checkString($var, True); + $this->field_name = $var; + + return $this; + } + + /** + * Optional. The attribute type to be used to determine the boost amount. + * The attribute value can be derived from the field value of the + * specified field_name. In the case of numerical it is straightforward + * i.e. attribute_value = numerical_field_value. In the case of freshness + * however, attribute_value = (time.now() - datetime_field_value). + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getAttributeType() + { + return $this->attribute_type; + } + + /** + * Optional. The attribute type to be used to determine the boost amount. + * The attribute value can be derived from the field value of the + * specified field_name. In the case of numerical it is straightforward + * i.e. attribute_value = numerical_field_value. In the case of freshness + * however, attribute_value = (time.now() - datetime_field_value). + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setAttributeType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec\AttributeType::class); + $this->attribute_type = $var; + + return $this; + } + + /** + * Optional. The interpolation type to be applied to connect the control + * points listed below. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getInterpolationType() + { + return $this->interpolation_type; + } + + /** + * Optional. The interpolation type to be applied to connect the control + * points listed below. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setInterpolationType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec\InterpolationType::class); + $this->interpolation_type = $var; + + return $this; + } + + /** + * Optional. The control points used to define the curve. The monotonic + * function (defined through the interpolation_type above) passes through + * the control points listed here. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getControlPoints() + { + return $this->control_points; + } + + /** + * Optional. The control points used to define the curve. The monotonic + * function (defined through the interpolation_type above) passes through + * the control points listed here. + * + * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec\ControlPoint>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setControlPoints($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\Cx\V3\BoostSpec\ConditionBoostSpec\BoostControlSpec\ControlPoint::class); + $this->control_points = $arr; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/AttributeType.php b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/AttributeType.php new file mode 100644 index 000000000000..ebed2c8275b6 --- /dev/null +++ b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/AttributeType.php @@ -0,0 +1,71 @@ +google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType + */ +class AttributeType +{ + /** + * Unspecified AttributeType. + * + * Generated from protobuf enum ATTRIBUTE_TYPE_UNSPECIFIED = 0; + */ + const ATTRIBUTE_TYPE_UNSPECIFIED = 0; + /** + * The value of the numerical field will be used to dynamically update + * the boost amount. In this case, the attribute_value (the x value) + * of the control point will be the actual value of the numerical + * field for which the boost_amount is specified. + * + * Generated from protobuf enum NUMERICAL = 1; + */ + const NUMERICAL = 1; + /** + * For the freshness use case the attribute value will be the duration + * between the current time and the date in the datetime field + * specified. The value must be formatted as an XSD `dayTimeDuration` + * value (a restricted subset of an ISO 8601 duration value). The + * pattern for this is: `[nD][T[nH][nM][nS]]`. + * E.g. `5D`, `3DT12H30M`, `T24H`. + * + * Generated from protobuf enum FRESHNESS = 2; + */ + const FRESHNESS = 2; + + private static $valueToName = [ + self::ATTRIBUTE_TYPE_UNSPECIFIED => 'ATTRIBUTE_TYPE_UNSPECIFIED', + self::NUMERICAL => 'NUMERICAL', + self::FRESHNESS => 'FRESHNESS', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/ControlPoint.php b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/ControlPoint.php new file mode 100644 index 000000000000..9798224aa371 --- /dev/null +++ b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/ControlPoint.php @@ -0,0 +1,128 @@ +google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint + */ +class ControlPoint extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Can be one of: + * 1. The numerical field value. + * 2. The duration spec for freshness: + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for + * this is: `[nD][T[nH][nM][nS]]`. + * + * Generated from protobuf field string attribute_value = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $attribute_value = ''; + /** + * Optional. The value between -1 to 1 by which to boost the score if + * the attribute_value evaluates to the value specified above. + * + * Generated from protobuf field float boost_amount = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $boost_amount = 0.0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $attribute_value + * Optional. Can be one of: + * 1. The numerical field value. + * 2. The duration spec for freshness: + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for + * this is: `[nD][T[nH][nM][nS]]`. + * @type float $boost_amount + * Optional. The value between -1 to 1 by which to boost the score if + * the attribute_value evaluates to the value specified above. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Session::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Can be one of: + * 1. The numerical field value. + * 2. The duration spec for freshness: + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for + * this is: `[nD][T[nH][nM][nS]]`. + * + * Generated from protobuf field string attribute_value = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getAttributeValue() + { + return $this->attribute_value; + } + + /** + * Optional. Can be one of: + * 1. The numerical field value. + * 2. The duration spec for freshness: + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for + * this is: `[nD][T[nH][nM][nS]]`. + * + * Generated from protobuf field string attribute_value = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setAttributeValue($var) + { + GPBUtil::checkString($var, True); + $this->attribute_value = $var; + + return $this; + } + + /** + * Optional. The value between -1 to 1 by which to boost the score if + * the attribute_value evaluates to the value specified above. + * + * Generated from protobuf field float boost_amount = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return float + */ + public function getBoostAmount() + { + return $this->boost_amount; + } + + /** + * Optional. The value between -1 to 1 by which to boost the score if + * the attribute_value evaluates to the value specified above. + * + * Generated from protobuf field float boost_amount = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param float $var + * @return $this + */ + public function setBoostAmount($var) + { + GPBUtil::checkFloat($var); + $this->boost_amount = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/InterpolationType.php b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/InterpolationType.php new file mode 100644 index 000000000000..22dac6c9226e --- /dev/null +++ b/DialogflowCx/src/V3/BoostSpec/ConditionBoostSpec/BoostControlSpec/InterpolationType.php @@ -0,0 +1,57 @@ +google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType + */ +class InterpolationType +{ + /** + * Interpolation type is unspecified. In this case, it defaults to + * Linear. + * + * Generated from protobuf enum INTERPOLATION_TYPE_UNSPECIFIED = 0; + */ + const INTERPOLATION_TYPE_UNSPECIFIED = 0; + /** + * Piecewise linear interpolation will be applied. + * + * Generated from protobuf enum LINEAR = 1; + */ + const LINEAR = 1; + + private static $valueToName = [ + self::INTERPOLATION_TYPE_UNSPECIFIED => 'INTERPOLATION_TYPE_UNSPECIFIED', + self::LINEAR => 'LINEAR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/DialogflowCx/src/V3/CalculateCoverageRequest.php b/DialogflowCx/src/V3/CalculateCoverageRequest.php index d99eceebfa52..0ae4b3ac2b13 100644 --- a/DialogflowCx/src/V3/CalculateCoverageRequest.php +++ b/DialogflowCx/src/V3/CalculateCoverageRequest.php @@ -18,7 +18,7 @@ class CalculateCoverageRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to calculate coverage for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string agent = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -38,7 +38,7 @@ class CalculateCoverageRequest extends \Google\Protobuf\Internal\Message * * @type string $agent * Required. The agent to calculate coverage for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type int $type * Required. The type of coverage requested. * } @@ -50,7 +50,7 @@ public function __construct($data = NULL) { /** * Required. The agent to calculate coverage for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string agent = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -62,7 +62,7 @@ public function getAgent() /** * Required. The agent to calculate coverage for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string agent = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CalculateCoverageResponse.php b/DialogflowCx/src/V3/CalculateCoverageResponse.php index 1d21d3a7b51e..9c933eaecdf5 100644 --- a/DialogflowCx/src/V3/CalculateCoverageResponse.php +++ b/DialogflowCx/src/V3/CalculateCoverageResponse.php @@ -18,7 +18,7 @@ class CalculateCoverageResponse extends \Google\Protobuf\Internal\Message { /** * The agent to calculate coverage for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string agent = 5 [(.google.api.resource_reference) = { */ @@ -33,7 +33,7 @@ class CalculateCoverageResponse extends \Google\Protobuf\Internal\Message * * @type string $agent * The agent to calculate coverage for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\IntentCoverage $intent_coverage * Intent coverage. * @type \Google\Cloud\Dialogflow\Cx\V3\TransitionCoverage $transition_coverage @@ -49,7 +49,7 @@ public function __construct($data = NULL) { /** * The agent to calculate coverage for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string agent = 5 [(.google.api.resource_reference) = { * @return string @@ -61,7 +61,7 @@ public function getAgent() /** * The agent to calculate coverage for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string agent = 5 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/Changelog.php b/DialogflowCx/src/V3/Changelog.php index c0ca058f57a0..01b9f8e84c48 100644 --- a/DialogflowCx/src/V3/Changelog.php +++ b/DialogflowCx/src/V3/Changelog.php @@ -17,8 +17,8 @@ class Changelog extends \Google\Protobuf\Internal\Message { /** * The unique identifier of the changelog. - * Format: `projects//locations//agents//changelogs/`. + * Format: + * `projects//locations//agents//changelogs/`. * * Generated from protobuf field string name = 1; */ @@ -74,8 +74,8 @@ class Changelog extends \Google\Protobuf\Internal\Message * * @type string $name * The unique identifier of the changelog. - * Format: `projects//locations//agents//changelogs/`. + * Format: + * `projects//locations//agents//changelogs/`. * @type string $user_email * Email address of the authenticated user. * @type string $display_name @@ -99,8 +99,8 @@ public function __construct($data = NULL) { /** * The unique identifier of the changelog. - * Format: `projects//locations//agents//changelogs/`. + * Format: + * `projects//locations//agents//changelogs/`. * * Generated from protobuf field string name = 1; * @return string @@ -112,8 +112,8 @@ public function getName() /** * The unique identifier of the changelog. - * Format: `projects//locations//agents//changelogs/`. + * Format: + * `projects//locations//agents//changelogs/`. * * Generated from protobuf field string name = 1; * @param string $var diff --git a/DialogflowCx/src/V3/Client/AgentsClient.php b/DialogflowCx/src/V3/Client/AgentsClient.php index 449ba5083be5..77a76d16bedd 100644 --- a/DialogflowCx/src/V3/Client/AgentsClient.php +++ b/DialogflowCx/src/V3/Client/AgentsClient.php @@ -303,6 +303,25 @@ public static function locationName(string $project, string $location): string ]); } + /** + * Formats a string containing the fully-qualified path to represent a + * secret_version resource. + * + * @param string $project + * @param string $secret + * @param string $version + * + * @return string The formatted secret_version resource. + */ + public static function secretVersionName(string $project, string $secret, string $version): string + { + return self::getPathTemplate('secretVersion')->render([ + 'project' => $project, + 'secret' => $secret, + 'version' => $version, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a * security_settings resource. @@ -332,6 +351,7 @@ public static function securitySettingsName(string $project, string $location, s * - environment: projects/{project}/locations/{location}/agents/{agent}/environments/{environment} * - flow: projects/{project}/locations/{location}/agents/{agent}/flows/{flow} * - location: projects/{project}/locations/{location} + * - secretVersion: projects/{project}/secrets/{secret}/versions/{version} * - securitySettings: projects/{project}/locations/{location}/securitySettings/{security_settings} * * The optional $template argument can be supplied to specify a particular pattern, diff --git a/DialogflowCx/src/V3/CompareVersionsRequest.php b/DialogflowCx/src/V3/CompareVersionsRequest.php index c645cb60f55b..3708cff2bdad 100644 --- a/DialogflowCx/src/V3/CompareVersionsRequest.php +++ b/DialogflowCx/src/V3/CompareVersionsRequest.php @@ -19,8 +19,8 @@ class CompareVersionsRequest extends \Google\Protobuf\Internal\Message /** * Required. Name of the base flow version to compare with the target version. * Use version ID `0` to indicate the draft version of the specified flow. - * Format: `projects//locations//agents/ - * /flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string base_version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -28,8 +28,8 @@ class CompareVersionsRequest extends \Google\Protobuf\Internal\Message /** * Required. Name of the target flow version to compare with the * base version. Use version ID `0` to indicate the draft version of the - * specified flow. Format: `projects//locations//agents//flows//versions/`. + * specified flow. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string target_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -50,8 +50,8 @@ class CompareVersionsRequest extends \Google\Protobuf\Internal\Message * @param string $baseVersion Required. Name of the base flow version to compare with the target version. * Use version ID `0` to indicate the draft version of the specified flow. * - * Format: `projects//locations//agents/ - * /flows//versions/`. Please see + * Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\CompareVersionsRequest @@ -73,13 +73,13 @@ public static function build(string $baseVersion): self * @type string $base_version * Required. Name of the base flow version to compare with the target version. * Use version ID `0` to indicate the draft version of the specified flow. - * Format: `projects//locations//agents/ - * /flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * @type string $target_version * Required. Name of the target flow version to compare with the * base version. Use version ID `0` to indicate the draft version of the - * specified flow. Format: `projects//locations//agents//flows//versions/`. + * specified flow. Format: + * `projects//locations//agents//flows//versions/`. * @type string $language_code * The language to compare the flow versions for. * If not specified, the agent's default language is used. @@ -97,8 +97,8 @@ public function __construct($data = NULL) { /** * Required. Name of the base flow version to compare with the target version. * Use version ID `0` to indicate the draft version of the specified flow. - * Format: `projects//locations//agents/ - * /flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string base_version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -111,8 +111,8 @@ public function getBaseVersion() /** * Required. Name of the base flow version to compare with the target version. * Use version ID `0` to indicate the draft version of the specified flow. - * Format: `projects//locations//agents/ - * /flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string base_version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -129,8 +129,8 @@ public function setBaseVersion($var) /** * Required. Name of the target flow version to compare with the * base version. Use version ID `0` to indicate the draft version of the - * specified flow. Format: `projects//locations//agents//flows//versions/`. + * specified flow. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string target_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -143,8 +143,8 @@ public function getTargetVersion() /** * Required. Name of the target flow version to compare with the * base version. Use version ID `0` to indicate the draft version of the - * specified flow. Format: `projects//locations//agents//flows//versions/`. + * specified flow. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string target_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ContinuousTestResult.php b/DialogflowCx/src/V3/ContinuousTestResult.php index 086bd1526534..f258bf25c93f 100644 --- a/DialogflowCx/src/V3/ContinuousTestResult.php +++ b/DialogflowCx/src/V3/ContinuousTestResult.php @@ -17,9 +17,7 @@ class ContinuousTestResult extends \Google\Protobuf\Internal\Message { /** * The resource name for the continuous test result. Format: - * `projects//locations//agents//environments//continuousTestResults/`. + * `projects//locations//agents//environments//continuousTestResults/`. * * Generated from protobuf field string name = 1; */ @@ -52,9 +50,7 @@ class ContinuousTestResult extends \Google\Protobuf\Internal\Message * * @type string $name * The resource name for the continuous test result. Format: - * `projects//locations//agents//environments//continuousTestResults/`. + * `projects//locations//agents//environments//continuousTestResults/`. * @type int $result * The result of this continuous test run, i.e. whether all the tests in this * continuous test run pass or not. @@ -71,9 +67,7 @@ public function __construct($data = NULL) { /** * The resource name for the continuous test result. Format: - * `projects//locations//agents//environments//continuousTestResults/`. + * `projects//locations//agents//environments//continuousTestResults/`. * * Generated from protobuf field string name = 1; * @return string @@ -85,9 +79,7 @@ public function getName() /** * The resource name for the continuous test result. Format: - * `projects//locations//agents//environments//continuousTestResults/`. + * `projects//locations//agents//environments//continuousTestResults/`. * * Generated from protobuf field string name = 1; * @param string $var diff --git a/DialogflowCx/src/V3/CreateAgentRequest.php b/DialogflowCx/src/V3/CreateAgentRequest.php index 7be5e9586186..df418e380976 100644 --- a/DialogflowCx/src/V3/CreateAgentRequest.php +++ b/DialogflowCx/src/V3/CreateAgentRequest.php @@ -18,7 +18,7 @@ class CreateAgentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The location to create a agent for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -32,7 +32,7 @@ class CreateAgentRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The location to create a agent for. - * Format: `projects//locations/`. Please see + * Format: `projects//locations/`. Please see * {@see AgentsClient::locationName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Agent $agent Required. The agent to create. * @@ -55,7 +55,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Agen * * @type string $parent * Required. The location to create a agent for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Agent $agent * Required. The agent to create. * } @@ -67,7 +67,7 @@ public function __construct($data = NULL) { /** * Required. The location to create a agent for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -79,7 +79,7 @@ public function getParent() /** * Required. The location to create a agent for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateEntityTypeRequest.php b/DialogflowCx/src/V3/CreateEntityTypeRequest.php index 1b76d3915df2..b74e55a837aa 100644 --- a/DialogflowCx/src/V3/CreateEntityTypeRequest.php +++ b/DialogflowCx/src/V3/CreateEntityTypeRequest.php @@ -18,7 +18,7 @@ class CreateEntityTypeRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to create a entity type for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -46,7 +46,7 @@ class CreateEntityTypeRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to create a entity type for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see EntityTypesClient::agentName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\EntityType $entityType Required. The entity type to create. * @@ -69,7 +69,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Enti * * @type string $parent * Required. The agent to create a entity type for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\EntityType $entity_type * Required. The entity type to create. * @type string $language_code @@ -91,7 +91,7 @@ public function __construct($data = NULL) { /** * Required. The agent to create a entity type for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -103,7 +103,7 @@ public function getParent() /** * Required. The agent to create a entity type for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateEnvironmentRequest.php b/DialogflowCx/src/V3/CreateEnvironmentRequest.php index 6c56a2331c9f..db001090b83b 100644 --- a/DialogflowCx/src/V3/CreateEnvironmentRequest.php +++ b/DialogflowCx/src/V3/CreateEnvironmentRequest.php @@ -19,7 +19,7 @@ class CreateEnvironmentRequest extends \Google\Protobuf\Internal\Message /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents/`. + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -34,7 +34,7 @@ class CreateEnvironmentRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents/`. Please see + * `projects//locations//agents/`. Please see * {@see EnvironmentsClient::agentName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Environment $environment Required. The environment to create. * @@ -58,7 +58,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Envi * @type string $parent * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents/`. + * `projects//locations//agents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Environment $environment * Required. The environment to create. * } @@ -71,7 +71,7 @@ public function __construct($data = NULL) { /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents/`. + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -84,7 +84,7 @@ public function getParent() /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents/`. + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateExperimentRequest.php b/DialogflowCx/src/V3/CreateExperimentRequest.php index 7f5b6dcbdf95..3e24428f7f56 100644 --- a/DialogflowCx/src/V3/CreateExperimentRequest.php +++ b/DialogflowCx/src/V3/CreateExperimentRequest.php @@ -19,8 +19,7 @@ class CreateExperimentRequest extends \Google\Protobuf\Internal\Message /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -35,8 +34,7 @@ class CreateExperimentRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents//environments/`. Please see + * `projects//locations//agents//environments/`. Please see * {@see ExperimentsClient::environmentName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Experiment $experiment Required. The experiment to create. * @@ -60,8 +58,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Expe * @type string $parent * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Experiment $experiment * Required. The experiment to create. * } @@ -74,8 +71,7 @@ public function __construct($data = NULL) { /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -88,8 +84,7 @@ public function getParent() /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an * [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateFlowRequest.php b/DialogflowCx/src/V3/CreateFlowRequest.php index 53af33b52af0..cafcee4975c2 100644 --- a/DialogflowCx/src/V3/CreateFlowRequest.php +++ b/DialogflowCx/src/V3/CreateFlowRequest.php @@ -18,7 +18,7 @@ class CreateFlowRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to create a flow for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -47,7 +47,7 @@ class CreateFlowRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to create a flow for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see FlowsClient::agentName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Flow $flow Required. The flow to create. * @@ -70,7 +70,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Flow * * @type string $parent * Required. The agent to create a flow for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Flow $flow * Required. The flow to create. * @type string $language_code @@ -93,7 +93,7 @@ public function __construct($data = NULL) { /** * Required. The agent to create a flow for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -105,7 +105,7 @@ public function getParent() /** * Required. The agent to create a flow for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateGeneratorRequest.php b/DialogflowCx/src/V3/CreateGeneratorRequest.php index d2afe49dc0d2..a6d888dc916b 100644 --- a/DialogflowCx/src/V3/CreateGeneratorRequest.php +++ b/DialogflowCx/src/V3/CreateGeneratorRequest.php @@ -18,7 +18,7 @@ class CreateGeneratorRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to create a generator for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -40,7 +40,7 @@ class CreateGeneratorRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to create a generator for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see GeneratorsClient::agentName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Generator $generator Required. The generator to create. * @@ -63,7 +63,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Gene * * @type string $parent * Required. The agent to create a generator for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Generator $generator * Required. The generator to create. * @type string $language_code @@ -79,7 +79,7 @@ public function __construct($data = NULL) { /** * Required. The agent to create a generator for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -91,7 +91,7 @@ public function getParent() /** * Required. The agent to create a generator for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateIntentRequest.php b/DialogflowCx/src/V3/CreateIntentRequest.php index 63bb4b62e097..1525af676e71 100644 --- a/DialogflowCx/src/V3/CreateIntentRequest.php +++ b/DialogflowCx/src/V3/CreateIntentRequest.php @@ -18,7 +18,7 @@ class CreateIntentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to create an intent for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -44,7 +44,7 @@ class CreateIntentRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to create an intent for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see IntentsClient::agentName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Intent $intent Required. The intent to create. * @@ -67,7 +67,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Inte * * @type string $parent * Required. The agent to create an intent for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Intent $intent * Required. The intent to create. * @type string $language_code @@ -87,7 +87,7 @@ public function __construct($data = NULL) { /** * Required. The agent to create an intent for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -99,7 +99,7 @@ public function getParent() /** * Required. The agent to create an intent for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreatePageRequest.php b/DialogflowCx/src/V3/CreatePageRequest.php index 59875695b930..6fac94bb204b 100644 --- a/DialogflowCx/src/V3/CreatePageRequest.php +++ b/DialogflowCx/src/V3/CreatePageRequest.php @@ -18,8 +18,8 @@ class CreatePageRequest extends \Google\Protobuf\Internal\Message { /** * Required. The flow to create a page for. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -56,8 +56,8 @@ class CreatePageRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The flow to create a page for. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see PagesClient::flowName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Page $page Required. The page to create. * @@ -80,8 +80,8 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Page * * @type string $parent * Required. The flow to create a page for. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Page $page * Required. The page to create. * @type string $language_code @@ -112,8 +112,8 @@ public function __construct($data = NULL) { /** * Required. The flow to create a page for. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -125,8 +125,8 @@ public function getParent() /** * Required. The flow to create a page for. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateSecuritySettingsRequest.php b/DialogflowCx/src/V3/CreateSecuritySettingsRequest.php index 777208ede0d6..86a69de5e77f 100644 --- a/DialogflowCx/src/V3/CreateSecuritySettingsRequest.php +++ b/DialogflowCx/src/V3/CreateSecuritySettingsRequest.php @@ -18,7 +18,7 @@ class CreateSecuritySettingsRequest extends \Google\Protobuf\Internal\Message /** * Required. The location to create an * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,7 +33,7 @@ class CreateSecuritySettingsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The location to create an * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. - * Format: `projects//locations/`. Please see + * Format: `projects//locations/`. Please see * {@see SecuritySettingsServiceClient::locationName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\SecuritySettings $securitySettings Required. The security settings to create. * @@ -57,7 +57,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Secu * @type string $parent * Required. The location to create an * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * @type \Google\Cloud\Dialogflow\Cx\V3\SecuritySettings $security_settings * Required. The security settings to create. * } @@ -70,7 +70,7 @@ public function __construct($data = NULL) { /** * Required. The location to create an * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -83,7 +83,7 @@ public function getParent() /** * Required. The location to create an * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateSessionEntityTypeRequest.php b/DialogflowCx/src/V3/CreateSessionEntityTypeRequest.php index e41a9eb4ab0a..ac1aaeb53278 100644 --- a/DialogflowCx/src/V3/CreateSessionEntityTypeRequest.php +++ b/DialogflowCx/src/V3/CreateSessionEntityTypeRequest.php @@ -18,9 +18,10 @@ class CreateSessionEntityTypeRequest extends \Google\Protobuf\Internal\Message { /** * Required. The session to create a session entity type for. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * @@ -36,9 +37,10 @@ class CreateSessionEntityTypeRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The session to create a session entity type for. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. Please see * {@see SessionEntityTypesClient::sessionName()} for help formatting this field. @@ -63,9 +65,10 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Sess * * @type string $parent * Required. The session to create a session entity type for. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * @type \Google\Cloud\Dialogflow\Cx\V3\SessionEntityType $session_entity_type @@ -79,9 +82,10 @@ public function __construct($data = NULL) { /** * Required. The session to create a session entity type for. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * @@ -95,9 +99,10 @@ public function getParent() /** * Required. The session to create a session entity type for. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * diff --git a/DialogflowCx/src/V3/CreateTestCaseRequest.php b/DialogflowCx/src/V3/CreateTestCaseRequest.php index 7b4e376c5211..c61290e07925 100644 --- a/DialogflowCx/src/V3/CreateTestCaseRequest.php +++ b/DialogflowCx/src/V3/CreateTestCaseRequest.php @@ -18,7 +18,7 @@ class CreateTestCaseRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to create the test case for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -32,7 +32,7 @@ class CreateTestCaseRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to create the test case for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\TestCase $testCase Required. The test case to create. * @@ -55,7 +55,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Test * * @type string $parent * Required. The agent to create the test case for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\TestCase $test_case * Required. The test case to create. * } @@ -67,7 +67,7 @@ public function __construct($data = NULL) { /** * Required. The agent to create the test case for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -79,7 +79,7 @@ public function getParent() /** * Required. The agent to create the test case for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateTransitionRouteGroupRequest.php b/DialogflowCx/src/V3/CreateTransitionRouteGroupRequest.php index f05e99e79ea1..13085a8d7d59 100644 --- a/DialogflowCx/src/V3/CreateTransitionRouteGroupRequest.php +++ b/DialogflowCx/src/V3/CreateTransitionRouteGroupRequest.php @@ -19,9 +19,9 @@ class CreateTransitionRouteGroupRequest extends \Google\Protobuf\Internal\Messag /** * Required. The flow to create an * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * for. Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/` + * for. Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/` * for agent-level groups. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -51,9 +51,9 @@ class CreateTransitionRouteGroupRequest extends \Google\Protobuf\Internal\Messag /** * @param string $parent Required. The flow to create an * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * for. Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/` + * for. Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/` * for agent-level groups. Please see * {@see TransitionRouteGroupsClient::flowName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroup $transitionRouteGroup Required. The transition route group to create. @@ -78,9 +78,9 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Tran * @type string $parent * Required. The flow to create an * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * for. Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/` + * for. Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/` * for agent-level groups. * @type \Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroup $transition_route_group * Required. The transition route group to create. @@ -104,9 +104,9 @@ public function __construct($data = NULL) { /** * Required. The flow to create an * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * for. Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/` + * for. Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/` * for agent-level groups. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -120,9 +120,9 @@ public function getParent() /** * Required. The flow to create an * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * for. Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/` + * for. Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/` * for agent-level groups. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/DialogflowCx/src/V3/CreateVersionOperationMetadata.php b/DialogflowCx/src/V3/CreateVersionOperationMetadata.php index 06278aed37b5..af1c5c45c1bd 100644 --- a/DialogflowCx/src/V3/CreateVersionOperationMetadata.php +++ b/DialogflowCx/src/V3/CreateVersionOperationMetadata.php @@ -18,8 +18,8 @@ class CreateVersionOperationMetadata extends \Google\Protobuf\Internal\Message { /** * Name of the created version. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string version = 1 [(.google.api.resource_reference) = { */ @@ -33,8 +33,8 @@ class CreateVersionOperationMetadata extends \Google\Protobuf\Internal\Message * * @type string $version * Name of the created version. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * } */ public function __construct($data = NULL) { @@ -44,8 +44,8 @@ public function __construct($data = NULL) { /** * Name of the created version. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string version = 1 [(.google.api.resource_reference) = { * @return string @@ -57,8 +57,8 @@ public function getVersion() /** * Name of the created version. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string version = 1 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateVersionRequest.php b/DialogflowCx/src/V3/CreateVersionRequest.php index c2c9e74f224e..32887cd53c1e 100644 --- a/DialogflowCx/src/V3/CreateVersionRequest.php +++ b/DialogflowCx/src/V3/CreateVersionRequest.php @@ -19,8 +19,7 @@ class CreateVersionRequest extends \Google\Protobuf\Internal\Message /** * Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an * [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: - * `projects//locations//agents//flows/`. + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -35,8 +34,7 @@ class CreateVersionRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an * [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: - * `projects//locations//agents//flows/`. Please see + * `projects//locations//agents//flows/`. Please see * {@see VersionsClient::flowName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Version $version Required. The version to create. * @@ -60,8 +58,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Vers * @type string $parent * Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an * [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: - * `projects//locations//agents//flows/`. + * `projects//locations//agents//flows/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Version $version * Required. The version to create. * } @@ -74,8 +71,7 @@ public function __construct($data = NULL) { /** * Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an * [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: - * `projects//locations//agents//flows/`. + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -88,8 +84,7 @@ public function getParent() /** * Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an * [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: - * `projects//locations//agents//flows/`. + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/CreateWebhookRequest.php b/DialogflowCx/src/V3/CreateWebhookRequest.php index cfd10cdb2cf2..b3a09aa0e45f 100644 --- a/DialogflowCx/src/V3/CreateWebhookRequest.php +++ b/DialogflowCx/src/V3/CreateWebhookRequest.php @@ -18,7 +18,7 @@ class CreateWebhookRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to create a webhook for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -32,7 +32,7 @@ class CreateWebhookRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to create a webhook for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see WebhooksClient::agentName()} for help formatting this field. * @param \Google\Cloud\Dialogflow\Cx\V3\Webhook $webhook Required. The webhook to create. * @@ -55,7 +55,7 @@ public static function build(string $parent, \Google\Cloud\Dialogflow\Cx\V3\Webh * * @type string $parent * Required. The agent to create a webhook for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\Webhook $webhook * Required. The webhook to create. * } @@ -67,7 +67,7 @@ public function __construct($data = NULL) { /** * Required. The agent to create a webhook for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -79,7 +79,7 @@ public function getParent() /** * Required. The agent to create a webhook for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteAgentRequest.php b/DialogflowCx/src/V3/DeleteAgentRequest.php index 46233ee2ba36..eb1b6ddaa6e3 100644 --- a/DialogflowCx/src/V3/DeleteAgentRequest.php +++ b/DialogflowCx/src/V3/DeleteAgentRequest.php @@ -18,7 +18,7 @@ class DeleteAgentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the agent to delete. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -26,7 +26,7 @@ class DeleteAgentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the agent to delete. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see AgentsClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteAgentRequest @@ -47,7 +47,7 @@ public static function build(string $name): self * * @type string $name * Required. The name of the agent to delete. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * } */ public function __construct($data = NULL) { @@ -57,7 +57,7 @@ public function __construct($data = NULL) { /** * Required. The name of the agent to delete. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -69,7 +69,7 @@ public function getName() /** * Required. The name of the agent to delete. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteEntityTypeRequest.php b/DialogflowCx/src/V3/DeleteEntityTypeRequest.php index dbb5302b1ee9..dea705ed203d 100644 --- a/DialogflowCx/src/V3/DeleteEntityTypeRequest.php +++ b/DialogflowCx/src/V3/DeleteEntityTypeRequest.php @@ -18,8 +18,8 @@ class DeleteEntityTypeRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the entity type to delete. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -43,8 +43,8 @@ class DeleteEntityTypeRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the entity type to delete. - * Format: `projects//locations//agents//entityTypes/`. Please see + * Format: + * `projects//locations//agents//entityTypes/`. Please see * {@see EntityTypesClient::entityTypeName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteEntityTypeRequest @@ -65,8 +65,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the entity type to delete. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * @type bool $force * This field has no effect for entity type not being used. * For entity types that are used by intents or pages: @@ -88,8 +88,8 @@ public function __construct($data = NULL) { /** * Required. The name of the entity type to delete. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -101,8 +101,8 @@ public function getName() /** * Required. The name of the entity type to delete. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteEnvironmentRequest.php b/DialogflowCx/src/V3/DeleteEnvironmentRequest.php index 7f2a2ed73b0a..e6c6bedcfb9b 100644 --- a/DialogflowCx/src/V3/DeleteEnvironmentRequest.php +++ b/DialogflowCx/src/V3/DeleteEnvironmentRequest.php @@ -19,8 +19,7 @@ class DeleteEnvironmentRequest extends \Google\Protobuf\Internal\Message /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -29,8 +28,7 @@ class DeleteEnvironmentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments/`. Please see + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteEnvironmentRequest @@ -52,8 +50,7 @@ public static function build(string $name): self * @type string $name * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * } */ public function __construct($data = NULL) { @@ -64,8 +61,7 @@ public function __construct($data = NULL) { /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -78,8 +74,7 @@ public function getName() /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteExperimentRequest.php b/DialogflowCx/src/V3/DeleteExperimentRequest.php index f716a89b61d2..a71540139d64 100644 --- a/DialogflowCx/src/V3/DeleteExperimentRequest.php +++ b/DialogflowCx/src/V3/DeleteExperimentRequest.php @@ -19,8 +19,7 @@ class DeleteExperimentRequest extends \Google\Protobuf\Internal\Message /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments//experiments/`. + * `projects//locations//agents//environments//experiments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -29,8 +28,7 @@ class DeleteExperimentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments//experiments/`. Please see + * `projects//locations//agents//environments//experiments/`. Please see * {@see ExperimentsClient::experimentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteExperimentRequest @@ -52,8 +50,7 @@ public static function build(string $name): self * @type string $name * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments//experiments/`. + * `projects//locations//agents//environments//experiments/`. * } */ public function __construct($data = NULL) { @@ -64,8 +61,7 @@ public function __construct($data = NULL) { /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments//experiments/`. + * `projects//locations//agents//environments//experiments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -78,8 +74,7 @@ public function getName() /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: - * `projects//locations//agents//environments//experiments/`. + * `projects//locations//agents//environments//experiments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteFlowRequest.php b/DialogflowCx/src/V3/DeleteFlowRequest.php index 574851eb24f4..7bbcd2aba2ca 100644 --- a/DialogflowCx/src/V3/DeleteFlowRequest.php +++ b/DialogflowCx/src/V3/DeleteFlowRequest.php @@ -18,8 +18,8 @@ class DeleteFlowRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the flow to delete. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -41,8 +41,8 @@ class DeleteFlowRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the flow to delete. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see FlowsClient::flowName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteFlowRequest @@ -63,8 +63,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the flow to delete. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * @type bool $force * This field has no effect for flows with no incoming transitions. * For flows with incoming transitions: @@ -84,8 +84,8 @@ public function __construct($data = NULL) { /** * Required. The name of the flow to delete. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -97,8 +97,8 @@ public function getName() /** * Required. The name of the flow to delete. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteGeneratorRequest.php b/DialogflowCx/src/V3/DeleteGeneratorRequest.php index 88a4d7873ad0..f1516d54364d 100644 --- a/DialogflowCx/src/V3/DeleteGeneratorRequest.php +++ b/DialogflowCx/src/V3/DeleteGeneratorRequest.php @@ -18,8 +18,8 @@ class DeleteGeneratorRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the generator to delete. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -39,8 +39,8 @@ class DeleteGeneratorRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the generator to delete. - * Format: `projects//locations//agents//generators/`. Please see + * Format: + * `projects//locations//agents//generators/`. Please see * {@see GeneratorsClient::generatorName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteGeneratorRequest @@ -61,8 +61,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the generator to delete. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * @type bool $force * This field has no effect for generators not being used. * For generators that are used by pages/flows/transition route groups: @@ -80,8 +80,8 @@ public function __construct($data = NULL) { /** * Required. The name of the generator to delete. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -93,8 +93,8 @@ public function getName() /** * Required. The name of the generator to delete. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteIntentRequest.php b/DialogflowCx/src/V3/DeleteIntentRequest.php index e13d235b6c88..033f90777f2a 100644 --- a/DialogflowCx/src/V3/DeleteIntentRequest.php +++ b/DialogflowCx/src/V3/DeleteIntentRequest.php @@ -18,8 +18,8 @@ class DeleteIntentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the intent to delete. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -27,8 +27,8 @@ class DeleteIntentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the intent to delete. - * Format: `projects//locations//agents//intents/`. Please see + * Format: + * `projects//locations//agents//intents/`. Please see * {@see IntentsClient::intentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteIntentRequest @@ -49,8 +49,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the intent to delete. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * } */ public function __construct($data = NULL) { @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * Required. The name of the intent to delete. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,8 +73,8 @@ public function getName() /** * Required. The name of the intent to delete. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeletePageRequest.php b/DialogflowCx/src/V3/DeletePageRequest.php index 6a68eab0089f..8070937f94e0 100644 --- a/DialogflowCx/src/V3/DeletePageRequest.php +++ b/DialogflowCx/src/V3/DeletePageRequest.php @@ -18,8 +18,8 @@ class DeletePageRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the page to delete. - * Format: `projects//locations//agents//Flows//pages/`. + * Format: + * `projects//locations//agents//Flows//pages/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -41,8 +41,8 @@ class DeletePageRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the page to delete. - * Format: `projects//locations//agents//Flows//pages/`. Please see + * Format: + * `projects//locations//agents//Flows//pages/`. Please see * {@see PagesClient::pageName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeletePageRequest @@ -63,8 +63,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the page to delete. - * Format: `projects//locations//agents//Flows//pages/`. + * Format: + * `projects//locations//agents//Flows//pages/`. * @type bool $force * This field has no effect for pages with no incoming transitions. * For pages with incoming transitions: @@ -84,8 +84,8 @@ public function __construct($data = NULL) { /** * Required. The name of the page to delete. - * Format: `projects//locations//agents//Flows//pages/`. + * Format: + * `projects//locations//agents//Flows//pages/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -97,8 +97,8 @@ public function getName() /** * Required. The name of the page to delete. - * Format: `projects//locations//agents//Flows//pages/`. + * Format: + * `projects//locations//agents//Flows//pages/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteSecuritySettingsRequest.php b/DialogflowCx/src/V3/DeleteSecuritySettingsRequest.php index 405087966090..748895a9a067 100644 --- a/DialogflowCx/src/V3/DeleteSecuritySettingsRequest.php +++ b/DialogflowCx/src/V3/DeleteSecuritySettingsRequest.php @@ -18,8 +18,8 @@ class DeleteSecuritySettingsRequest extends \Google\Protobuf\Internal\Message /** * Required. The name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to - * delete. Format: `projects//locations//securitySettings/`. + * delete. Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -28,8 +28,8 @@ class DeleteSecuritySettingsRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to - * delete. Format: `projects//locations//securitySettings/`. Please see + * delete. Format: + * `projects//locations//securitySettings/`. Please see * {@see SecuritySettingsServiceClient::securitySettingsName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteSecuritySettingsRequest @@ -51,8 +51,8 @@ public static function build(string $name): self * @type string $name * Required. The name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to - * delete. Format: `projects//locations//securitySettings/`. + * delete. Format: + * `projects//locations//securitySettings/`. * } */ public function __construct($data = NULL) { @@ -63,8 +63,8 @@ public function __construct($data = NULL) { /** * Required. The name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to - * delete. Format: `projects//locations//securitySettings/`. + * delete. Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -77,8 +77,8 @@ public function getName() /** * Required. The name of the * [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to - * delete. Format: `projects//locations//securitySettings/`. + * delete. Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteSessionEntityTypeRequest.php b/DialogflowCx/src/V3/DeleteSessionEntityTypeRequest.php index 9e1a38fbcdcf..628ffaacc6fd 100644 --- a/DialogflowCx/src/V3/DeleteSessionEntityTypeRequest.php +++ b/DialogflowCx/src/V3/DeleteSessionEntityTypeRequest.php @@ -18,12 +18,12 @@ class DeleteSessionEntityTypeRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the session entity type to delete. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, + * we assume default 'draft' environment. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -31,12 +31,12 @@ class DeleteSessionEntityTypeRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the session entity type to delete. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. Please see + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, + * we assume default 'draft' environment. Please see * {@see SessionEntityTypesClient::sessionEntityTypeName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteSessionEntityTypeRequest @@ -57,12 +57,12 @@ public static function build(string $name): self * * @type string $name * Required. The name of the session entity type to delete. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, + * we assume default 'draft' environment. * } */ public function __construct($data = NULL) { @@ -72,12 +72,12 @@ public function __construct($data = NULL) { /** * Required. The name of the session entity type to delete. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, + * we assume default 'draft' environment. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -89,12 +89,12 @@ public function getName() /** * Required. The name of the session entity type to delete. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, + * we assume default 'draft' environment. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteTransitionRouteGroupRequest.php b/DialogflowCx/src/V3/DeleteTransitionRouteGroupRequest.php index 78c42e93f8a7..5be18f395885 100644 --- a/DialogflowCx/src/V3/DeleteTransitionRouteGroupRequest.php +++ b/DialogflowCx/src/V3/DeleteTransitionRouteGroupRequest.php @@ -19,10 +19,10 @@ class DeleteTransitionRouteGroupRequest extends \Google\Protobuf\Internal\Messag /** * Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`. + * to delete. Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -42,10 +42,10 @@ class DeleteTransitionRouteGroupRequest extends \Google\Protobuf\Internal\Messag /** * @param string $name Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`. Please see + * to delete. Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. Please see * {@see TransitionRouteGroupsClient::transitionRouteGroupName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteTransitionRouteGroupRequest @@ -67,10 +67,10 @@ public static function build(string $name): self * @type string $name * Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`. + * to delete. Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. * @type bool $force * This field has no effect for transition route group that no page is using. * If the transition route group is referenced by any page: @@ -88,10 +88,10 @@ public function __construct($data = NULL) { /** * Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`. + * to delete. Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -104,10 +104,10 @@ public function getName() /** * Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] - * to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`. + * to delete. Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteVersionRequest.php b/DialogflowCx/src/V3/DeleteVersionRequest.php index 4491f17a9db7..626c94df2c3a 100644 --- a/DialogflowCx/src/V3/DeleteVersionRequest.php +++ b/DialogflowCx/src/V3/DeleteVersionRequest.php @@ -18,8 +18,8 @@ class DeleteVersionRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] - * to delete. Format: `projects//locations//agents//flows//versions/`. + * to delete. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -27,8 +27,8 @@ class DeleteVersionRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] - * to delete. Format: `projects//locations//agents//flows//versions/`. Please see + * to delete. Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteVersionRequest @@ -49,8 +49,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] - * to delete. Format: `projects//locations//agents//flows//versions/`. + * to delete. Format: + * `projects//locations//agents//flows//versions/`. * } */ public function __construct($data = NULL) { @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] - * to delete. Format: `projects//locations//agents//flows//versions/`. + * to delete. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,8 +73,8 @@ public function getName() /** * Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] - * to delete. Format: `projects//locations//agents//flows//versions/`. + * to delete. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeleteWebhookRequest.php b/DialogflowCx/src/V3/DeleteWebhookRequest.php index 2c6616c283e5..df7ac21131f8 100644 --- a/DialogflowCx/src/V3/DeleteWebhookRequest.php +++ b/DialogflowCx/src/V3/DeleteWebhookRequest.php @@ -18,8 +18,8 @@ class DeleteWebhookRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the webhook to delete. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -41,8 +41,8 @@ class DeleteWebhookRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the webhook to delete. - * Format: `projects//locations//agents//webhooks/`. Please see + * Format: + * `projects//locations//agents//webhooks/`. Please see * {@see WebhooksClient::webhookName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\DeleteWebhookRequest @@ -63,8 +63,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the webhook to delete. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * @type bool $force * This field has no effect for webhook not being used. * For webhooks that are used by pages/flows/transition route groups: @@ -84,8 +84,8 @@ public function __construct($data = NULL) { /** * Required. The name of the webhook to delete. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -97,8 +97,8 @@ public function getName() /** * Required. The name of the webhook to delete. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeployFlowRequest.php b/DialogflowCx/src/V3/DeployFlowRequest.php index f7828bee1212..f9da9bee827c 100644 --- a/DialogflowCx/src/V3/DeployFlowRequest.php +++ b/DialogflowCx/src/V3/DeployFlowRequest.php @@ -18,16 +18,16 @@ class DeployFlowRequest extends \Google\Protobuf\Internal\Message { /** * Required. The environment to deploy the flow to. - * Format: `projects//locations//agents// - * environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $environment = ''; /** * Required. The flow version to deploy. - * Format: `projects//locations//agents// - * flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string flow_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -41,12 +41,12 @@ class DeployFlowRequest extends \Google\Protobuf\Internal\Message * * @type string $environment * Required. The environment to deploy the flow to. - * Format: `projects//locations//agents// - * environments/`. + * Format: + * `projects//locations//agents//environments/`. * @type string $flow_version * Required. The flow version to deploy. - * Format: `projects//locations//agents// - * flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * } */ public function __construct($data = NULL) { @@ -56,8 +56,8 @@ public function __construct($data = NULL) { /** * Required. The environment to deploy the flow to. - * Format: `projects//locations//agents// - * environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -69,8 +69,8 @@ public function getEnvironment() /** * Required. The environment to deploy the flow to. - * Format: `projects//locations//agents// - * environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -86,8 +86,8 @@ public function setEnvironment($var) /** * Required. The flow version to deploy. - * Format: `projects//locations//agents// - * flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string flow_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -99,8 +99,8 @@ public function getFlowVersion() /** * Required. The flow version to deploy. - * Format: `projects//locations//agents// - * flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string flow_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DeployFlowResponse.php b/DialogflowCx/src/V3/DeployFlowResponse.php index e49e4d591003..c95cb3d350e8 100644 --- a/DialogflowCx/src/V3/DeployFlowResponse.php +++ b/DialogflowCx/src/V3/DeployFlowResponse.php @@ -25,8 +25,7 @@ class DeployFlowResponse extends \Google\Protobuf\Internal\Message /** * The name of the flow version * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents// - * environments//deployments/`. + * `projects//locations//agents//environments//deployments/`. * * Generated from protobuf field string deployment = 2; */ @@ -43,8 +42,7 @@ class DeployFlowResponse extends \Google\Protobuf\Internal\Message * @type string $deployment * The name of the flow version * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents// - * environments//deployments/`. + * `projects//locations//agents//environments//deployments/`. * } */ public function __construct($data = NULL) { @@ -91,8 +89,7 @@ public function setEnvironment($var) /** * The name of the flow version * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents// - * environments//deployments/`. + * `projects//locations//agents//environments//deployments/`. * * Generated from protobuf field string deployment = 2; * @return string @@ -105,8 +102,7 @@ public function getDeployment() /** * The name of the flow version * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents// - * environments//deployments/`. + * `projects//locations//agents//environments//deployments/`. * * Generated from protobuf field string deployment = 2; * @param string $var diff --git a/DialogflowCx/src/V3/Deployment.php b/DialogflowCx/src/V3/Deployment.php index 0aaf5de05157..860efcd56c61 100644 --- a/DialogflowCx/src/V3/Deployment.php +++ b/DialogflowCx/src/V3/Deployment.php @@ -20,16 +20,16 @@ class Deployment extends \Google\Protobuf\Internal\Message { /** * The name of the deployment. - * Format: projects//locations//agents//environments//deployments/. + * Format: + * projects//locations//agents//environments//deployments/. * * Generated from protobuf field string name = 1; */ protected $name = ''; /** * The name of the flow version for this deployment. - * Format: projects//locations//agents//flows//versions/. + * Format: + * projects//locations//agents//flows//versions/. * * Generated from protobuf field string flow_version = 2 [(.google.api.resource_reference) = { */ @@ -67,12 +67,12 @@ class Deployment extends \Google\Protobuf\Internal\Message * * @type string $name * The name of the deployment. - * Format: projects//locations//agents//environments//deployments/. + * Format: + * projects//locations//agents//environments//deployments/. * @type string $flow_version * The name of the flow version for this deployment. - * Format: projects//locations//agents//flows//versions/. + * Format: + * projects//locations//agents//flows//versions/. * @type int $state * The current state of the deployment. * @type \Google\Cloud\Dialogflow\Cx\V3\Deployment\Result $result @@ -90,8 +90,8 @@ public function __construct($data = NULL) { /** * The name of the deployment. - * Format: projects//locations//agents//environments//deployments/. + * Format: + * projects//locations//agents//environments//deployments/. * * Generated from protobuf field string name = 1; * @return string @@ -103,8 +103,8 @@ public function getName() /** * The name of the deployment. - * Format: projects//locations//agents//environments//deployments/. + * Format: + * projects//locations//agents//environments//deployments/. * * Generated from protobuf field string name = 1; * @param string $var @@ -120,8 +120,8 @@ public function setName($var) /** * The name of the flow version for this deployment. - * Format: projects//locations//agents//flows//versions/. + * Format: + * projects//locations//agents//flows//versions/. * * Generated from protobuf field string flow_version = 2 [(.google.api.resource_reference) = { * @return string @@ -133,8 +133,8 @@ public function getFlowVersion() /** * The name of the flow version for this deployment. - * Format: projects//locations//agents//flows//versions/. + * Format: + * projects//locations//agents//flows//versions/. * * Generated from protobuf field string flow_version = 2 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/Deployment/Result.php b/DialogflowCx/src/V3/Deployment/Result.php index 42dcc0925bff..62439e19d304 100644 --- a/DialogflowCx/src/V3/Deployment/Result.php +++ b/DialogflowCx/src/V3/Deployment/Result.php @@ -17,16 +17,16 @@ class Result extends \Google\Protobuf\Internal\Message { /** * Results of test cases running before the deployment. - * Format: `projects//locations//agents//testCases//results/`. + * Format: + * `projects//locations//agents//testCases//results/`. * * Generated from protobuf field repeated string deployment_test_results = 1 [(.google.api.resource_reference) = { */ private $deployment_test_results; /** * The name of the experiment triggered by this deployment. - * Format: projects//locations//agents//environments//experiments/. + * Format: + * projects//locations//agents//environments//experiments/. * * Generated from protobuf field string experiment = 2 [(.google.api.resource_reference) = { */ @@ -40,12 +40,12 @@ class Result extends \Google\Protobuf\Internal\Message * * @type array|\Google\Protobuf\Internal\RepeatedField $deployment_test_results * Results of test cases running before the deployment. - * Format: `projects//locations//agents//testCases//results/`. + * Format: + * `projects//locations//agents//testCases//results/`. * @type string $experiment * The name of the experiment triggered by this deployment. - * Format: projects//locations//agents//environments//experiments/. + * Format: + * projects//locations//agents//environments//experiments/. * } */ public function __construct($data = NULL) { @@ -55,8 +55,8 @@ public function __construct($data = NULL) { /** * Results of test cases running before the deployment. - * Format: `projects//locations//agents//testCases//results/`. + * Format: + * `projects//locations//agents//testCases//results/`. * * Generated from protobuf field repeated string deployment_test_results = 1 [(.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -68,8 +68,8 @@ public function getDeploymentTestResults() /** * Results of test cases running before the deployment. - * Format: `projects//locations//agents//testCases//results/`. + * Format: + * `projects//locations//agents//testCases//results/`. * * Generated from protobuf field repeated string deployment_test_results = 1 [(.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var @@ -85,8 +85,8 @@ public function setDeploymentTestResults($var) /** * The name of the experiment triggered by this deployment. - * Format: projects//locations//agents//environments//experiments/. + * Format: + * projects//locations//agents//environments//experiments/. * * Generated from protobuf field string experiment = 2 [(.google.api.resource_reference) = { * @return string @@ -98,8 +98,8 @@ public function getExperiment() /** * The name of the experiment triggered by this deployment. - * Format: projects//locations//agents//environments//experiments/. + * Format: + * projects//locations//agents//environments//experiments/. * * Generated from protobuf field string experiment = 2 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/DetectIntentRequest.php b/DialogflowCx/src/V3/DetectIntentRequest.php index 156e9281112d..315fa48ec970 100644 --- a/DialogflowCx/src/V3/DetectIntentRequest.php +++ b/DialogflowCx/src/V3/DetectIntentRequest.php @@ -17,9 +17,10 @@ class DetectIntentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be @@ -61,9 +62,10 @@ class DetectIntentRequest extends \Google\Protobuf\Internal\Message * * @type string $session * Required. The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be @@ -89,9 +91,10 @@ public function __construct($data = NULL) { /** * Required. The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be @@ -113,9 +116,10 @@ public function getSession() /** * Required. The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be diff --git a/DialogflowCx/src/V3/EntityType.php b/DialogflowCx/src/V3/EntityType.php index f99d1e426b82..1bd168f35fcc 100644 --- a/DialogflowCx/src/V3/EntityType.php +++ b/DialogflowCx/src/V3/EntityType.php @@ -41,8 +41,8 @@ class EntityType extends \Google\Protobuf\Internal\Message * The unique identifier of the entity type. * Required for * [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType]. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1; */ @@ -107,8 +107,8 @@ class EntityType extends \Google\Protobuf\Internal\Message * The unique identifier of the entity type. * Required for * [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType]. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * @type string $display_name * Required. The human-readable name of the entity type, unique within the * agent. @@ -141,8 +141,8 @@ public function __construct($data = NULL) { * The unique identifier of the entity type. * Required for * [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType]. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1; * @return string @@ -156,8 +156,8 @@ public function getName() * The unique identifier of the entity type. * Required for * [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType]. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1; * @param string $var diff --git a/DialogflowCx/src/V3/Environment.php b/DialogflowCx/src/V3/Environment.php index 433ee0fd6f1e..3674b1ac6cbd 100644 --- a/DialogflowCx/src/V3/Environment.php +++ b/DialogflowCx/src/V3/Environment.php @@ -24,8 +24,8 @@ class Environment extends \Google\Protobuf\Internal\Message { /** * The name of the environment. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1; */ @@ -80,8 +80,8 @@ class Environment extends \Google\Protobuf\Internal\Message * * @type string $name * The name of the environment. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * @type string $display_name * Required. The human-readable name of the environment (unique in an agent). * Limit of 64 characters. @@ -108,8 +108,8 @@ public function __construct($data = NULL) { /** * The name of the environment. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1; * @return string @@ -121,8 +121,8 @@ public function getName() /** * The name of the environment. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1; * @param string $var diff --git a/DialogflowCx/src/V3/Environment/TestCasesConfig.php b/DialogflowCx/src/V3/Environment/TestCasesConfig.php index 035ef87264c8..1c52a03926e4 100644 --- a/DialogflowCx/src/V3/Environment/TestCasesConfig.php +++ b/DialogflowCx/src/V3/Environment/TestCasesConfig.php @@ -17,8 +17,8 @@ class TestCasesConfig extends \Google\Protobuf\Internal\Message { /** * A list of test case names to run. They should be under the same agent. - * Format of each test case name: `projects//locations/ - * /agents//testCases/` + * Format of each test case name: + * `projects//locations//agents//testCases/` * * Generated from protobuf field repeated string test_cases = 1 [(.google.api.resource_reference) = { */ @@ -48,8 +48,8 @@ class TestCasesConfig extends \Google\Protobuf\Internal\Message * * @type array|\Google\Protobuf\Internal\RepeatedField $test_cases * A list of test case names to run. They should be under the same agent. - * Format of each test case name: `projects//locations/ - * /agents//testCases/` + * Format of each test case name: + * `projects//locations//agents//testCases/` * @type bool $enable_continuous_run * Whether to run test cases in * [TestCasesConfig.test_cases][google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig.test_cases] @@ -67,8 +67,8 @@ public function __construct($data = NULL) { /** * A list of test case names to run. They should be under the same agent. - * Format of each test case name: `projects//locations/ - * /agents//testCases/` + * Format of each test case name: + * `projects//locations//agents//testCases/` * * Generated from protobuf field repeated string test_cases = 1 [(.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -80,8 +80,8 @@ public function getTestCases() /** * A list of test case names to run. They should be under the same agent. - * Format of each test case name: `projects//locations/ - * /agents//testCases/` + * Format of each test case name: + * `projects//locations//agents//testCases/` * * Generated from protobuf field repeated string test_cases = 1 [(.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/Environment/VersionConfig.php b/DialogflowCx/src/V3/Environment/VersionConfig.php index b0627d616560..e0000ec78bc0 100644 --- a/DialogflowCx/src/V3/Environment/VersionConfig.php +++ b/DialogflowCx/src/V3/Environment/VersionConfig.php @@ -16,8 +16,11 @@ class VersionConfig extends \Google\Protobuf\Internal\Message { /** - * Required. Format: projects//locations//agents//flows//versions/. + * Required. Both flow and playbook versions are supported. + * Format for flow version: + * projects//locations//agents//flows//versions/. + * Format for playbook version: + * projects//locations//agents//playbooks//versions/. * * Generated from protobuf field string version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -30,8 +33,11 @@ class VersionConfig extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $version - * Required. Format: projects//locations//agents//flows//versions/. + * Required. Both flow and playbook versions are supported. + * Format for flow version: + * projects//locations//agents//flows//versions/. + * Format for playbook version: + * projects//locations//agents//playbooks//versions/. * } */ public function __construct($data = NULL) { @@ -40,8 +46,11 @@ public function __construct($data = NULL) { } /** - * Required. Format: projects//locations//agents//flows//versions/. + * Required. Both flow and playbook versions are supported. + * Format for flow version: + * projects//locations//agents//flows//versions/. + * Format for playbook version: + * projects//locations//agents//playbooks//versions/. * * Generated from protobuf field string version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -52,8 +61,11 @@ public function getVersion() } /** - * Required. Format: projects//locations//agents//flows//versions/. + * Required. Both flow and playbook versions are supported. + * Format for flow version: + * projects//locations//agents//flows//versions/. + * Format for playbook version: + * projects//locations//agents//playbooks//versions/. * * Generated from protobuf field string version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/EventHandler.php b/DialogflowCx/src/V3/EventHandler.php index d15e2832532e..32c60215e66b 100644 --- a/DialogflowCx/src/V3/EventHandler.php +++ b/DialogflowCx/src/V3/EventHandler.php @@ -69,12 +69,12 @@ class EventHandler extends \Google\Protobuf\Internal\Message * handler handling webhooks. * @type string $target_page * The target page to transition to. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * @type string $target_flow * The target flow to transition to. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * } */ public function __construct($data = NULL) { @@ -178,8 +178,8 @@ public function setTriggerFulfillment($var) /** * The target page to transition to. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string target_page = 2 [(.google.api.resource_reference) = { * @return string @@ -196,8 +196,8 @@ public function hasTargetPage() /** * The target page to transition to. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string target_page = 2 [(.google.api.resource_reference) = { * @param string $var @@ -213,8 +213,8 @@ public function setTargetPage($var) /** * The target flow to transition to. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string target_flow = 3 [(.google.api.resource_reference) = { * @return string @@ -231,8 +231,8 @@ public function hasTargetFlow() /** * The target flow to transition to. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string target_flow = 3 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/Experiment.php b/DialogflowCx/src/V3/Experiment.php index 9cb98c31f53c..84ed495da596 100644 --- a/DialogflowCx/src/V3/Experiment.php +++ b/DialogflowCx/src/V3/Experiment.php @@ -17,8 +17,8 @@ class Experiment extends \Google\Protobuf\Internal\Message { /** * The name of the experiment. - * Format: projects//locations//agents//environments//experiments/.. + * Format: + * projects//locations//agents//environments//experiments/. * * Generated from protobuf field string name = 1; */ @@ -127,8 +127,8 @@ class Experiment extends \Google\Protobuf\Internal\Message * * @type string $name * The name of the experiment. - * Format: projects//locations//agents//environments//experiments/.. + * Format: + * projects//locations//agents//environments//experiments/. * @type string $display_name * Required. The human-readable name of the experiment (unique in an * environment). Limit of 64 characters. @@ -177,8 +177,8 @@ public function __construct($data = NULL) { /** * The name of the experiment. - * Format: projects//locations//agents//environments//experiments/.. + * Format: + * projects//locations//agents//environments//experiments/. * * Generated from protobuf field string name = 1; * @return string @@ -190,8 +190,8 @@ public function getName() /** * The name of the experiment. - * Format: projects//locations//agents//environments//experiments/.. + * Format: + * projects//locations//agents//environments//experiments/. * * Generated from protobuf field string name = 1; * @param string $var diff --git a/DialogflowCx/src/V3/Experiment/Result/VersionMetrics.php b/DialogflowCx/src/V3/Experiment/Result/VersionMetrics.php index 8973c525fff9..143f2023e661 100644 --- a/DialogflowCx/src/V3/Experiment/Result/VersionMetrics.php +++ b/DialogflowCx/src/V3/Experiment/Result/VersionMetrics.php @@ -17,8 +17,8 @@ class VersionMetrics extends \Google\Protobuf\Internal\Message { /** * The name of the flow [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string version = 1 [(.google.api.resource_reference) = { */ @@ -45,8 +45,8 @@ class VersionMetrics extends \Google\Protobuf\Internal\Message * * @type string $version * The name of the flow [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * @type array<\Google\Cloud\Dialogflow\Cx\V3\Experiment\Result\Metric>|\Google\Protobuf\Internal\RepeatedField $metrics * The metrics and corresponding confidence intervals in the inference * result. @@ -61,8 +61,8 @@ public function __construct($data = NULL) { /** * The name of the flow [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string version = 1 [(.google.api.resource_reference) = { * @return string @@ -74,8 +74,8 @@ public function getVersion() /** * The name of the flow [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string version = 1 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ExportAgentRequest.php b/DialogflowCx/src/V3/ExportAgentRequest.php index b2041dd0f619..fbeb8f65dc9b 100644 --- a/DialogflowCx/src/V3/ExportAgentRequest.php +++ b/DialogflowCx/src/V3/ExportAgentRequest.php @@ -18,7 +18,7 @@ class ExportAgentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the agent to export. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -46,8 +46,8 @@ class ExportAgentRequest extends \Google\Protobuf\Internal\Message protected $data_format = 0; /** * Optional. Environment name. If not set, draft environment is assumed. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ @@ -73,7 +73,7 @@ class ExportAgentRequest extends \Google\Protobuf\Internal\Message * * @type string $name * Required. The name of the agent to export. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $agent_uri * Optional. The [Google Cloud * Storage](https://cloud.google.com/storage/docs/) URI to export the agent @@ -89,8 +89,8 @@ class ExportAgentRequest extends \Google\Protobuf\Internal\Message * is assumed. * @type string $environment * Optional. Environment name. If not set, draft environment is assumed. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * @type \Google\Cloud\Dialogflow\Cx\V3\ExportAgentRequest\GitDestination $git_destination * Optional. The Git branch to export the agent to. * @type bool $include_bigquery_export_settings @@ -104,7 +104,7 @@ public function __construct($data = NULL) { /** * Required. The name of the agent to export. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -116,7 +116,7 @@ public function getName() /** * Required. The name of the agent to export. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -202,8 +202,8 @@ public function setDataFormat($var) /** * Optional. Environment name. If not set, draft environment is assumed. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string @@ -215,8 +215,8 @@ public function getEnvironment() /** * Optional. Environment name. If not set, draft environment is assumed. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ExportEntityTypesRequest.php b/DialogflowCx/src/V3/ExportEntityTypesRequest.php index 7e1c517a2be0..abd0830d226c 100644 --- a/DialogflowCx/src/V3/ExportEntityTypesRequest.php +++ b/DialogflowCx/src/V3/ExportEntityTypesRequest.php @@ -18,16 +18,15 @@ class ExportEntityTypesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the parent agent to export entity types. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Required. The name of the entity types to export. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field repeated string entity_types = 2 [(.google.api.field_behavior) = REQUIRED]; */ @@ -64,12 +63,11 @@ class ExportEntityTypesRequest extends \Google\Protobuf\Internal\Message * * @type string $parent * Required. The name of the parent agent to export entity types. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type array|\Google\Protobuf\Internal\RepeatedField $entity_types * Required. The name of the entity types to export. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * @type string $entity_types_uri * Optional. The [Google Cloud * Storage](https://cloud.google.com/storage/docs/) URI to export the entity @@ -105,8 +103,7 @@ public function __construct($data = NULL) { /** * Required. The name of the parent agent to export entity types. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -118,8 +115,7 @@ public function getParent() /** * Required. The name of the parent agent to export entity types. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -135,8 +131,8 @@ public function setParent($var) /** * Required. The name of the entity types to export. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field repeated string entity_types = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\Internal\RepeatedField @@ -148,8 +144,8 @@ public function getEntityTypes() /** * Required. The name of the entity types to export. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field repeated string entity_types = 2 [(.google.api.field_behavior) = REQUIRED]; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/ExportFlowRequest.php b/DialogflowCx/src/V3/ExportFlowRequest.php index 7078ba86db52..52a18b27dc1e 100644 --- a/DialogflowCx/src/V3/ExportFlowRequest.php +++ b/DialogflowCx/src/V3/ExportFlowRequest.php @@ -18,8 +18,8 @@ class ExportFlowRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the flow to export. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -53,8 +53,8 @@ class ExportFlowRequest extends \Google\Protobuf\Internal\Message * * @type string $name * Required. The name of the flow to export. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * @type string $flow_uri * Optional. The [Google Cloud * Storage](https://cloud.google.com/storage/docs/) URI to export the flow to. @@ -76,8 +76,8 @@ public function __construct($data = NULL) { /** * Required. The name of the flow to export. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -89,8 +89,8 @@ public function getName() /** * Required. The name of the flow to export. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ExportIntentsRequest.php b/DialogflowCx/src/V3/ExportIntentsRequest.php index d73a911102a5..4b9f7ca27d1a 100644 --- a/DialogflowCx/src/V3/ExportIntentsRequest.php +++ b/DialogflowCx/src/V3/ExportIntentsRequest.php @@ -18,16 +18,15 @@ class ExportIntentsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the parent agent to export intents. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Required. The name of the intents to export. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field repeated string intents = 2 [(.google.api.field_behavior) = REQUIRED]; */ @@ -49,12 +48,11 @@ class ExportIntentsRequest extends \Google\Protobuf\Internal\Message * * @type string $parent * Required. The name of the parent agent to export intents. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type array|\Google\Protobuf\Internal\RepeatedField $intents * Required. The name of the intents to export. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * @type string $intents_uri * Optional. The [Google Cloud * Storage](https://cloud.google.com/storage/docs/) URI to export the @@ -79,8 +77,7 @@ public function __construct($data = NULL) { /** * Required. The name of the parent agent to export intents. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -92,8 +89,7 @@ public function getParent() /** * Required. The name of the parent agent to export intents. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -109,8 +105,8 @@ public function setParent($var) /** * Required. The name of the intents to export. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field repeated string intents = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\Internal\RepeatedField @@ -122,8 +118,8 @@ public function getIntents() /** * Required. The name of the intents to export. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field repeated string intents = 2 [(.google.api.field_behavior) = REQUIRED]; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/ExportTestCasesRequest.php b/DialogflowCx/src/V3/ExportTestCasesRequest.php index 4d94d37ffdd8..00969237f19d 100644 --- a/DialogflowCx/src/V3/ExportTestCasesRequest.php +++ b/DialogflowCx/src/V3/ExportTestCasesRequest.php @@ -18,7 +18,7 @@ class ExportTestCasesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent where to export test cases from. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -52,7 +52,7 @@ class ExportTestCasesRequest extends \Google\Protobuf\Internal\Message * * @type string $parent * Required. The agent where to export test cases from. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $gcs_uri * The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to * export the test cases to. The format of this URI must be @@ -83,7 +83,7 @@ public function __construct($data = NULL) { /** * Required. The agent where to export test cases from. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -95,7 +95,7 @@ public function getParent() /** * Required. The agent where to export test cases from. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ExportTestCasesResponse.php b/DialogflowCx/src/V3/ExportTestCasesResponse.php index 6247b21ef71f..5fbeeedaea5e 100644 --- a/DialogflowCx/src/V3/ExportTestCasesResponse.php +++ b/DialogflowCx/src/V3/ExportTestCasesResponse.php @@ -26,7 +26,7 @@ class ExportTestCasesResponse extends \Google\Protobuf\Internal\Message * * @type string $gcs_uri * The URI to a file containing the exported test cases. This field is - * populated only if `gcs_uri` is specified in + * populated only if `gcs_uri` is specified in * [ExportTestCasesRequest][google.cloud.dialogflow.cx.v3.ExportTestCasesRequest]. * @type string $content * Uncompressed raw byte content for test cases. @@ -39,7 +39,7 @@ public function __construct($data = NULL) { /** * The URI to a file containing the exported test cases. This field is - * populated only if `gcs_uri` is specified in + * populated only if `gcs_uri` is specified in * [ExportTestCasesRequest][google.cloud.dialogflow.cx.v3.ExportTestCasesRequest]. * * Generated from protobuf field string gcs_uri = 1; @@ -57,7 +57,7 @@ public function hasGcsUri() /** * The URI to a file containing the exported test cases. This field is - * populated only if `gcs_uri` is specified in + * populated only if `gcs_uri` is specified in * [ExportTestCasesRequest][google.cloud.dialogflow.cx.v3.ExportTestCasesRequest]. * * Generated from protobuf field string gcs_uri = 1; diff --git a/DialogflowCx/src/V3/Flow.php b/DialogflowCx/src/V3/Flow.php index 64f35ad728b9..e6ae0447ab09 100644 --- a/DialogflowCx/src/V3/Flow.php +++ b/DialogflowCx/src/V3/Flow.php @@ -28,8 +28,8 @@ class Flow extends \Google\Protobuf\Internal\Message { /** * The unique identifier of the flow. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1; */ @@ -87,11 +87,11 @@ class Flow extends \Google\Protobuf\Internal\Message * * They are inherited by every page's [transition * route groups][Page.transition_route_groups]. Transition route groups * defined in the page have higher priority than those defined in the flow. - * Format:`projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/` for agent-level - * groups. + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/` + * for agent-level groups. * * Generated from protobuf field repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { */ @@ -137,8 +137,8 @@ class Flow extends \Google\Protobuf\Internal\Message * * @type string $name * The unique identifier of the flow. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * @type string $display_name * Required. The human-readable name of the flow. * @type string $description @@ -176,11 +176,11 @@ class Flow extends \Google\Protobuf\Internal\Message * * They are inherited by every page's [transition * route groups][Page.transition_route_groups]. Transition route groups * defined in the page have higher priority than those defined in the flow. - * Format:`projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/` for agent-level - * groups. + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/` + * for agent-level groups. * @type \Google\Cloud\Dialogflow\Cx\V3\NluSettings $nlu_settings * NLU related settings of the flow. * @type \Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings $advanced_settings @@ -202,8 +202,8 @@ public function __construct($data = NULL) { /** * The unique identifier of the flow. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1; * @return string @@ -215,8 +215,8 @@ public function getName() /** * The unique identifier of the flow. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1; * @param string $var @@ -385,11 +385,11 @@ public function setEventHandlers($var) * * They are inherited by every page's [transition * route groups][Page.transition_route_groups]. Transition route groups * defined in the page have higher priority than those defined in the flow. - * Format:`projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/` for agent-level - * groups. + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/` + * for agent-level groups. * * Generated from protobuf field repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -406,11 +406,11 @@ public function getTransitionRouteGroups() * * They are inherited by every page's [transition * route groups][Page.transition_route_groups]. Transition route groups * defined in the page have higher priority than those defined in the flow. - * Format:`projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/` for agent-level - * groups. + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/` + * for agent-level groups. * * Generated from protobuf field repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/FlowValidationResult.php b/DialogflowCx/src/V3/FlowValidationResult.php index e09b98e2d7c4..63ce87551bc0 100644 --- a/DialogflowCx/src/V3/FlowValidationResult.php +++ b/DialogflowCx/src/V3/FlowValidationResult.php @@ -18,8 +18,8 @@ class FlowValidationResult extends \Google\Protobuf\Internal\Message { /** * The unique identifier of the flow validation result. - * Format: `projects//locations//agents//flows//validationResult`. + * Format: + * `projects//locations//agents//flows//validationResult`. * * Generated from protobuf field string name = 1; */ @@ -45,8 +45,8 @@ class FlowValidationResult extends \Google\Protobuf\Internal\Message * * @type string $name * The unique identifier of the flow validation result. - * Format: `projects//locations//agents//flows//validationResult`. + * Format: + * `projects//locations//agents//flows//validationResult`. * @type array<\Google\Cloud\Dialogflow\Cx\V3\ValidationMessage>|\Google\Protobuf\Internal\RepeatedField $validation_messages * Contains all validation messages. * @type \Google\Protobuf\Timestamp $update_time @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * The unique identifier of the flow validation result. - * Format: `projects//locations//agents//flows//validationResult`. + * Format: + * `projects//locations//agents//flows//validationResult`. * * Generated from protobuf field string name = 1; * @return string @@ -73,8 +73,8 @@ public function getName() /** * The unique identifier of the flow validation result. - * Format: `projects//locations//agents//flows//validationResult`. + * Format: + * `projects//locations//agents//flows//validationResult`. * * Generated from protobuf field string name = 1; * @param string $var diff --git a/DialogflowCx/src/V3/Form/Parameter.php b/DialogflowCx/src/V3/Form/Parameter.php index d327e14bf300..5b82c874ea68 100644 --- a/DialogflowCx/src/V3/Form/Parameter.php +++ b/DialogflowCx/src/V3/Form/Parameter.php @@ -32,11 +32,12 @@ class Parameter extends \Google\Protobuf\Internal\Message protected $required = false; /** * Required. The entity type of the parameter. - * Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, + * Format: + * `projects/-/locations/-/agents/-/entityTypes/` for + * system entity types (for example, * `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - * `projects//locations//agents//entityTypes/` for developer entity types. + * `projects//locations//agents//entityTypes/` + * for developer entity types. * * Generated from protobuf field string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -94,11 +95,12 @@ class Parameter extends \Google\Protobuf\Internal\Message * Required parameters must be filled before form filling concludes. * @type string $entity_type * Required. The entity type of the parameter. - * Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, + * Format: + * `projects/-/locations/-/agents/-/entityTypes/` for + * system entity types (for example, * `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - * `projects//locations//agents//entityTypes/` for developer entity types. + * `projects//locations//agents//entityTypes/` + * for developer entity types. * @type bool $is_list * Indicates whether the parameter represents a list of values. * @type \Google\Cloud\Dialogflow\Cx\V3\Form\Parameter\FillBehavior $fill_behavior @@ -183,11 +185,12 @@ public function setRequired($var) /** * Required. The entity type of the parameter. - * Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, + * Format: + * `projects/-/locations/-/agents/-/entityTypes/` for + * system entity types (for example, * `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - * `projects//locations//agents//entityTypes/` for developer entity types. + * `projects//locations//agents//entityTypes/` + * for developer entity types. * * Generated from protobuf field string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -199,11 +202,12 @@ public function getEntityType() /** * Required. The entity type of the parameter. - * Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, + * Format: + * `projects/-/locations/-/agents/-/entityTypes/` for + * system entity types (for example, * `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - * `projects//locations//agents//entityTypes/` for developer entity types. + * `projects//locations//agents//entityTypes/` + * for developer entity types. * * Generated from protobuf field string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/Fulfillment.php b/DialogflowCx/src/V3/Fulfillment.php index a8232743076a..93f5318766ad 100644 --- a/DialogflowCx/src/V3/Fulfillment.php +++ b/DialogflowCx/src/V3/Fulfillment.php @@ -35,8 +35,8 @@ class Fulfillment extends \Google\Protobuf\Internal\Message private $messages; /** * The webhook to call. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string webhook = 2 [(.google.api.resource_reference) = { */ @@ -107,8 +107,8 @@ class Fulfillment extends \Google\Protobuf\Internal\Message * The list of rich message responses to present to the user. * @type string $webhook * The webhook to call. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * @type bool $return_partial_responses * Whether Dialogflow should return currently queued fulfillment response * messages in streaming APIs. If a webhook is specified, it happens before @@ -175,8 +175,8 @@ public function setMessages($var) /** * The webhook to call. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string webhook = 2 [(.google.api.resource_reference) = { * @return string @@ -188,8 +188,8 @@ public function getWebhook() /** * The webhook to call. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string webhook = 2 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GenerativeSettings.php b/DialogflowCx/src/V3/GenerativeSettings.php index 42f34da2a054..bfb64503e0b8 100644 --- a/DialogflowCx/src/V3/GenerativeSettings.php +++ b/DialogflowCx/src/V3/GenerativeSettings.php @@ -16,8 +16,8 @@ class GenerativeSettings extends \Google\Protobuf\Internal\Message { /** - * Format: `projects//locations//agents//generativeSettings`. + * Format: + * `projects//locations//agents//generativeSettings`. * * Generated from protobuf field string name = 5; */ @@ -54,8 +54,8 @@ class GenerativeSettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Format: `projects//locations//agents//generativeSettings`. + * Format: + * `projects//locations//agents//generativeSettings`. * @type \Google\Cloud\Dialogflow\Cx\V3\GenerativeSettings\FallbackSettings $fallback_settings * Settings for Generative Fallback. * @type \Google\Cloud\Dialogflow\Cx\V3\SafetySettings $generative_safety_settings @@ -72,8 +72,8 @@ public function __construct($data = NULL) { } /** - * Format: `projects//locations//agents//generativeSettings`. + * Format: + * `projects//locations//agents//generativeSettings`. * * Generated from protobuf field string name = 5; * @return string @@ -84,8 +84,8 @@ public function getName() } /** - * Format: `projects//locations//agents//generativeSettings`. + * Format: + * `projects//locations//agents//generativeSettings`. * * Generated from protobuf field string name = 5; * @param string $var diff --git a/DialogflowCx/src/V3/Generator.php b/DialogflowCx/src/V3/Generator.php index ecfa207613e0..7068ad70c839 100644 --- a/DialogflowCx/src/V3/Generator.php +++ b/DialogflowCx/src/V3/Generator.php @@ -23,8 +23,8 @@ class Generator extends \Google\Protobuf\Internal\Message * Must be set for the * [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] * method. [Generators.CreateGenerate][] populates the name automatically. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1; */ @@ -50,6 +50,12 @@ class Generator extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $placeholders; + /** + * Parameters passed to the LLM to configure its behavior. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8; + */ + protected $model_parameter = null; /** * Constructor. @@ -62,8 +68,8 @@ class Generator extends \Google\Protobuf\Internal\Message * Must be set for the * [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] * method. [Generators.CreateGenerate][] populates the name automatically. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * @type string $display_name * Required. The human-readable name of the generator, unique within the * agent. The prompt contains pre-defined parameters such as $conversation, @@ -73,6 +79,8 @@ class Generator extends \Google\Protobuf\Internal\Message * Required. Prompt for the LLM model. * @type array<\Google\Cloud\Dialogflow\Cx\V3\Generator\Placeholder>|\Google\Protobuf\Internal\RepeatedField $placeholders * Optional. List of custom placeholders in the prompt text. + * @type \Google\Cloud\Dialogflow\Cx\V3\Generator\ModelParameter $model_parameter + * Parameters passed to the LLM to configure its behavior. * } */ public function __construct($data = NULL) { @@ -85,8 +93,8 @@ public function __construct($data = NULL) { * Must be set for the * [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] * method. [Generators.CreateGenerate][] populates the name automatically. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1; * @return string @@ -101,8 +109,8 @@ public function getName() * Must be set for the * [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] * method. [Generators.CreateGenerate][] populates the name automatically. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1; * @param string $var @@ -210,5 +218,41 @@ public function setPlaceholders($var) return $this; } + /** + * Parameters passed to the LLM to configure its behavior. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8; + * @return \Google\Cloud\Dialogflow\Cx\V3\Generator\ModelParameter|null + */ + public function getModelParameter() + { + return $this->model_parameter; + } + + public function hasModelParameter() + { + return isset($this->model_parameter); + } + + public function clearModelParameter() + { + unset($this->model_parameter); + } + + /** + * Parameters passed to the LLM to configure its behavior. + * + * Generated from protobuf field .google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8; + * @param \Google\Cloud\Dialogflow\Cx\V3\Generator\ModelParameter $var + * @return $this + */ + public function setModelParameter($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\Generator\ModelParameter::class); + $this->model_parameter = $var; + + return $this; + } + } diff --git a/DialogflowCx/src/V3/Generator/ModelParameter.php b/DialogflowCx/src/V3/Generator/ModelParameter.php new file mode 100644 index 000000000000..72209eab6001 --- /dev/null +++ b/DialogflowCx/src/V3/Generator/ModelParameter.php @@ -0,0 +1,255 @@ +google.cloud.dialogflow.cx.v3.Generator.ModelParameter + */ +class ModelParameter extends \Google\Protobuf\Internal\Message +{ + /** + * The temperature used for sampling. Temperature sampling occurs after both + * topP and topK have been applied. + * Valid range: [0.0, 1.0] + * Low temperature = less random. High temperature = more random. + * + * Generated from protobuf field optional float temperature = 1; + */ + protected $temperature = null; + /** + * The maximum number of tokens to generate. + * + * Generated from protobuf field optional int32 max_decode_steps = 2; + */ + protected $max_decode_steps = null; + /** + * If set, only the tokens comprising the top top_p probability mass are + * considered. If both top_p and top_k are + * set, top_p will be used for further refining candidates selected with + * top_k. + * Valid range: (0.0, 1.0]. + * Small topP = less random. Large topP = more random. + * + * Generated from protobuf field optional float top_p = 3; + */ + protected $top_p = null; + /** + * If set, the sampling process in each step is limited to the top_k tokens + * with highest probabilities. + * Valid range: [1, 40] or 1000+. + * Small topK = less random. Large topK = more random. + * + * Generated from protobuf field optional int32 top_k = 4; + */ + protected $top_k = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type float $temperature + * The temperature used for sampling. Temperature sampling occurs after both + * topP and topK have been applied. + * Valid range: [0.0, 1.0] + * Low temperature = less random. High temperature = more random. + * @type int $max_decode_steps + * The maximum number of tokens to generate. + * @type float $top_p + * If set, only the tokens comprising the top top_p probability mass are + * considered. If both top_p and top_k are + * set, top_p will be used for further refining candidates selected with + * top_k. + * Valid range: (0.0, 1.0]. + * Small topP = less random. Large topP = more random. + * @type int $top_k + * If set, the sampling process in each step is limited to the top_k tokens + * with highest probabilities. + * Valid range: [1, 40] or 1000+. + * Small topK = less random. Large topK = more random. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dialogflow\Cx\V3\Generator::initOnce(); + parent::__construct($data); + } + + /** + * The temperature used for sampling. Temperature sampling occurs after both + * topP and topK have been applied. + * Valid range: [0.0, 1.0] + * Low temperature = less random. High temperature = more random. + * + * Generated from protobuf field optional float temperature = 1; + * @return float + */ + public function getTemperature() + { + return isset($this->temperature) ? $this->temperature : 0.0; + } + + public function hasTemperature() + { + return isset($this->temperature); + } + + public function clearTemperature() + { + unset($this->temperature); + } + + /** + * The temperature used for sampling. Temperature sampling occurs after both + * topP and topK have been applied. + * Valid range: [0.0, 1.0] + * Low temperature = less random. High temperature = more random. + * + * Generated from protobuf field optional float temperature = 1; + * @param float $var + * @return $this + */ + public function setTemperature($var) + { + GPBUtil::checkFloat($var); + $this->temperature = $var; + + return $this; + } + + /** + * The maximum number of tokens to generate. + * + * Generated from protobuf field optional int32 max_decode_steps = 2; + * @return int + */ + public function getMaxDecodeSteps() + { + return isset($this->max_decode_steps) ? $this->max_decode_steps : 0; + } + + public function hasMaxDecodeSteps() + { + return isset($this->max_decode_steps); + } + + public function clearMaxDecodeSteps() + { + unset($this->max_decode_steps); + } + + /** + * The maximum number of tokens to generate. + * + * Generated from protobuf field optional int32 max_decode_steps = 2; + * @param int $var + * @return $this + */ + public function setMaxDecodeSteps($var) + { + GPBUtil::checkInt32($var); + $this->max_decode_steps = $var; + + return $this; + } + + /** + * If set, only the tokens comprising the top top_p probability mass are + * considered. If both top_p and top_k are + * set, top_p will be used for further refining candidates selected with + * top_k. + * Valid range: (0.0, 1.0]. + * Small topP = less random. Large topP = more random. + * + * Generated from protobuf field optional float top_p = 3; + * @return float + */ + public function getTopP() + { + return isset($this->top_p) ? $this->top_p : 0.0; + } + + public function hasTopP() + { + return isset($this->top_p); + } + + public function clearTopP() + { + unset($this->top_p); + } + + /** + * If set, only the tokens comprising the top top_p probability mass are + * considered. If both top_p and top_k are + * set, top_p will be used for further refining candidates selected with + * top_k. + * Valid range: (0.0, 1.0]. + * Small topP = less random. Large topP = more random. + * + * Generated from protobuf field optional float top_p = 3; + * @param float $var + * @return $this + */ + public function setTopP($var) + { + GPBUtil::checkFloat($var); + $this->top_p = $var; + + return $this; + } + + /** + * If set, the sampling process in each step is limited to the top_k tokens + * with highest probabilities. + * Valid range: [1, 40] or 1000+. + * Small topK = less random. Large topK = more random. + * + * Generated from protobuf field optional int32 top_k = 4; + * @return int + */ + public function getTopK() + { + return isset($this->top_k) ? $this->top_k : 0; + } + + public function hasTopK() + { + return isset($this->top_k); + } + + public function clearTopK() + { + unset($this->top_k); + } + + /** + * If set, the sampling process in each step is limited to the top_k tokens + * with highest probabilities. + * Valid range: [1, 40] or 1000+. + * Small topK = less random. Large topK = more random. + * + * Generated from protobuf field optional int32 top_k = 4; + * @param int $var + * @return $this + */ + public function setTopK($var) + { + GPBUtil::checkInt32($var); + $this->top_k = $var; + + return $this; + } + +} + + diff --git a/DialogflowCx/src/V3/GetAgentRequest.php b/DialogflowCx/src/V3/GetAgentRequest.php index 8213fb2f9fdc..66d7b0b06484 100644 --- a/DialogflowCx/src/V3/GetAgentRequest.php +++ b/DialogflowCx/src/V3/GetAgentRequest.php @@ -18,7 +18,7 @@ class GetAgentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the agent. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -26,7 +26,7 @@ class GetAgentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the agent. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see AgentsClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetAgentRequest @@ -47,7 +47,7 @@ public static function build(string $name): self * * @type string $name * Required. The name of the agent. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * } */ public function __construct($data = NULL) { @@ -57,7 +57,7 @@ public function __construct($data = NULL) { /** * Required. The name of the agent. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -69,7 +69,7 @@ public function getName() /** * Required. The name of the agent. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetAgentValidationResultRequest.php b/DialogflowCx/src/V3/GetAgentValidationResultRequest.php index a1a88413ad4d..c77940ba4421 100644 --- a/DialogflowCx/src/V3/GetAgentValidationResultRequest.php +++ b/DialogflowCx/src/V3/GetAgentValidationResultRequest.php @@ -18,8 +18,8 @@ class GetAgentValidationResultRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent name. - * Format: `projects//locations//agents//validationResult`. + * Format: + * `projects//locations//agents//validationResult`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,8 +33,8 @@ class GetAgentValidationResultRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The agent name. - * Format: `projects//locations//agents//validationResult`. Please see + * Format: + * `projects//locations//agents//validationResult`. Please see * {@see AgentsClient::agentValidationResultName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetAgentValidationResultRequest @@ -55,8 +55,8 @@ public static function build(string $name): self * * @type string $name * Required. The agent name. - * Format: `projects//locations//agents//validationResult`. + * Format: + * `projects//locations//agents//validationResult`. * @type string $language_code * If not specified, the agent's default language is used. * } @@ -68,8 +68,8 @@ public function __construct($data = NULL) { /** * Required. The agent name. - * Format: `projects//locations//agents//validationResult`. + * Format: + * `projects//locations//agents//validationResult`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -81,8 +81,8 @@ public function getName() /** * Required. The agent name. - * Format: `projects//locations//agents//validationResult`. + * Format: + * `projects//locations//agents//validationResult`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetChangelogRequest.php b/DialogflowCx/src/V3/GetChangelogRequest.php index 68b74f913fc5..f1224cb4e1f2 100644 --- a/DialogflowCx/src/V3/GetChangelogRequest.php +++ b/DialogflowCx/src/V3/GetChangelogRequest.php @@ -18,8 +18,8 @@ class GetChangelogRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the changelog to get. - * Format: `projects//locations//agents//changelogs/`. + * Format: + * `projects//locations//agents//changelogs/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -27,8 +27,8 @@ class GetChangelogRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the changelog to get. - * Format: `projects//locations//agents//changelogs/`. Please see + * Format: + * `projects//locations//agents//changelogs/`. Please see * {@see ChangelogsClient::changelogName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetChangelogRequest @@ -49,8 +49,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the changelog to get. - * Format: `projects//locations//agents//changelogs/`. + * Format: + * `projects//locations//agents//changelogs/`. * } */ public function __construct($data = NULL) { @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * Required. The name of the changelog to get. - * Format: `projects//locations//agents//changelogs/`. + * Format: + * `projects//locations//agents//changelogs/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,8 +73,8 @@ public function getName() /** * Required. The name of the changelog to get. - * Format: `projects//locations//agents//changelogs/`. + * Format: + * `projects//locations//agents//changelogs/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetDeploymentRequest.php b/DialogflowCx/src/V3/GetDeploymentRequest.php index 3afd3af928fe..ce855c20c702 100644 --- a/DialogflowCx/src/V3/GetDeploymentRequest.php +++ b/DialogflowCx/src/V3/GetDeploymentRequest.php @@ -19,8 +19,7 @@ class GetDeploymentRequest extends \Google\Protobuf\Internal\Message /** * Required. The name of the * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents//environments//deployments/`. + * `projects//locations//agents//environments//deployments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -29,8 +28,7 @@ class GetDeploymentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents//environments//deployments/`. Please see + * `projects//locations//agents//environments//deployments/`. Please see * {@see DeploymentsClient::deploymentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetDeploymentRequest @@ -52,8 +50,7 @@ public static function build(string $name): self * @type string $name * Required. The name of the * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents//environments//deployments/`. + * `projects//locations//agents//environments//deployments/`. * } */ public function __construct($data = NULL) { @@ -64,8 +61,7 @@ public function __construct($data = NULL) { /** * Required. The name of the * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents//environments//deployments/`. + * `projects//locations//agents//environments//deployments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -78,8 +74,7 @@ public function getName() /** * Required. The name of the * [Deployment][google.cloud.dialogflow.cx.v3.Deployment]. Format: - * `projects//locations//agents//environments//deployments/`. + * `projects//locations//agents//environments//deployments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetEntityTypeRequest.php b/DialogflowCx/src/V3/GetEntityTypeRequest.php index 8fc4b0595181..7effab8cda78 100644 --- a/DialogflowCx/src/V3/GetEntityTypeRequest.php +++ b/DialogflowCx/src/V3/GetEntityTypeRequest.php @@ -18,8 +18,8 @@ class GetEntityTypeRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the entity type. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -42,8 +42,8 @@ class GetEntityTypeRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the entity type. - * Format: `projects//locations//agents//entityTypes/`. Please see + * Format: + * `projects//locations//agents//entityTypes/`. Please see * {@see EntityTypesClient::entityTypeName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetEntityTypeRequest @@ -64,8 +64,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the entity type. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * @type string $language_code * The language to retrieve the entity type for. The following fields are * language dependent: @@ -86,8 +86,8 @@ public function __construct($data = NULL) { /** * Required. The name of the entity type. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -99,8 +99,8 @@ public function getName() /** * Required. The name of the entity type. - * Format: `projects//locations//agents//entityTypes/`. + * Format: + * `projects//locations//agents//entityTypes/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetEnvironmentRequest.php b/DialogflowCx/src/V3/GetEnvironmentRequest.php index 88856535e3ce..946c76f070c4 100644 --- a/DialogflowCx/src/V3/GetEnvironmentRequest.php +++ b/DialogflowCx/src/V3/GetEnvironmentRequest.php @@ -19,8 +19,7 @@ class GetEnvironmentRequest extends \Google\Protobuf\Internal\Message /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -29,8 +28,7 @@ class GetEnvironmentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments/`. Please see + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetEnvironmentRequest @@ -52,8 +50,7 @@ public static function build(string $name): self * @type string $name * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * } */ public function __construct($data = NULL) { @@ -64,8 +61,7 @@ public function __construct($data = NULL) { /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -78,8 +74,7 @@ public function getName() /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments/`. + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetExperimentRequest.php b/DialogflowCx/src/V3/GetExperimentRequest.php index bbbb079206d5..a3e27c2aa6d5 100644 --- a/DialogflowCx/src/V3/GetExperimentRequest.php +++ b/DialogflowCx/src/V3/GetExperimentRequest.php @@ -19,8 +19,7 @@ class GetExperimentRequest extends \Google\Protobuf\Internal\Message /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments//experiments/`. + * `projects//locations//agents//environments//experiments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -29,8 +28,7 @@ class GetExperimentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments//experiments/`. Please see + * `projects//locations//agents//environments//experiments/`. Please see * {@see ExperimentsClient::experimentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetExperimentRequest @@ -52,8 +50,7 @@ public static function build(string $name): self * @type string $name * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments//experiments/`. + * `projects//locations//agents//environments//experiments/`. * } */ public function __construct($data = NULL) { @@ -64,8 +61,7 @@ public function __construct($data = NULL) { /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments//experiments/`. + * `projects//locations//agents//environments//experiments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -78,8 +74,7 @@ public function getName() /** * Required. The name of the * [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: - * `projects//locations//agents//environments//experiments/`. + * `projects//locations//agents//environments//experiments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetFlowRequest.php b/DialogflowCx/src/V3/GetFlowRequest.php index 77d0bb69d7e9..6c4411625a6e 100644 --- a/DialogflowCx/src/V3/GetFlowRequest.php +++ b/DialogflowCx/src/V3/GetFlowRequest.php @@ -18,8 +18,8 @@ class GetFlowRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the flow to get. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -43,8 +43,8 @@ class GetFlowRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the flow to get. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see FlowsClient::flowName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetFlowRequest @@ -65,8 +65,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the flow to get. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * @type string $language_code * The language to retrieve the flow for. The following fields are language * dependent: @@ -88,8 +88,8 @@ public function __construct($data = NULL) { /** * Required. The name of the flow to get. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -101,8 +101,8 @@ public function getName() /** * Required. The name of the flow to get. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetFlowValidationResultRequest.php b/DialogflowCx/src/V3/GetFlowValidationResultRequest.php index d34b1f06c807..386b8d583a84 100644 --- a/DialogflowCx/src/V3/GetFlowValidationResultRequest.php +++ b/DialogflowCx/src/V3/GetFlowValidationResultRequest.php @@ -18,8 +18,8 @@ class GetFlowValidationResultRequest extends \Google\Protobuf\Internal\Message { /** * Required. The flow name. - * Format: `projects//locations//agents//flows//validationResult`. + * Format: + * `projects//locations//agents//flows//validationResult`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,8 +33,8 @@ class GetFlowValidationResultRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The flow name. - * Format: `projects//locations//agents//flows//validationResult`. Please see + * Format: + * `projects//locations//agents//flows//validationResult`. Please see * {@see FlowsClient::flowValidationResultName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetFlowValidationResultRequest @@ -55,8 +55,8 @@ public static function build(string $name): self * * @type string $name * Required. The flow name. - * Format: `projects//locations//agents//flows//validationResult`. + * Format: + * `projects//locations//agents//flows//validationResult`. * @type string $language_code * If not specified, the agent's default language is used. * } @@ -68,8 +68,8 @@ public function __construct($data = NULL) { /** * Required. The flow name. - * Format: `projects//locations//agents//flows//validationResult`. + * Format: + * `projects//locations//agents//flows//validationResult`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -81,8 +81,8 @@ public function getName() /** * Required. The flow name. - * Format: `projects//locations//agents//flows//validationResult`. + * Format: + * `projects//locations//agents//flows//validationResult`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetGenerativeSettingsRequest.php b/DialogflowCx/src/V3/GetGenerativeSettingsRequest.php index e60a0c87b341..d48839cc64e2 100644 --- a/DialogflowCx/src/V3/GetGenerativeSettingsRequest.php +++ b/DialogflowCx/src/V3/GetGenerativeSettingsRequest.php @@ -18,8 +18,8 @@ class GetGenerativeSettingsRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Format: `projects//locations//agents//generativeSettings`. + * Required. Format: + * `projects//locations//agents//generativeSettings`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -32,8 +32,8 @@ class GetGenerativeSettingsRequest extends \Google\Protobuf\Internal\Message protected $language_code = ''; /** - * @param string $name Required. Format: `projects//locations//agents//generativeSettings`. Please see + * @param string $name Required. Format: + * `projects//locations//agents//generativeSettings`. Please see * {@see AgentsClient::agentGenerativeSettingsName()} for help formatting this field. * @param string $languageCode Required. Language code of the generative settings. * @@ -55,8 +55,8 @@ public static function build(string $name, string $languageCode): self * Optional. Data for populating the Message object. * * @type string $name - * Required. Format: `projects//locations//agents//generativeSettings`. + * Required. Format: + * `projects//locations//agents//generativeSettings`. * @type string $language_code * Required. Language code of the generative settings. * } @@ -67,8 +67,8 @@ public function __construct($data = NULL) { } /** - * Required. Format: `projects//locations//agents//generativeSettings`. + * Required. Format: + * `projects//locations//agents//generativeSettings`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -79,8 +79,8 @@ public function getName() } /** - * Required. Format: `projects//locations//agents//generativeSettings`. + * Required. Format: + * `projects//locations//agents//generativeSettings`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetGeneratorRequest.php b/DialogflowCx/src/V3/GetGeneratorRequest.php index ec136bd747a9..78213756fbee 100644 --- a/DialogflowCx/src/V3/GetGeneratorRequest.php +++ b/DialogflowCx/src/V3/GetGeneratorRequest.php @@ -18,8 +18,8 @@ class GetGeneratorRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the generator. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,8 +33,8 @@ class GetGeneratorRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the generator. - * Format: `projects//locations//agents//generators/`. Please see + * Format: + * `projects//locations//agents//generators/`. Please see * {@see GeneratorsClient::generatorName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetGeneratorRequest @@ -55,8 +55,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the generator. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * @type string $language_code * The language to list generators for. * } @@ -68,8 +68,8 @@ public function __construct($data = NULL) { /** * Required. The name of the generator. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -81,8 +81,8 @@ public function getName() /** * Required. The name of the generator. - * Format: `projects//locations//agents//generators/`. + * Format: + * `projects//locations//agents//generators/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetIntentRequest.php b/DialogflowCx/src/V3/GetIntentRequest.php index a64a9afec5aa..9a87d6268651 100644 --- a/DialogflowCx/src/V3/GetIntentRequest.php +++ b/DialogflowCx/src/V3/GetIntentRequest.php @@ -18,8 +18,8 @@ class GetIntentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the intent. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -40,8 +40,8 @@ class GetIntentRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the intent. - * Format: `projects//locations//agents//intents/`. Please see + * Format: + * `projects//locations//agents//intents/`. Please see * {@see IntentsClient::intentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetIntentRequest @@ -62,8 +62,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the intent. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * @type string $language_code * The language to retrieve the intent for. The following fields are language * dependent: @@ -82,8 +82,8 @@ public function __construct($data = NULL) { /** * Required. The name of the intent. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -95,8 +95,8 @@ public function getName() /** * Required. The name of the intent. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetPageRequest.php b/DialogflowCx/src/V3/GetPageRequest.php index e62f722da435..d5d22c9a3d98 100644 --- a/DialogflowCx/src/V3/GetPageRequest.php +++ b/DialogflowCx/src/V3/GetPageRequest.php @@ -18,8 +18,8 @@ class GetPageRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the page. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -51,8 +51,8 @@ class GetPageRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the page. - * Format: `projects//locations//agents//flows//pages/`. Please see + * Format: + * `projects//locations//agents//flows//pages/`. Please see * {@see PagesClient::pageName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetPageRequest @@ -73,8 +73,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the page. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * @type string $language_code * The language to retrieve the page for. The following fields are language * dependent: @@ -104,8 +104,8 @@ public function __construct($data = NULL) { /** * Required. The name of the page. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -117,8 +117,8 @@ public function getName() /** * Required. The name of the page. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetSecuritySettingsRequest.php b/DialogflowCx/src/V3/GetSecuritySettingsRequest.php index 0d54c2da7b6d..8c64d8ed1b53 100644 --- a/DialogflowCx/src/V3/GetSecuritySettingsRequest.php +++ b/DialogflowCx/src/V3/GetSecuritySettingsRequest.php @@ -18,8 +18,8 @@ class GetSecuritySettingsRequest extends \Google\Protobuf\Internal\Message { /** * Required. Resource name of the settings. - * Format: `projects//locations//securitySettings/`. + * Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -27,8 +27,8 @@ class GetSecuritySettingsRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. Resource name of the settings. - * Format: `projects//locations//securitySettings/`. Please see + * Format: + * `projects//locations//securitySettings/`. Please see * {@see SecuritySettingsServiceClient::securitySettingsName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetSecuritySettingsRequest @@ -49,8 +49,8 @@ public static function build(string $name): self * * @type string $name * Required. Resource name of the settings. - * Format: `projects//locations//securitySettings/`. + * Format: + * `projects//locations//securitySettings/`. * } */ public function __construct($data = NULL) { @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * Required. Resource name of the settings. - * Format: `projects//locations//securitySettings/`. + * Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,8 +73,8 @@ public function getName() /** * Required. Resource name of the settings. - * Format: `projects//locations//securitySettings/`. + * Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetSessionEntityTypeRequest.php b/DialogflowCx/src/V3/GetSessionEntityTypeRequest.php index bf673f6c5b91..13dc7ecc6a3f 100644 --- a/DialogflowCx/src/V3/GetSessionEntityTypeRequest.php +++ b/DialogflowCx/src/V3/GetSessionEntityTypeRequest.php @@ -18,11 +18,11 @@ class GetSessionEntityTypeRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the session entity type. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, we assume default 'draft' * environment. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -31,11 +31,11 @@ class GetSessionEntityTypeRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the session entity type. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, we assume default 'draft' * environment. Please see * {@see SessionEntityTypesClient::sessionEntityTypeName()} for help formatting this field. * @@ -57,11 +57,11 @@ public static function build(string $name): self * * @type string $name * Required. The name of the session entity type. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, we assume default 'draft' * environment. * } */ @@ -72,11 +72,11 @@ public function __construct($data = NULL) { /** * Required. The name of the session entity type. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, we assume default 'draft' * environment. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -89,11 +89,11 @@ public function getName() /** * Required. The name of the session entity type. - * Format: `projects//locations//agents//sessions//entityTypes/` or - * `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + * Format: + * `projects//locations//agents//sessions//entityTypes/` + * or + * `projects//locations//agents//environments//sessions//entityTypes/`. + * If `Environment ID` is not specified, we assume default 'draft' * environment. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/DialogflowCx/src/V3/GetTestCaseRequest.php b/DialogflowCx/src/V3/GetTestCaseRequest.php index a721c9668c38..30997320b4ef 100644 --- a/DialogflowCx/src/V3/GetTestCaseRequest.php +++ b/DialogflowCx/src/V3/GetTestCaseRequest.php @@ -18,8 +18,8 @@ class GetTestCaseRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the testcase. - * Format: `projects//locations//agents//testCases/`. + * Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -27,8 +27,8 @@ class GetTestCaseRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the testcase. - * Format: `projects//locations//agents//testCases/`. Please see + * Format: + * `projects//locations//agents//testCases/`. Please see * {@see TestCasesClient::testCaseName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetTestCaseRequest @@ -49,8 +49,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the testcase. - * Format: `projects//locations//agents//testCases/`. + * Format: + * `projects//locations//agents//testCases/`. * } */ public function __construct($data = NULL) { @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * Required. The name of the testcase. - * Format: `projects//locations//agents//testCases/`. + * Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,8 +73,8 @@ public function getName() /** * Required. The name of the testcase. - * Format: `projects//locations//agents//testCases/`. + * Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetTestCaseResultRequest.php b/DialogflowCx/src/V3/GetTestCaseResultRequest.php index 210b372f91c7..a5b229faf6a6 100644 --- a/DialogflowCx/src/V3/GetTestCaseResultRequest.php +++ b/DialogflowCx/src/V3/GetTestCaseResultRequest.php @@ -18,8 +18,8 @@ class GetTestCaseResultRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the testcase. - * Format: `projects//locations//agents//testCases//results/`. + * Format: + * `projects//locations//agents//testCases//results/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -27,8 +27,8 @@ class GetTestCaseResultRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the testcase. - * Format: `projects//locations//agents//testCases//results/`. Please see + * Format: + * `projects//locations//agents//testCases//results/`. Please see * {@see TestCasesClient::testCaseResultName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetTestCaseResultRequest @@ -49,8 +49,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the testcase. - * Format: `projects//locations//agents//testCases//results/`. + * Format: + * `projects//locations//agents//testCases//results/`. * } */ public function __construct($data = NULL) { @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * Required. The name of the testcase. - * Format: `projects//locations//agents//testCases//results/`. + * Format: + * `projects//locations//agents//testCases//results/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,8 +73,8 @@ public function getName() /** * Required. The name of the testcase. - * Format: `projects//locations//agents//testCases//results/`. + * Format: + * `projects//locations//agents//testCases//results/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetTransitionRouteGroupRequest.php b/DialogflowCx/src/V3/GetTransitionRouteGroupRequest.php index 236882f97bb3..6a2f1a533b0d 100644 --- a/DialogflowCx/src/V3/GetTransitionRouteGroupRequest.php +++ b/DialogflowCx/src/V3/GetTransitionRouteGroupRequest.php @@ -19,10 +19,10 @@ class GetTransitionRouteGroupRequest extends \Google\Protobuf\Internal\Message /** * Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. - * Format: `projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/`. + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -46,10 +46,10 @@ class GetTransitionRouteGroupRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. - * Format: `projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/`. Please see + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. Please see * {@see TransitionRouteGroupsClient::transitionRouteGroupName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetTransitionRouteGroupRequest @@ -71,10 +71,10 @@ public static function build(string $name): self * @type string $name * Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. - * Format: `projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/`. + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. * @type string $language_code * The language to retrieve the transition route group for. The following * fields are language dependent: @@ -96,10 +96,10 @@ public function __construct($data = NULL) { /** * Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. - * Format: `projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/`. + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -112,10 +112,10 @@ public function getName() /** * Required. The name of the * [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. - * Format: `projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/`. + * Format: + * `projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetVersionRequest.php b/DialogflowCx/src/V3/GetVersionRequest.php index b8e8e7c3162f..5936c66c863d 100644 --- a/DialogflowCx/src/V3/GetVersionRequest.php +++ b/DialogflowCx/src/V3/GetVersionRequest.php @@ -18,8 +18,8 @@ class GetVersionRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -27,8 +27,8 @@ class GetVersionRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. Please see + * Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetVersionRequest @@ -49,8 +49,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * } */ public function __construct($data = NULL) { @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,8 +73,8 @@ public function getName() /** * Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/GetWebhookRequest.php b/DialogflowCx/src/V3/GetWebhookRequest.php index c68f3f629ab6..88404bd3075f 100644 --- a/DialogflowCx/src/V3/GetWebhookRequest.php +++ b/DialogflowCx/src/V3/GetWebhookRequest.php @@ -18,8 +18,8 @@ class GetWebhookRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the webhook. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -27,8 +27,8 @@ class GetWebhookRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The name of the webhook. - * Format: `projects//locations//agents//webhooks/`. Please see + * Format: + * `projects//locations//agents//webhooks/`. Please see * {@see WebhooksClient::webhookName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\GetWebhookRequest @@ -49,8 +49,8 @@ public static function build(string $name): self * * @type string $name * Required. The name of the webhook. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * } */ public function __construct($data = NULL) { @@ -60,8 +60,8 @@ public function __construct($data = NULL) { /** * Required. The name of the webhook. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -73,8 +73,8 @@ public function getName() /** * Required. The name of the webhook. - * Format: `projects//locations//agents//webhooks/`. + * Format: + * `projects//locations//agents//webhooks/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ImportEntityTypesRequest.php b/DialogflowCx/src/V3/ImportEntityTypesRequest.php index 3238f6a92292..fc5722d082e1 100644 --- a/DialogflowCx/src/V3/ImportEntityTypesRequest.php +++ b/DialogflowCx/src/V3/ImportEntityTypesRequest.php @@ -18,7 +18,7 @@ class ImportEntityTypesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to import the entity types into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -31,8 +31,8 @@ class ImportEntityTypesRequest extends \Google\Protobuf\Internal\Message protected $merge_option = 0; /** * Optional. The target entity type to import into. - * Format: `projects//locations//agents//entity_types/`. + * Format: + * `projects//locations//agents//entity_types/`. * If set, there should be only one entity type included in * [entity_types][google.cloud.dialogflow.cx.v3.ImportEntityTypesRequest.entity_types], * of which the type should match the type of the target entity type. All @@ -52,7 +52,7 @@ class ImportEntityTypesRequest extends \Google\Protobuf\Internal\Message * * @type string $parent * Required. The agent to import the entity types into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $entity_types_uri * The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI * to import entity types from. The format of this URI must be @@ -68,8 +68,8 @@ class ImportEntityTypesRequest extends \Google\Protobuf\Internal\Message * Required. Merge option for importing entity types. * @type string $target_entity_type * Optional. The target entity type to import into. - * Format: `projects//locations//agents//entity_types/`. + * Format: + * `projects//locations//agents//entity_types/`. * If set, there should be only one entity type included in * [entity_types][google.cloud.dialogflow.cx.v3.ImportEntityTypesRequest.entity_types], * of which the type should match the type of the target entity type. All @@ -84,7 +84,7 @@ public function __construct($data = NULL) { /** * Required. The agent to import the entity types into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -96,7 +96,7 @@ public function getParent() /** * Required. The agent to import the entity types into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -214,8 +214,8 @@ public function setMergeOption($var) /** * Optional. The target entity type to import into. - * Format: `projects//locations//agents//entity_types/`. + * Format: + * `projects//locations//agents//entity_types/`. * If set, there should be only one entity type included in * [entity_types][google.cloud.dialogflow.cx.v3.ImportEntityTypesRequest.entity_types], * of which the type should match the type of the target entity type. All @@ -232,8 +232,8 @@ public function getTargetEntityType() /** * Optional. The target entity type to import into. - * Format: `projects//locations//agents//entity_types/`. + * Format: + * `projects//locations//agents//entity_types/`. * If set, there should be only one entity type included in * [entity_types][google.cloud.dialogflow.cx.v3.ImportEntityTypesRequest.entity_types], * of which the type should match the type of the target entity type. All diff --git a/DialogflowCx/src/V3/ImportEntityTypesResponse.php b/DialogflowCx/src/V3/ImportEntityTypesResponse.php index de84826d293a..ad58590898c3 100644 --- a/DialogflowCx/src/V3/ImportEntityTypesResponse.php +++ b/DialogflowCx/src/V3/ImportEntityTypesResponse.php @@ -18,8 +18,8 @@ class ImportEntityTypesResponse extends \Google\Protobuf\Internal\Message { /** * The unique identifier of the imported entity types. - * Format: `projects//locations//agents//entity_types/`. + * Format: + * `projects//locations//agents//entity_types/`. * * Generated from protobuf field repeated string entity_types = 1 [(.google.api.resource_reference) = { */ @@ -41,8 +41,8 @@ class ImportEntityTypesResponse extends \Google\Protobuf\Internal\Message * * @type array|\Google\Protobuf\Internal\RepeatedField $entity_types * The unique identifier of the imported entity types. - * Format: `projects//locations//agents//entity_types/`. + * Format: + * `projects//locations//agents//entity_types/`. * @type \Google\Cloud\Dialogflow\Cx\V3\ImportEntityTypesResponse\ConflictingResources $conflicting_resources * Info which resources have conflicts when * [REPORT_CONFLICT][ImportEntityTypesResponse.REPORT_CONFLICT] merge_option @@ -56,8 +56,8 @@ public function __construct($data = NULL) { /** * The unique identifier of the imported entity types. - * Format: `projects//locations//agents//entity_types/`. + * Format: + * `projects//locations//agents//entity_types/`. * * Generated from protobuf field repeated string entity_types = 1 [(.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -69,8 +69,8 @@ public function getEntityTypes() /** * The unique identifier of the imported entity types. - * Format: `projects//locations//agents//entity_types/`. + * Format: + * `projects//locations//agents//entity_types/`. * * Generated from protobuf field repeated string entity_types = 1 [(.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/ImportFlowRequest.php b/DialogflowCx/src/V3/ImportFlowRequest.php index 08ebb9fb9b2b..89c1fe18c85a 100644 --- a/DialogflowCx/src/V3/ImportFlowRequest.php +++ b/DialogflowCx/src/V3/ImportFlowRequest.php @@ -18,7 +18,7 @@ class ImportFlowRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to import the flow into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -46,7 +46,7 @@ class ImportFlowRequest extends \Google\Protobuf\Internal\Message * * @type string $parent * Required. The agent to import the flow into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $flow_uri * The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI * to import flow from. The format of this URI must be @@ -72,7 +72,7 @@ public function __construct($data = NULL) { /** * Required. The agent to import the flow into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -84,7 +84,7 @@ public function getParent() /** * Required. The agent to import the flow into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ImportFlowResponse.php b/DialogflowCx/src/V3/ImportFlowResponse.php index f49941b0b297..bdc4ed0ce833 100644 --- a/DialogflowCx/src/V3/ImportFlowResponse.php +++ b/DialogflowCx/src/V3/ImportFlowResponse.php @@ -18,8 +18,8 @@ class ImportFlowResponse extends \Google\Protobuf\Internal\Message { /** * The unique identifier of the new flow. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string flow = 1 [(.google.api.resource_reference) = { */ @@ -33,8 +33,8 @@ class ImportFlowResponse extends \Google\Protobuf\Internal\Message * * @type string $flow * The unique identifier of the new flow. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * } */ public function __construct($data = NULL) { @@ -44,8 +44,8 @@ public function __construct($data = NULL) { /** * The unique identifier of the new flow. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string flow = 1 [(.google.api.resource_reference) = { * @return string @@ -57,8 +57,8 @@ public function getFlow() /** * The unique identifier of the new flow. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string flow = 1 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ImportIntentsRequest.php b/DialogflowCx/src/V3/ImportIntentsRequest.php index 698bb1f29df6..94fec9e77ad9 100644 --- a/DialogflowCx/src/V3/ImportIntentsRequest.php +++ b/DialogflowCx/src/V3/ImportIntentsRequest.php @@ -18,7 +18,7 @@ class ImportIntentsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to import the intents into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -39,7 +39,7 @@ class ImportIntentsRequest extends \Google\Protobuf\Internal\Message * * @type string $parent * Required. The agent to import the intents into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $intents_uri * The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI * to import intents from. The format of this URI must be @@ -62,7 +62,7 @@ public function __construct($data = NULL) { /** * Required. The agent to import the intents into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -74,7 +74,7 @@ public function getParent() /** * Required. The agent to import the intents into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ImportIntentsResponse.php b/DialogflowCx/src/V3/ImportIntentsResponse.php index c1db25e27b51..0dedb47f4d78 100644 --- a/DialogflowCx/src/V3/ImportIntentsResponse.php +++ b/DialogflowCx/src/V3/ImportIntentsResponse.php @@ -18,8 +18,8 @@ class ImportIntentsResponse extends \Google\Protobuf\Internal\Message { /** * The unique identifier of the imported intents. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field repeated string intents = 1 [(.google.api.resource_reference) = { */ @@ -41,8 +41,8 @@ class ImportIntentsResponse extends \Google\Protobuf\Internal\Message * * @type array|\Google\Protobuf\Internal\RepeatedField $intents * The unique identifier of the imported intents. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * @type \Google\Cloud\Dialogflow\Cx\V3\ImportIntentsResponse\ConflictingResources $conflicting_resources * Info which resources have conflicts when * [REPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT] merge_option is @@ -56,8 +56,8 @@ public function __construct($data = NULL) { /** * The unique identifier of the imported intents. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field repeated string intents = 1 [(.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -69,8 +69,8 @@ public function getIntents() /** * The unique identifier of the imported intents. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field repeated string intents = 1 [(.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/ImportTestCasesRequest.php b/DialogflowCx/src/V3/ImportTestCasesRequest.php index d247a33a50a3..5d14d6f7a6bd 100644 --- a/DialogflowCx/src/V3/ImportTestCasesRequest.php +++ b/DialogflowCx/src/V3/ImportTestCasesRequest.php @@ -18,7 +18,7 @@ class ImportTestCasesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to import test cases to. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,7 +33,7 @@ class ImportTestCasesRequest extends \Google\Protobuf\Internal\Message * * @type string $parent * Required. The agent to import test cases to. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $gcs_uri * The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI * to import test cases from. The format of this URI must be @@ -54,7 +54,7 @@ public function __construct($data = NULL) { /** * Required. The agent to import test cases to. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -66,7 +66,7 @@ public function getParent() /** * Required. The agent to import test cases to. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ImportTestCasesResponse.php b/DialogflowCx/src/V3/ImportTestCasesResponse.php index 22692be05db2..b0bc9ef0ac80 100644 --- a/DialogflowCx/src/V3/ImportTestCasesResponse.php +++ b/DialogflowCx/src/V3/ImportTestCasesResponse.php @@ -18,8 +18,8 @@ class ImportTestCasesResponse extends \Google\Protobuf\Internal\Message { /** * The unique identifiers of the new test cases. - * Format: `projects//locations//agents//testCases/`. + * Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string names = 1 [(.google.api.resource_reference) = { */ @@ -33,8 +33,8 @@ class ImportTestCasesResponse extends \Google\Protobuf\Internal\Message * * @type array|\Google\Protobuf\Internal\RepeatedField $names * The unique identifiers of the new test cases. - * Format: `projects//locations//agents//testCases/`. + * Format: + * `projects//locations//agents//testCases/`. * } */ public function __construct($data = NULL) { @@ -44,8 +44,8 @@ public function __construct($data = NULL) { /** * The unique identifiers of the new test cases. - * Format: `projects//locations//agents//testCases/`. + * Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string names = 1 [(.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -57,8 +57,8 @@ public function getNames() /** * The unique identifiers of the new test cases. - * Format: `projects//locations//agents//testCases/`. + * Format: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field repeated string names = 1 [(.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/Intent.php b/DialogflowCx/src/V3/Intent.php index af2df524d860..5f4fe761130e 100644 --- a/DialogflowCx/src/V3/Intent.php +++ b/DialogflowCx/src/V3/Intent.php @@ -25,8 +25,8 @@ class Intent extends \Google\Protobuf\Internal\Message * method. * [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent] * populates the name automatically. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1; */ @@ -110,8 +110,8 @@ class Intent extends \Google\Protobuf\Internal\Message * method. * [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent] * populates the name automatically. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * @type string $display_name * Required. The human-readable name of the intent, unique within the agent. * @type array<\Google\Cloud\Dialogflow\Cx\V3\Intent\TrainingPhrase>|\Google\Protobuf\Internal\RepeatedField $training_phrases @@ -163,8 +163,8 @@ public function __construct($data = NULL) { * method. * [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent] * populates the name automatically. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1; * @return string @@ -181,8 +181,8 @@ public function getName() * method. * [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent] * populates the name automatically. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string name = 1; * @param string $var diff --git a/DialogflowCx/src/V3/Intent/Parameter.php b/DialogflowCx/src/V3/Intent/Parameter.php index 64d5747c9a57..1b55bc977759 100644 --- a/DialogflowCx/src/V3/Intent/Parameter.php +++ b/DialogflowCx/src/V3/Intent/Parameter.php @@ -26,11 +26,12 @@ class Parameter extends \Google\Protobuf\Internal\Message protected $id = ''; /** * Required. The entity type of the parameter. - * Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, + * Format: + * `projects/-/locations/-/agents/-/entityTypes/` for + * system entity types (for example, * `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - * `projects//locations//agents//entityTypes/` for developer entity types. + * `projects//locations//agents//entityTypes/` + * for developer entity types. * * Generated from protobuf field string entity_type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -66,11 +67,12 @@ class Parameter extends \Google\Protobuf\Internal\Message * their [parts][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part]. * @type string $entity_type * Required. The entity type of the parameter. - * Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, + * Format: + * `projects/-/locations/-/agents/-/entityTypes/` for + * system entity types (for example, * `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - * `projects//locations//agents//entityTypes/` for developer entity types. + * `projects//locations//agents//entityTypes/` + * for developer entity types. * @type bool $is_list * Indicates whether the parameter represents a list of values. * @type bool $redact @@ -121,11 +123,12 @@ public function setId($var) /** * Required. The entity type of the parameter. - * Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, + * Format: + * `projects/-/locations/-/agents/-/entityTypes/` for + * system entity types (for example, * `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - * `projects//locations//agents//entityTypes/` for developer entity types. + * `projects//locations//agents//entityTypes/` + * for developer entity types. * * Generated from protobuf field string entity_type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -137,11 +140,12 @@ public function getEntityType() /** * Required. The entity type of the parameter. - * Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, + * Format: + * `projects/-/locations/-/agents/-/entityTypes/` for + * system entity types (for example, * `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - * `projects//locations//agents//entityTypes/` for developer entity types. + * `projects//locations//agents//entityTypes/` + * for developer entity types. * * Generated from protobuf field string entity_type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/IntentInput.php b/DialogflowCx/src/V3/IntentInput.php index c90f0098146d..9f8ca905c9a9 100644 --- a/DialogflowCx/src/V3/IntentInput.php +++ b/DialogflowCx/src/V3/IntentInput.php @@ -18,8 +18,8 @@ class IntentInput extends \Google\Protobuf\Internal\Message { /** * Required. The unique identifier of the intent. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string intent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -33,8 +33,8 @@ class IntentInput extends \Google\Protobuf\Internal\Message * * @type string $intent * Required. The unique identifier of the intent. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * } */ public function __construct($data = NULL) { @@ -44,8 +44,8 @@ public function __construct($data = NULL) { /** * Required. The unique identifier of the intent. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string intent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -57,8 +57,8 @@ public function getIntent() /** * Required. The unique identifier of the intent. - * Format: `projects//locations//agents//intents/`. + * Format: + * `projects//locations//agents//intents/`. * * Generated from protobuf field string intent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/KnowledgeConnectorSettings.php b/DialogflowCx/src/V3/KnowledgeConnectorSettings.php index 72087ad2c0f5..dab6fef5b467 100644 --- a/DialogflowCx/src/V3/KnowledgeConnectorSettings.php +++ b/DialogflowCx/src/V3/KnowledgeConnectorSettings.php @@ -59,12 +59,12 @@ class KnowledgeConnectorSettings extends \Google\Protobuf\Internal\Message * construct the fulfillment. * @type string $target_page * The target page to transition to. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * @type string $target_flow * The target flow to transition to. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * @type array<\Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection>|\Google\Protobuf\Internal\RepeatedField $data_store_connections * Optional. List of related data store connections. * } @@ -148,8 +148,8 @@ public function setTriggerFulfillment($var) /** * The target page to transition to. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string target_page = 4 [(.google.api.resource_reference) = { * @return string @@ -166,8 +166,8 @@ public function hasTargetPage() /** * The target page to transition to. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string target_page = 4 [(.google.api.resource_reference) = { * @param string $var @@ -183,8 +183,8 @@ public function setTargetPage($var) /** * The target flow to transition to. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string target_flow = 5 [(.google.api.resource_reference) = { * @return string @@ -201,8 +201,8 @@ public function hasTargetFlow() /** * The target flow to transition to. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string target_flow = 5 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListAgentsRequest.php b/DialogflowCx/src/V3/ListAgentsRequest.php index 2138f9ad25cc..e6845b2b4c93 100644 --- a/DialogflowCx/src/V3/ListAgentsRequest.php +++ b/DialogflowCx/src/V3/ListAgentsRequest.php @@ -18,7 +18,7 @@ class ListAgentsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The location to list all agents for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -39,7 +39,7 @@ class ListAgentsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The location to list all agents for. - * Format: `projects//locations/`. Please see + * Format: `projects//locations/`. Please see * {@see AgentsClient::locationName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListAgentsRequest @@ -60,7 +60,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The location to list all agents for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * @type int $page_size * The maximum number of items to return in a single page. By default 100 and * at most 1000. @@ -75,7 +75,7 @@ public function __construct($data = NULL) { /** * Required. The location to list all agents for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -87,7 +87,7 @@ public function getParent() /** * Required. The location to list all agents for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListChangelogsRequest.php b/DialogflowCx/src/V3/ListChangelogsRequest.php index 11e985ae4cf7..0bd5b7e00f46 100644 --- a/DialogflowCx/src/V3/ListChangelogsRequest.php +++ b/DialogflowCx/src/V3/ListChangelogsRequest.php @@ -18,7 +18,7 @@ class ListChangelogsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent containing the changelogs. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -64,7 +64,7 @@ class ListChangelogsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent containing the changelogs. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see ChangelogsClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListChangelogsRequest @@ -85,7 +85,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The agent containing the changelogs. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $filter * The filter string. Supports filter by user_email, resource, type and * create_time. Some examples: @@ -121,7 +121,7 @@ public function __construct($data = NULL) { /** * Required. The agent containing the changelogs. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -133,7 +133,7 @@ public function getParent() /** * Required. The agent containing the changelogs. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListContinuousTestResultsRequest.php b/DialogflowCx/src/V3/ListContinuousTestResultsRequest.php index 28374b5ca0d6..e9975dc06884 100644 --- a/DialogflowCx/src/V3/ListContinuousTestResultsRequest.php +++ b/DialogflowCx/src/V3/ListContinuousTestResultsRequest.php @@ -18,8 +18,8 @@ class ListContinuousTestResultsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The environment to list results for. - * Format: `projects//locations//agents// - * environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -40,8 +40,8 @@ class ListContinuousTestResultsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The environment to list results for. - * Format: `projects//locations//agents// - * environments/`. Please see + * Format: + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListContinuousTestResultsRequest @@ -62,8 +62,8 @@ public static function build(string $parent): self * * @type string $parent * Required. The environment to list results for. - * Format: `projects//locations//agents// - * environments/`. + * Format: + * `projects//locations//agents//environments/`. * @type int $page_size * The maximum number of items to return in a single page. By default 100 and * at most 1000. @@ -78,8 +78,8 @@ public function __construct($data = NULL) { /** * Required. The environment to list results for. - * Format: `projects//locations//agents// - * environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -91,8 +91,8 @@ public function getParent() /** * Required. The environment to list results for. - * Format: `projects//locations//agents// - * environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListDeploymentsRequest.php b/DialogflowCx/src/V3/ListDeploymentsRequest.php index ff572ac54799..995e6212de81 100644 --- a/DialogflowCx/src/V3/ListDeploymentsRequest.php +++ b/DialogflowCx/src/V3/ListDeploymentsRequest.php @@ -18,9 +18,8 @@ class ListDeploymentsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. + * list all environments for. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -41,9 +40,8 @@ class ListDeploymentsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. Please see + * list all environments for. Format: + * `projects//locations//agents//environments/`. Please see * {@see DeploymentsClient::environmentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListDeploymentsRequest @@ -64,9 +62,8 @@ public static function build(string $parent): self * * @type string $parent * Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. + * list all environments for. Format: + * `projects//locations//agents//environments/`. * @type int $page_size * The maximum number of items to return in a single page. By default 20 and * at most 100. @@ -81,9 +78,8 @@ public function __construct($data = NULL) { /** * Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. + * list all environments for. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -95,9 +91,8 @@ public function getParent() /** * Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. + * list all environments for. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListEntityTypesRequest.php b/DialogflowCx/src/V3/ListEntityTypesRequest.php index db4205733dde..39cdd6e90823 100644 --- a/DialogflowCx/src/V3/ListEntityTypesRequest.php +++ b/DialogflowCx/src/V3/ListEntityTypesRequest.php @@ -18,7 +18,7 @@ class ListEntityTypesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to list all entity types for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -54,7 +54,7 @@ class ListEntityTypesRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to list all entity types for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see EntityTypesClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListEntityTypesRequest @@ -75,7 +75,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The agent to list all entity types for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $language_code * The language to list entity types for. The following fields are language * dependent: @@ -101,7 +101,7 @@ public function __construct($data = NULL) { /** * Required. The agent to list all entity types for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -113,7 +113,7 @@ public function getParent() /** * Required. The agent to list all entity types for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListEnvironmentsRequest.php b/DialogflowCx/src/V3/ListEnvironmentsRequest.php index 16a54de19865..27109ec748e3 100644 --- a/DialogflowCx/src/V3/ListEnvironmentsRequest.php +++ b/DialogflowCx/src/V3/ListEnvironmentsRequest.php @@ -18,8 +18,8 @@ class ListEnvironmentsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all - * environments for. Format: `projects//locations//agents/`. + * environments for. Format: + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -40,8 +40,8 @@ class ListEnvironmentsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all - * environments for. Format: `projects//locations//agents/`. Please see + * environments for. Format: + * `projects//locations//agents/`. Please see * {@see EnvironmentsClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListEnvironmentsRequest @@ -62,8 +62,8 @@ public static function build(string $parent): self * * @type string $parent * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all - * environments for. Format: `projects//locations//agents/`. + * environments for. Format: + * `projects//locations//agents/`. * @type int $page_size * The maximum number of items to return in a single page. By default 20 and * at most 100. @@ -78,8 +78,8 @@ public function __construct($data = NULL) { /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all - * environments for. Format: `projects//locations//agents/`. + * environments for. Format: + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -91,8 +91,8 @@ public function getParent() /** * Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all - * environments for. Format: `projects//locations//agents/`. + * environments for. Format: + * `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListExperimentsRequest.php b/DialogflowCx/src/V3/ListExperimentsRequest.php index d69bba8f11f1..546ddb2f7c86 100644 --- a/DialogflowCx/src/V3/ListExperimentsRequest.php +++ b/DialogflowCx/src/V3/ListExperimentsRequest.php @@ -18,9 +18,8 @@ class ListExperimentsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. + * list all environments for. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -41,9 +40,8 @@ class ListExperimentsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. Please see + * list all environments for. Format: + * `projects//locations//agents//environments/`. Please see * {@see ExperimentsClient::environmentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListExperimentsRequest @@ -64,9 +62,8 @@ public static function build(string $parent): self * * @type string $parent * Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. + * list all environments for. Format: + * `projects//locations//agents//environments/`. * @type int $page_size * The maximum number of items to return in a single page. By default 20 and * at most 100. @@ -81,9 +78,8 @@ public function __construct($data = NULL) { /** * Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. + * list all environments for. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -95,9 +91,8 @@ public function getParent() /** * Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to - * list all environments for. Format: `projects//locations//agents//environments/`. + * list all environments for. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListFlowsRequest.php b/DialogflowCx/src/V3/ListFlowsRequest.php index db07b32102c5..cd166946c2a9 100644 --- a/DialogflowCx/src/V3/ListFlowsRequest.php +++ b/DialogflowCx/src/V3/ListFlowsRequest.php @@ -18,7 +18,7 @@ class ListFlowsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent containing the flows. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -55,7 +55,7 @@ class ListFlowsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent containing the flows. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see FlowsClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListFlowsRequest @@ -76,7 +76,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The agent containing the flows. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type int $page_size * The maximum number of items to return in a single page. By default 100 and * at most 1000. @@ -103,7 +103,7 @@ public function __construct($data = NULL) { /** * Required. The agent containing the flows. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -115,7 +115,7 @@ public function getParent() /** * Required. The agent containing the flows. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListGeneratorsRequest.php b/DialogflowCx/src/V3/ListGeneratorsRequest.php index 438bd593c0f8..d5b4de9508a6 100644 --- a/DialogflowCx/src/V3/ListGeneratorsRequest.php +++ b/DialogflowCx/src/V3/ListGeneratorsRequest.php @@ -18,7 +18,7 @@ class ListGeneratorsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to list all generators for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -45,7 +45,7 @@ class ListGeneratorsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to list all generators for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see GeneratorsClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListGeneratorsRequest @@ -66,7 +66,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The agent to list all generators for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $language_code * The language to list generators for. * @type int $page_size @@ -83,7 +83,7 @@ public function __construct($data = NULL) { /** * Required. The agent to list all generators for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -95,7 +95,7 @@ public function getParent() /** * Required. The agent to list all generators for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListIntentsRequest.php b/DialogflowCx/src/V3/ListIntentsRequest.php index 7a9065dcb926..7f3216516f9c 100644 --- a/DialogflowCx/src/V3/ListIntentsRequest.php +++ b/DialogflowCx/src/V3/ListIntentsRequest.php @@ -18,7 +18,7 @@ class ListIntentsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to list all intents for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -58,7 +58,7 @@ class ListIntentsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to list all intents for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see IntentsClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListIntentsRequest @@ -79,7 +79,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The agent to list all intents for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $language_code * The language to list intents for. The following fields are language * dependent: @@ -105,7 +105,7 @@ public function __construct($data = NULL) { /** * Required. The agent to list all intents for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -117,7 +117,7 @@ public function getParent() /** * Required. The agent to list all intents for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListPagesRequest.php b/DialogflowCx/src/V3/ListPagesRequest.php index 0a7848ca3e8b..87cae28c9915 100644 --- a/DialogflowCx/src/V3/ListPagesRequest.php +++ b/DialogflowCx/src/V3/ListPagesRequest.php @@ -18,8 +18,8 @@ class ListPagesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The flow to list all pages for. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -64,8 +64,8 @@ class ListPagesRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The flow to list all pages for. - * Format: `projects//locations//agents//flows/`. Please see + * Format: + * `projects//locations//agents//flows/`. Please see * {@see PagesClient::flowName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListPagesRequest @@ -86,8 +86,8 @@ public static function build(string $parent): self * * @type string $parent * Required. The flow to list all pages for. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * @type string $language_code * The language to list pages for. The following fields are language * dependent: @@ -122,8 +122,8 @@ public function __construct($data = NULL) { /** * Required. The flow to list all pages for. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -135,8 +135,8 @@ public function getParent() /** * Required. The flow to list all pages for. - * Format: `projects//locations//agents//flows/`. + * Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListSecuritySettingsRequest.php b/DialogflowCx/src/V3/ListSecuritySettingsRequest.php index bf0786db3f61..5daac5e980c9 100644 --- a/DialogflowCx/src/V3/ListSecuritySettingsRequest.php +++ b/DialogflowCx/src/V3/ListSecuritySettingsRequest.php @@ -17,7 +17,7 @@ class ListSecuritySettingsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The location to list all security settings for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -38,7 +38,7 @@ class ListSecuritySettingsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The location to list all security settings for. - * Format: `projects//locations/`. Please see + * Format: `projects//locations/`. Please see * {@see SecuritySettingsServiceClient::locationName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListSecuritySettingsRequest @@ -59,7 +59,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The location to list all security settings for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * @type int $page_size * The maximum number of items to return in a single page. By default 20 and * at most 100. @@ -74,7 +74,7 @@ public function __construct($data = NULL) { /** * Required. The location to list all security settings for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -86,7 +86,7 @@ public function getParent() /** * Required. The location to list all security settings for. - * Format: `projects//locations/`. + * Format: `projects//locations/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListSessionEntityTypesRequest.php b/DialogflowCx/src/V3/ListSessionEntityTypesRequest.php index 42ec7f555680..ca21e06cb693 100644 --- a/DialogflowCx/src/V3/ListSessionEntityTypesRequest.php +++ b/DialogflowCx/src/V3/ListSessionEntityTypesRequest.php @@ -18,9 +18,10 @@ class ListSessionEntityTypesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The session to list all session entity types from. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * @@ -43,9 +44,10 @@ class ListSessionEntityTypesRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The session to list all session entity types from. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. Please see * {@see SessionEntityTypesClient::sessionName()} for help formatting this field. @@ -68,9 +70,10 @@ public static function build(string $parent): self * * @type string $parent * Required. The session to list all session entity types from. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * @type int $page_size @@ -87,9 +90,10 @@ public function __construct($data = NULL) { /** * Required. The session to list all session entity types from. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * @@ -103,9 +107,10 @@ public function getParent() /** * Required. The session to list all session entity types from. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * diff --git a/DialogflowCx/src/V3/ListTestCaseResultsRequest.php b/DialogflowCx/src/V3/ListTestCaseResultsRequest.php index 48bfae19d703..aee87cbefeb2 100644 --- a/DialogflowCx/src/V3/ListTestCaseResultsRequest.php +++ b/DialogflowCx/src/V3/ListTestCaseResultsRequest.php @@ -18,9 +18,10 @@ class ListTestCaseResultsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The test case to list results for. - * Format: `projects//locations//agents// - * testCases/`. Specify a `-` as a wildcard for TestCase ID to - * list results across multiple test cases. + * Format: + * `projects//locations//agents//testCases/`. + * Specify a `-` as a wildcard for TestCase ID to + * list results across multiple test cases. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -65,8 +66,9 @@ class ListTestCaseResultsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The test case to list results for. - * Format: `projects//locations//agents// - * testCases/`. Specify a `-` as a wildcard for TestCase ID to + * Format: + * `projects//locations//agents//testCases/`. + * Specify a `-` as a wildcard for TestCase ID to * list results across multiple test cases. Please see * {@see TestCasesClient::testCaseName()} for help formatting this field. * @@ -88,9 +90,10 @@ public static function build(string $parent): self * * @type string $parent * Required. The test case to list results for. - * Format: `projects//locations//agents// - * testCases/`. Specify a `-` as a wildcard for TestCase ID to - * list results across multiple test cases. + * Format: + * `projects//locations//agents//testCases/`. + * Specify a `-` as a wildcard for TestCase ID to + * list results across multiple test cases. * @type int $page_size * The maximum number of items to return in a single page. By default 100 and * at most 1000. @@ -125,9 +128,10 @@ public function __construct($data = NULL) { /** * Required. The test case to list results for. - * Format: `projects//locations//agents// - * testCases/`. Specify a `-` as a wildcard for TestCase ID to - * list results across multiple test cases. + * Format: + * `projects//locations//agents//testCases/`. + * Specify a `-` as a wildcard for TestCase ID to + * list results across multiple test cases. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -139,9 +143,10 @@ public function getParent() /** * Required. The test case to list results for. - * Format: `projects//locations//agents// - * testCases/`. Specify a `-` as a wildcard for TestCase ID to - * list results across multiple test cases. + * Format: + * `projects//locations//agents//testCases/`. + * Specify a `-` as a wildcard for TestCase ID to + * list results across multiple test cases. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListTestCasesRequest.php b/DialogflowCx/src/V3/ListTestCasesRequest.php index 126b96cb6fd1..e9194713d6a2 100644 --- a/DialogflowCx/src/V3/ListTestCasesRequest.php +++ b/DialogflowCx/src/V3/ListTestCasesRequest.php @@ -18,7 +18,7 @@ class ListTestCasesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to list all pages for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -46,7 +46,7 @@ class ListTestCasesRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to list all pages for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see TestCasesClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListTestCasesRequest @@ -67,7 +67,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The agent to list all pages for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type int $page_size * The maximum number of items to return in a single page. By default 20. * Note that when TestCaseView = FULL, the maximum page size allowed is 20. @@ -85,7 +85,7 @@ public function __construct($data = NULL) { /** * Required. The agent to list all pages for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -97,7 +97,7 @@ public function getParent() /** * Required. The agent to list all pages for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListTransitionRouteGroupsRequest.php b/DialogflowCx/src/V3/ListTransitionRouteGroupsRequest.php index 54ba858d3f29..0b5f38ebce4e 100644 --- a/DialogflowCx/src/V3/ListTransitionRouteGroupsRequest.php +++ b/DialogflowCx/src/V3/ListTransitionRouteGroupsRequest.php @@ -18,9 +18,9 @@ class ListTransitionRouteGroupsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The flow to list all transition route groups for. - * Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/. + * Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -56,9 +56,9 @@ class ListTransitionRouteGroupsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The flow to list all transition route groups for. - * Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/. Please see + * Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/. Please see * {@see TransitionRouteGroupsClient::flowName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListTransitionRouteGroupsRequest @@ -79,9 +79,9 @@ public static function build(string $parent): self * * @type string $parent * Required. The flow to list all transition route groups for. - * Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/. + * Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/. * @type int $page_size * The maximum number of items to return in a single page. By default 100 and * at most 1000. @@ -107,9 +107,9 @@ public function __construct($data = NULL) { /** * Required. The flow to list all transition route groups for. - * Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/. + * Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -121,9 +121,9 @@ public function getParent() /** * Required. The flow to list all transition route groups for. - * Format: `projects//locations//agents//flows/` - * or `projects//locations//agents/. + * Format: + * `projects//locations//agents//flows/` + * or `projects//locations//agents/. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListVersionsRequest.php b/DialogflowCx/src/V3/ListVersionsRequest.php index 724b7b6700b9..894d16df9940 100644 --- a/DialogflowCx/src/V3/ListVersionsRequest.php +++ b/DialogflowCx/src/V3/ListVersionsRequest.php @@ -18,8 +18,8 @@ class ListVersionsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all - * versions for. Format: `projects//locations//agents//flows/`. + * versions for. Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -40,8 +40,8 @@ class ListVersionsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all - * versions for. Format: `projects//locations//agents//flows/`. Please see + * versions for. Format: + * `projects//locations//agents//flows/`. Please see * {@see VersionsClient::flowName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListVersionsRequest @@ -62,8 +62,8 @@ public static function build(string $parent): self * * @type string $parent * Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all - * versions for. Format: `projects//locations//agents//flows/`. + * versions for. Format: + * `projects//locations//agents//flows/`. * @type int $page_size * The maximum number of items to return in a single page. By default 20 and * at most 100. @@ -78,8 +78,8 @@ public function __construct($data = NULL) { /** * Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all - * versions for. Format: `projects//locations//agents//flows/`. + * versions for. Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -91,8 +91,8 @@ public function getParent() /** * Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all - * versions for. Format: `projects//locations//agents//flows/`. + * versions for. Format: + * `projects//locations//agents//flows/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/ListWebhooksRequest.php b/DialogflowCx/src/V3/ListWebhooksRequest.php index 7dae89e4852d..0c1dbafe4807 100644 --- a/DialogflowCx/src/V3/ListWebhooksRequest.php +++ b/DialogflowCx/src/V3/ListWebhooksRequest.php @@ -18,7 +18,7 @@ class ListWebhooksRequest extends \Google\Protobuf\Internal\Message { /** * Required. The agent to list all webhooks for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -39,7 +39,7 @@ class ListWebhooksRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The agent to list all webhooks for. - * Format: `projects//locations//agents/`. Please see + * Format: `projects//locations//agents/`. Please see * {@see WebhooksClient::agentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\ListWebhooksRequest @@ -60,7 +60,7 @@ public static function build(string $parent): self * * @type string $parent * Required. The agent to list all webhooks for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type int $page_size * The maximum number of items to return in a single page. By default 100 and * at most 1000. @@ -75,7 +75,7 @@ public function __construct($data = NULL) { /** * Required. The agent to list all webhooks for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -87,7 +87,7 @@ public function getParent() /** * Required. The agent to list all webhooks for. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/LoadVersionRequest.php b/DialogflowCx/src/V3/LoadVersionRequest.php index 956456fd0620..d2566208a1f1 100644 --- a/DialogflowCx/src/V3/LoadVersionRequest.php +++ b/DialogflowCx/src/V3/LoadVersionRequest.php @@ -18,8 +18,8 @@ class LoadVersionRequest extends \Google\Protobuf\Internal\Message { /** * Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded - * to draft flow. Format: `projects//locations//agents//flows//versions/`. + * to draft flow. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -36,8 +36,8 @@ class LoadVersionRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded - * to draft flow. Format: `projects//locations//agents//flows//versions/`. Please see + * to draft flow. Format: + * `projects//locations//agents//flows//versions/`. Please see * {@see VersionsClient::versionName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\LoadVersionRequest @@ -58,8 +58,8 @@ public static function build(string $name): self * * @type string $name * Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded - * to draft flow. Format: `projects//locations//agents//flows//versions/`. + * to draft flow. Format: + * `projects//locations//agents//flows//versions/`. * @type bool $allow_override_agent_resources * This field is used to prevent accidental overwrite of other agent * resources, which can potentially impact other flow's behavior. If @@ -74,8 +74,8 @@ public function __construct($data = NULL) { /** * Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded - * to draft flow. Format: `projects//locations//agents//flows//versions/`. + * to draft flow. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -87,8 +87,8 @@ public function getName() /** * Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded - * to draft flow. Format: `projects//locations//agents//flows//versions/`. + * to draft flow. Format: + * `projects//locations//agents//flows//versions/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/LookupEnvironmentHistoryRequest.php b/DialogflowCx/src/V3/LookupEnvironmentHistoryRequest.php index 1b41646f3ff0..7e6f8f61c9be 100644 --- a/DialogflowCx/src/V3/LookupEnvironmentHistoryRequest.php +++ b/DialogflowCx/src/V3/LookupEnvironmentHistoryRequest.php @@ -18,8 +18,8 @@ class LookupEnvironmentHistoryRequest extends \Google\Protobuf\Internal\Message { /** * Required. Resource name of the environment to look up the history for. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -40,8 +40,8 @@ class LookupEnvironmentHistoryRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. Resource name of the environment to look up the history for. - * Format: `projects//locations//agents//environments/`. Please see + * Format: + * `projects//locations//agents//environments/`. Please see * {@see EnvironmentsClient::environmentName()} for help formatting this field. * * @return \Google\Cloud\Dialogflow\Cx\V3\LookupEnvironmentHistoryRequest @@ -62,8 +62,8 @@ public static function build(string $name): self * * @type string $name * Required. Resource name of the environment to look up the history for. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * @type int $page_size * The maximum number of items to return in a single page. By default 100 and * at most 1000. @@ -78,8 +78,8 @@ public function __construct($data = NULL) { /** * Required. Resource name of the environment to look up the history for. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -91,8 +91,8 @@ public function getName() /** * Required. Resource name of the environment to look up the history for. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/MatchIntentRequest.php b/DialogflowCx/src/V3/MatchIntentRequest.php index ecbbe66b6c0b..73bdef19c36b 100644 --- a/DialogflowCx/src/V3/MatchIntentRequest.php +++ b/DialogflowCx/src/V3/MatchIntentRequest.php @@ -17,9 +17,10 @@ class MatchIntentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be @@ -58,9 +59,10 @@ class MatchIntentRequest extends \Google\Protobuf\Internal\Message * * @type string $session * Required. The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be @@ -83,9 +85,10 @@ public function __construct($data = NULL) { /** * Required. The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be @@ -104,9 +107,10 @@ public function getSession() /** * Required. The name of the session this query is sent to. - * Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. + * Format: + * `projects//locations//agents//sessions/` + * or + * `projects//locations//agents//environments//sessions/`. * If `Environment ID` is not specified, we assume default 'draft' * environment. * It's up to the API caller to choose an appropriate `Session ID`. It can be diff --git a/DialogflowCx/src/V3/MatchIntentResponse.php b/DialogflowCx/src/V3/MatchIntentResponse.php index fec6319524bd..8333b7295a57 100644 --- a/DialogflowCx/src/V3/MatchIntentResponse.php +++ b/DialogflowCx/src/V3/MatchIntentResponse.php @@ -44,8 +44,7 @@ class MatchIntentResponse extends \Google\Protobuf\Internal\Message * @type string $trigger_intent * If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as * input, this field will contain a copy of the intent identifier. Format: - * `projects//locations//agents//intents/`. + * `projects//locations//agents//intents/`. * @type string $transcript * If [natural language speech * audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, @@ -103,8 +102,7 @@ public function setText($var) /** * If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as * input, this field will contain a copy of the intent identifier. Format: - * `projects//locations//agents//intents/`. + * `projects//locations//agents//intents/`. * * Generated from protobuf field string trigger_intent = 2 [(.google.api.resource_reference) = { * @return string @@ -122,8 +120,7 @@ public function hasTriggerIntent() /** * If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as * input, this field will contain a copy of the intent identifier. Format: - * `projects//locations//agents//intents/`. + * `projects//locations//agents//intents/`. * * Generated from protobuf field string trigger_intent = 2 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/NluSettings.php b/DialogflowCx/src/V3/NluSettings.php index 8941c2189aef..957b9d6e4d4c 100644 --- a/DialogflowCx/src/V3/NluSettings.php +++ b/DialogflowCx/src/V3/NluSettings.php @@ -27,7 +27,8 @@ class NluSettings extends \Google\Protobuf\Internal\Message * classification threshold. If the returned score value is less than the * threshold value, then a no-match event will be triggered. The score values * range from 0.0 (completely uncertain) to 1.0 (completely certain). If set - * to 0.0, the default of 0.3 is used. + * to 0.0, the default of 0.3 is used. You can set a separate classification + * threshold for the flow in each language enabled for the agent. * * Generated from protobuf field float classification_threshold = 3; */ @@ -53,7 +54,8 @@ class NluSettings extends \Google\Protobuf\Internal\Message * classification threshold. If the returned score value is less than the * threshold value, then a no-match event will be triggered. The score values * range from 0.0 (completely uncertain) to 1.0 (completely certain). If set - * to 0.0, the default of 0.3 is used. + * to 0.0, the default of 0.3 is used. You can set a separate classification + * threshold for the flow in each language enabled for the agent. * @type int $model_training_mode * Indicates NLU model training mode. * } @@ -95,7 +97,8 @@ public function setModelType($var) * classification threshold. If the returned score value is less than the * threshold value, then a no-match event will be triggered. The score values * range from 0.0 (completely uncertain) to 1.0 (completely certain). If set - * to 0.0, the default of 0.3 is used. + * to 0.0, the default of 0.3 is used. You can set a separate classification + * threshold for the flow in each language enabled for the agent. * * Generated from protobuf field float classification_threshold = 3; * @return float @@ -111,7 +114,8 @@ public function getClassificationThreshold() * classification threshold. If the returned score value is less than the * threshold value, then a no-match event will be triggered. The score values * range from 0.0 (completely uncertain) to 1.0 (completely certain). If set - * to 0.0, the default of 0.3 is used. + * to 0.0, the default of 0.3 is used. You can set a separate classification + * threshold for the flow in each language enabled for the agent. * * Generated from protobuf field float classification_threshold = 3; * @param float $var diff --git a/DialogflowCx/src/V3/OutputAudioEncoding.php b/DialogflowCx/src/V3/OutputAudioEncoding.php index 2e80a0f33a21..c12c52eb1ef7 100644 --- a/DialogflowCx/src/V3/OutputAudioEncoding.php +++ b/DialogflowCx/src/V3/OutputAudioEncoding.php @@ -53,6 +53,12 @@ class OutputAudioEncoding * Generated from protobuf enum OUTPUT_AUDIO_ENCODING_MULAW = 5; */ const OUTPUT_AUDIO_ENCODING_MULAW = 5; + /** + * 8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law. + * + * Generated from protobuf enum OUTPUT_AUDIO_ENCODING_ALAW = 6; + */ + const OUTPUT_AUDIO_ENCODING_ALAW = 6; private static $valueToName = [ self::OUTPUT_AUDIO_ENCODING_UNSPECIFIED => 'OUTPUT_AUDIO_ENCODING_UNSPECIFIED', @@ -61,6 +67,7 @@ class OutputAudioEncoding self::OUTPUT_AUDIO_ENCODING_MP3_64_KBPS => 'OUTPUT_AUDIO_ENCODING_MP3_64_KBPS', self::OUTPUT_AUDIO_ENCODING_OGG_OPUS => 'OUTPUT_AUDIO_ENCODING_OGG_OPUS', self::OUTPUT_AUDIO_ENCODING_MULAW => 'OUTPUT_AUDIO_ENCODING_MULAW', + self::OUTPUT_AUDIO_ENCODING_ALAW => 'OUTPUT_AUDIO_ENCODING_ALAW', ]; public static function name($value) diff --git a/DialogflowCx/src/V3/Page.php b/DialogflowCx/src/V3/Page.php index d06908873a36..0b2d2ec9257e 100644 --- a/DialogflowCx/src/V3/Page.php +++ b/DialogflowCx/src/V3/Page.php @@ -33,8 +33,8 @@ class Page extends \Google\Protobuf\Internal\Message * [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. * [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage] * populates the name automatically. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string name = 1; */ @@ -76,11 +76,10 @@ class Page extends \Google\Protobuf\Internal\Message * transition route group -> flow's transition routes. * * If multiple transition route groups within a page contain the same * intent, then the first group in the ordered list takes precedence. - * Format:`projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/` for agent-level - * groups. + * Format:`projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/` + * for agent-level groups. * * Generated from protobuf field repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { */ @@ -143,8 +142,8 @@ class Page extends \Google\Protobuf\Internal\Message * [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. * [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage] * populates the name automatically. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * @type string $display_name * Required. The human-readable name of the page, unique within the flow. * @type string $description @@ -166,11 +165,10 @@ class Page extends \Google\Protobuf\Internal\Message * transition route group -> flow's transition routes. * * If multiple transition route groups within a page contain the same * intent, then the first group in the ordered list takes precedence. - * Format:`projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/` for agent-level - * groups. + * Format:`projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/` + * for agent-level groups. * @type array<\Google\Cloud\Dialogflow\Cx\V3\TransitionRoute>|\Google\Protobuf\Internal\RepeatedField $transition_routes * A list of transitions for the transition rules of this page. * They route the conversation to another page in the same flow, or another @@ -213,8 +211,8 @@ public function __construct($data = NULL) { * [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. * [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage] * populates the name automatically. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string name = 1; * @return string @@ -230,8 +228,8 @@ public function getName() * [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. * [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage] * populates the name automatically. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string name = 1; * @param string $var @@ -383,11 +381,10 @@ public function setForm($var) * transition route group -> flow's transition routes. * * If multiple transition route groups within a page contain the same * intent, then the first group in the ordered list takes precedence. - * Format:`projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/` for agent-level - * groups. + * Format:`projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/` + * for agent-level groups. * * Generated from protobuf field repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { * @return \Google\Protobuf\Internal\RepeatedField @@ -409,11 +406,10 @@ public function getTransitionRouteGroups() * transition route group -> flow's transition routes. * * If multiple transition route groups within a page contain the same * intent, then the first group in the ordered list takes precedence. - * Format:`projects//locations//agents//flows//transitionRouteGroups/` - * or `projects//locations//agents//transitionRouteGroups/` for agent-level - * groups. + * Format:`projects//locations//agents//flows//transitionRouteGroups/` + * or + * `projects//locations//agents//transitionRouteGroups/` + * for agent-level groups. * * Generated from protobuf field repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/PageInfo.php b/DialogflowCx/src/V3/PageInfo.php index 8c9ad6fbebf2..e2d569fa7233 100644 --- a/DialogflowCx/src/V3/PageInfo.php +++ b/DialogflowCx/src/V3/PageInfo.php @@ -19,9 +19,8 @@ class PageInfo extends \Google\Protobuf\Internal\Message * Always present for * [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for * [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The - * unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`. + * unique identifier of the current page. Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string current_page = 1 [(.google.api.resource_reference) = { */ @@ -55,9 +54,8 @@ class PageInfo extends \Google\Protobuf\Internal\Message * Always present for * [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for * [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The - * unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`. + * unique identifier of the current page. Format: + * `projects//locations//agents//flows//pages/`. * @type string $display_name * Always present for * [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for @@ -79,9 +77,8 @@ public function __construct($data = NULL) { * Always present for * [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for * [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The - * unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`. + * unique identifier of the current page. Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string current_page = 1 [(.google.api.resource_reference) = { * @return string @@ -95,9 +92,8 @@ public function getCurrentPage() * Always present for * [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for * [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The - * unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`. + * unique identifier of the current page. Format: + * `projects//locations//agents//flows//pages/`. * * Generated from protobuf field string current_page = 1 [(.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/QueryParameters.php b/DialogflowCx/src/V3/QueryParameters.php index d861dab3cf26..0d36fd38d748 100644 --- a/DialogflowCx/src/V3/QueryParameters.php +++ b/DialogflowCx/src/V3/QueryParameters.php @@ -81,8 +81,8 @@ class QueryParameters extends \Google\Protobuf\Internal\Message /** * The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to * override the [current page][QueryResult.current_page] in the session. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * If `current_page` is specified, the previous state of the session will be * ignored by Dialogflow, including the [previous * page][QueryResult.current_page] and the [previous session @@ -123,8 +123,8 @@ class QueryParameters extends \Google\Protobuf\Internal\Message private $webhook_headers; /** * A list of flow versions to override for the request. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * If version 1 of flow X is included in this list, the traffic of * flow X will go through version 1 regardless of the version configuration in * the environment. Each flow can have at most one version specified in this @@ -245,8 +245,8 @@ class QueryParameters extends \Google\Protobuf\Internal\Message * @type string $current_page * The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to * override the [current page][QueryResult.current_page] in the session. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * If `current_page` is specified, the previous state of the session will be * ignored by Dialogflow, including the [previous * page][QueryResult.current_page] and the [previous session @@ -271,8 +271,8 @@ class QueryParameters extends \Google\Protobuf\Internal\Message * "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc. * @type array|\Google\Protobuf\Internal\RepeatedField $flow_versions * A list of flow versions to override for the request. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * If version 1 of flow X is included in this list, the traffic of * flow X will go through version 1 regardless of the version configuration in * the environment. Each flow can have at most one version specified in this @@ -552,8 +552,8 @@ public function setParameters($var) /** * The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to * override the [current page][QueryResult.current_page] in the session. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * If `current_page` is specified, the previous state of the session will be * ignored by Dialogflow, including the [previous * page][QueryResult.current_page] and the [previous session @@ -574,8 +574,8 @@ public function getCurrentPage() /** * The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to * override the [current page][QueryResult.current_page] in the session. - * Format: `projects//locations//agents//flows//pages/`. + * Format: + * `projects//locations//agents//flows//pages/`. * If `current_page` is specified, the previous state of the session will be * ignored by Dialogflow, including the [previous * page][QueryResult.current_page] and the [previous session @@ -693,8 +693,8 @@ public function setWebhookHeaders($var) /** * A list of flow versions to override for the request. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * If version 1 of flow X is included in this list, the traffic of * flow X will go through version 1 regardless of the version configuration in * the environment. Each flow can have at most one version specified in this @@ -710,8 +710,8 @@ public function getFlowVersions() /** * A list of flow versions to override for the request. - * Format: `projects//locations//agents//flows//versions/`. + * Format: + * `projects//locations//agents//flows//versions/`. * If version 1 of flow X is included in this list, the traffic of * flow X will go through version 1 regardless of the version configuration in * the environment. Each flow can have at most one version specified in this diff --git a/DialogflowCx/src/V3/QueryResult.php b/DialogflowCx/src/V3/QueryResult.php index 8a30be3c061f..8d287ba83bf2 100644 --- a/DialogflowCx/src/V3/QueryResult.php +++ b/DialogflowCx/src/V3/QueryResult.php @@ -187,8 +187,8 @@ class QueryResult extends \Google\Protobuf\Internal\Message /** * Optional. Data store connection feature output signals. * Filled only when data stores are involved in serving the query and - * DetectIntentRequest.populate data_store_connection_quality_signals is set - * to true in the request. + * DetectIntentRequest.populate_data_store_connection_signals is set to true + * in the request. * * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -207,8 +207,7 @@ class QueryResult extends \Google\Protobuf\Internal\Message * @type string $trigger_intent * If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as * input, this field will contain a copy of the intent identifier. Format: - * `projects//locations//agents//intents/`. + * `projects//locations//agents//intents/`. * @type string $transcript * If [natural language speech * audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, @@ -318,8 +317,8 @@ class QueryResult extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals $data_store_connection_signals * Optional. Data store connection feature output signals. * Filled only when data stores are involved in serving the query and - * DetectIntentRequest.populate data_store_connection_quality_signals is set - * to true in the request. + * DetectIntentRequest.populate_data_store_connection_signals is set to true + * in the request. * } */ public function __construct($data = NULL) { @@ -363,8 +362,7 @@ public function setText($var) /** * If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as * input, this field will contain a copy of the intent identifier. Format: - * `projects//locations//agents//intents/`. + * `projects//locations//agents//intents/`. * * Generated from protobuf field string trigger_intent = 11 [(.google.api.resource_reference) = { * @return string @@ -382,8 +380,7 @@ public function hasTriggerIntent() /** * If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as * input, this field will contain a copy of the intent identifier. Format: - * `projects//locations//agents//intents/`. + * `projects//locations//agents//intents/`. * * Generated from protobuf field string trigger_intent = 11 [(.google.api.resource_reference) = { * @param string $var @@ -1179,8 +1176,8 @@ public function setAllowAnswerFeedback($var) /** * Optional. Data store connection feature output signals. * Filled only when data stores are involved in serving the query and - * DetectIntentRequest.populate data_store_connection_quality_signals is set - * to true in the request. + * DetectIntentRequest.populate_data_store_connection_signals is set to true + * in the request. * * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals|null @@ -1203,8 +1200,8 @@ public function clearDataStoreConnectionSignals() /** * Optional. Data store connection feature output signals. * Filled only when data stores are involved in serving the query and - * DetectIntentRequest.populate data_store_connection_quality_signals is set - * to true in the request. + * DetectIntentRequest.populate_data_store_connection_signals is set to true + * in the request. * * Generated from protobuf field .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Dialogflow\Cx\V3\DataStoreConnectionSignals $var diff --git a/DialogflowCx/src/V3/ResponseMessage/Text.php b/DialogflowCx/src/V3/ResponseMessage/Text.php index deb8af9c8ea1..7f3dfa074aac 100644 --- a/DialogflowCx/src/V3/ResponseMessage/Text.php +++ b/DialogflowCx/src/V3/ResponseMessage/Text.php @@ -16,7 +16,8 @@ class Text extends \Google\Protobuf\Internal\Message { /** - * Required. A collection of text responses. + * Required. A collection of text response variants. If multiple variants + * are defined, only one text response variant is returned at runtime. * * Generated from protobuf field repeated string text = 1 [(.google.api.field_behavior) = REQUIRED]; */ @@ -37,7 +38,8 @@ class Text extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array|\Google\Protobuf\Internal\RepeatedField $text - * Required. A collection of text responses. + * Required. A collection of text response variants. If multiple variants + * are defined, only one text response variant is returned at runtime. * @type bool $allow_playback_interruption * Output only. Whether the playback of this message can be interrupted by * the end user's speech and the client can then starts the next Dialogflow @@ -50,7 +52,8 @@ public function __construct($data = NULL) { } /** - * Required. A collection of text responses. + * Required. A collection of text response variants. If multiple variants + * are defined, only one text response variant is returned at runtime. * * Generated from protobuf field repeated string text = 1 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\Internal\RepeatedField @@ -61,7 +64,8 @@ public function getText() } /** - * Required. A collection of text responses. + * Required. A collection of text response variants. If multiple variants + * are defined, only one text response variant is returned at runtime. * * Generated from protobuf field repeated string text = 1 [(.google.api.field_behavior) = REQUIRED]; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DialogflowCx/src/V3/RestoreAgentRequest.php b/DialogflowCx/src/V3/RestoreAgentRequest.php index 00e8e68ed169..61add1cb7f43 100644 --- a/DialogflowCx/src/V3/RestoreAgentRequest.php +++ b/DialogflowCx/src/V3/RestoreAgentRequest.php @@ -18,7 +18,7 @@ class RestoreAgentRequest extends \Google\Protobuf\Internal\Message { /** * Required. The name of the agent to restore into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -39,7 +39,7 @@ class RestoreAgentRequest extends \Google\Protobuf\Internal\Message * * @type string $name * Required. The name of the agent to restore into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * @type string $agent_uri * The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI * to restore agent from. The format of this URI must be @@ -64,7 +64,7 @@ public function __construct($data = NULL) { /** * Required. The name of the agent to restore into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -76,7 +76,7 @@ public function getName() /** * Required. The name of the agent to restore into. - * Format: `projects//locations//agents/`. + * Format: `projects//locations//agents/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/RunContinuousTestRequest.php b/DialogflowCx/src/V3/RunContinuousTestRequest.php index 8758231500cf..f1a0e46bb7c2 100644 --- a/DialogflowCx/src/V3/RunContinuousTestRequest.php +++ b/DialogflowCx/src/V3/RunContinuousTestRequest.php @@ -17,8 +17,8 @@ class RunContinuousTestRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Format: `projects//locations//agents//environments/`. + * Required. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -31,8 +31,8 @@ class RunContinuousTestRequest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $environment - * Required. Format: `projects//locations//agents//environments/`. + * Required. Format: + * `projects//locations//agents//environments/`. * } */ public function __construct($data = NULL) { @@ -41,8 +41,8 @@ public function __construct($data = NULL) { } /** - * Required. Format: `projects//locations//agents//environments/`. + * Required. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -53,8 +53,8 @@ public function getEnvironment() } /** - * Required. Format: `projects//locations//agents//environments/`. + * Required. Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/RunTestCaseRequest.php b/DialogflowCx/src/V3/RunTestCaseRequest.php index f0257812b66a..90e3bf3f4682 100644 --- a/DialogflowCx/src/V3/RunTestCaseRequest.php +++ b/DialogflowCx/src/V3/RunTestCaseRequest.php @@ -17,16 +17,16 @@ class RunTestCaseRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Format of test case name to run: `projects//locations/ /agents//testCases/`. + * Required. Format of test case name to run: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** * Optional. Environment name. If not set, draft environment is assumed. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { */ @@ -39,12 +39,12 @@ class RunTestCaseRequest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Required. Format of test case name to run: `projects//locations/ /agents//testCases/`. + * Required. Format of test case name to run: + * `projects//locations//agents//testCases/`. * @type string $environment * Optional. Environment name. If not set, draft environment is assumed. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * } */ public function __construct($data = NULL) { @@ -53,8 +53,8 @@ public function __construct($data = NULL) { } /** - * Required. Format of test case name to run: `projects//locations/ /agents//testCases/`. + * Required. Format of test case name to run: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -65,8 +65,8 @@ public function getName() } /** - * Required. Format of test case name to run: `projects//locations/ /agents//testCases/`. + * Required. Format of test case name to run: + * `projects//locations//agents//testCases/`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -82,8 +82,8 @@ public function setName($var) /** * Optional. Environment name. If not set, draft environment is assumed. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @return string @@ -95,8 +95,8 @@ public function getEnvironment() /** * Optional. Environment name. If not set, draft environment is assumed. - * Format: `projects//locations//agents//environments/`. + * Format: + * `projects//locations//agents//environments/`. * * Generated from protobuf field string environment = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { * @param string $var diff --git a/DialogflowCx/src/V3/SecuritySettings.php b/DialogflowCx/src/V3/SecuritySettings.php index f4707817be0e..ac6874769c0e 100644 --- a/DialogflowCx/src/V3/SecuritySettings.php +++ b/DialogflowCx/src/V3/SecuritySettings.php @@ -23,8 +23,8 @@ class SecuritySettings extends \Google\Protobuf\Internal\Message * [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings] * method. * [SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.CreateSecuritySettings] - * populates the name automatically. Format: `projects//locations//securitySettings/`. + * populates the name automatically. Format: + * `projects//locations//securitySettings/`. * * Generated from protobuf field string name = 1; */ @@ -59,9 +59,9 @@ class SecuritySettings extends \Google\Protobuf\Internal\Message * for your agent's project. * If empty, we use the default DLP inspect config. * The template name will have one of the following formats: - * `projects//locations//inspectTemplates/